org.kuali.rice.krad.uif.field

Class FieldBase

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

org.kuali.rice.krad.uif.component.ComponentBase

org.kuali.rice.krad.uif.field.FieldBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ActionField, DataFieldBase, FieldGroup, GenericField, ImageField, LinkField, MessageField, ProgressBarField, SpaceField

public class FieldBase
extends ComponentBase
implements Field

Base class for Field implementations

Sets the component type name so that all field templates have a fixed contract

Holds a nested Label with configuration for rendering the label and configuration on label placement.

Author:

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

See Also:

Serialized Form

Field Summary

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

templateOptions

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

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

Constructors

Constructor and Description
FieldBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterEvaluateExpression() No-op impelemtnation.
String	getComponentTypeName() The name for the component type
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
protected void	initializeComponentSecurity() Initializes (if necessary) the component security instance for the component type
Boolean	isEditInLineAuthz()
boolean	isLabelRendered() Indicates whether the contained Label has been rendered as part of another field and thus should not be rendered with the attribute
Boolean	isViewInLineAuthz()
void	performApplyModel(Object model, LifecycleElement parent) The following finalization is performed: Make sure that a label is defined for any data fields.
void	performFinalize(Object model, LifecycleElement parent) The following finalization is performed: Set the labelForComponentId to this component id Set the label text on the label field from the field's label property Set the render property on the label's required message field if this field is marked as required The following finalization is done here: progressiveRender and conditionalRefresh variables are processed if set If any of the style properties were given, sets the style string on the style property Set the skipInTabOrder flag for nested components The last phase before the view is rendered
void	setComponentSecurity(ComponentSecurity componentSecurity) Override to assert a FieldSecurity instance is set
void	setEditInLineAuthz(Boolean editInLineAuthz)
void	setFieldLabel(Label fieldLabel) 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 labelRendered) Setter for the label field rendered indicator
void	setLabelStyleClasses(List<String> labelStyleClasses) Setter for the field's label style classes
protected void	setNestedComponentIdAndSuffix(Component component, String suffix) Helper method for suffixing the ids of the fields nested components
void	setShortLabel(String shortLabel) Setter for the field's short label text
void	setShowLabel(boolean showLabel) Sets whether the label should be displayed
void	setViewInLineAuthz(Boolean viewInLineAuthz)

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPhasePathMapping, 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, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializePendingTasks, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPhasePathMapping, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, 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, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setLibraryCssClasses, 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, initializePendingTasks, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, 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

Constructor Detail

FieldBase

public FieldBase()

Method Detail

performApplyModel

public void performApplyModel(Object model,
                     LifecycleElement parent)

The following finalization is performed:

• Make sure that a label is defined for any data fields. If not then create hidden label using property name.
• If no label for a non data field then just log a warning.

The following updates are done here:

• Evaluate the progressive render condition (if set) and combine with the current render status to set the render status

Called after the initialize phase to perform conditional logic based on the model data

Where components can perform conditional logic such as dynamically generating new fields or setting field state based on the given data

Specified by:

performApplyModel in interface LifecycleElement

Overrides:

performApplyModel in class ComponentBase

Parameters:

model - - Top level object containing the data (could be the form or a top level business object, dto)

parent - parent lifecycle element

afterEvaluateExpression

public void afterEvaluateExpression()

No-op impelemtnation. Override for custom behavior in subclasses. Invoked by the view lifecycle after expressions are evaluated at the apply model phase.

In general, this method is preferred to LifecycleElement.performApplyModel(Object, LifecycleElement) for populating model data via code, since it is called before client-side state is synchronize.

Specified by:

afterEvaluateExpression in interface Component

Overrides:

afterEvaluateExpression in class ComponentBase

performFinalize

public void performFinalize(Object model,
                   LifecycleElement parent)

The following finalization is performed:

• Set the labelForComponentId to this component id
• Set the label text on the label field from the field's label property
• Set the render property on the label's required message field if this field is marked as required

The following finalization is done here:

• progressiveRender and conditionalRefresh variables are processed if set
• If any of the style properties were given, sets the style string on the style property
• Set the skipInTabOrder flag for nested components

The last phase before the view is rendered

Here final preparations can be made based on the updated view state.

Specified by:

performFinalize in interface LifecycleElement

Overrides:

performFinalize in class ComponentBase

Parameters:

model - - top level object containing the data

parent - - parent component

setNestedComponentIdAndSuffix

protected void setNestedComponentIdAndSuffix(Component component,
                                 String suffix)

Helper method for suffixing the ids of the fields nested components

Parameters:

component - component to adjust id for

suffix - suffix to append to id

getComponentTypeName

public final String getComponentTypeName()

The name for the component type

This is used within the rendering layer to pass the component instance into the template. The component instance is exported under the name given by this method.

Specified by:

getComponentTypeName in interface Component

Returns:

String type name

getLabel

public String getLabel()

Description copied from interface: Field

Label text for the field

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

Specified by:

getLabel in interface Field

Returns:

String label text

See Also:

Field.getLabel()

setLabel

public void setLabel(String labelText)

Description copied from interface: Field

Setter for the field's label text

Specified by:

setLabel in interface Field

See Also:

Field.setLabel(java.lang.String)

getLabelStyleClasses

public List<String> getLabelStyleClasses()

Description copied from interface: Field

Label style classes for the field

Specified by:

getLabelStyleClasses in interface Field

Returns:

List label style classes

See Also:

Field.getLabelStyleClasses()

setLabelStyleClasses

public void setLabelStyleClasses(List<String> labelStyleClasses)

Description copied from interface: Field

Setter for the field's label style classes

Specified by:

setLabelStyleClasses in interface Field

See Also:

Field.setLabelStyleClasses(java.util.List<java.lang.String>)

getLabelColSpan

public int getLabelColSpan()

Description copied from interface: Field

Label column span for the field

Specified by:

getLabelColSpan in interface Field

Returns:

int label column span

See Also:

Field.getLabelColSpan()

setLabelColSpan

public void setLabelColSpan(int labelColSpan)

Description copied from interface: Field

Setter for the field's label column span

Specified by:

setLabelColSpan in interface Field

See Also:

Field.setLabelColSpan(int)

getShortLabel

public String getShortLabel()

Description copied from interface: Field

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

Specified by:

getShortLabel in interface Field

Returns:

String short label

See Also:

Field.getShortLabel()

setShortLabel

public void setShortLabel(String shortLabel)

Description copied from interface: Field

Setter for the field's short label text

Specified by:

setShortLabel in interface Field

See Also:

Field.setShortLabel(java.lang.String)

setShowLabel

public void setShowLabel(boolean showLabel)

Sets whether the label should be displayed

Convenience method for configuration that sets the hidden indicator on the fields Label instance. The label is not really hidden but set off screen for accessibility.

Parameters:

showLabel - true if label should be hidden, false if the label should not be hidden

getFieldLabel

public Label getFieldLabel()

Description copied from interface: Field

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)

Specified by:

getFieldLabel in interface Field

Returns:

Label instance

See Also:

Field.getLabel()

setFieldLabel

public void setFieldLabel(Label fieldLabel)

Description copied from interface: Field

Setter for the field's label field

Specified by:

setFieldLabel in interface Field

See Also:

Field.setFieldLabel(org.kuali.rice.krad.uif.element.Label)

isLabelRendered

public boolean isLabelRendered()

Description copied from interface: Field

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

Specified by:

isLabelRendered in interface Field

Returns:

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

See Also:

Field.isLabelRendered()

setLabelRendered

public void setLabelRendered(boolean labelRendered)

Description copied from interface: Field

Setter for the label field rendered indicator

Specified by:

setLabelRendered in interface Field

See Also:

Field.setLabelRendered(boolean)

getFieldSecurity

public FieldSecurity getFieldSecurity()

Description copied from interface: Field

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

Specified by:

getFieldSecurity in interface Field

Returns:

FieldSecurity instance

See Also:

Field.getFieldSecurity()

setComponentSecurity

public void setComponentSecurity(ComponentSecurity componentSecurity)

Override to assert a FieldSecurity instance is set

Specified by:

setComponentSecurity in interface Component

Overrides:

setComponentSecurity in class ComponentBase

Parameters:

componentSecurity - instance of FieldSecurity

initializeComponentSecurity

protected void initializeComponentSecurity()

Initializes (if necessary) the component security instance for the component type

Overrides:

initializeComponentSecurity in class ComponentBase

isEditInLineAuthz

public Boolean isEditInLineAuthz()

See Also:

FieldSecurity.isEditInLineAuthz()

setEditInLineAuthz

public void setEditInLineAuthz(Boolean editInLineAuthz)

See Also:

FieldSecurity.setEditInLineAuthz(Boolean)

isViewInLineAuthz

public Boolean isViewInLineAuthz()

See Also:

FieldSecurity.isViewInLineAuthz()

setViewInLineAuthz

public void setViewInLineAuthz(Boolean viewInLineAuthz)

See Also:

FieldSecurity.setViewInLineAuthz(Boolean)