org.kuali.rice.krad.uif.control
Class ControlBase

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.control.ControlBase

All Implemented Interfaces:

Serializable, Component, Configurable, ScriptEventSupport, Control, org.springframework.core.Ordered

Direct Known Subclasses:

CheckboxControl, FileControl, HiddenControl, MultiValueControlBase, TextAreaControl, TextControl

public abstract class ControlBase
extends ComponentBase
implements Control

Base class for all Control implementations

Author:

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

See Also:

Control, Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

ControlBase()

Method Summary

String	getComponentTypeName() The name for the component type
String	getDisabledReason() If the control is disabled, gives a reason for why which will be displayed as a tooltip on the control
boolean	getSupportsOnBlur() Indicates whether the component supports the onBlur event
boolean	getSupportsOnChange() Indicates whether the component supports the onChange event
boolean	getSupportsOnClick() Indicates whether the component supports the onClick event
boolean	getSupportsOnDblClick() Indicates whether the component supports the onDblClick event
boolean	getSupportsOnFocus() Indicates whether the component supports the onFocus event
int	getTabIndex() Unique index of the control within the tab order
boolean	isDisabled() Indicates whether the control is disabled (doesn't allow input)
void	setDisabled(boolean disabled) Setter for the disabled indicator
void	setDisabledReason(String disabledReason) Setter for the disabled reason text
void	setTabIndex(int tabIndex) Setter for the controls tab order index

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getComponentSecurityClass, getComponentsForLifecycle, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshDiscloseMethodToCall, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnClose, getSupportsOnDocumentReady, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

Methods inherited from class org.kuali.rice.krad.uif.component.ConfigurableBase

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getComponentsForLifecycle, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnClose, getSupportsOnDocumentReady, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Constructor Detail

ControlBase

public ControlBase()

Method Detail

getComponentTypeName

public final String getComponentTypeName()

Description copied from interface: Component

The name for the component type

This is used within the rendering layer to pass the component instance into the template. The component instance is exported under the name given by this method.

Specified by:

getComponentTypeName in interface Component

Returns:

String type name

See Also:

Component.getComponentTypeName()

getTabIndex

public int getTabIndex()

Description copied from interface: Control

Unique index of the control within the tab order

Tab index provides a way to set the order users will tab through the controls. The control with index 1 will receive focus when the page is rendered. Tabing from the field will then take the user to the control with index 2, then index 3, and so on.

Specified by:

getTabIndex in interface Control

Returns:

int the tab index for the control

See Also:

Control.getTabIndex()

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Control

Setter for the controls tab order index

Specified by:

setTabIndex in interface Control

See Also:

Control.setTabIndex(int)

isDisabled

public boolean isDisabled()

Description copied from interface: Control

Indicates whether the control is disabled (doesn't allow input)

Specified by:

isDisabled in interface Control

Returns:

boolean true if the control is disabled, false if not

See Also:

Control.isDisabled()

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: Control

Setter for the disabled indicator

Specified by:

setDisabled in interface Control

See Also:

Control.setDisabled(boolean)

getDisabledReason

public String getDisabledReason()

Description copied from interface: Control

If the control is disabled, gives a reason for why which will be displayed as a tooltip on the control

Specified by:

getDisabledReason in interface Control

Returns:

String disabled reason text

See Also:

Control.getDisabledReason()

setDisabledReason

public void setDisabledReason(String disabledReason)

Description copied from interface: Control

Setter for the disabled reason text

Specified by:

setDisabledReason in interface Control

See Also:

Control.setDisabledReason(java.lang.String)

getSupportsOnChange

public boolean getSupportsOnChange()

Description copied from interface: ScriptEventSupport

Indicates whether the component supports the onChange event

Specified by:

getSupportsOnChange in interface ScriptEventSupport

Overrides:

getSupportsOnChange in class ComponentBase

Returns:

boolean true if event is supported, false if the event is not supported

See Also:

ScriptEventSupport.getSupportsOnChange()

getSupportsOnBlur

public boolean getSupportsOnBlur()

Description copied from interface: ScriptEventSupport

Indicates whether the component supports the onBlur event

Specified by:

getSupportsOnBlur in interface ScriptEventSupport

Overrides:

getSupportsOnBlur in class ComponentBase

Returns:

boolean true if event is supported, false if the event is not supported

See Also:

ScriptEventSupport.getSupportsOnBlur()

getSupportsOnClick

public boolean getSupportsOnClick()

Description copied from interface: ScriptEventSupport

Indicates whether the component supports the onClick event

Specified by:

getSupportsOnClick in interface ScriptEventSupport

Overrides:

getSupportsOnClick in class ComponentBase

Returns:

boolean true if event is supported, false if the event is not supported

See Also:

ScriptEventSupport.getSupportsOnClick()

getSupportsOnDblClick

public boolean getSupportsOnDblClick()

Description copied from interface: ScriptEventSupport

Indicates whether the component supports the onDblClick event

Specified by:

getSupportsOnDblClick in interface ScriptEventSupport

Overrides:

getSupportsOnDblClick in class ComponentBase

Returns:

boolean true if event is supported, false if the event is not supported

See Also:

ScriptEventSupport.getSupportsOnDblClick()

getSupportsOnFocus

public boolean getSupportsOnFocus()

Description copied from interface: ScriptEventSupport

Indicates whether the component supports the onFocus event

Specified by:

getSupportsOnFocus in interface ScriptEventSupport

Overrides:

getSupportsOnFocus in class ComponentBase

Returns:

boolean true if event is supported, false if the event is not supported

See Also:

ScriptEventSupport.getSupportsOnFocus()