| java.lang.Object
 org.apache.cocoon.forms.formmodel.AbstractWidget
org.apache.cocoon.forms.formmodel.Field
All known Subclasses: org.apache.cocoon.forms.formmodel.CalculatedField, org.apache.cocoon.forms.formmodel.RepeaterFilterField, org.apache.cocoon.forms.formmodel.AggregateField, org.apache.cocoon.forms.formmodel.CaptchaField,
| Field | | public class Field extends AbstractWidget implements ValidationErrorAware,DataWidget,SelectableWidget,ValueChangedListenerEnabled(Code) | | A general-purpose Widget that can hold one value. A Field widget can be associated
with a
org.apache.cocoon.forms.datatype.Datatype Datatype , and thus
a Field widget can be used to edit different kinds of data, such as strings,
numbers and dates. A Datatype can also have an associated SelectionList, so
that the value for the Field can be selected from a list, rather than being
entered in a textbox. The validation of the field is delegated to its associated
Datatype.
version:
$Id: Field.java 474132 2006-11-13 04:07:30Z jjohnston $ |
| Field Summary | |
| final public static String | SUGGESTED_LABEL_ATTR
If the field was rendered as a suggestion-list and the user chose one of the suggestions,
the field's value is the chosen item's value and the SUGGESTED_LABEL_ATTR field
attribute contains the chosen item's label. | | final protected static int | VALUE_DISPLAY_PARSE_ERROR
Value state indicating that validate() has been called when state was
VALUE_PARSE_ERROR. | | final protected static int | VALUE_DISPLAY_VALIDATION
Value state indicating that value validation has occured, and the
validation error, if any, should be displayed. | | final protected static int | VALUE_PARSED
| | final protected static int | VALUE_PARSE_ERROR
Value state indicating that a parse error was encountered but should not
yet be displayed. | | final protected static int | VALUE_UNPARSED
Value state indicating that a new value has been read from the request,
but has not yet been parsed. | | final protected static int | VALUE_VALIDATED
Value state indicating that validation has occured, but that any error should not
yet be displayed. | | final protected static int | VALUE_VALIDATING
Transient value state indicating that validation is going on. | | protected String | enteredValue
| | protected boolean | required
| | protected SelectionList | selectionList
Overrides selection list defined in FieldDefinition, if any. | | protected ValidationError | validationError
| | protected Object | value
| | protected int | valueState
Transient widget processing state indicating that the widget is currently validating
(used to avoid endless loops when a validator calls getValue). |
| SUGGESTED_LABEL_ATTR | | final public static String SUGGESTED_LABEL_ATTR(Code) | | If the field was rendered as a suggestion-list and the user chose one of the suggestions,
the field's value is the chosen item's value and the SUGGESTED_LABEL_ATTR field
attribute contains the chosen item's label.
See Also: Field.isSuggested()
since:
2.1.9 |
| VALUE_DISPLAY_PARSE_ERROR | | final protected static int VALUE_DISPLAY_PARSE_ERROR(Code) | | Value state indicating that validate() has been called when state was
VALUE_PARSE_ERROR. This makes the error visible on output.
|
| VALUE_DISPLAY_VALIDATION | | final protected static int VALUE_DISPLAY_VALIDATION(Code) | | Value state indicating that value validation has occured, and the
validation error, if any, should be displayed.
|
| VALUE_PARSED | | final protected static int VALUE_PARSED(Code) | | Value state indicating that a value has been parsed, but needs to be
validated (that must occur before the value is given to the application)
|
| VALUE_PARSE_ERROR | | final protected static int VALUE_PARSE_ERROR(Code) | | Value state indicating that a parse error was encountered but should not
yet be displayed.
|
| VALUE_UNPARSED | | final protected static int VALUE_UNPARSED(Code) | | Value state indicating that a new value has been read from the request,
but has not yet been parsed.
|
| VALUE_VALIDATED | | final protected static int VALUE_VALIDATED(Code) | | Value state indicating that validation has occured, but that any error should not
yet be displayed.
|
| VALUE_VALIDATING | | final protected static int VALUE_VALIDATING(Code) | | Transient value state indicating that validation is going on.
See Also: Field.validate() |
| required | | protected boolean required(Code) | | |
| selectionList | | protected SelectionList selectionList(Code) | | Overrides selection list defined in FieldDefinition, if any.
|
| valueState | | protected int valueState(Code) | | Transient widget processing state indicating that the widget is currently validating
(used to avoid endless loops when a validator calls getValue).
|
| addValueChangedListener | | public void addValueChangedListener(ValueChangedListener listener)(Code) | | Adds a ValueChangedListener to this widget instance. Listeners defined
on the widget instance will be executed in addtion to any listeners
that might have been defined in the widget definition.
|
| getSuggestionLabel | | public String getSuggestionLabel()(Code) | | If the user has chosen an item in a suggestion list, returns that item's label.
since:
2.1.9 the item's label, or null if the user entered a new value orif there's not suggestion list. |
| getValidationError | | public ValidationError getValidationError()(Code) | | Returns the validation error, if any. There will always be a validation error in case the
Field.validate method returned false.
This method does not cause parsing to take effect, use
Field.getValue if value
is not parsed yet.
|
| getXMLElementAttributes | | public AttributesImpl getXMLElementAttributes()(Code) | | Adds the @required attribute
|
| getXMLElementName | | public String getXMLElementName()(Code) | | "field" |
| hasValueChangedListeners | | public boolean hasValueChangedListeners()(Code) | | |
| initialize | | public void initialize()(Code) | | |
| isRequired | | public boolean isRequired()(Code) | | |
| isSuggested | | public boolean isSuggested()(Code) | | If this field has a selection-list, indicates if the value comes from that list
or if a new value was input by the user.
since:
2.1.9 true if the user has chosen a suggested value |
| readFromRequest | | protected void readFromRequest(String newEnteredValue)(Code) | | |
| setRequired | | public void setRequired(boolean required)(Code) | | |
| setSelectionList | | public void setSelectionList(SelectionList selectionList)(Code) | | Set this field's selection list.
Parameters:
selectionList - The new selection list. |
| setSelectionList | | public void setSelectionList(String uri)(Code) | | Read this field's selection list from an external source.
All Cocoon-supported protocols can be used.
The format of the XML produced by the source should be the
same as in case of inline specification of the selection list,
thus the root element should be a fd:selection-list
element.
Parameters:
uri - The URI of the source. |
| setSelectionList | | public void setSelectionList(Object model, String valuePath, String labelPath)(Code) | | Set this field's selection list using values from an in-memory
object. The object parameter should point to a collection
(Java collection or array, or Javascript array) of objects. Each object
belonging to the collection should have a value property and a
label property, whose values are used to specify the value
attribute and the contents of the fd:label child element
of every fd:item in the list.
Access to the values of the above mentioned properties is done
via XPath expressions.
Parameters:
model - The collection used as a model for the selection list.
Parameters:
valuePath - An XPath expression referring to the attribute usedto populate the values of the list's items.
Parameters:
labelPath - An XPath expression referring to the attribute usedto populate the labels of the list's items. |
| setSuggestionLabel | | public void setSuggestionLabel(String label)(Code) | | Set the suggestion label associated to the widget's current value. This is used to initialize
a combobox's rendering. If not such label exists, the widget's value is used.
since:
2.1.9 |
| setValidationError | | public void setValidationError(ValidationError error)(Code) | | Set a validation error on this field. This allows fields to be externally marked as invalid by
application logic.
Parameters:
error - the validation error |
| Fields inherited from org.apache.cocoon.forms.formmodel.AbstractWidget | protected boolean wasValid(Code)(Java Doc)
|
|
|