org.kuali.rice.krad.uif.control
Interface Control

All Superinterfaces:
Component, Configurable, ContentElement, org.springframework.core.Ordered, ScriptEventSupport, Serializable
All Known Implementing Classes:
CheckboxControl, CheckboxGroupControl, ControlBase, FileControl, GroupControl, HiddenControl, MultiValueControlBase, RadioGroupControl, SelectControl, SpinnerControl, TextAreaControl, TextControl, UserControl

public interface Control
extends ContentElement

Represents an interactive element in the UI (typically an HTML control)

Each control that can be rendered in the UIF should be an implement the Control interface. The control is a regular component, thus has a corresponding template that will render the control for the UI. Controls provide the mechanism for gathering data from the User or for the User to initiate an action. HTML controls must be rendered within a Form element.

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

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
 
Method Summary
 String getDisabledReason()
          If the control is disabled, gives a reason for why which will be displayed as a tooltip on the control
 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 interface org.kuali.rice.krad.uif.component.Component
addDataAttribute, addStyleClass, appendToStyle, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getComponentsForLifecycle, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip
 
Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
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, setOnBlurScript, setOnLoadScript
 

Method Detail

getTabIndex

int getTabIndex()
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.

Returns:
int the tab index for the control

setTabIndex

void setTabIndex(int tabIndex)
Setter for the controls tab order index

Parameters:
tabIndex -

isDisabled

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

Returns:
boolean true if the control is disabled, false if not

setDisabled

void setDisabled(boolean disabled)
Setter for the disabled indicator

Parameters:
disabled -

getDisabledReason

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

Returns:
String disabled reason text
See Also:
#isDisabled()}

setDisabledReason

void setDisabledReason(String disabledReason)
Setter for the disabled reason text

Parameters:
disabledReason -


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.