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

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.field.FieldBase
              org.kuali.rice.krad.uif.field.AttributeField

All Implemented Interfaces:

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

Direct Known Subclasses:

LookupAttributeField

public class AttributeField
extends FieldBase
implements DataBinding

Field that encapsulates data input/output captured by an attribute within the application

The AttributField provides the majority of the data input/output for the screen. Through these fields the model can be displayed and updated. For data input, the field contains a Control instance will render an HTML control element(s). The attribute field also contains a LabelField, summary, and widgets such as a quickfinder (for looking up values) and inquiry (for getting more information on the value). AttributeField instances can have associated messages (errors) due to invalid input or business rule failures. Security can also be configured to restrict who may view the fields value.

Author:

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

See Also:

Serialized Form

Field Summary

protected String	additionalDisplayPropertyName
protected String	alternateDisplayPropertyName

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

AttributeField()

Method Summary

void	copyFromAttributeDefinition(AttributeDefinition attributeDefinition) Defaults the properties of the AttributeField to the corresponding properties of its AttributeDefinition retrieved from the dictionary (if such an entry exists).
String	getAdditionalDisplayPropertyName() Returns the additional display attribute name to be displayed when the field is readonly
String	getAdditionalDisplayValue() Returns the additional display value.
String	getAlternateDisplayPropertyName() Returns the alternate display attribute name to be displayed when the field is readonly.
String	getAlternateDisplayValue() Returns the alternate display value
AttributeSecurity	getAttributeSecurity() Holds security configuration for the attribute field.
BindingInfo	getBindingInfo() Returns the BindingInfo instance that is configured for the component
CaseConstraint	getCaseConstraint()
String	getConstraint() Returns the contraint set on the field
MessageField	getConstraintMessageField() Returns the contraint message field.
Control	getControl() Control instance that should be used to input data for the field
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
List<PrerequisiteConstraint>	getDependencyConstraints()
String	getDescription() Full explanation of the field (attribute).
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
String	getErrorMessagePlacement()
ErrorsField	getErrorsField() Field that contains the messages (errors) for the attribute field.
String	getExclusiveMin() The exclusiveMin element determines the minimum allowable value for data entry editing purposes.
AttributeQuery	getFieldAttributeQuery() Attribute query instance configured for this field to dynamically pull information back for updates other fields or providing messages
DirectInquiry	getFieldDirectInquiry() DirectInquiry widget for the field
Inquiry	getFieldInquiry() Inquiry widget for the field
QuickFinder	getFieldLookup() Lookup finder widget for the field
Suggest	getFieldSuggest() Suggest box widget for the attribute field
Formatter	getFormatter() Formatter instance that should be used when displaying and accepting the field's value in the user interface
List<String>	getHiddenPropertyNames() Allows specifying hidden property names without having to specify as a field in the group config (that might impact layout)
String	getInclusiveMax() The inclusiveMax element determines the maximum allowable value for data entry editing purposes.
List<String>	getInformationalDisplayPropertyNames() List of property names whose values should be displayed read-only under this field
Integer	getMaxLength() Maximum number of the characters the attribute value is allowed to have.
Integer	getMinLength()
List<MustOccurConstraint>	getMustOccurConstraints()
List<Component>	getNestedComponents() List of components that are contained within the component
KeyValuesFinder	getOptionsFinder() Instance of KeyValluesFinder that should be invoked to provide a List of values the field can have.
String	getPropertyName() Name of the property (relative to the parent object) the component binds to
Boolean	getRequired() Indicates whether the component is required
SimpleConstraint	getSimpleConstraint() A simple constraint which store the values for required, min/max length, and min/max value
String	getSummary() Brief statement of the field (attribute) purpose.
MessageField	getSummaryMessageField()
boolean	getSupportsOnLoad() Indicates whether the component supports the onLoad event
ValidCharactersConstraint	getValidCharactersConstraint() Valid character constraint that defines regular expressions for the valid characters for this field
boolean	isEscapeHtmlInPropertyValue() Returns true if HTML escape allowed for this field
boolean	isPerformUppercase() Perform uppercase flag for this field to force input to uppercase.
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) The following initialization is performed: Set defaults for binding Default the model path if not set
void	setAdditionalDisplayPropertyName(String additionalDisplayPropertyName) Additional display attribute name, which will be displayed next to the actual field value when the field is readonly with hypen inbetween like PropertyValue - AdditionalPropertyValue
protected void	setAlternateAndAdditionalDisplayValue(View view, Object model) Sets alternate and additional property value for this field.
void	setAlternateDisplayPropertyName(String alternateDisplayPropertyName) Sets the alternate display attribute name to be displayed when the field is readonly.
void	setAttributeSecurity(AttributeSecurity attributeSecurity) Setter for the AttributeSecurity instance that defines restrictions for the field
void	setBindingInfo(BindingInfo bindingInfo) Setter for the field's binding info
void	setCaseConstraint(CaseConstraint caseConstraint)
void	setConstraint(String constraint) Sets the constraint text.
void	setConstraintMessageField(MessageField constraintMessageField) Sets the constraint message field.
void	setControl(Control control) Setter for the field's control
void	setDefaultValue(String defaultValue) Setter for the fields default value
void	setDefaultValueFinderClass(Class<? extends ValueFinder> defaultValueFinderClass) Setter for the default value finder class
void	setDependencyConstraints(List<PrerequisiteConstraint> dependencyConstraints)
void	setDescription(String description) Setter for the description message
void	setDictionaryAttributeName(String dictionaryAttributeName) Setter for the dictionary attribute name
void	setDictionaryObjectEntry(String dictionaryObjectEntry) Setter for the dictionary object entry
void	setErrorMessagePlacement(String errorMessagePlacement)
void	setErrorsField(ErrorsField errorsField) Setter for the attribute field's errors field
void	setEscapeHtmlInPropertyValue(boolean escapeHtmlInPropertyValue) Sets HTML escaping for this property value.
void	setExclusiveMin(String exclusiveMin)
void	setFieldAttributeQuery(AttributeQuery fieldAttributeQuery) Setter for this fields query
void	setFieldDirectInquiry(DirectInquiry fieldDirectInquiry) Setter for the direct inquiry widget
void	setFieldInquiry(Inquiry fieldInquiry) Setter for the inquiry widget
void	setFieldLookup(QuickFinder fieldLookup) Setter for the lookup widget
void	setFieldSuggest(Suggest fieldSuggest) Setter for the fields Suggest widget
void	setFormatter(Formatter formatter) Setter for the field's formatter
void	setHiddenPropertyNames(List<String> hiddenPropertyNames) Setter for the hidden property names
void	setInclusiveMax(String inclusiveMax)
void	setInformationalDisplayPropertyNames(List<String> informationalDisplayPropertyNames) Setter for the list of informational property names
void	setMaxLength(Integer maxLength) Setter for attributes max length
void	setMinLength(Integer minLength)
void	setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints)
void	setOptionsFinder(KeyValuesFinder optionsFinder) Setter for the field's KeyValuesFinder instance
void	setOptionsFinderClass(Class<? extends KeyValuesFinder> optionsFinderClass) Setter that takes in the class name for the options finder and creates a new instance to use as the finder for the attribute field
void	setPerformUppercase(boolean performUppercase) Setter for this fields performUppercase flag
void	setPropertyName(String propertyName) Setter for the component's property name
void	setRequired(Boolean required) Setter for the required indicator
void	setSimpleConstraint(SimpleConstraint simpleConstraint) When a simple constraint is set on this object ALL simple validation constraints set directly will be overridden - recommended to use this or the other gets/sets for defining simple constraints, not both
void	setSummary(String summary) Setter for the summary message
void	setSummaryMessageField(MessageField summaryField) Sets the summary message field.
protected void	setupFieldQuery() Performs setup of the field attribute query and informational display properties.
void	setValidCharactersConstraint(ValidCharactersConstraint validCharactersConstraint)

Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase

getComponentTypeName, getLabel, getLabelField, getLabelPlacement, getShortLabel, isLabelFieldRendered, setLabel, setLabelField, setLabelFieldRendered, setLabelPlacement, setShortLabel, setShowLabel

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

addStyleClass, appendToStyle, getAlign, getBaseId, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, isSkipInTabOrder, performApplyModel, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setComponentOptions, setConditionalRefresh, setContext, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRenderOutput, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

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

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

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

addStyleClass, appendToStyle, getBaseId, getColSpan, getComponentModifiers, getComponentOptions, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, performApplyModel, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setComponentOptions, setConditionalRefresh, setContext, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRenderOutput, 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, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnLoadScript

Field Detail

alternateDisplayPropertyName

protected String alternateDisplayPropertyName

additionalDisplayPropertyName

protected String additionalDisplayPropertyName

Constructor Detail

AttributeField

public AttributeField()

Method Detail

performInitialization

public void performInitialization(View view)

The following initialization is performed:

• Set defaults for binding
• Default the model path if not set

Specified by:

performInitialization in interface Component

Overrides:

performInitialization in class FieldBase

Parameters:

view - - view instance in which the component belongs

See Also:

ComponentBase.performInitialization(org.kuali.rice.krad.uif.view.View)

performFinalize

public 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. In addition, it sets up the messages applied to this field

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)

setupFieldQuery

protected void setupFieldQuery()

Performs setup of the field attribute query and informational display properties. Paths are adjusted to match the binding for the this field, and the necessary onblur script for triggering the query client side is constructed

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(AttributeDefinition attributeDefinition)

Defaults the properties of the AttributeField 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:

attributeDefinition - - AttributeDefinition instance the property values should be copied from

getNestedComponents

public List<Component> getNestedComponents()

Description copied from interface: Component

List of components that are contained within the component

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getNestedComponents in interface Component

Overrides:

getNestedComponents in class FieldBase

Returns:

List child components

See Also:

ComponentBase.getNestedComponents()

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 -

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 -

getFormatter

public Formatter getFormatter()

Formatter instance that should be used when displaying and accepting the field's value in the user interface

Formatters can provide conversion between datatypes in addition to special string formatting such as currency display

Returns:

Formatter instance

See Also:

org.kuali.rice.krad.web.format.Formatter

setFormatter

public void setFormatter(Formatter formatter)

Setter for the field's formatter

Parameters:

formatter -

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

Parameters:

bindingInfo -

getControl

public Control getControl()

Control instance that should be used to input data for the field

When the field is editable, the control will be rendered so the user can input a value(s). Controls typically are part of a Form and render standard HTML control elements such as text input, select, and checkbox

Returns:

Control instance

setControl

public void setControl(Control control)

Setter for the field's control

Parameters:

control -

getErrorMessagePlacement

public String getErrorMessagePlacement()

setErrorMessagePlacement

public void setErrorMessagePlacement(String errorMessagePlacement)

getErrorsField

public ErrorsField getErrorsField()

Field that contains the messages (errors) for the attribute field. The ErrorsField holds configuration on associated messages along with information on rendering the messages in the user interface

Returns:

ErrorsField instance

setErrorsField

public void setErrorsField(ErrorsField errorsField)

Setter for the attribute field's errors field

Parameters:

errorsField -

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 -

getOptionsFinder

public KeyValuesFinder getOptionsFinder()

Instance of KeyValluesFinder that should be invoked to provide a List of values the field can have. Generally used to provide the options for a multi-value control or to validate the submitted field value

Returns:

KeyValuesFinder instance

setOptionsFinder

public void setOptionsFinder(KeyValuesFinder optionsFinder)

Setter for the field's KeyValuesFinder instance

Parameters:

optionsFinder -

setOptionsFinderClass

public void setOptionsFinderClass(Class<? extends KeyValuesFinder> optionsFinderClass)

Setter that takes in the class name for the options finder and creates a new instance to use as the finder for the attribute field

Parameters:

optionsFinderClass -

getSummary

public String getSummary()

Brief statement of the field (attribute) purpose. Used to display helpful information to the user on the form

Returns:

String summary message

setSummary

public void setSummary(String summary)

Setter for the summary message

Parameters:

summary -

getDescription

public String getDescription()

Full explanation of the field (attribute). Used in help contents

Returns:

String description message

setDescription

public void setDescription(String description)

Setter for the description message

Parameters:

description -

getAttributeSecurity

public AttributeSecurity getAttributeSecurity()

Holds security configuration for the attribute field. This triggers corresponding permission checks in KIM and can result in an update to the field state (such as read-only or hidden) and masking of the value

Returns:

AttributeSecurity instance configured for field or Null if no restrictions are defined

setAttributeSecurity

public void setAttributeSecurity(AttributeSecurity attributeSecurity)

Setter for the AttributeSecurity instance that defines restrictions for the field

Parameters:

attributeSecurity -

getSupportsOnLoad

public boolean getSupportsOnLoad()

Description copied from interface: ScriptEventSupport

Indicates whether the component supports the onLoad event

Specified by:

getSupportsOnLoad in interface ScriptEventSupport

Overrides:

getSupportsOnLoad in class ComponentBase

Returns:

boolean true if event is supported, false if the event is not supported

See Also:

ComponentBase.getSupportsOnLoad()

getFieldLookup

public QuickFinder getFieldLookup()

Lookup finder widget for the field

The quickfinder widget places a small icon next to the field that allows the user to bring up a search screen for finding valid field values. The Widget instance can be configured to point to a certain LookupView, or the framework will attempt to associate the field with a lookup based on its metadata (in particular its relationships in the model)

Returns:

QuickFinder lookup widget

setFieldLookup

public void setFieldLookup(QuickFinder fieldLookup)

Setter for the lookup widget

Parameters:

fieldLookup -

getFieldInquiry

public Inquiry getFieldInquiry()

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

setFieldInquiry

public void setFieldInquiry(Inquiry fieldInquiry)

Setter for the inquiry widget

Parameters:

fieldInquiry -

getFieldSuggest

public Suggest getFieldSuggest()

Suggest box widget for the attribute field

If enabled (by render flag), as the user inputs data into the fields control a dynamic query is performed to provide the user suggestions on values which they can then select

Note the Suggest widget is only valid when using a standard TextControl

Returns:

Suggest instance

setFieldSuggest

public void setFieldSuggest(Suggest fieldSuggest)

Setter for the fields Suggest widget

Parameters:

fieldSuggest -

getSummaryMessageField

public MessageField getSummaryMessageField()

Returns:

the summaryField

setSummaryMessageField

public void setSummaryMessageField(MessageField summaryField)

Sets the summary message field. Developers can use the setSummary method which would set the summary text.

Parameters:

summary - field to set

See Also:

setSummary

getConstraint

public String getConstraint()

Returns the contraint set on the field

Returns:

the constraint

setConstraint

public void setConstraint(String constraint)

Sets the constraint text. This text will be displayed below the component.

Parameters:

constraint - for this field

setConstraintMessageField

public void setConstraintMessageField(MessageField constraintMessageField)

Sets the constraint message field. Developers can use the setContraint method which would set the constraint text.

Parameters:

constraint - field to set

See Also:

setContraint

getConstraintMessageField

public MessageField getConstraintMessageField()

Returns the contraint message field.

Returns:

constraint Message Field

getValidCharactersConstraint

public ValidCharactersConstraint getValidCharactersConstraint()

Valid character constraint that defines regular expressions for the valid characters for this field

Returns:

the validCharactersConstraint

setValidCharactersConstraint

public void setValidCharactersConstraint(ValidCharactersConstraint validCharactersConstraint)

Parameters:

validCharactersConstraint - the validCharactersConstraint to set

getCaseConstraint

public CaseConstraint getCaseConstraint()

Returns:

the caseConstraint

setCaseConstraint

public void setCaseConstraint(CaseConstraint caseConstraint)

Parameters:

caseConstraint - the caseConstraint to set

getDependencyConstraints

public List<PrerequisiteConstraint> getDependencyConstraints()

Returns:

the dependencyConstraints

setDependencyConstraints

public void setDependencyConstraints(List<PrerequisiteConstraint> dependencyConstraints)

Parameters:

dependencyConstraints - the dependencyConstraints to set

getMustOccurConstraints

public List<MustOccurConstraint> getMustOccurConstraints()

Returns:

the mustOccurConstraints

setMustOccurConstraints

public void setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints)

Parameters:

mustOccurConstraints - the mustOccurConstraints to set

getSimpleConstraint

public SimpleConstraint getSimpleConstraint()

A simple constraint which store the values for required, min/max length, and min/max value

Returns:

the simpleConstraint

setSimpleConstraint

public void setSimpleConstraint(SimpleConstraint simpleConstraint)

When a simple constraint is set on this object ALL simple validation constraints set directly will be overridden - recommended to use this or the other gets/sets for defining simple constraints, not both

Parameters:

simpleConstraint - the simpleConstraint to set

getMaxLength

public Integer getMaxLength()

Maximum number of the characters the attribute value is allowed to have. Used to set the maxLength for supporting controls. Note this can be smaller or longer than the actual control size

Returns:

Integer max length

setMaxLength

public void setMaxLength(Integer maxLength)

Setter for attributes max length

Parameters:

maxLength -

getMinLength

public Integer getMinLength()

Returns:

the minLength

setMinLength

public void setMinLength(Integer minLength)

Parameters:

minLength - the minLength to set

getRequired

public Boolean getRequired()

Description copied from interface: Component

Indicates whether the component is required

At the general component level required means there is some action the user needs to take within the component. For example, within a section it might mean the fields within the section should be completed. At a field level, it means the field should be completed. This provides the ability for the renderers to indicate the required action.

Specified by:

getRequired in interface Component

Overrides:

getRequired in class ComponentBase

Returns:

boolean true if the component is required, false if it is not required

See Also:

ComponentBase.getRequired()

setRequired

public void setRequired(Boolean required)

Description copied from interface: Component

Setter for the required indicator

Specified by:

setRequired in interface Component

Overrides:

setRequired in class ComponentBase

See Also:

ComponentBase.setRequired(java.lang.Boolean)

getExclusiveMin

public String getExclusiveMin()

The exclusiveMin element determines the minimum allowable value for data entry editing purposes. Value can be an integer or decimal value such as -.001 or 99.

setExclusiveMin

public void setExclusiveMin(String exclusiveMin)

Parameters:

minValue - the minValue to set

getInclusiveMax

public String getInclusiveMax()

The inclusiveMax element determines the maximum allowable value for data entry editing purposes. Value can be an integer or decimal value such as -.001 or 99. JSTL: This field is mapped into the field named "exclusiveMax".

setInclusiveMax

public void setInclusiveMax(String inclusiveMax)

Parameters:

maxValue - the maxValue to set

setAdditionalDisplayPropertyName

public void setAdditionalDisplayPropertyName(String additionalDisplayPropertyName)

Additional display attribute name, which will be displayed next to the actual field value when the field is readonly with hypen inbetween like PropertyValue - AdditionalPropertyValue

Parameters:

additionalDisplayPropertyName - - Name of the additional display property

getAdditionalDisplayPropertyName

public String getAdditionalDisplayPropertyName()

Returns the additional display attribute name to be displayed when the field is readonly

Returns:

Additional Display Attribute Name

setAlternateDisplayPropertyName

public void setAlternateDisplayPropertyName(String alternateDisplayPropertyName)

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:

alternateDisplayPropertyName - - alternate display property name

getAlternateDisplayPropertyName

public String getAlternateDisplayPropertyName()

Returns the alternate display attribute name to be displayed when the field is readonly.

Returns:

alternate Display Property Name

getAlternateDisplayValue

public String getAlternateDisplayValue()

Returns the alternate display value

Returns:

the alternate display value set for this field

getAdditionalDisplayValue

public String getAdditionalDisplayValue()

Returns the additional display value.

Returns:

the additional display value set for this field

setFieldDirectInquiry

public void setFieldDirectInquiry(DirectInquiry fieldDirectInquiry)

Setter for the direct inquiry widget

Parameters:

the - DirectInquiry field DirectInquiry to set

getFieldDirectInquiry

public DirectInquiry getFieldDirectInquiry()

DirectInquiry widget for the field

The direct inquiry widget will render a button for the field value when that field is editable. It 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:

the DirectInquiry field DirectInquiry

getInformationalDisplayPropertyNames

public List<String> getInformationalDisplayPropertyNames()

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

setInformationalDisplayPropertyNames

public void setInformationalDisplayPropertyNames(List<String> informationalDisplayPropertyNames)

Setter for the list of informational property names

Parameters:

informationalDisplayPropertyNames -

getHiddenPropertyNames

public List<String> getHiddenPropertyNames()

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

setHiddenPropertyNames

public void setHiddenPropertyNames(List<String> hiddenPropertyNames)

Setter for the hidden property names

Parameters:

hiddenPropertyNames -

getFieldAttributeQuery

public AttributeQuery getFieldAttributeQuery()

Attribute query instance configured for this field to dynamically pull information back for updates other fields or providing messages

If field attribute query is not null, associated event script will be generated to trigger the query from the UI. This will invoke the AttributeQueryService to execute the query and return an instance of AttributeQueryResult that is then read by the script to update the UI. Typically used to update informational property values or other field values

Returns:

AttributeQuery instance

setFieldAttributeQuery

public void setFieldAttributeQuery(AttributeQuery fieldAttributeQuery)

Setter for this fields query

Parameters:

fieldAttributeQuery -

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

isPerformUppercase

public boolean isPerformUppercase()

Perform uppercase flag for this field to force input to uppercase.

It this flag is set to true the 'text-transform' style on the field will be set to 'uppercase' which will automatically change any text input into the field to uppercase.

Returns:

performUppercase flag

setPerformUppercase

public void setPerformUppercase(boolean performUppercase)

Setter for this fields performUppercase flag

Parameters:

performUppercase - flag