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

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.DataField
                  org.kuali.rice.krad.uif.field.InputField

All Implemented Interfaces:

Serializable, CaseConstrainable, Constrainable, LengthConstrainable, MustOccurConstrainable, PrerequisiteConstrainable, RangeConstrainable, SimpleConstrainable, ValidCharactersConstrainable, Constraint, DataTypeConstraint, LengthConstraint, RangeConstraint, Component, Configurable, DataBinding, ScriptEventSupport, Field, org.springframework.core.Ordered

Direct Known Subclasses:

LookupInputField

public class InputField
extends DataField
implements SimpleConstrainable, CaseConstrainable, PrerequisiteConstrainable, MustOccurConstrainable, LengthConstrainable, RangeConstrainable, ValidCharactersConstrainable

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

R The InputField 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 input 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). InputField 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

Fields inherited from class org.kuali.rice.krad.uif.field.DataField

additionalDisplayPropertyName, 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

InputField()

Method Summary

protected void	adjustMustOccurConstraintBinding(List<MustOccurConstraint> mustOccurConstraints) Adjust paths on the must occur constrain bindings
protected void	adjustPrerequisiteConstraintBinding(List<PrerequisiteConstraint> prerequisiteConstraints) Adjust paths on the prerequisite constraint bindings
void	copyFromAttributeDefinition(View view, AttributeDefinition attributeDefinition) Defaults the properties of the InputField to the corresponding properties of its AttributeDefinition retrieved from the dictionary (if such an entry exists).
CaseConstraint	getCaseConstraint() The CaseConstraint that applies to this InputField
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
MessageField	getConstraintMessageField() Message field that displays constraint text
String	getConstraintText() Text that display a restriction on the value a field can hold
Control	getControl() Control instance that should be used to input data for the field
DataType	getDataType() Gets the DataType of this InputField, note that DataType set to be date when this field is using a date picker with a TextControl and hasnt otherwise been explicitly set.
List<PrerequisiteConstraint>	getDependencyConstraints() List of PrerequisiteConstraint that apply to this InputField
Boolean	getDirectInquiryRender()
ErrorsField	getErrorsField() Field that contains the messages (errors) for the input field.
String	getExclusiveMin() The exclusive minimum value for numeric or date field.
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
QuickFinder	getFieldLookup() Lookup finder widget for the field
Suggest	getFieldSuggest() Suggest box widget for the input field
String	getInclusiveMax() The inclusive maximum value for numeric or date field.
MessageField	getInstructionalMessageField() Message field that displays instructional text
String	getInstructionalText() Instructional text that display an explanation of the field usage
Integer	getMaxLength() Maximum number of characters the input field value is allowed to have
Integer	getMinLength() Minimum number of characters the input field value needs to be
List<MustOccurConstraint>	getMustOccurConstraints() List of MustOccurConstraint that apply to this InputField
String	getName() Returns the full binding path (the path used in the name attribute of the input).
KeyValuesFinder	getOptionsFinder() Instance of KeyValuesFinder that should be invoked to provide a List of values the field can have.
List<PrerequisiteConstraint>	getPrerequisiteConstraints()
Boolean	getRequired() Indicates whether the component is required
SimpleConstraint	getSimpleConstraint() Simple constraints for the input field
boolean	getSupportsOnLoad() Indicates whether the component supports the onLoad event
ValidCharactersConstraint	getValidCharactersConstraint() The ValideCharacterConstraint that applies to this InputField
boolean	isInputAllowed() Indicates whether the data field instance allows input, subclasses should override and set to true if input is allowed
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	setCaseConstraint(CaseConstraint caseConstraint) Setter for caseConstraint
void	setConstraintMessageField(MessageField constraintMessageField) Setter for the constraint text message field
void	setConstraintText(String constraintText) Setter for the constraint message text
void	setControl(Control control) Setter for the field's control
void	setDataType(DataType dataType) This does not have to be set, represents the DataType constraint of this field.
void	setDataType(String dataType)
void	setDependencyConstraints(List<PrerequisiteConstraint> dependencyConstraints) Setter for dependencyConstraints
void	setDirectInquiryRender(Boolean directInquiryRender)
void	setErrorsField(ErrorsField errorsField) Setter for the input field's errors field
void	setExclusiveMin(String exclusiveMin) Setter for the field's exclusive minimum value
void	setFieldAttributeQuery(AttributeQuery fieldAttributeQuery) Setter for this field's attribute query
void	setFieldDirectInquiry(DirectInquiry fieldDirectInquiry) Setter for the field's direct inquiry widget
void	setFieldLookup(QuickFinder fieldLookup) Setter for the lookup widget
void	setFieldSuggest(Suggest fieldSuggest) Setter for the fields suggest widget
void	setInclusiveMax(String inclusiveMax) Setter for the field's inclusive maximum value
void	setInstructionalMessageField(MessageField instructionalMessageField) Setter for the instructional text message field
void	setInstructionalText(String instructionalText) Setter for the instructional message
void	setMaxLength(Integer maxLength) Setter for input field max length
void	setMinLength(Integer minLength) Setter for input field minimum length
void	setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints) Setter for 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 input field
void	setPerformUppercase(boolean performUppercase) Setter for this field's performUppercase flag
void	setRequired(Boolean required) Setter for the required indicator
void	setSimpleConstraint(SimpleConstraint simpleConstraint) Setter for simple constraint
protected void	setupFieldQuery() Performs setup of the field attribute query and informational display properties.
protected void	setupIds() Sets the ids on all components the input field uses so they will all contain this input field's id in their ids.
void	setValidCharactersConstraint(ValidCharactersConstraint validCharactersConstraint) Setter for validCharacterConstraint

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

getAdditionalDisplayPropertyName, getAdditionalDisplayValue, getAlternateDisplayPropertyName, getAlternateDisplayValue, getBindingInfo, getComponentSecurityClass, getDataFieldSecurity, getDefaultValue, getDefaultValueFinderClass, getDictionaryAttributeName, getDictionaryObjectEntry, getFieldInquiry, getHelpDescription, getHelpSummary, getHiddenPropertyNames, getInformationalDisplayPropertyNames, getMaskFormatter, getPropertyEditor, getPropertyName, hasSecureValue, isApplyValueMask, isEscapeHtmlInPropertyValue, isReadOnlyHidden, performApplyModel, performInitialization, setAdditionalDisplayPropertyName, setAdditionalDisplayValue, setAlternateAndAdditionalDisplayValue, setAlternateDisplayPropertyName, setAlternateDisplayValue, setApplyValueMask, setBindingInfo, setComponentSecurity, setDefaultValue, setDefaultValueFinderClass, setDictionaryAttributeName, setDictionaryObjectEntry, setEscapeHtmlInPropertyValue, setFieldInquiry, setHelpDescription, setHelpSummary, setHiddenPropertyNames, setInformationalDisplayPropertyNames, setMaskFormatter, setPropertyEditor, setPropertyEditorClass, setPropertyName, setReadOnlyHidden

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

getComponentTypeName, getFieldSecurity, 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, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, 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, getRefreshDiscloseMethodToCall, 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, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setResetDataOnRefresh, 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, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setResetDataOnRefresh, 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, setOnDocumentReadyScript, setOnLoadScript

Constructor Detail

InputField

public InputField()

Method Detail

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 DataField

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)

adjustMustOccurConstraintBinding

protected void adjustMustOccurConstraintBinding(List<MustOccurConstraint> mustOccurConstraints)

Adjust paths on the must occur constrain bindings

Parameters:

mustOccurConstraints -

adjustPrerequisiteConstraintBinding

protected void adjustPrerequisiteConstraintBinding(List<PrerequisiteConstraint> prerequisiteConstraints)

Adjust paths on the prerequisite constraint bindings

Parameters:

prerequisiteConstraints -

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

setupIds

protected void setupIds()

Sets the ids on all components the input field uses so they will all contain this input field's id in their ids. This is useful for jQuery manipulation.

copyFromAttributeDefinition

public void copyFromAttributeDefinition(View view,
                                        AttributeDefinition attributeDefinition)

Defaults the properties of the InputField 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.

Overrides:

copyFromAttributeDefinition in class DataField

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 DataField

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

isInputAllowed

public boolean isInputAllowed()

Description copied from class: DataField

Indicates whether the data field instance allows input, subclasses should override and set to true if input is allowed

Overrides:

isInputAllowed in class DataField

Returns:

boolean true if input is allowed, false if read only

See Also:

DataField.isInputAllowed()

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 -

getErrorsField

public ErrorsField getErrorsField()

Field that contains the messages (errors) for the input 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 input field's errors field

Parameters:

errorsField -

getOptionsFinder

public KeyValuesFinder getOptionsFinder()

Instance of KeyValuesFinder 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 input field

Parameters:

optionsFinderClass - - the options finder class to set

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 - - the field lookup widget to set

getFieldSuggest

public Suggest getFieldSuggest()

Suggest box widget for the input 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 - - the field suggest widget to set

getInstructionalText

public String getInstructionalText()

Instructional text that display an explanation of the field usage

Text explaining how to use the field, including things like what values should be selected in certain cases and so on (instructions)

Returns:

String instructional message

setInstructionalText

public void setInstructionalText(String instructionalText)

Setter for the instructional message

Parameters:

instructionalText - - the instructional text to set

getInstructionalMessageField

public MessageField getInstructionalMessageField()

Message field that displays instructional text

This message field can be configured to for adjusting how the instructional text will display. Generally the styleClasses property will be of most interest

Returns:

MessageField instructional message field

setInstructionalMessageField

public void setInstructionalMessageField(MessageField instructionalMessageField)

Setter for the instructional text message field

Note this is the setter for the field that will render the instructional text. The actual text can be set on the field but can also be set using setInstructionalText(String)

Parameters:

instructionalMessageField - - the instructional message to set

getConstraintText

public String getConstraintText()

Text that display a restriction on the value a field can hold

For example when the value must be a valid format (phone number, email), certain length, min/max value and so on this text can be used to indicate the constraint to the user. Generally displays with the control so it is visible when the user tabs to the field

Returns:

String text to display for the constraint message

setConstraintText

public void setConstraintText(String constraintText)

Setter for the constraint message text

Parameters:

constraintText - - the constraint text to set

getConstraintMessageField

public MessageField getConstraintMessageField()

Message field that displays constraint text

This message field can be configured to for adjusting how the constrain text will display. Generally the styleClasses property will be of most interest

Returns:

MessageField constraint message field

setConstraintMessageField

public void setConstraintMessageField(MessageField constraintMessageField)

Setter for the constraint text message field

Note this is the setter for the field that will render the constraint text. The actual text can be set on the field but can also be set using setConstraintText(String)

Parameters:

constraintMessageField - - the constrain message field to set

getValidCharactersConstraint

public ValidCharactersConstraint getValidCharactersConstraint()

The ValideCharacterConstraint that applies to this InputField

Specified by:

getValidCharactersConstraint in interface ValidCharactersConstrainable

Returns:

the valid characters constraint for this input field

setValidCharactersConstraint

public void setValidCharactersConstraint(ValidCharactersConstraint validCharactersConstraint)

Setter for validCharacterConstraint

Parameters:

validCharactersConstraint - - the ValidCharactersConstraint to set

getCaseConstraint

public CaseConstraint getCaseConstraint()

The CaseConstraint that applies to this InputField

Specified by:

getCaseConstraint in interface CaseConstrainable

Returns:

the case constraint for this input field

setCaseConstraint

public void setCaseConstraint(CaseConstraint caseConstraint)

Setter for caseConstraint

Parameters:

caseConstraint - - the CaseConstraint to set

getDependencyConstraints

public List<PrerequisiteConstraint> getDependencyConstraints()

List of PrerequisiteConstraint that apply to this InputField

Returns:

the dependency constraints for this input field

setDependencyConstraints

public void setDependencyConstraints(List<PrerequisiteConstraint> dependencyConstraints)

Setter for dependencyConstraints

Parameters:

dependencyConstraints - - list of PrerequisiteConstraint to set

getMustOccurConstraints

public List<MustOccurConstraint> getMustOccurConstraints()

List of MustOccurConstraint that apply to this InputField

Specified by:

getMustOccurConstraints in interface MustOccurConstrainable

Returns:

the must occur constraints for this input field

setMustOccurConstraints

public void setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints)

Setter for mustOccurConstraints

Parameters:

mustOccurConstraints - - list of MustOccurConstraint to set

getSimpleConstraint

public SimpleConstraint getSimpleConstraint()

Simple constraints for the input field

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

Specified by:

getSimpleConstraint in interface SimpleConstrainable

Returns:

the simple constraint of the input field

setSimpleConstraint

public void setSimpleConstraint(SimpleConstraint simpleConstraint)

Setter for simple constraint

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 simple constraint to set

getMaxLength

public Integer getMaxLength()

Maximum number of characters the input field value is allowed to have

The maximum length determines the maximum allowable length of the value for data entry editing purposes. The maximum length is inclusive and can be smaller or longer than the actual control size. The constraint is enforced on all data types (e.g. a numeric data type needs to meet the maximum length constraint in which digits and symbols are counted).

Specified by:

getMaxLength in interface LengthConstraint

Returns:

the maximum length of the input field

setMaxLength

public void setMaxLength(Integer maxLength)

Setter for input field max length

Parameters:

maxLength - - the maximum length to set

getMinLength

public Integer getMinLength()

Minimum number of characters the input field value needs to be

The minimum length determines the minimum required length of the value for data entry editing purposes. The minimum length is inclusive. The constraint is enforced on all data types (e.g. a numeric data type needs to meet the minimum length requirement in which digits and symbols are counted).

Specified by:

getMinLength in interface LengthConstraint

Returns:

the minimum length of the input field

setMinLength

public void setMinLength(Integer minLength)

Setter for input field minimum length

Parameters:

minLength - - the minLength to set

getDirectInquiryRender

public Boolean getDirectInquiryRender()

setDirectInquiryRender

public void setDirectInquiryRender(Boolean directInquiryRender)

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 exclusive minimum value for numeric or date field.

The exclusiveMin element determines the minimum allowable value for data entry editing purposes. This constrain is supported for numeric and date fields and to be used in conjunction with the appropriate ValidCharactersConstraint. For numeric constraint the value can be an integer or decimal such as -.001 or 99.

Specified by:

getExclusiveMin in interface RangeConstraint

Returns:

the exclusive minimum numeric value of the input field

setExclusiveMin

public void setExclusiveMin(String exclusiveMin)

Setter for the field's exclusive minimum value

Parameters:

exclusiveMin - - the minimum value to set

getInclusiveMax

public String getInclusiveMax()

The inclusive maximum value for numeric or date field.

The inclusiveMax element determines the maximum allowable value for data entry editing purposes. This constrain is supported for numeric and date fields and to be used in conjunction with the appropriate ValidCharactersConstraint. For numeric constraint the value can be an integer or decimal such as -.001 or 99.

Specified by:

getInclusiveMax in interface RangeConstraint

Returns:

the inclusive maximum numeric value of the input field

setInclusiveMax

public void setInclusiveMax(String inclusiveMax)

Setter for the field's inclusive maximum value

Parameters:

inclusiveMax - - the maximum value 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

setFieldDirectInquiry

public void setFieldDirectInquiry(DirectInquiry fieldDirectInquiry)

Setter for the field's direct inquiry widget

Parameters:

fieldDirectInquiry - - the DirectInquiry to set

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 field's attribute query

Parameters:

fieldAttributeQuery -

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 field's performUppercase flag

Parameters:

performUppercase - - boolean flag

getName

public String getName()

Returns the full binding path (the path used in the name attribute of the input). This differs from propertyName in that it uses BindingInfo to determine the path.

Specified by:

getName in interface Constrainable

Returns:

full binding path name

getPrerequisiteConstraints

public List<PrerequisiteConstraint> getPrerequisiteConstraints()

Specified by:

getPrerequisiteConstraints in interface PrerequisiteConstrainable

setDataType

public void setDataType(DataType dataType)

This does not have to be set, represents the DataType constraint of this field. This is only checked during server side validation.

Parameters:

dataType - the dataType to set

setDataType

public void setDataType(String dataType)

getDataType

public DataType getDataType()

Gets the DataType of this InputField, note that DataType set to be date when this field is using a date picker with a TextControl and hasnt otherwise been explicitly set.

Specified by:

getDataType in interface DataTypeConstraint

Returns: