Class Hierarchy All Classes All Fields and Methods

 

Interface javax.faces.component.EditableValueHolder

public interface EditableValueHolder
extends ValueHolder

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

Method Index

Method	Description
void addValidator(Validator)	Add a Validator instance to the set associated with this component.
void addValueChangeListener(ValueChangeListener)	Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvents occur.
Object getSubmittedValue()	Return the submittedValue value of this component.
MethodBinding getValidator()	Return a MethodBinding pointing at a method that will be used to validate the current value of this component.
Validator[] getValidators()	Return the set of registered Validators for this component instance.
MethodBinding getValueChangeListener()	Return a MethodBinding instance method that will be called after any registered ValueChangeListeners have been notified of a value change.
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(Validator)	Remove a Validator instance from the set associated with this component, if it was previously associated.
void removeValueChangeListener(ValueChangeListener)	Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvents occur.
void setImmediate(boolean)	Set the "immediate" state for this component.
void setLocalValueSet(boolean)	Sets the "local value set" state for this component.
void setRequired(boolean)	Set the "required field" state for this component.
void setSubmittedValue(Object)	Set the submittedValue value of this component.
void setValid(boolean)	Set a flag indicating whether the local value of this component is valid (no conversion error has occurred).
void setValidator(MethodBinding)	Set a MethodBinding pointing at a method that will be used to validate the current value of this component.
void setValueChangeListener(MethodBinding)	Set a MethodBinding instance method that will be called after any registered ValueChangeListeners have been notified of a value change.

 

Methods

 

addValidator

public void addValidator(Validator validator) 

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

• Parameters

  • validator - The Validator to add

• Throws

  • NullPointerException if validator is null

 

addValueChangeListener

public void addValueChangeListener(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

  • NullPointerException if listener is null

 

getSubmittedValue

public Object getSubmittedValue() 

Return 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.

 

getValidator

public 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).

 

getValidators

public Validator[] getValidators() 

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

 

getValueChangeListener

public 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).

 

getValueChangeListeners

public ValueChangeListener[] getValueChangeListeners() 

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

 

isImmediate

public boolean isImmediate() 

Return the "immediate" state for this component.

 

isLocalValueSet

public boolean isLocalValueSet() 

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

 

isRequired

public boolean isRequired() 

Return the "required field" 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).

 

removeValidator

public void removeValidator(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

 

removeValueChangeListener

public void removeValueChangeListener(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

  • NullPointerException if listener is null

 

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

 

setLocalValueSet

public void setLocalValueSet(boolean localValueSet) 

Sets the "local value set" 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

 

setSubmittedValue

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.

• Parameters

  • submittedValue - The new submitted value

 

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

 

setValidator

public void setValidator(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

 

setValueChangeListener

public void setValueChangeListener(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

Class Hierarchy All Classes All Fields and Methods