javax.faces.component: public interface: EditableValueHolder

javax.faces.component
public interface: EditableValueHolder [javadoc | source]

All Implemented Interfaces:
ValueHolder

All Known Implementing Classes:
HtmlSelectManyCheckbox, UISelectBoolean, UIInput, UIViewParameter, HtmlSelectOneListbox, HtmlInputSecret, UISelectOne, HtmlSelectOneRadio, HtmlSelectOneMenu, HtmlSelectManyListbox, HtmlInputTextarea, HtmlInputText, UISelectMany, HtmlSelectManyMenu, HtmlInputHidden, HtmlSelectBooleanCheckbox

EditableValueHolder is an extension of ValueHolder that describes additional features supported by editable components, including ValueChangeEvent s and Validator s.
Method from javax.faces.component.EditableValueHolder Summary:
addValidator, addValueChangeListener, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValueChangeListener
Method from javax.faces.component.EditableValueHolder Detail:

public void addValidator(Validator validator)
Add a Validator instance to the set associated with this component.
public void addValueChangeListener(ValueChangeListener listener)
Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvent s occur.
public Object getSubmittedValue()
Return the submittedValue value of this component. This method should only be used by the encodeBegin() and/or encodeEnd() methods of this component, or its corresponding Renderer .
public MethodBinding getValidator()Deprecated! { - @link #getValidators} should be used instead.

If #setValidator was not previously called for this instance, this method must return null. If it was called, this method must return the exact MethodBinding instance that was passed to #setValidator .

This method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).
public Validator[] getValidators()
Return the set of registered Validator s for this component instance. If there are no registered validators, a zero-length array is returned.
public MethodBinding getValueChangeListener()Deprecated! Use - #getValueChangeListeners instead.

If #setValueChangeListener was not previously called for this instance, this method must return null. If it was called, this method must return the exact MethodBinding instance that was passed to #setValueChangeListener .
public ValueChangeListener[] getValueChangeListeners()
Return the set of registered ValueChangeListener s for this component instance. If there are no registered listeners, a zero-length array is returned.
public boolean isImmediate()
Return the "immediate" state for this component.
public boolean isLocalValueSet()
Return the "local value set" state for this component. Calls to setValue() automatically reset this property to true.
public boolean isRequired()
Return the "required field" state for this component.
public boolean isValid()
Return a flag indicating whether the local value of this component is valid (no conversion error has occurred).
public void removeValidator(Validator validator)
Remove a Validator instance from the set associated with this component, if it was previously associated. Otherwise, do nothing.
public void removeValueChangeListener(ValueChangeListener listener)
Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvent s occur.
public void resetValue()
Convenience method to reset this component's value to the un-initialized state.
public void setImmediate(boolean immediate)
Set the "immediate" state for this component. When set to true, the component's value will be converted and validated immediately in the Apply Request Values phase, and ValueChangeEvent s will be delivered in that phase as well. The default value for this property must be false.
public void setLocalValueSet(boolean localValueSet)
Sets the "local value set" state for this component.
public void setRequired(boolean required)
Set the "required field" state for this component.
public void setSubmittedValue(Object submittedValue)
Set the submittedValue value of this component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer .
public void setValid(boolean valid)
Set a flag indicating whether the local value of this component is valid (no conversion error has occurred).
public void setValidator(MethodBinding validatorBinding)Deprecated! Use - #addValidator instead, obtaining the argument Validator by creating an instance of javax.faces.validator.MethodExpressionValidator .

Wrap the argument validatorBinding in an implementation of javax.faces.validator.Validator and store it in the internal data structure that backs the #getValidators method, taking care to over-write any instance that was stored by a previous call to setValidator.

The argument method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

Any method referenced by such an expression must be public, with a return type of void, and accept parameters of type javax.faces.context.FacesContext , UIComponent , and Object.
public void setValueChangeListener(MethodBinding valueChangeMethod)Deprecated! Use - #addValueChangeListener instead, obtaining the argument ValueChangeListener by creating an instance of javax.faces.event.MethodExpressionValueChangeListener .

Wrap the argument valueChangeMethod in an implementation of ValueChangeListener and store it in the internal data structure that backs the #getValueChangeListeners method, taking care to over-write any instance that was stored by a previous call to setValueChangeListener.

This argument method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

Any method referenced by such an expression must be public, with a return type of void, and accept a parameter of type javax.faces.event.ValueChangeEvent .