/*

  * Copyright 2007 The Kuali Foundation Licensed under the Educational Community

  * License, Version 1.0 (the "License"); you may not use this file except in

  * compliance with the License. You may obtain a copy of the License at

  * http://www.opensource.org/licenses/ecl1.php Unless required by applicable law

  * or agreed to in writing, software distributed under the License is

  * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied. See the License for the specific language

  * governing permissions and limitations under the License.

  */

 package org.kuali.rice.kns.uif.core;

 import java.util.ArrayList;

 import java.util.HashMap;

 import java.util.HashSet;

 import java.util.List;

 import java.util.ListIterator;

 import java.util.Map;

 import java.util.Set;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.kns.uif.CssConstants;

 import org.kuali.rice.kns.uif.UifConstants.ViewStatus;

 import org.kuali.rice.kns.uif.UifPropertyPaths;

 import org.kuali.rice.kns.uif.container.View;

 import org.kuali.rice.kns.uif.control.ControlBase;

 import org.kuali.rice.kns.uif.field.AttributeField;

 import org.kuali.rice.kns.uif.modifier.ComponentModifier;

 import org.kuali.rice.kns.uif.util.ComponentUtils;

 import org.kuali.rice.kns.uif.util.ViewModelUtils;

 /**

  * Base implementation of <code>Component</code> which other component

  * implementations should extend

  *

  * <p>

  * Provides base component properties such as id and template. Also provides

  * default implementation for the <code>ScriptEventSupport</code> and

  * <code>Ordered</code> interfaces. By default no script events except the

  * onDocumentReady are supported.

  * </p>

  *

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 public abstract class ComponentBase implements Component {

     private static final long serialVersionUID = -4449335748129894350L;

     private String id;

     private String template;

     private String title;

     private boolean render;

     private boolean refresh;

     private String conditionalRender;

     private String progressiveRender;

     private boolean progressiveRenderViaAJAX;

     private boolean progressiveRenderAndRefresh;

     private List<String> progressiveDisclosureControlNames;

     private String progressiveDisclosureConditionJs;

     private String conditionalRefresh;

     private String conditionalRefreshConditionJs;

     private List<String> conditionalRefreshControlNames;

     private String refreshWhenChanged;

     private List<String> refreshWhenChangedControlNames;

     private boolean hidden;

     private boolean readOnly;

     private String conditionalReadOnly;

     private Boolean required;

     private String conditionalRequired;

     private String align;

     private String valign;

     private String width;

     private int colSpan;

     private String conditionalColSpan;

     private int rowSpan;

     private String conditionalRowSpan;

     private String style;

     private List<String> styleClasses;

     private int order;

     private boolean skipInTabOrder;

     private String finalizeMethodToCall;

     private MethodInvokerConfig finalizeMethodInvoker;

     private boolean selfRendered;

     private String renderOutput;

     private String onLoadScript;

     private String onUnloadScript;

     private String onCloseScript;

     private String onBlurScript;

     private String onChangeScript;

     private String onClickScript;

     private String onDblClickScript;

     private String onFocusScript;

     private String onSubmitScript;

     private String onKeyPressScript;

     private String onKeyUpScript;

     private String onKeyDownScript;

     private String onMouseOverScript;

     private String onMouseOutScript;

     private String onMouseUpScript;

     private String onMouseDownScript;

     private String onMouseMoveScript;

     private String onDocumentReadyScript;

     private List<ComponentModifier> componentModifiers;

     private Map<String, String> componentOptions;

     @ReferenceCopy(newCollectionInstance = true)

     private transient Map<String, Object> context;

     private Map<String, String> propertyExpressions;

     private List<PropertyReplacer> propertyReplacers;

     public ComponentBase() {

         order = 0;

         colSpan = 1;

         rowSpan = 1;

         render = true;

         selfRendered = false;

         progressiveRenderViaAJAX = false;

         progressiveRenderAndRefresh = false;

         styleClasses = new ArrayList<String>();

         componentModifiers = new ArrayList<ComponentModifier>();

         componentOptions = new HashMap<String, String>();

         context = new HashMap<String, Object>();

         propertyExpressions = new HashMap<String, String>();

         propertyReplacers = new ArrayList<PropertyReplacer>();

     }

     /**

      * The following initialization is performed: progressiveRender and

      * conditionalRefresh variables are processed if set.

      * <ul>

      * </ul>

      * 

      * @see org.kuali.rice.kns.uif.core.ComponentBase#performInitialization(org.kuali.rice.kns.uif.container.View)

      */

     public void performInitialization(View view) {

         if (StringUtils.isNotEmpty(progressiveRender)) {

             // progressive anded with conditional render, will not render at

             // least one of the two are false.

             if (StringUtils.isNotEmpty(conditionalRender)) {

                 conditionalRender = "(" + conditionalRender + ") and (" + progressiveRender + ")";

             } else {

                 conditionalRender = progressiveRender;

             }

             progressiveDisclosureControlNames = new ArrayList<String>();

             progressiveDisclosureConditionJs = ComponentUtils.parseExpression(progressiveRender,

                     progressiveDisclosureControlNames);

         }

         if (StringUtils.isNotEmpty(conditionalRefresh)) {

             conditionalRefreshControlNames = new ArrayList<String>();

             conditionalRefreshConditionJs = ComponentUtils.parseExpression(conditionalRefresh,

                     conditionalRefreshControlNames);

         }

         if (StringUtils.isNotEmpty(refreshWhenChanged)) {

             refreshWhenChangedControlNames = new ArrayList<String>();

             String[] names = StringUtils.split(refreshWhenChanged, ",");

             for (String name : names) {

                 refreshWhenChangedControlNames.add(name.trim());

             }

         }

     }

     /**

      * The following updates are done here:

      * <ul>

      * <li></li>

      * </ul>

      * 

      * @see org.kuali.rice.kns.uif.core.Component#performApplyModel(org.kuali.rice.kns.uif.container.View,

      *      java.lang.Object)

      */

     public void performApplyModel(View view, Object model) {

     }

     /**

      * The following finalization is done here:

      * <ul>

      * <li>If any of the style properties were given, sets the style string on

      * the style property</li>

      * <li>Setup the decorator chain (if component has decorators) for rendering

      * </li>

      * <li>Set the skipInTabOrder flag for nested components</li>

      * </ul>

      * 

      * @see org.kuali.rice.kns.uif.core.Component#performFinalize(org.kuali.rice.kns.uif.container.View,

      *      java.lang.Object, org.kuali.rice.kns.uif.core.Component)

      */

     public void performFinalize(View view, Object model, Component parent) {

         if (!ViewStatus.FINAL.equals(view.getViewStatus())) {

             // add the align, valign, and width settings to style

             if (StringUtils.isNotBlank(getAlign()) && !StringUtils.contains(getStyle(), CssConstants.TEXT_ALIGN)) {

                 appendToStyle(CssConstants.TEXT_ALIGN + getAlign() + ";");

             }

             if (StringUtils.isNotBlank(getValign()) && !StringUtils.contains(getStyle(), CssConstants.VERTICAL_ALIGN)) {

                 appendToStyle(CssConstants.VERTICAL_ALIGN + getValign() + ";");

             }

             if (StringUtils.isNotBlank(getWidth()) && !StringUtils.contains(getStyle(), CssConstants.WIDTH)) {

                 appendToStyle(CssConstants.WIDTH + getWidth() + ";");

             }

         }

         // Set the skipInTabOrder flag on all nested components

         // Set the tabIndex on controls to -1 in order to be skipped on tabbing

         for (Component component : getNestedComponents()) {

             if (component != null && component instanceof ComponentBase && skipInTabOrder) {

                 ((ComponentBase) component).setSkipInTabOrder(skipInTabOrder);

                 if (component instanceof ControlBase) {

                     ((ControlBase) component).setTabIndex(-1);

                 }

             }

         }

         // replace the #line? collections place holder with the correct binding

         // path

         // TODO : handle all components not only AttributeField

         if (StringUtils.isNotEmpty(progressiveRender)) {

             if (progressiveRender.indexOf("#line?") != -1 && this instanceof AttributeField) {

                 String path = ViewModelUtils.getParentObjectPath((AttributeField) this);

                 progressiveDisclosureConditionJs = progressiveDisclosureConditionJs.replace("#line?", path);

                 ListIterator<String> listIterator = progressiveDisclosureControlNames.listIterator();

                 while (listIterator.hasNext()) {

                     listIterator.set(listIterator.next().replace("#line?", path));

                 }

             }

         }

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getNestedComponents()

      */

     @Override

     public List<Component> getNestedComponents() {

         List<Component> components = new ArrayList<Component>();

         return components;

     }

     /**

      * Set of property names for the component base for which on the property

      * value reference should be copied. Subclasses can override this but should

      * include a call to super

      * 

      * @see org.kuali.rice.kns.uif.core.Component#getPropertiesForReferenceCopy()

      */

     public Set<String> getPropertiesForReferenceCopy() {

         Set<String> refCopyProperties = new HashSet<String>();

         refCopyProperties.add(UifPropertyPaths.COMPONENT_MODIFIERS);

         refCopyProperties.add(UifPropertyPaths.CONTEXT);

         return refCopyProperties;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getId()

      */

     public String getId() {

         return this.id;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setId(java.lang.String)

      */

     public void setId(String id) {

         this.id = id;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getTemplate()

      */

     public String getTemplate() {

         return this.template;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setTemplate(java.lang.String)

      */

     public void setTemplate(String template) {

         this.template = template;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getTitle()

      */

     public String getTitle() {

         return this.title;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setTitle(java.lang.String)

      */

     public void setTitle(String title) {

         this.title = title;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#isHidden()

      */

     public boolean isHidden() {

         return this.hidden;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setHidden(boolean)

      */

     public void setHidden(boolean hidden) {

         this.hidden = hidden;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#isReadOnly()

      */

     public boolean isReadOnly() {

         return this.readOnly;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setReadOnly(boolean)

      */

     public void setReadOnly(boolean readOnly) {

         this.readOnly = readOnly;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getConditionalReadOnly()

      */

     public String getConditionalReadOnly() {

         return this.conditionalReadOnly;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setConditionalReadOnly(java.lang.String)

      */

     public void setConditionalReadOnly(String conditionalReadOnly) {

         this.conditionalReadOnly = conditionalReadOnly;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getRequired()

      */

     public Boolean getRequired() {

         return this.required;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setRequired(java.lang.Boolean)

      */

     public void setRequired(Boolean required) {

         this.required = required;

     }

     /**

      * Expression language string for conditionally setting the required

      * property

      * 

      * @return String el that should evaluate to boolean

      */

     public String getConditionalRequired() {

         return this.conditionalRequired;

     }

     /**

      * Setter for the conditional required string

      * 

      * @param conditionalRequired

      */

     public void setConditionalRequired(String conditionalRequired) {

         this.conditionalRequired = conditionalRequired;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#isRender()

      */

     public boolean isRender() {

         return this.render;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setRender(boolean)

      */

     public void setRender(boolean render) {

         this.render = render;

     }

     public void setRender(String render) {

         this.propertyExpressions.put("render", render);

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getConditionalRender()

      */

     public String getConditionalRender() {

         return this.conditionalRender;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setConditionalRender(java.lang.String)

      */

     public void setConditionalRender(String conditionalRender) {

         this.conditionalRender = conditionalRender;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getColSpan()

      */

     public int getColSpan() {

         return this.colSpan;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setColSpan(int)

      */

     public void setColSpan(int colSpan) {

         this.colSpan = colSpan;

     }

     /**

      * Expression language string for conditionally setting the colSpan property

      * 

      * @return String el that should evaluate to int

      */

     public String getConditionalColSpan() {

         return this.conditionalColSpan;

     }

     /**

      * Setter for the conditional colSpan string

      * 

      * @param conditionalColSpan

      */

     public void setConditionalColSpan(String conditionalColSpan) {

         this.conditionalColSpan = conditionalColSpan;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getRowSpan()

      */

     public int getRowSpan() {

         return this.rowSpan;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setRowSpan(int)

      */

     public void setRowSpan(int rowSpan) {

         this.rowSpan = rowSpan;

     }

     /**

      * Expression language string for conditionally setting the rowSpan property

      * 

      * @return String el that should evaluate to int

      */

     public String getConditionalRowSpan() {

         return this.conditionalRowSpan;

     }

     /**

      * Setter for the conditional rowSpan string

      * 

      * @param conditionalRowSpan

      */

     public void setConditionalRowSpan(String conditionalRowSpan) {

         this.conditionalRowSpan = conditionalRowSpan;

     }

     /**

      * Horizontal alignment of the component within its container

      * <p>

      * All components belong to a <code>Container</code> and are placed using a

      * <code>LayoutManager</code>. This property specifies how the component

      * should be aligned horizontally within the container. During the finalize

      * phase the CSS text-align style will be created for the align setting.

      * </p>

      * 

      * @return String horizontal align

      * @see org.kuali.rice.kns.uif.CssConstants.TextAligns

      */

     public String getAlign() {

         return this.align;

     }

     /**

      * Sets the components horizontal alignment

      * 

      * @param align

      */

     public void setAlign(String align) {

         this.align = align;

     }

     /**

      * Vertical alignment of the component within its container

      * <p>

      * All components belong to a <code>Container</code> and are placed using a

      * <code>LayoutManager</code>. This property specifies how the component

      * should be aligned vertically within the container. During the finalize

      * phase the CSS vertical-align style will be created for the valign

      * setting.

      * </p>

      * 

      * @return String vertical align

      * @see org.kuali.rice.kns.uif.CssConstants.VerticalAligns

      */

     public String getValign() {

         return this.valign;

     }

     /**

      * Setter for the component's vertical align

      * 

      * @param valign

      */

     public void setValign(String valign) {

         this.valign = valign;

     }

     /**

      * Width the component should take up in the container

      * <p>

      * All components belong to a <code>Container</code> and are placed using a

      * <code>LayoutManager</code>. This property specifies a width the component

      * should take up in the Container. This is not applicable for all layout

      * managers. During the finalize phase the CSS width style will be created

      * for the width setting.

      * </p>

      * <p>

      * e.g. '30%', '55px'

      * </p>

      * 

      * @return String width string

      */

     public String getWidth() {

         return this.width;

     }

     /**

      * Setter for the components width

      * 

      * @param width

      */

     public void setWidth(String width) {

         this.width = width;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getStyle()

      */

     public String getStyle() {

         return this.style;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setStyle(java.lang.String)

      */

     public void setStyle(String style) {

         this.style = style;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getStyleClasses()

      */

     public List<String> getStyleClasses() {

         return this.styleClasses;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setStyleClasses(java.util.List)

      */

     public void setStyleClasses(List<String> styleClasses) {

         this.styleClasses = styleClasses;

     }

     /**

      * Builds the HTML class attribute string by combining the styleClasses list

      * with a space delimiter

      * 

      * @return String class attribute string

      */

     public String getStyleClassesAsString() {

         if (styleClasses != null) {

             return StringUtils.join(styleClasses, " ");

         }

         return "";

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#addStyleClass(java.lang.String)

      */

     public void addStyleClass(String styleClass) {

         if (!styleClasses.contains(styleClass)) {

             styleClasses.add(styleClass);

         }

     }

     /**

      * @see org.kuali.rice.kns.uif.Component#appendToStyle(java.lang.String)

      */

     public void appendToStyle(String styleRules) {

         if (style == null) {

             style = "";

         }

         style = style + styleRules;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getFinalizeMethodToCall()

      */

     public String getFinalizeMethodToCall() {

         return this.finalizeMethodToCall;

     }

     /**

      * Setter for the finalize method

      * 

      * @param finalizeMethodToCall

      */

     public void setFinalizeMethodToCall(String finalizeMethodToCall) {

         this.finalizeMethodToCall = finalizeMethodToCall;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getFinalizeMethodInvoker()

      */

     public MethodInvokerConfig getFinalizeMethodInvoker() {

         return this.finalizeMethodInvoker;

     }

     /**

      * Setter for the method invoker instance

      * 

      * @param renderingMethodInvoker

      */

     public void setFinalizeMethodInvoker(MethodInvokerConfig finalizeMethodInvoker) {

         this.finalizeMethodInvoker = finalizeMethodInvoker;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#isSelfRendered()

      */

     public boolean isSelfRendered() {

         return this.selfRendered;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setSelfRendered(boolean)

      */

     public void setSelfRendered(boolean selfRendered) {

         this.selfRendered = selfRendered;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getRenderOutput()

      */

     public String getRenderOutput() {

         return this.renderOutput;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setRenderOutput(java.lang.String)

      */

     public void setRenderOutput(String renderOutput) {

         this.renderOutput = renderOutput;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getComponentModifiers()

      */

     public List<ComponentModifier> getComponentModifiers() {

         return this.componentModifiers;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setComponentModifiers(java.util.List)

      */

     public void setComponentModifiers(List<ComponentModifier> componentModifiers) {

         this.componentModifiers = componentModifiers;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getContext()

      */

     public Map<String, Object> getContext() {

         return this.context;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setContext(java.util.Map)

      */

     public void setContext(Map<String, Object> context) {

         this.context = context;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#pushObjectToContext(java.lang.String,

      *      java.lang.Object)

      */

     public void pushObjectToContext(String objectName, Object object) {

         if (this.context == null) {

             this.context = new HashMap<String, Object>();

         }

         this.context.put(objectName, object);

     }

     public Map<String, String> getPropertyExpressions() {

         return propertyExpressions;

     }

     public void setPropertyExpressions(Map<String, String> propertyExpressions) {

         this.propertyExpressions = propertyExpressions;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#getPropertyReplacers()

      */

     public List<PropertyReplacer> getPropertyReplacers() {

         return this.propertyReplacers;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.Component#setPropertyReplacers(java.util.List)

      */

     public void setPropertyReplacers(List<PropertyReplacer> propertyReplacers) {

         this.propertyReplacers = propertyReplacers;

     }

     /**

      * @see org.springframework.core.Ordered#getOrder()

      */

     public int getOrder() {

         return this.order;

     }

     /**

      * Setter for the component's order

      * 

      * @param order

      */

     public void setOrder(int order) {

         this.order = order;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnLoad()

      */

     public boolean getSupportsOnLoad() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnLoadScript()

      */

     public String getOnLoadScript() {

         return onLoadScript;

     }

     /**

      * Setter for the components onLoad script

      * 

      * @param onLoadScript

      */

     public void setOnLoadScript(String onLoadScript) {

         this.onLoadScript = onLoadScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnDocumentReady()

      */

     public boolean getSupportsOnDocumentReady() {

         return true;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnDocumentReadyScript()

      */

     public String getOnDocumentReadyScript() {

         return onDocumentReadyScript;

     }

     /**

      * Setter for the components onDocumentReady script

      * 

      * @param onDocumentReadyScript

      */

     public void setOnDocumentReadyScript(String onDocumentReadyScript) {

         this.onDocumentReadyScript = onDocumentReadyScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnUnload()

      */

     public boolean getSupportsOnUnload() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnUnloadScript()

      */

     public String getOnUnloadScript() {

         return onUnloadScript;

     }

     /**

      * Setter for the components onUnload script

      * 

      * @param onUnloadScript

      */

     public void setOnUnloadScript(String onUnloadScript) {

         this.onUnloadScript = onUnloadScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnClose()

      */

     public boolean getSupportsOnClose() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnCloseScript()

      */

     public String getOnCloseScript() {

         return onCloseScript;

     }

     /**

      * Setter for the components onClose script

      * 

      * @param onCloseScript

      */

     public void setOnCloseScript(String onCloseScript) {

         this.onCloseScript = onCloseScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnBlur()

      */

     public boolean getSupportsOnBlur() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnBlurScript()

      */

     public String getOnBlurScript() {

         return onBlurScript;

     }

     /**

      * Setter for the components onBlur script

      * 

      * @param onBlurScript

      */

     public void setOnBlurScript(String onBlurScript) {

         this.onBlurScript = onBlurScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnChange()

      */

     public boolean getSupportsOnChange() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnChangeScript()

      */

     public String getOnChangeScript() {

         return onChangeScript;

     }

     /**

      * Setter for the components onChange script

      * 

      * @param onChangeScript

      */

     public void setOnChangeScript(String onChangeScript) {

         this.onChangeScript = onChangeScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnClick()

      */

     public boolean getSupportsOnClick() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnClickScript()

      */

     public String getOnClickScript() {

         return onClickScript;

     }

     /**

      * Setter for the components onClick script

      * 

      * @param onClickScript

      */

     public void setOnClickScript(String onClickScript) {

         this.onClickScript = onClickScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnDblClick()

      */

     public boolean getSupportsOnDblClick() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnDblClickScript()

      */

     public String getOnDblClickScript() {

         return onDblClickScript;

     }

     /**

      * Setter for the components onDblClick script

      * 

      * @param onDblClickScript

      */

     public void setOnDblClickScript(String onDblClickScript) {

         this.onDblClickScript = onDblClickScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnFocus()

      */

     public boolean getSupportsOnFocus() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnFocusScript()

      */

     public String getOnFocusScript() {

         return onFocusScript;

     }

     /**

      * Setter for the components onFocus script

      * 

      * @param onFocusScript

      */

     public void setOnFocusScript(String onFocusScript) {

         this.onFocusScript = onFocusScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnSubmit()

      */

     public boolean getSupportsOnSubmit() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnSubmitScript()

      */

     public String getOnSubmitScript() {

         return onSubmitScript;

     }

     /**

      * Setter for the components onSubmit script

      * 

      * @param onSubmitScript

      */

     public void setOnSubmitScript(String onSubmitScript) {

         this.onSubmitScript = onSubmitScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnKeyPress()

      */

     public boolean getSupportsOnKeyPress() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnKeyPressScript()

      */

     public String getOnKeyPressScript() {

         return onKeyPressScript;

     }

     /**

      * Setter for the components onKeyPress script

      * 

      * @param onKeyPressScript

      */

     public void setOnKeyPressScript(String onKeyPressScript) {

         this.onKeyPressScript = onKeyPressScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnKeyUp()

      */

     public boolean getSupportsOnKeyUp() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnKeyUpScript()

      */

     public String getOnKeyUpScript() {

         return onKeyUpScript;

     }

     /**

      * Setter for the components onKeyUp script

      * 

      * @param onKeyUpScript

      */

     public void setOnKeyUpScript(String onKeyUpScript) {

         this.onKeyUpScript = onKeyUpScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnKeyDown()

      */

     public boolean getSupportsOnKeyDown() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnKeyDownScript()

      */

     public String getOnKeyDownScript() {

         return onKeyDownScript;

     }

     /**

      * Setter for the components onKeyDown script

      * 

      * @param onKeyDownScript

      */

     public void setOnKeyDownScript(String onKeyDownScript) {

         this.onKeyDownScript = onKeyDownScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnMouseOver()

      */

     public boolean getSupportsOnMouseOver() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnMouseOverScript()

      */

     public String getOnMouseOverScript() {

         return onMouseOverScript;

     }

     /**

      * Setter for the components onMouseOver script

      * 

      * @param onMouseOverScript

      */

     public void setOnMouseOverScript(String onMouseOverScript) {

         this.onMouseOverScript = onMouseOverScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnMouseOut()

      */

     public boolean getSupportsOnMouseOut() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnMouseOutScript()

      */

     public String getOnMouseOutScript() {

         return onMouseOutScript;

     }

     /**

      * Setter for the components onMouseOut script

      * 

      * @param onMouseOutScript

      */

     public void setOnMouseOutScript(String onMouseOutScript) {

         this.onMouseOutScript = onMouseOutScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnMouseUp()

      */

     public boolean getSupportsOnMouseUp() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnMouseUpScript()

      */

     public String getOnMouseUpScript() {

         return onMouseUpScript;

     }

     /**

      * Setter for the components onMouseUp script

      * 

      * @param onMouseUpScript

      */

     public void setOnMouseUpScript(String onMouseUpScript) {

         this.onMouseUpScript = onMouseUpScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnMouseDown()

      */

     public boolean getSupportsOnMouseDown() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnMouseDownScript()

      */

     public String getOnMouseDownScript() {

         return onMouseDownScript;

     }

     /**

      * Setter for the components onMouseDown script

      * 

      * @param onMouseDownScript

      */

     public void setOnMouseDownScript(String onMouseDownScript) {

         this.onMouseDownScript = onMouseDownScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getSupportsOnMouseMove()

      */

     public boolean getSupportsOnMouseMove() {

         return false;

     }

     /**

      * @see org.kuali.rice.kns.uif.core.ScriptEventSupport#getOnMouseMoveScript()

      */

     public String getOnMouseMoveScript() {

         return onMouseMoveScript;

     }

     /**

      * Setter for the components onMouseMove script

      * 

      * @param onMouseMoveScript

      */

     public void setOnMouseMoveScript(String onMouseMoveScript) {

         this.onMouseMoveScript = onMouseMoveScript;

     }

     /**

      * @see org.kuali.rice.kns.uif.widget.Widget#getWidgetOptions()

      */

     public Map<String, String> getComponentOptions() {

         if (componentOptions == null) {

             componentOptions = new HashMap<String, String>();

         }

         return this.componentOptions;

     }

     /**

      * @see org.kuali.rice.kns.uif.widget.Widget#setWidgetOptions(java.util.Map)

      */

     public void setComponentOptions(Map<String, String> componentOptions) {

         this.componentOptions = componentOptions;

     }

     /**

      * Builds a string from the underlying <code>Map</code> of component options

      * that will export that options as a JavaScript Map for use in js and

      * jQuery plugins

      * 

      * @return String of widget options formatted as JS Map

      */

     public String getComponentOptionsJSString() {

         if (componentOptions == null) {

             componentOptions = new HashMap<String, String>();

         }

         StringBuffer sb = new StringBuffer();

         sb.append("{");

         for (String optionKey : componentOptions.keySet()) {

             String optionValue = componentOptions.get(optionKey);

             if (sb.length() > 1) {

                 sb.append(",");

             }

             sb.append(optionKey);

             sb.append(":");

             boolean isNumber = false;

             if (StringUtils.isNotBlank(optionValue)

                     && (StringUtils.isNumeric(optionValue.trim().substring(0, 1)) || optionValue.trim().substring(0, 1)

                             .equals("-"))) {

                 try {

                     Double.parseDouble(optionValue.trim());

                     isNumber = true;

                 } catch (NumberFormatException e) {

                     isNumber = false;

                 }

             }

             // If an option value starts with { or [, it would be a nested value

             // and it should not use quotes around it

             if (StringUtils.startsWith(optionValue, "{") || StringUtils.startsWith(optionValue, "[")) {

                 sb.append(optionValue);

             }

             // need to be the base boolean value "false" is true in js - a non

             // empty string

             else if (optionValue.equalsIgnoreCase("false") || optionValue.equalsIgnoreCase("true")) {

                 sb.append(optionValue);

             }

             // for numerics

             else if (isNumber) {

                 sb.append(optionValue);

             } else {

                 sb.append("\"" + optionValue + "\"");

             }

         }

         sb.append("}");

         return sb.toString();

     }

     public String getEventCode() {

         String eventCode = "";

         return eventCode;

     }

     /**

      * When set if the condition is satisfied, the component will be displayed.

      * The component MUST BE a container or field type. progressiveRender is

      * defined in a limited Spring EL syntax. Only valid form property names,

      * and, or, logical comparison operators (non-arithmetic), and the matches

      * clause are allowed. String and regex values must use single quotes ('),

      * booleans must be either true or false, numbers must be a valid double,

      * either negative or positive. <br>

      * DO NOT use progressiveRender and conditionalRefresh on the same component

      * unless it is known that the component will always be visible in all cases

      * when a conditionalRefresh happens (ie conditionalRefresh has

      * progressiveRender's condition anded with its own condition). <b>If a

      * component should be refreshed every time it is shown, use the

      * progressiveRenderAndRefresh option with this property instead.</b>

      * 

      * @return the progressiveRender

      */

     public String getProgressiveRender() {

         return this.progressiveRender;

     }

     /**

      * @param progressiveRender

      *            the progressiveRender to set

      */

     public void setProgressiveRender(String progressiveRender) {

         this.progressiveRender = progressiveRender;

     }

     /**

      * When set if the condition is satisfied, the component will be refreshed.

      * The component MUST BE a container or field type. conditionalRefresh is

      * defined in a limited Spring EL syntax. Only valid form property names,

      * and, or, logical comparison operators (non-arithmetic), and the matches

      * clause are allowed. String and regex values must use single quotes ('),

      * booleans must be either true or false, numbers must be a valid double

      * either negative or positive. <br>

      * DO NOT use progressiveRender and conditionalRefresh on the same component

      * unless it is known that the component will always be visible in all cases

      * when a conditionalRefresh happens (ie conditionalRefresh has

      * progressiveRender's condition anded with its own condition). <b>If a