org.kuali.rice.krad.uif.control

Class TextControl

java.lang.Object

org.kuali.rice.krad.uif.component.ConfigurableBase

org.kuali.rice.krad.uif.component.ComponentBase

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

org.kuali.rice.krad.uif.control.TextControl

All Implemented Interfaces:

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

Direct Known Subclasses:

GroupControl, SpinnerControl, UserControl

public class TextControl
extends ControlBase
implements SizedControl

Represents a HTML Text control, generally rendered as a input field of type 'text'. This can display and receive a single value

Author:

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

See Also:

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

Constructors

Constructor and Description
TextControl()

Method Summary

Methods

Modifier and Type	Method and Description
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
DatePicker	getDatePicker() Renders a calendar that can be used to select a date value for the text control.
Integer	getMaxLength() Maximum number of characters that can be inputted
Integer	getMinLength() Minimum number of characters that can be inputted
int	getSize() Retrieves the configured size for the control, which reflects the display width in characters for the control within the UI
String	getWatermarkText() Gets the watermark text for this TextControl.
boolean	isTextExpand() If set to true, this control will have a button which can be clicked to expand the text area through a popup window so the user has more space to type and see the data they are entering in this text field.
void	performFinalize(View view, Object model, Component parent) The following actions are performed: Defaults maxLength, minLength (if not set) to maxLength of parent field
void	setDatePicker(DatePicker datePicker)
void	setMaxLength(Integer maxLength) Setter for the max number of input characters
void	setMinLength(Integer minLength) Setter for the min number of input characters
void	setSize(int size) Sets the size for the control
void	setTextExpand(boolean textExpand) Sets whether this control will have a button to expand the text area through a popup window.
void	setWatermarkText(String watermarkText) Sets the watermark text for this TextControl

Methods inherited from class org.kuali.rice.krad.uif.control.ControlBase

getComponentTypeName, getDisabledReason, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnDblClick, getSupportsOnFocus, getTabIndex, isDisabled, setDisabled, setDisabledReason, setTabIndex

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

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getComponentSecurityClass, 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, 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, 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, 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

TextControl

public TextControl()

Method Detail

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()

Description copied from interface: Component

List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getComponentsForLifecycle in interface Component

Overrides:

getComponentsForLifecycle in class ComponentBase

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

performFinalize

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

The following actions are performed:

• Defaults maxLength, minLength (if not set) to maxLength of parent field

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class ComponentBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

ComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

getSize

public int getSize()

Description copied from interface: SizedControl

Retrieves the configured size for the control, which reflects the display width in characters for the control within the UI

Specified by:

getSize in interface SizedControl

Returns:

int control size

See Also:

SizedControl.getSize()

setSize

public void setSize(int size)

Description copied from interface: SizedControl

Sets the size for the control

Specified by:

setSize in interface SizedControl

See Also:

SizedControl.setSize(int)

getMaxLength

public Integer getMaxLength()

Maximum number of characters that can be inputted

If not set on control, max length of field will be used

Returns:

int max number of characters

setMaxLength

public void setMaxLength(Integer maxLength)

Setter for the max number of input characters

Parameters:

maxLength -

getMinLength

public Integer getMinLength()

Minimum number of characters that can be inputted

If not set on control, min length of field will be used

Returns:

int max number of characters

setMinLength

public void setMinLength(Integer minLength)

Setter for the min number of input characters

Parameters:

minLength -

getDatePicker

public DatePicker getDatePicker()

Renders a calendar that can be used to select a date value for the text control. The Calendar instance contains configuration such as the date format string

Returns:

Calendar

setDatePicker

public void setDatePicker(DatePicker datePicker)

getWatermarkText

public String getWatermarkText()

Gets the watermark text for this TextControl.

A watermark typically appears as light gray text within the text input element whenever the element is empty and does not have focus. This provides a hint to the user as to what the input is used for, or the type of input that is required.

Returns:

the watermarkText

setWatermarkText

public void setWatermarkText(String watermarkText)

Sets the watermark text for this TextControl

Parameters:

watermarkText - the watermarkText to set

isTextExpand

public boolean isTextExpand()

If set to true, this control will have a button which can be clicked to expand the text area through a popup window so the user has more space to type and see the data they are entering in this text field.

Returns:

the textExpand

setTextExpand

public void setTextExpand(boolean textExpand)

Sets whether this control will have a button to expand the text area through a popup window.

Parameters:

textExpand - the textExpand to set