org.kuali.rice.krad.uif.field

Interface Field

All Superinterfaces:

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

All Known Implementing Classes:

ActionField, AjaxActionField, BlankField, DataField, ErrorsField, FieldBase, FieldGroup, GenericField, HeaderField, IframeField, ImageField, InputField, LabelField, LinkField, LookupInputField, MessageField

public interface Field
extends Component

Component that contains one or more user interface elements and can be placed into a Container

Provides a wrapper for various user interface elements so they can be treated uniformly by a container and rendered using a LayoutManager. Implementations exist for various types of elements and properties to configure that 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

Modifier and Type	Method and Description
FieldSecurity	getFieldSecurity() Field Security object that indicates what authorization (permissions) exist for the field
String	getLabel() Label text for the field
LabelField	getLabelField() LabelField instance for the field
String	getShortLabel() Short label for the field
boolean	isLabelFieldRendered() Indicates whether the contained LabelField has been rendered as part of another field and thus should not be rendered with the attribute
void	setLabel(String label) Setter for the field's label text
void	setLabelField(LabelField labelField) Setter for the field's label field
void	setLabelFieldRendered(boolean labelFieldRendered) Setter for the label field rendered indicator
void	setShortLabel(String shortLabel) Setter for the field's short label text

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

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getComponentsForLifecycle, getComponentTypeName, 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, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Method Detail

getLabel

String getLabel()

Label text for the field

The label is generally used to identify the field in the user interface

Returns:

String label text

setLabel

void setLabel(String label)

Setter for the field's label text

Parameters:

label -

getShortLabel

String getShortLabel()

Short label for the field

For areas of the user interface that have limited area (such as table headers), the short label can be used to identify the field

Returns:

String short label

setShortLabel

void setShortLabel(String shortLabel)

Setter for the field's short label text

Parameters:

shortLabel -

getLabelField

LabelField getLabelField()

LabelField instance for the field

The label field contains the labeling text for the field in addition to configuration for rendering in the user interface (such as the styling for the label area)

Returns:

LabelField instance

setLabelField

void setLabelField(LabelField labelField)

Setter for the field's label field

Parameters:

labelField -

isLabelFieldRendered

boolean isLabelFieldRendered()

Indicates whether the contained LabelField has been rendered as part of another field and thus should not be rendered with the attribute

Returns:

boolean true if the label field has been rendered, false if it should be rendered with the attribute

setLabelFieldRendered

void setLabelFieldRendered(boolean labelFieldRendered)

Setter for the label field rendered indicator

Parameters:

labelFieldRendered -

getFieldSecurity

FieldSecurity getFieldSecurity()

Field Security object that indicates what authorization (permissions) exist for the field

Returns:

FieldSecurity instance