javax.faces.component
Interface EditableValueHolder

All Superinterfaces:

ValueHolder

All Known Implementing Classes:

UIInput

public interface EditableValueHolder

extends ValueHolder

EditableValueHolder is an extension of ValueHolder that describes additional features supported by editable components, including ValueChangeEvents and Validators.

Method Summary

void	addValidator(javax.faces.validator.Validator validator) Add a Validator instance to the set associated with this component.
void	addValueChangeListener(javax.faces.event.ValueChangeListener listener) Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvents occur.
java.lang.Object	getSubmittedValue() Return the submittedValue value of this component.
javax.faces.el.MethodBinding	getValidator() Return a MethodBinding pointing at a method that will be used to validate the current value of this component.
javax.faces.validator.Validator[]	getValidators() Return the set of registered Validators for this component instance.
javax.faces.el.MethodBinding	getValueChangeListener() Return a MethodBinding instance method that will be called after any registered ValueChangeListeners have been notified of a value change.
javax.faces.event.ValueChangeListener[]	getValueChangeListeners() Return the set of registered ValueChangeListeners for this component instance.
boolean	isImmediate() Return the "immediate" state for this component.
boolean	isLocalValueSet() Return the "local value set" state for this component.
boolean	isRequired() Return the "required field" state for this component.
boolean	isValid() Return a flag indicating whether the local value of this component is valid (no conversion error has occurred).
void	removeValidator(javax.faces.validator.Validator validator) Remove a Validator instance from the set associated with this component, if it was previously associated.
void	removeValueChangeListener(javax.faces.event.ValueChangeListener listener) Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvents occur.
void	setImmediate(boolean immediate) Set the "immediate" state for this component.
void	setLocalValueSet(boolean localValueSet) Sets the "local value set" state for this component.
void	setRequired(boolean required) Set the "required field" state for this component.
void	setSubmittedValue(java.lang.Object submittedValue) Set the submittedValue value of this component.
void	setValid(boolean valid) Set a flag indicating whether the local value of this component is valid (no conversion error has occurred).
void	setValidator(javax.faces.el.MethodBinding validatorBinding) Set a MethodBinding pointing at a method that will be used to validate the current value of this component.
void	setValueChangeListener(javax.faces.el.MethodBinding valueChangeMethod) Set a MethodBinding instance method that will be called after any registered ValueChangeListeners have been notified of a value change.

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Method Detail

getSubmittedValue

public java.lang.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.

setSubmittedValue

public void setSubmittedValue(java.lang.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.

Parameters:

submittedValue - The new submitted value

isLocalValueSet

public boolean isLocalValueSet()

Return the "local value set" state for this component. Calls to setValue() automatically reset this property to true.

setLocalValueSet

public void setLocalValueSet(boolean localValueSet)

Sets the "local value set" state for this component.

isValid

public boolean isValid()

Return a flag indicating whether the local value of this component is valid (no conversion error has occurred).

setValid

public void setValid(boolean valid)

Set a flag indicating whether the local value of this component is valid (no conversion error has occurred).

Parameters:

valid - The new valid flag

isRequired

public boolean isRequired()

Return the "required field" state for this component.

setRequired

public void setRequired(boolean required)

Set the "required field" state for this component.

Parameters:

required - The new "required field" state

isImmediate

public boolean isImmediate()

Return the "immediate" state for this component.

setImmediate

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 ValueChangeEvents will be delivered in that phase as well. The default value for this property must be false.

Parameters:

immediate - The new "immediate" state

getValidator

public javax.faces.el.MethodBinding getValidator()

Return a MethodBinding pointing at a method that will be used to validate the current value of this component. This method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

setValidator

public void setValidator(javax.faces.el.MethodBinding validatorBinding)

Set a MethodBinding pointing at a method that will be used to validate the current value of this component. This 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 FacesContext, UIComponent, and Object.

Parameters:

validatorBinding - The new MethodBinding instance

getValueChangeListener

public javax.faces.el.MethodBinding getValueChangeListener()

Return a MethodBinding instance method that will be called after any registered ValueChangeListeners have been notified of a value change. This method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

setValueChangeListener

public void setValueChangeListener(javax.faces.el.MethodBinding valueChangeMethod)

Set a MethodBinding instance method that will be called after any registered ValueChangeListeners have been notified of a value change. This method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

Parameters:

valueChangeMethod - The new method binding instance

addValidator

public void addValidator(javax.faces.validator.Validator validator)

Add a Validator instance to the set associated with this component.

Parameters:

validator - The Validator to add

Throws:

java.lang.NullPointerException - if validator is null

getValidators

public javax.faces.validator.Validator[] getValidators()

Return the set of registered Validators for this component instance. If there are no registered validators, a zero-length array is returned.

removeValidator

public void removeValidator(javax.faces.validator.Validator validator)

Remove a Validator instance from the set associated with this component, if it was previously associated. Otherwise, do nothing.

Parameters:

validator - The Validator to remove

addValueChangeListener

public void addValueChangeListener(javax.faces.event.ValueChangeListener listener)

Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvents occur.

Parameters:

listener - The ValueChangeListener to be added

Throws:

java.lang.NullPointerException - if listener is null

getValueChangeListeners

public javax.faces.event.ValueChangeListener[] getValueChangeListeners()

Return the set of registered ValueChangeListeners for this component instance. If there are no registered listeners, a zero-length array is returned.

removeValueChangeListener

public void removeValueChangeListener(javax.faces.event.ValueChangeListener listener)

Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvents occur.

Parameters:

listener - The ValueChangeListener to be removed

Throws:

java.lang.NullPointerException - if listener is null