public class UIInput extends UIOutput implements EditableValueHolder
Type | Phases | Description |
---|---|---|
javax.faces.event.ValueChangeEvent |
The valueChange event is delivered when the value attribute is changed. |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
CONVERSION_MESSAGE_ID |
static String |
REQUIRED_MESSAGE_ID |
static String |
UPDATE_MESSAGE_ID |
bindings
Constructor and Description |
---|
UIInput()
Construct an instance of the UIInput.
|
Modifier and Type | Method and Description |
---|---|
void |
addValidator(Validator validator)
Adds a A method which is invoked during the validation phase for this component.
|
void |
addValueChangeListener(ValueChangeListener listener)
Adds a valueChange listener.
|
void |
broadcast(FacesEvent event)
Invoke any listeners attached to this object which are listening
for an event whose type matches the specified event's runtime
type.
|
protected boolean |
compareValues(Object previous,
Object value) |
void |
decode(FacesContext context)
Check the submitted form parameters for data associated with this
component.
|
protected Object |
getConvertedValue(FacesContext context,
Object submittedValue)
Convert the provided object to the desired value.
|
String |
getConverterMessage()
Gets Text of the converter message.
|
String |
getFamily() |
String |
getRequiredMessage()
Gets Text which will be shown if a required value is not submitted.
|
Object |
getSubmittedValue()
Gets the current submitted value.
|
MethodBinding |
getValidator()
Deprecated.
|
String |
getValidatorMessage()
Gets Text which will be shown, if validation fails.
|
Validator[] |
getValidators()
Gets all A method which is invoked during the validation phase for this component.
|
MethodBinding |
getValueChangeListener()
Deprecated.
|
ValueChangeListener[] |
getValueChangeListeners()
Returns an array of attached valueChange listeners.
|
boolean |
isImmediate()
Gets A boolean value that identifies the phase during which action events
should fire.
|
boolean |
isLocalValueSet()
Gets whether a local value is currently set.
|
boolean |
isRequired()
Gets A boolean value that indicates whether a value is required.
|
boolean |
isValid()
Gets whether the component's value is currently valid
|
void |
processDecodes(FacesContext context)
Set the "submitted value" of this component from the relevant data
in the current servet request object.
|
void |
processUpdates(FacesContext context)
This isn't an input component, so just pass on the processUpdates
call to child components and facets that might be input components.
|
void |
processValidators(FacesContext context) |
void |
removeValidator(Validator validator)
Removes a A method which is invoked during the validation phase for this component.
|
void |
removeValueChangeListener(ValueChangeListener listener)
Removes a valueChange listener.
|
void |
resetValue() |
void |
restoreState(FacesContext facesContext,
Object state)
Invoked in the "restore view" phase, this initialises this
object's members from the values saved previously into the
provided state object.
|
Object |
saveState(FacesContext facesContext)
Invoked after the render phase has completed, this method
returns an object which can be passed to the restoreState
of some other instance of UIComponentBase to reset that
object's state to the same values as this object currently
has.
|
void |
setConverterMessage(String converterMessage)
Sets Text of the converter message.
|
void |
setImmediate(boolean immediate)
Sets A boolean value that identifies the phase during which action events
should fire.
|
void |
setLocalValueSet(boolean localValueSet)
Sets whether a local value is currently set.
|
void |
setRequired(boolean required)
Sets A boolean value that indicates whether a value is required.
|
void |
setRequiredMessage(String requiredMessage)
Sets Text which will be shown if a required value is not submitted.
|
void |
setSubmittedValue(Object submittedValue)
Sets the current submitted value.
|
void |
setValid(boolean valid)
Sets whether the component's value is currently valid
|
void |
setValidator(MethodBinding validator)
Deprecated.
|
void |
setValidatorMessage(String validatorMessage)
Sets Text which will be shown, if validation fails.
|
void |
setValue(Object value)
Store the specified object as the "local value" of this component.
|
void |
setValueChangeListener(MethodBinding valueChangeListener)
Deprecated.
|
void |
updateModel(FacesContext context) |
void |
validate(FacesContext context)
Determine whether the new value is valid, and queue a ValueChangeEvent
if necessary.
|
protected void |
validateValue(FacesContext context,
Object convertedValue) |
getConverter, getLocalValue, getValue, setConverter
addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
encodeAll, getContainerClientId, getValueExpression, setValueExpression
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getConverter, getLocalValue, getValue, setConverter
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public static final String CONVERSION_MESSAGE_ID
public static final String REQUIRED_MESSAGE_ID
public static final String UPDATE_MESSAGE_ID
public void setValue(Object value)
setValue
in interface ValueHolder
setValue
in class UIOutput
value
- the new value valuepublic void processDecodes(FacesContext context)
If this component is not rendered, then do nothing; no output would have been sent to the client so no input is expected.
Invoke the inherited functionality, which typically invokes the renderer associated with this component to extract and set this component's "submitted value".
If this component is marked "immediate", then immediately apply validation to the submitted value found. On error, call context method "renderResponse" which will force processing to leap to the "render response" phase as soon as the "decode" step has completed for all other components.
processDecodes
in class UIComponentBase
public void processValidators(FacesContext context)
processValidators
in class UIComponentBase
public void processUpdates(FacesContext context)
UIComponentBase
Components that were never rendered can't possibly be receiving update data (no corresponding fields were ever put into the response) so if this component is not rendered then this method does not invoke processUpdates on its children.
processUpdates
in class UIComponentBase
public void decode(FacesContext context)
UIComponentBase
decode
in class UIComponentBase
public void broadcast(FacesEvent event) throws AbortProcessingException
UIComponentBase
This method does not propagate the event up to parent components, ie listeners attached to parent components don't automatically get called.
If any of the listeners throws AbortProcessingException then that exception will prevent any further listener callbacks from occurring, and the exception propagates out of this method without alteration.
ActionEvent events are typically queued by the renderer associated with this component in its decode method; ValueChangeEvent events by the component's validate method. In either case the event's source property references a component. At some later time the UIViewRoot component iterates over its queued events and invokes the broadcast method on each event's source object.
broadcast
in class UIComponentBase
event
- must not be null.AbortProcessingException
public void updateModel(FacesContext context)
protected void validateValue(FacesContext context, Object convertedValue)
public void validate(FacesContext context)
The "submitted value" is converted to the necessary type; conversion failure is reported as an error and validation processing terminates for this component. See documentation for method getConvertedValue for details on the conversion process.
Any validators attached to this component are then run, passing the converted value.
The old value of this component is then fetched (possibly involving the evaluation of a value-binding expression, ie invoking a method on a user object). The old value is compared to the new validated value, and if they are different then a ValueChangeEvent is queued for later processing.
On successful completion of this method:
protected Object getConvertedValue(FacesContext context, Object submittedValue)
If there is a renderer for this component, then call the renderer's getConvertedValue method. While this can of course be implemented in any way the renderer desires, it typically performs exactly the same processing that this method would have done anyway (ie that described below for the no-renderer case).
Otherwise:
public void resetValue()
public boolean isImmediate()
isImmediate
in interface EditableValueHolder
public void setImmediate(boolean immediate)
setImmediate
in interface EditableValueHolder
immediate
- the new immediate valuepublic boolean isRequired()
isRequired
in interface EditableValueHolder
public void setRequired(boolean required)
setRequired
in interface EditableValueHolder
required
- the new required valuepublic String getConverterMessage()
public void setConverterMessage(String converterMessage)
converterMessage
- the new converterMessage valuepublic String getRequiredMessage()
public void setRequiredMessage(String requiredMessage)
requiredMessage
- the new requiredMessage valuepublic MethodBinding getValidator()
getValidator
in interface EditableValueHolder
public void setValidator(MethodBinding validator)
setValidator
in interface EditableValueHolder
validator
- the new validator valuepublic void addValidator(Validator validator)
addValidator
in interface EditableValueHolder
public void removeValidator(Validator validator)
removeValidator
in interface EditableValueHolder
public Validator[] getValidators()
getValidators
in interface EditableValueHolder
public String getValidatorMessage()
public void setValidatorMessage(String validatorMessage)
validatorMessage
- the new validatorMessage valuepublic MethodBinding getValueChangeListener()
getValueChangeListener
in interface EditableValueHolder
public void setValueChangeListener(MethodBinding valueChangeListener)
setValueChangeListener
in interface EditableValueHolder
valueChangeListener
- the new valueChangeListener valuepublic boolean isValid()
isValid
in interface EditableValueHolder
public void setValid(boolean valid)
setValid
in interface EditableValueHolder
valid
- the new valid valuepublic boolean isLocalValueSet()
isLocalValueSet
in interface EditableValueHolder
public void setLocalValueSet(boolean localValueSet)
setLocalValueSet
in interface EditableValueHolder
localValueSet
- the new localValueSet valuepublic Object getSubmittedValue()
getSubmittedValue
in interface EditableValueHolder
public void setSubmittedValue(Object submittedValue)
setSubmittedValue
in interface EditableValueHolder
submittedValue
- the new submittedValue valuepublic void addValueChangeListener(ValueChangeListener listener)
addValueChangeListener
in interface EditableValueHolder
listener
- the valueChange listener to addpublic void removeValueChangeListener(ValueChangeListener listener)
removeValueChangeListener
in interface EditableValueHolder
listener
- the valueChange listener to removepublic ValueChangeListener[] getValueChangeListeners()
getValueChangeListeners
in interface EditableValueHolder
public Object saveState(FacesContext facesContext)
UIComponentBase
saveState
in interface StateHolder
saveState
in class UIOutput
public void restoreState(FacesContext facesContext, Object state)
UIComponentBase
restoreState
in interface StateHolder
restoreState
in class UIOutput
state
- is an object previously returned by
the saveState method of this class.Copyright © 2013 Apache Software Foundation. All Rights Reserved.