org.kuali.rice.krad.uif.field

Interface Field

All Superinterfaces:

Cloneable, Component, Copyable, DictionaryBean, LifecycleElement, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean

All Known Subinterfaces:

DataField, InputField

All Known Implementing Classes:

ActionField, DataFieldBase, FieldBase, FieldGroup, GenericField, GroupLinkField, ImageField, InputFieldBase, LinkField, LookupInputField, MessageField, ProgressBarField, RoleLinkField, SpaceField, UserLinkField

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

Methods

Modifier and Type	Method and Description
Label	getFieldLabel() Label instance for the field
FieldSecurity	getFieldSecurity() Field Security object that indicates what authorization (permissions) exist for the field
String	getLabel() Label text for the field
int	getLabelColSpan() Label column span for the field
List<String>	getLabelStyleClasses() Label style classes for the field
String	getShortLabel() Short label for the field
boolean	isLabelLeft() The label for this field will be positioned to the left of the field content, when true.
boolean	isLabelRendered() Indicates whether the contained Label has been rendered as part of another field and thus should not be rendered with the attribute
void	setFieldLabel(Label label) Setter for the field's label field
void	setLabel(String labelText) Setter for the field's label text
void	setLabelColSpan(int labelColSpan) Setter for the field's label column span
void	setLabelLeft(boolean labelLeft)
void	setLabelRendered(boolean labelFieldRendered) Setter for the label field rendered indicator
void	setLabelStyleClasses(List<String> labelStyleClasses) Setter for the field's label style classes
void	setShortLabel(String shortLabel) Setter for the field's short label text

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, afterEvaluateExpression, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

Methods inherited from interface org.kuali.rice.krad.datadictionary.Copyable

clone

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

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

Setter for the field's label text

Parameters:

labelText -

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 -

getFieldLabel

Label getFieldLabel()

Label 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:

Label instance

setFieldLabel

void setFieldLabel(Label label)

Setter for the field's label field

Parameters:

label -

isLabelLeft

boolean isLabelLeft()

The label for this field will be positioned to the left of the field content, when true.

The usage of this option is for one-off instances in which a label must be positioned to the left of a field for layout purposes. It is recommended that if many fields will have their labels positioned to the left in a group that a CssGridLabelColumnLayoutManager backed group be used instead.

setLabelLeft

void setLabelLeft(boolean labelLeft)

See Also:

isLabelLeft()

isLabelRendered

boolean isLabelRendered()

Indicates whether the contained Label 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

setLabelRendered

void setLabelRendered(boolean labelFieldRendered)

Setter for the label field rendered indicator

Parameters:

labelFieldRendered -

getLabelStyleClasses

List<String> getLabelStyleClasses()

Label style classes for the field

Returns:

List label style classes

setLabelStyleClasses

void setLabelStyleClasses(List<String> labelStyleClasses)

Setter for the field's label style classes

Parameters:

labelStyleClasses -

getLabelColSpan

int getLabelColSpan()

Label column span for the field

Returns:

int label column span

setLabelColSpan

void setLabelColSpan(int labelColSpan)

Setter for the field's label column span

Parameters:

labelColSpan -

getFieldSecurity

FieldSecurity getFieldSecurity()

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

Returns:

FieldSecurity instance