org.kuali.rice.krad.uif.field
Class DataField

java.lang.Object
  extended by org.kuali.rice.krad.uif.component.ConfigurableBase
      extended by org.kuali.rice.krad.uif.component.ComponentBase
          extended by org.kuali.rice.krad.uif.field.FieldBase
              extended by org.kuali.rice.krad.uif.field.DataField
All Implemented Interfaces:
Serializable, Component, Configurable, DataBinding, ScriptEventSupport, Field, Helpable, org.springframework.core.Ordered
Direct Known Subclasses:
InputField

public class DataField
extends FieldBase
implements DataBinding, Helpable

Field that renders data from the application, such as the value of a data object property

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:
Serialized Form

Field Summary
protected  String readOnlyDisplayReplacementPropertyName
           
protected  String readOnlyDisplaySuffixPropertyName
           
 
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
DataField()
           
 
Method Summary
 void copyFromAttributeDefinition(View view, AttributeDefinition attributeDefinition)
          Defaults the properties of the DataField to the corresponding properties of its AttributeDefinition retrieved from the dictionary (if such an entry exists).
 List<String> getAdditionalHiddenPropertyNames()
          Allows specifying hidden property names without having to specify as a field in the group config (that might impact layout)
 BindingInfo getBindingInfo()
          Returns the BindingInfo instance that is configured for the component
 DataFieldSecurity getComponentSecurity()
          Data Field Security object that indicates what authorization (permissions) exist for the field
protected  Class<? extends ComponentSecurity> getComponentSecurityClass()
          Returns the security class that is associated with the component (used for initialization and validation)
 List<Component> getComponentsForLifecycle()
          List of components that are contained within the component and should be sent through the lifecycle
 String getDefaultValue()
          Default value for the model property the field points to
 Class<? extends ValueFinder> getDefaultValueFinderClass()
          Gives Class that should be invoked to produce the default value for the field
 Object[] getDefaultValues()
          Array of default values for the model property the field points to
 String getDictionaryAttributeName()
          Name of the attribute within the data dictionary the attribute field is associated with
 String getDictionaryObjectEntry()
          Object entry name in the data dictionary the associated attribute is apart of
 Help getHelp()
          Help configuration object for the datafield
 String getHelpSummary()
          Summary help text for the field
 String getHelpTitle()
          Return the field label for the help title
 Inquiry getInquiry()
          Inquiry widget for the field
 MaskFormatter getMaskFormatter()
          MaskFormatter instance that will be used to mask the field value when isApplyMask() is true
 PropertyEditor getPropertyEditor()
          Performs formatting of the field value for display and then converting the value back to its expected type from a string
 String getPropertyName()
          Name of the property (relative to the parent object) the component binds to
 List<String> getPropertyNamesForAdditionalDisplay()
          List of property names whose values should be displayed read-only under this field
 String getReadOnlyDisplayReplacement()
          Returns the alternate display value
 String getReadOnlyDisplayReplacementPropertyName()
          Returns the alternate display attribute name to be displayed when the field is readonly.
 String getReadOnlyDisplaySuffix()
          Returns the additional display value.
 String getReadOnlyDisplaySuffixPropertyName()
          Returns the additional display attribute name to be displayed when the field is readonly
 boolean hasSecureValue()
          Indicates whether the value for the field is secure
 boolean isAddHiddenWhenReadOnly()
          Indicates the field should be read-only but also a hidden should be generated for the field
 boolean isApplyMask()
          Indicates whether the value for the field should be masked (or partially masked) on display
 boolean isEscapeHtmlInPropertyValue()
          Returns true if HTML escape allowed for this field
 boolean isInputAllowed()
          Indicates whether the data field instance allows input, subclasses should override and set to true if input is allowed
 void performApplyModel(View view, Object model, Component parent)
          The following updates are done here: If readOnlyHidden set to true, set field to readonly and add to hidden property names
 void performFinalize(View view, Object model, Component parent)
          The following actions are performed: Set the ids for the various attribute components Sets up the client side validation for constraints on this field.
 void performInitialization(View view, Object model)
          The following initialization is performed: Set defaults for binding Default the model path if not set
 void setAddHiddenWhenReadOnly(boolean addHiddenWhenReadOnly)
          Setter for the read-only hidden indicator
 void setAdditionalHiddenPropertyNames(List<String> additionalHiddenPropertyNames)
          Setter for the hidden property names
protected  void setAlternateAndAdditionalDisplayValue(View view, Object model)
          Sets alternate and additional property value for this field.
 void setApplyMask(boolean applyMask)
          Setter for the apply value mask flag
 void setBindingInfo(BindingInfo bindingInfo)
          Setter for the field's binding info
 void setComponentSecurity(ComponentSecurity componentSecurity)
          Override to assert a DataFieldSecurity instance is set
 void setDefaultValue(String defaultValue)
          Setter for the fields default value
 void setDefaultValueFinderClass(Class<? extends ValueFinder> defaultValueFinderClass)
          Setter for the default value finder class
 void setDefaultValues(Object[] defaultValues)
          Setter for the fields default values
 void setDictionaryAttributeName(String dictionaryAttributeName)
          Setter for the dictionary attribute name
 void setDictionaryObjectEntry(String dictionaryObjectEntry)
          Setter for the dictionary object entry
 void setEscapeHtmlInPropertyValue(boolean escapeHtmlInPropertyValue)
          Sets HTML escaping for this property value.
 void setHelp(Help help)
          Setter for the datafield help content
 void setHelpSummary(String helpSummary)
          Setter for the summary help text
 void setInquiry(Inquiry inquiry)
          Setter for the inquiry widget
 void setMaskFormatter(MaskFormatter maskFormatter)
          Setter for the MaskFormatter instance to apply when the value is masked
 void setPropertyEditor(PropertyEditor propertyEditor)
          Setter for the custom property editor to use for the field
 void setPropertyEditorClass(Class<? extends PropertyEditor> propertyEditorClass)
          Convenience setter for configuring a property editor by class
 void setPropertyName(String propertyName)
          Setter for the component's property name
 void setPropertyNamesForAdditionalDisplay(List<String> propertyNamesForAdditionalDisplay)
          Setter for the list of informational property names
 void setReadOnlyDisplayReplacement(String value)
          Setter for the alternative display value
 void setReadOnlyDisplayReplacementPropertyName(String readOnlyDisplayReplacementPropertyName)
          Sets the alternate display attribute name to be displayed when the field is readonly.
 void setReadOnlyDisplaySuffix(String value)
          Setter for the additional display value
 void setReadOnlyDisplaySuffixPropertyName(String readOnlyDisplaySuffixPropertyName)
          Additional display attribute name, which will be displayed next to the actual field value when the field is readonly with hyphen in between like PropertyValue - AdditionalPropertyValue
 void setTooltipOfComponent(Tooltip tooltip)
          For data fields the help tooltip is placed on the label.
 
Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase
getComponentTypeName, getFieldLabel, getLabel, getLabelColSpan, getLabelPlacement, getLabelStyleClasses, getShortLabel, isLabelRendered, setFieldLabel, setLabel, setLabelColSpan, setLabelPlacement, setLabelRendered, setLabelStyleClasses, setNestedComponentIdAndSuffix, setShortLabel, setShowLabel
 
Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase
addDataAttribute, addStyleClass, appendToStyle, getAlign, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getDataMetaAttribute, getDataRoleAttribute, getDataTypeAttribute, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDataMetaAttribute, setDataRoleAttribute, setDataTypeAttribute, setDisableSessionPersistence, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth
 
Methods inherited from class org.kuali.rice.krad.uif.component.ConfigurableBase
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
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.krad.uif.component.Component
addDataAttribute, addStyleClass, appendToStyle, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip
 
Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
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
 

Field Detail

readOnlyDisplayReplacementPropertyName

protected String readOnlyDisplayReplacementPropertyName

readOnlyDisplaySuffixPropertyName

protected String readOnlyDisplaySuffixPropertyName
Constructor Detail

DataField

public DataField()
Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)
The following initialization is performed:

Specified by:
performInitialization in interface Component
Overrides:
performInitialization in class FieldBase
Parameters:
view - - view instance in which the component belongs
model - - object instance containing the view data
See Also:
ComponentBase.performInitialization(org.kuali.rice.krad.uif.view.View, java.lang.Object)

performApplyModel

public void performApplyModel(View view,
                              Object model,
                              Component parent)
The following updates are done here:

Specified by:
performApplyModel in interface Component
Overrides:
performApplyModel in class ComponentBase
Parameters:
view - - view instance to which the component belongs
model - - Top level object containing the data (could be the form or a top level business object, dto)
See Also:
Component.performApplyModel(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component parent)
The following actions are performed:

Specified by:
performFinalize in interface Component
Overrides:
performFinalize in class FieldBase
Parameters:
view - - view instance that should be finalized for rendering
model - - top level object containing the data
parent - - parent component
See Also:
ComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

setAlternateAndAdditionalDisplayValue

protected void setAlternateAndAdditionalDisplayValue(View view,
                                                     Object model)
Sets alternate and additional property value for this field.

If AttributeSecurity present in this field, make sure the current user has permission to view the field value. If user doesn't have permission to view the value, mask the value as configured and set it as alternate value for display. If security doesn't exists for this field but alternateDisplayPropertyName present, get its value and format it based on that fields formatting and set for display.

For additional display value, if AttributeSecurity not present, sets the value if additionalDisplayPropertyName present. If not present, check whether this field is a KualiCode and get the relationship configured in the datadictionary file and set the name additional display value which will be displayed along with the code. If additional display property not present, check whether this field is has MultiValueControlBase. If yes, get the Label for the value and set it as additional display value.

Parameters:
view - - the current view instance
model - - model instance

copyFromAttributeDefinition

public void copyFromAttributeDefinition(View view,
                                        AttributeDefinition attributeDefinition)
Defaults the properties of the DataField to the corresponding properties of its AttributeDefinition retrieved from the dictionary (if such an entry exists). If the field already contains a value for a property, the definitions value is not used.

Parameters:
view - - view instance the field belongs to
attributeDefinition - - AttributeDefinition instance the property values should be copied from

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()
Description copied from interface: Component
List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:
getComponentsForLifecycle in interface Component
Overrides:
getComponentsForLifecycle in class FieldBase
Returns:
List child components
See Also:
ComponentBase.getComponentsForLifecycle()

isInputAllowed

public boolean isInputAllowed()
Indicates whether the data field instance allows input, subclasses should override and set to true if input is allowed

Returns:
boolean true if input is allowed, false if read only

getPropertyName

public String getPropertyName()
Description copied from interface: DataBinding
Name of the property (relative to the parent object) the component binds to

Specified by:
getPropertyName in interface DataBinding
Returns:
String property name
See Also:
DataBinding.getPropertyName()

setPropertyName

public void setPropertyName(String propertyName)
Setter for the component's property name

Parameters:
propertyName -

getPropertyEditor

public PropertyEditor getPropertyEditor()
Performs formatting of the field value for display and then converting the value back to its expected type from a string

Note property editors exist and are already registered for the basic Java types and the common Kuali types such as [@link KualiDecimal}. Registration with this property is only needed for custom property editors

Returns:
PropertyEditor property editor instance to use for this field

setPropertyEditor

public void setPropertyEditor(PropertyEditor propertyEditor)
Setter for the custom property editor to use for the field

Parameters:
propertyEditor -

setPropertyEditorClass

public void setPropertyEditorClass(Class<? extends PropertyEditor> propertyEditorClass)
Convenience setter for configuring a property editor by class

Parameters:
propertyEditorClass -

getBindingInfo

public BindingInfo getBindingInfo()
Description copied from interface: DataBinding
Returns the BindingInfo instance that is configured for the component

Specified by:
getBindingInfo in interface DataBinding
Returns:
BindingInfo
See Also:
DataBinding.getBindingInfo()

setBindingInfo

public void setBindingInfo(BindingInfo bindingInfo)
Setter for the field's binding info

Specified by:
setBindingInfo in interface DataBinding
Parameters:
bindingInfo -

getDictionaryAttributeName

public String getDictionaryAttributeName()
Name of the attribute within the data dictionary the attribute field is associated with

During the initialize phase for the View, properties for attribute fields are defaulted from a corresponding AttributeDefinition in the data dictionary. Based on the propertyName and parent object class the framework attempts will determine the attribute definition that is associated with the field and set this property. However this property can also be set in the fields configuration to use another dictionary attribute.

The attribute name is used along with the dictionary object entry to find the AttributeDefinition

Returns:
String attribute name

setDictionaryAttributeName

public void setDictionaryAttributeName(String dictionaryAttributeName)
Setter for the dictionary attribute name

Parameters:
dictionaryAttributeName -

getDictionaryObjectEntry

public String getDictionaryObjectEntry()
Object entry name in the data dictionary the associated attribute is apart of

During the initialize phase for the View, properties for attribute fields are defaulted from a corresponding AttributeDefinition in the data dictionary. Based on the parent object class the framework will determine the object entry for the associated attribute. However the object entry can be set in the field's configuration to use another object entry for the attribute

The attribute name is used along with the dictionary object entry to find the AttributeDefinition

Returns:

setDictionaryObjectEntry

public void setDictionaryObjectEntry(String dictionaryObjectEntry)
Setter for the dictionary object entry

Parameters:
dictionaryObjectEntry -

getDefaultValue

public String getDefaultValue()
Default value for the model property the field points to

When a new View instance is requested, the corresponding model will be newly created. During this initialization process the value for the model property will be set to the given default value (if set)

Returns:
String default value

setDefaultValue

public void setDefaultValue(String defaultValue)
Setter for the fields default value

Parameters:
defaultValue -

getDefaultValueFinderClass

public Class<? extends ValueFinder> getDefaultValueFinderClass()
Gives Class that should be invoked to produce the default value for the field

Returns:
Class default value finder class

setDefaultValueFinderClass

public void setDefaultValueFinderClass(Class<? extends ValueFinder> defaultValueFinderClass)
Setter for the default value finder class

Parameters:
defaultValueFinderClass -

getDefaultValues

public Object[] getDefaultValues()
Array of default values for the model property the field points to

When a new View instance is requested, the corresponding model will be newly created. During this initialization process the value for the model property will be set to the given default values (if set)

Returns:
String default value

setDefaultValues

public void setDefaultValues(Object[] defaultValues)
Setter for the fields default values

Parameters:
defaultValues -

getHelpSummary

public String getHelpSummary()
Summary help text for the field

Returns:
String summary help text

setHelpSummary

public void setHelpSummary(String helpSummary)
Setter for the summary help text

Parameters:
helpSummary -

getComponentSecurity

public DataFieldSecurity getComponentSecurity()
Data Field Security object that indicates what authorization (permissions) exist for the field

Specified by:
getComponentSecurity in interface Component
Overrides:
getComponentSecurity in class FieldBase
Returns:
DataFieldSecurity instance
See Also:
Component.getComponentSecurity()

setComponentSecurity

public void setComponentSecurity(ComponentSecurity componentSecurity)
Override to assert a DataFieldSecurity instance is set

Specified by:
setComponentSecurity in interface Component
Overrides:
setComponentSecurity in class FieldBase
Parameters:
componentSecurity - - instance of DataFieldSecurity
See Also:
Component.setComponentSecurity(org.kuali.rice.krad.uif.component.ComponentSecurity)

getComponentSecurityClass

protected Class<? extends ComponentSecurity> getComponentSecurityClass()
Description copied from class: ComponentBase
Returns the security class that is associated with the component (used for initialization and validation)

Overrides:
getComponentSecurityClass in class FieldBase
Returns:
Class

isAddHiddenWhenReadOnly

public boolean isAddHiddenWhenReadOnly()
Indicates the field should be read-only but also a hidden should be generated for the field

Useful for when a value is just displayed but is needed by script

Returns:
boolean true if field should be readOnly hidden, false if not

setAddHiddenWhenReadOnly

public void setAddHiddenWhenReadOnly(boolean addHiddenWhenReadOnly)
Setter for the read-only hidden indicator

Parameters:
addHiddenWhenReadOnly -

getInquiry

public Inquiry getInquiry()
Inquiry widget for the field

The inquiry widget will render a link for the field value when read-only that points to the associated inquiry view for the field. The inquiry can be configured to point to a certain InquiryView, or the framework will attempt to associate the field with a inquiry based on its metadata (in particular its relationships in the model)

Returns:
Inquiry field inquiry

setInquiry

public void setInquiry(Inquiry inquiry)
Setter for the inquiry widget

Parameters:
inquiry -

getHelp

public Help getHelp()
Help configuration object for the datafield

External help information can be configured for the datafield. The Help object can the configuration for rendering a link to that help information.

Specified by:
getHelp in interface Helpable
Returns:
Help for datafield

setHelp

public void setHelp(Help help)
Setter for the datafield help content

Specified by:
setHelp in interface Helpable
Parameters:
help -

setTooltipOfComponent

public void setTooltipOfComponent(Tooltip tooltip)
For data fields the help tooltip is placed on the label.

Specified by:
setTooltipOfComponent in interface Helpable
See Also:
org.kuali.rice.krad.uif.widget.Helpable#setTooltipOfComponent(org.kuali.rice.krad.uif.widget.Tooltip))

getHelpTitle

public String getHelpTitle()
Return the field label for the help title

Specified by:
getHelpTitle in interface Helpable
Returns:
field label
See Also:
Helpable.setTooltipOfComponent(org.kuali.rice.krad.uif.widget.Tooltip)

setReadOnlyDisplaySuffixPropertyName

public void setReadOnlyDisplaySuffixPropertyName(String readOnlyDisplaySuffixPropertyName)
Additional display attribute name, which will be displayed next to the actual field value when the field is readonly with hyphen in between like PropertyValue - AdditionalPropertyValue

Parameters:
readOnlyDisplaySuffixPropertyName - - Name of the additional display property

getReadOnlyDisplaySuffixPropertyName

public String getReadOnlyDisplaySuffixPropertyName()
Returns the additional display attribute name to be displayed when the field is readonly

Returns:
Additional Display Attribute Name

setReadOnlyDisplayReplacementPropertyName

public void setReadOnlyDisplayReplacementPropertyName(String readOnlyDisplayReplacementPropertyName)
Sets the alternate display attribute name to be displayed when the field is readonly. This properties value will be displayed instead of actual fields value when the field is readonly.

Parameters:
readOnlyDisplayReplacementPropertyName - - alternate display property name

getReadOnlyDisplayReplacementPropertyName

public String getReadOnlyDisplayReplacementPropertyName()
Returns the alternate display attribute name to be displayed when the field is readonly.

Returns:
alternate Display Property Name

getReadOnlyDisplayReplacement

public String getReadOnlyDisplayReplacement()
Returns the alternate display value

Returns:
the alternate display value set for this field

setReadOnlyDisplayReplacement

public void setReadOnlyDisplayReplacement(String value)
Setter for the alternative display value

Parameters:
value -

getReadOnlyDisplaySuffix

public String getReadOnlyDisplaySuffix()
Returns the additional display value.

Returns:
the additional display value set for this field

setReadOnlyDisplaySuffix

public void setReadOnlyDisplaySuffix(String value)
Setter for the additional display value

Parameters:
value -

isApplyMask

public boolean isApplyMask()
Indicates whether the value for the field should be masked (or partially masked) on display

If set to true, the field value will be masked by applying the configured getMaskFormatter()

If a KIM permission exists that should be checked to determine whether the value should be masked or not, this value should not be set but instead the mask or partialMask property on getComponentSecurity() should be set to true. This indicates there is a mask permission that should be consulted. If the user does not have the permission, this flag will be set to true by the framework and the value masked using the mask formatter configured on the security object

Returns:
boolean true if the field value should be masked, false if not

setApplyMask

public void setApplyMask(boolean applyMask)
Setter for the apply value mask flag

Parameters:
applyMask -

getMaskFormatter

public MaskFormatter getMaskFormatter()
MaskFormatter instance that will be used to mask the field value when isApplyMask() is true

Note in cases where the mask is applied due to security (KIM permissions), the mask or partial mask formatter configured on getComponentSecurity() will be used instead of this mask formatter

Returns:
MaskFormatter instance

setMaskFormatter

public void setMaskFormatter(MaskFormatter maskFormatter)
Setter for the MaskFormatter instance to apply when the value is masked

Parameters:
maskFormatter -

getAdditionalHiddenPropertyNames

public List<String> getAdditionalHiddenPropertyNames()
Allows specifying hidden property names without having to specify as a field in the group config (that might impact layout)

Returns:
List hidden property names

setAdditionalHiddenPropertyNames

public void setAdditionalHiddenPropertyNames(List<String> additionalHiddenPropertyNames)
Setter for the hidden property names

Parameters:
additionalHiddenPropertyNames -

getPropertyNamesForAdditionalDisplay

public List<String> getPropertyNamesForAdditionalDisplay()
List of property names whose values should be displayed read-only under this field

In the attribute field template for each information property name given its values is outputted read-only. Informational property values can also be updated dynamically with the use of field attribute query

Simple property names can be given if the property has the same binding parent as this field, in which case the binding path will be adjusted by the framework. If the property names starts with org.kuali.rice.krad.uif.UifConstants#NO_BIND_ADJUST_PREFIX, no binding prefix will be added.

Returns:
List informational property names

setPropertyNamesForAdditionalDisplay

public void setPropertyNamesForAdditionalDisplay(List<String> propertyNamesForAdditionalDisplay)
Setter for the list of informational property names

Parameters:
propertyNamesForAdditionalDisplay -

setEscapeHtmlInPropertyValue

public void setEscapeHtmlInPropertyValue(boolean escapeHtmlInPropertyValue)
Sets HTML escaping for this property value. HTML escaping will be handled in alternate and additional fields also.


isEscapeHtmlInPropertyValue

public boolean isEscapeHtmlInPropertyValue()
Returns true if HTML escape allowed for this field

Returns:
true if escaping allowed

hasSecureValue

public boolean hasSecureValue()
Indicates whether the value for the field is secure

A value will be secured if masking has been applied (by configuration or a failed KIM permission) or the field has been marked as hidden due to an authorization check

Returns:
boolean true if value is secure, false if not


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