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, org.springframework.core.Ordered

Direct Known Subclasses:

GroupControl, UserControl

public class TextControl
extends ControlBase

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

TextControl()

Method Summary

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
List<Component>	getNestedComponents() List of components that are contained within the component
int	getSize() Horizontal display size of the control (in number of characters)
String	getWatermarkText()
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) Setter for the horizontal display size
void	setTextExpand(boolean textExpand)
void	setWatermarkText(String watermarkText)

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

getComponentTypeName, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnDblClick, getSupportsOnFocus, getTabIndex, setTabIndex

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

addStyleClass, appendToStyle, getAlign, getBaseId, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, 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, 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, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, isSkipInTabOrder, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setComponentOptions, setConditionalRefresh, setContext, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, 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, getBaseId, getColSpan, getComponentModifiers, getComponentOptions, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setComponentOptions, setConditionalRefresh, setContext, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, 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, setOnLoadScript

Constructor Detail

TextControl

public TextControl()

Method Detail

getNestedComponents

public List<Component> getNestedComponents()

Description copied from interface: Component

List of components that are contained within the component

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getNestedComponents in interface Component

Overrides:

getNestedComponents in class ComponentBase

Returns:

List child components

See Also:

ComponentBase.getNestedComponents()

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()

Horizontal display size of the control (in number of characters)

Returns:

int size

setSize

public void setSize(int size)

Setter for the horizontal display size

Parameters:

size -

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:

maxLength -

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()

Returns:

the watermarkText

setWatermarkText

public void setWatermarkText(String watermarkText)

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)

Parameters:

textExpand - the textExpand to set