|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class InputField
Field that encapsulates data input/output captured by an attribute within the application
R
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).
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.
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)
|
protected void |
adjustPrerequisiteConstraintBinding(List<PrerequisiteConstraint> prerequisiteConstraints)
|
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()
|
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 |
List<PrerequisiteConstraint> |
getDependencyConstraints()
|
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 |
QuickFinder |
getFieldLookup()
Lookup finder widget for the field |
Suggest |
getFieldSuggest()
Suggest box widget for the attribute field |
String |
getInclusiveMax()
The inclusiveMax element determines the maximum allowable value for data entry editing purposes. |
MessageField |
getInstructionalMessageField()
Message field that displays instructional text |
String |
getInstructionalText()
Text explaining how to use the field, including things like what values should be selected in certain cases and so on (instructions) |
Integer |
getMaxLength()
Maximum number of the characters the attribute value is allowed to have. |
Integer |
getMinLength()
|
List<MustOccurConstraint> |
getMustOccurConstraints()
|
KeyValuesFinder |
getOptionsFinder()
Instance of KeyValluesFinder that should be invoked to
provide a List of values the field can have. |
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 |
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 |
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)
|
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 |
setDependencyConstraints(List<PrerequisiteConstraint> dependencyConstraints)
|
void |
setErrorMessagePlacement(String errorMessagePlacement)
|
void |
setErrorsField(ErrorsField errorsField)
Setter for the attribute field's errors field |
void |
setExclusiveMin(String exclusiveMin)
|
void |
setFieldAttributeQuery(AttributeQuery fieldAttributeQuery)
Setter for this fields query |
void |
setFieldDirectInquiry(DirectInquiry fieldDirectInquiry)
Setter for the 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)
|
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 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 |
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 |
protected void |
setupFieldQuery()
Performs setup of the field attribute query and informational display properties. |
protected void |
setupIds()
Sets the ids on all components the attribute field uses so they will all contain this attribute's id in their ids. |
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.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.Configurable |
---|
getPropertyExpression, getPropertyExpressions, setPropertyExpressions |
Constructor Detail |
---|
public InputField()
Method Detail |
---|
public void performFinalize(View view, Object model, Component parent)
performFinalize
in interface Component
performFinalize
in class DataField
view
- - view instance that should be finalized for renderingmodel
- - top level object containing the dataparent
- - parent componentComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View,
java.lang.Object, org.kuali.rice.krad.uif.component.Component)
protected void adjustMustOccurConstraintBinding(List<MustOccurConstraint> mustOccurConstraints)
protected void adjustPrerequisiteConstraintBinding(List<PrerequisiteConstraint> prerequisiteConstraints)
protected void setupFieldQuery()
protected void setupIds()
public void copyFromAttributeDefinition(View view, AttributeDefinition attributeDefinition)
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.
copyFromAttributeDefinition
in class DataField
view
- - view instance the field belongs toattributeDefinition
- - AttributeDefinition instance the property values should be
copied frompublic List<Component> getComponentsForLifecycle()
Component
Used by ViewHelperService
for the various lifecycle
callbacks
getComponentsForLifecycle
in interface Component
getComponentsForLifecycle
in class DataField
ComponentBase.getComponentsForLifecycle()
public boolean isInputAllowed()
DataField
isInputAllowed
in class DataField
DataField.isInputAllowed()
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
public void setControl(Control control)
control
- public String getErrorMessagePlacement()
public void setErrorMessagePlacement(String errorMessagePlacement)
public ErrorsField getErrorsField()
ErrorsField
holds configuration on associated messages along
with information on rendering the messages in the user interface
public void setErrorsField(ErrorsField errorsField)
errorsField
- public KeyValuesFinder getOptionsFinder()
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
public void setOptionsFinder(KeyValuesFinder optionsFinder)
optionsFinder
- public void setOptionsFinderClass(Class<? extends KeyValuesFinder> optionsFinderClass)
optionsFinderClass
- public String getInstructionalText()
public void setInstructionalText(String instructionalText)
instructionalText
- public boolean getSupportsOnLoad()
ScriptEventSupport
getSupportsOnLoad
in interface ScriptEventSupport
getSupportsOnLoad
in class ComponentBase
ComponentBase.getSupportsOnLoad()
public QuickFinder getFieldLookup()
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)
public void setFieldLookup(QuickFinder fieldLookup)
fieldLookup
- public Suggest getFieldSuggest()
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
public void setFieldSuggest(Suggest fieldSuggest)
fieldSuggest
- public MessageField getInstructionalMessageField()
This message field can be configured to for adjusting how the instructional text will display. Generally the styleClasses property will be of most interest
public void setInstructionalMessageField(MessageField instructionalMessageField)
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)
instructionalMessageField
- public String getConstraintText()
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
public void setConstraintText(String constraintText)
constraintText
- public MessageField getConstraintMessageField()
This message field can be configured to for adjusting how the constrain text will display. Generally the styleClasses property will be of most interest
public void setConstraintMessageField(MessageField constraintMessageField)
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)
constraintMessageField
- public ValidCharactersConstraint getValidCharactersConstraint()
public void setValidCharactersConstraint(ValidCharactersConstraint validCharactersConstraint)
validCharactersConstraint
- the validCharactersConstraint to setpublic CaseConstraint getCaseConstraint()
public void setCaseConstraint(CaseConstraint caseConstraint)
caseConstraint
- the caseConstraint to setpublic List<PrerequisiteConstraint> getDependencyConstraints()
public void setDependencyConstraints(List<PrerequisiteConstraint> dependencyConstraints)
dependencyConstraints
- the dependencyConstraints to setpublic List<MustOccurConstraint> getMustOccurConstraints()
public void setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints)
mustOccurConstraints
- the mustOccurConstraints to setpublic SimpleConstraint getSimpleConstraint()
public void setSimpleConstraint(SimpleConstraint simpleConstraint)
simpleConstraint
- the simpleConstraint to setpublic Integer getMaxLength()
public void setMaxLength(Integer maxLength)
maxLength
- public Integer getMinLength()
public void setMinLength(Integer minLength)
minLength
- the minLength to setpublic Boolean getRequired()
Component
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.
getRequired
in interface Component
getRequired
in class ComponentBase
ComponentBase.getRequired()
public void setRequired(Boolean required)
Component
setRequired
in interface Component
setRequired
in class ComponentBase
ComponentBase.setRequired(java.lang.Boolean)
public String getExclusiveMin()
public void setExclusiveMin(String exclusiveMin)
exclusiveMin
- the minValue to setpublic String getInclusiveMax()
public void setInclusiveMax(String inclusiveMax)
inclusiveMax
- the maxValue to setpublic void setFieldDirectInquiry(DirectInquiry fieldDirectInquiry)
fieldDirectInquiry
- - field DirectInquiry to setpublic DirectInquiry getFieldDirectInquiry()
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)
DirectInquiry
field DirectInquirypublic AttributeQuery getFieldAttributeQuery()
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
public void setFieldAttributeQuery(AttributeQuery fieldAttributeQuery)
fieldAttributeQuery
- public boolean isPerformUppercase()
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.
public void setPerformUppercase(boolean performUppercase)
performUppercase
- flag
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |