org.kuali.rice.kns.uif.field
Class LabelField

java.lang.Object
  org.kuali.rice.kns.uif.core.ComponentBase
      org.kuali.rice.kns.uif.field.FieldBase
          org.kuali.rice.kns.uif.field.LabelField

All Implemented Interfaces:

Serializable, Component, ScriptEventSupport, Field, org.springframework.core.Ordered

public class LabelField
extends FieldBase

Contains a label for another Field instance

The LabelField exists so that the label can be placed separate from the component in a layout manager such as the GridLayoutManager. It addition it can be used to style the label (from the inherited styleClass and style properties)

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.kns.uif.core.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

LabelField()

Method Summary

String	getLabelForComponentId() Indicates the id for the component the label applies to
String	getLabelText() Text that will display as the label
List<Component>	getNestedComponents() List of components that are contained within the component
MessageField	getRequiredMessageField() MessageField instance that will display a required indicator
String	getRequiredMessagePlacement() Indicates where the required message field should be placed in relation to the label field, valid options are 'LEFT' and 'RIGHT'
boolean	isRenderColon() Indicates whether a colon should be rendered after the label text, generally used when the label appears to the left of the field's control or value
void	setLabelForComponentId(String labelForComponentId) Setter for the component id the label applies to
void	setLabelText(String labelText) Setter for the label text
void	setRenderColon(boolean renderColon) Setter for the render colon indicator
void	setRequiredMessageField(MessageField requiredMessageField) Setter for the required message field
void	setRequiredMessagePlacement(String requiredMessagePlacement) Setter for the required message field placement

Methods inherited from class org.kuali.rice.kns.uif.field.FieldBase

getComponentTypeName, getLabel, getLabelField, getLabelPlacement, getShortLabel, isLabelFieldRendered, performFinalize, performInitialization, setLabel, setLabelField, setLabelFieldRendered, setLabelPlacement, setShortLabel, setShowLabel

Methods inherited from class org.kuali.rice.kns.uif.core.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getConditionalColSpan, getConditionalReadOnly, getConditionalRender, getConditionalRequired, getConditionalRowSpan, getContext, getEventCode, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPropertiesForReferenceCopy, getPropertyReplacers, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isReadOnly, isRender, performApplyModel, pushObjectToContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setConditionalColSpan, setConditionalReadOnly, setConditionalRender, setConditionalRequired, setConditionalRowSpan, setContext, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPropertyReplacers, setReadOnly, setRender, setRequired, setRowSpan, setStyle, setStyleClasses, setStyleClasses, setTemplate, setTitle, setValign, setWidth

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.kns.uif.core.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getConditionalReadOnly, getContext, getId, getOrder, getPropertiesForReferenceCopy, getPropertyReplacers, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isReadOnly, isRender, performApplyModel, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setConditionalReadOnly, setContext, setHidden, setId, setOrder, setPropertyReplacers, setReadOnly, setRender, setRequired, setRowSpan, setStyle, setStyleClasses, setTemplate, setTitle

Constructor Detail

LabelField

public LabelField()

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 FieldBase

Returns:

List child components

See Also:

ComponentBase.getNestedComponents()

getLabelForComponentId

public String getLabelForComponentId()

Indicates the id for the component the label applies to

Used for setting the labelFor attribute of the corresponding HTML element. Note this gets set automatically by the framework during the initialize phase

Returns:

String component id

setLabelForComponentId

public void setLabelForComponentId(String labelForComponentId)

Setter for the component id the label applies to

Parameters:

labelForComponentId -

getLabelText

public String getLabelText()

Text that will display as the label

Returns:

String label text

setLabelText

public void setLabelText(String labelText)

Setter for the label text

Parameters:

labelText -

isRenderColon

public boolean isRenderColon()

Indicates whether a colon should be rendered after the label text, generally used when the label appears to the left of the field's control or value

Returns:

boolean true if a colon should be rendered, false if it should not be

setRenderColon

public void setRenderColon(boolean renderColon)

Setter for the render colon indicator

Parameters:

renderColon -

getRequiredMessageField

public MessageField getRequiredMessageField()

MessageField instance that will display a required indicator

To indicate a field must have a value (required input) the required message field can be set to display an indicator or message along with the label. The message field also dictates the styling of the required message

Returns:

MessageField instance

setRequiredMessageField

public void setRequiredMessageField(MessageField requiredMessageField)

Setter for the required message field

Parameters:

requiredMessageField -

getRequiredMessagePlacement

public String getRequiredMessagePlacement()

Indicates where the required message field should be placed in relation to the label field, valid options are 'LEFT' and 'RIGHT'

Returns:

the requiredMessagePlacement

setRequiredMessagePlacement

public void setRequiredMessagePlacement(String requiredMessagePlacement)

Setter for the required message field placement

Parameters:

requiredMessagePlacement -