org.kuali.rice.krad.uif.field
Interface Field

All Superinterfaces:
Component, DictionaryBean, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean
All Known Implementing Classes:
ActionField, DataField, FieldBase, FieldGroup, GenericField, ImageField, InputField, LinkField, LookupInputField, MessageField, SpaceField

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
 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 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 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
addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAlign, getAllDataAttributesJs, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getComponentsForLifecycle, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth
 
Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
getComponentCode, getNamespaceCode
 
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, setOnBlurScript, 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 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 -

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


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.