| java.lang.Object
 javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
All known Subclasses: javax.faces.component.UISelectBoolean, javax.faces.component.html.HtmlInputTextarea, javax.faces.component.UISelectOne, javax.faces.component.html.HtmlInputSecret, javax.faces.component.html.HtmlInputText, javax.faces.component.html.HtmlInputHidden, javax.faces.component.UISelectMany,
| UIInput | | public class UIInput extends UIOutput implements EditableValueHolder(Code) | | Events:
| Type |
Phases |
Description |
javax.faces.event.ValueChangeEvent |
|
The valueChange event is delivered when the value
attribute is changed. |
|
| Constructor Summary | |
| public | UIInput()
Construct an instance of the UIInput. |
| Method Summary | |
| public void | addValidator(Validator validator)
Adds a Validator Method, which should be invoked for validation. | | public void | addValueChangeListener(ValueChangeListener listener)
Adds a valueChange listener. | | public void | broadcast(FacesEvent event)
| | protected boolean | compareValues(Object previous, Object value)
| | public void | decode(FacesContext context)
| | protected Object | getConvertedValue(FacesContext context, Object submittedValue)
Convert the provided object to the desired value.
If there is a renderer for this component, then call the renderer's
getConvertedValue method. | | public String | getConverterMessage()
Gets Text of the converter message. | | public String | getFamily()
| | public String | getRequiredMessage()
Gets Text which will be shown if a required value is not submitted. | | public Object | getSubmittedValue()
Gets the current submitted value. | | public MethodBinding | getValidator()
Gets Validator Method, which should be invoked for validation. | | public String | getValidatorMessage()
Gets Text which will be shown, if validation fails. | | public Validator[] | getValidators()
Gets all Validator Method, which should be invoked for validation. | | public MethodBinding | getValueChangeListener()
Gets A Method which is called when the value changed. | | public ValueChangeListener[] | getValueChangeListeners()
Returns an array of attached valueChange listeners. | | public boolean | isImmediate()
Gets A boolean value that identifies the phase during which action events
should fire. | | public boolean | isLocalValueSet()
Gets whether a local value is currently set. | | public boolean | isRequired()
Gets A boolean value that indicates whether a value is required. | | public boolean | isValid()
| | public void | processDecodes(FacesContext context)
Set the "submitted value" of this component from the relevant data
in the current servet request object.
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. | | public void | processUpdates(FacesContext context)
| | public void | processValidators(FacesContext context)
| | public void | removeValidator(Validator validator)
Removes a Validator Method, which should be invoked for validation. | | public void | removeValueChangeListener(ValueChangeListener listener)
Removes a valueChange listener. | | public void | resetValue()
| | public void | restoreState(FacesContext facesContext, Object state)
| | public Object | saveState(FacesContext facesContext)
| | public void | setConverterMessage(String converterMessage)
Sets Text of the converter message. | | public void | setImmediate(boolean immediate)
Sets A boolean value that identifies the phase during which action events
should fire. | | public void | setLocalValueSet(boolean localValueSet)
Sets whether a local value is currently set. | | public void | setRequired(boolean required)
Sets A boolean value that indicates whether a value is required. | | public void | setRequiredMessage(String requiredMessage)
Sets Text which will be shown if a required value is not submitted. | | public void | setSubmittedValue(Object submittedValue)
Sets the current submitted value. | | public void | setValid(boolean valid)
| | public void | setValidator(MethodBinding validator)
Sets Validator Method, which should be invoked for validation. | | public void | setValidatorMessage(String validatorMessage)
Sets Text which will be shown, if validation fails. | | public void | setValue(Object value)
Store the specified object as the "local value" of this component.
The value-binding named "value" (if any) is ignored; the object is
only stored locally on this component. | | public void | setValueChangeListener(MethodBinding valueChangeListener)
Sets A Method which is called when the value changed. | | public void | updateModel(FacesContext context)
| | public void | validate(FacesContext context)
Determine whether the new value is valid, and queue a ValueChangeEvent
if necessary.
The "submitted value" is converted to the necessary type; conversion
failure is reported as an error and validation processing terminates
for this component. | | protected void | validateValue(FacesContext context, Object convertedValue)
|
| COMPONENT_FAMILY | | final public static String COMPONENT_FAMILY(Code) | | |
| COMPONENT_TYPE | | final public static String COMPONENT_TYPE(Code) | | |
| CONVERSION_MESSAGE_ID | | final public static String CONVERSION_MESSAGE_ID(Code) | | |
| REQUIRED_MESSAGE_ID | | final public static String REQUIRED_MESSAGE_ID(Code) | | |
| UPDATE_MESSAGE_ID | | final public static String UPDATE_MESSAGE_ID(Code) | | |
| UIInput | | public UIInput()(Code) | | Construct an instance of the UIInput.
|
| addValidator | | public void addValidator(Validator validator)(Code) | | Adds a Validator Method, which should be invoked for validation.
|
| addValueChangeListener | | public void addValueChangeListener(ValueChangeListener listener)(Code) | | Adds a valueChange listener.
Parameters:
listener - the valueChange listener to add |
| getConvertedValue | | protected Object getConvertedValue(FacesContext context, Object submittedValue)(Code) | | Convert the provided object to the desired value.
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:
- If the submittedValue is not a String then just return the
submittedValue unconverted.
- If there is no "value" value-binding then just return the
submittedValue unconverted.
- Use introspection to determine the type of the target
property specified by the value-binding, and then use
Application.createConverter to find a converter that can
map from String to the required type. Apply the converter
to the submittedValue and return the result.
|
| getConverterMessage | | public String getConverterMessage()(Code) | | Gets Text of the converter message.
the new converterMessage value |
| getRequiredMessage | | public String getRequiredMessage()(Code) | | Gets Text which will be shown if a required value is not submitted.
the new requiredMessage value |
| getSubmittedValue | | public Object getSubmittedValue()(Code) | | Gets the current submitted value. This value,
if non-null, is set by the Renderer to store a possibly invalid value
for later conversion or redisplay, and has not yet been converted
into the proper type for this component instance. This method
should only be used by the decode() and validate() method
of this component, or its corresponding Renderer; however, user code
may manually set it to null to erase any submitted value.
the new submittedValue value |
| getValidator | | public MethodBinding getValidator()(Code) | | Gets Validator Method, which should be invoked for validation.
the new validator value |
| getValidatorMessage | | public String getValidatorMessage()(Code) | | Gets Text which will be shown, if validation fails.
the new validatorMessage value |
| getValidators | | public Validator[] getValidators()(Code) | | Gets all Validator Method, which should be invoked for validation.
|
| getValueChangeListener | | public MethodBinding getValueChangeListener()(Code) | | Gets A Method which is called when the value changed.
the new valueChangeListener value |
| getValueChangeListeners | | public ValueChangeListener[] getValueChangeListeners()(Code) | | Returns an array of attached valueChange listeners.
an array of attached valueChange listeners. |
| isImmediate | | public boolean isImmediate()(Code) | | Gets A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
the new immediate value |
| isLocalValueSet | | public boolean isLocalValueSet()(Code) | | Gets whether a local value is currently set. If false, values are being retrieved from any attached ValueBinding
the new localValueSet value |
| isRequired | | public boolean isRequired()(Code) | | Gets A boolean value that indicates whether a value is required. Default value: false.
the new required value |
| isValid | | public boolean isValid()(Code) | | Gets whether the component's value is currently valid
the new valid value |
| processDecodes | | public void processDecodes(FacesContext context)(Code) | | Set the "submitted value" of this component from the relevant data
in the current servet request object.
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.
|
| removeValidator | | public void removeValidator(Validator validator)(Code) | | Removes a Validator Method, which should be invoked for validation.
|
| removeValueChangeListener | | public void removeValueChangeListener(ValueChangeListener listener)(Code) | | Removes a valueChange listener.
Parameters:
listener - the valueChange listener to remove |
| resetValue | | public void resetValue()(Code) | |
since:
1.2 |
| setConverterMessage | | public void setConverterMessage(String converterMessage)(Code) | | Sets Text of the converter message.
Parameters:
converterMessage - the new converterMessage value |
| setImmediate | | public void setImmediate(boolean immediate)(Code) | | Sets A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
Parameters:
immediate - the new immediate value |
| setLocalValueSet | | public void setLocalValueSet(boolean localValueSet)(Code) | | Sets whether a local value is currently set. If false, values are being retrieved from any attached ValueBinding
Parameters:
localValueSet - the new localValueSet value |
| setRequired | | public void setRequired(boolean required)(Code) | | Sets A boolean value that indicates whether a value is required. Default value: false.
Parameters:
required - the new required value |
| setRequiredMessage | | public void setRequiredMessage(String requiredMessage)(Code) | | Sets Text which will be shown if a required value is not submitted.
Parameters:
requiredMessage - the new requiredMessage value |
| setSubmittedValue | | public void setSubmittedValue(Object submittedValue)(Code) | | Sets the current submitted value. This value,
if non-null, is set by the Renderer to store a possibly invalid value
for later conversion or redisplay, and has not yet been converted
into the proper type for this component instance. This method
should only be used by the decode() and validate() method
of this component, or its corresponding Renderer; however, user code
may manually set it to null to erase any submitted value.
Parameters:
submittedValue - the new submittedValue value |
| setValid | | public void setValid(boolean valid)(Code) | | Sets whether the component's value is currently valid
Parameters:
valid - the new valid value |
| setValidator | | public void setValidator(MethodBinding validator)(Code) | | Sets Validator Method, which should be invoked for validation.
Parameters:
validator - the new validator value |
| setValidatorMessage | | public void setValidatorMessage(String validatorMessage)(Code) | | Sets Text which will be shown, if validation fails.
Parameters:
validatorMessage - the new validatorMessage value |
| setValue | | public void setValue(Object value)(Code) | | Store the specified object as the "local value" of this component.
The value-binding named "value" (if any) is ignored; the object is
only stored locally on this component. During the "update model"
phase, if there is a value-binding named "value" then this local
value will be stored via that value-binding and the "local value"
reset to null.
|
| setValueChangeListener | | public void setValueChangeListener(MethodBinding valueChangeListener)(Code) | | Sets A Method which is called when the value changed.
Parameters:
valueChangeListener - the new valueChangeListener value |
| validate | | public void validate(FacesContext context)(Code) | | Determine whether the new value is valid, and queue a ValueChangeEvent
if necessary.
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:
- isValid() is true
- isLocalValueSet() is true
- submittedValue is reset to null
- a ValueChangeEvent is queued if the new value != old value
|
| Methods inherited from javax.faces.component.UIComponentBase | protected void addFacesListener(FacesListener listener)(Code)(Java Doc)
public void broadcast(FacesEvent event) throws AbortProcessingException(Code)(Java Doc)
public void decode(FacesContext context)(Code)(Java Doc)
public void encodeBegin(FacesContext context) throws IOException(Code)(Java Doc)
public void encodeChildren(FacesContext context) throws IOException(Code)(Java Doc)
public void encodeEnd(FacesContext context) throws IOException(Code)(Java Doc)
public UIComponent findComponent(String expr)(Code)(Java Doc)
public Map<String, Object> getAttributes()(Code)(Java Doc)
public int getChildCount()(Code)(Java Doc)
public List<UIComponent> getChildren()(Code)(Java Doc)
public String getClientId(FacesContext context)(Code)(Java Doc)
T getExpressionValue(String attribute, T explizitValue, T defaultValueIfExpressionNull)(Code)(Java Doc)
protected FacesContext getFacesContext()(Code)(Java Doc)
protected FacesListener[] getFacesListeners(Class clazz)(Code)(Java Doc)
public UIComponent getFacet(String name)(Code)(Java Doc)
public int getFacetCount()(Code)(Java Doc)
public Map<String, UIComponent> getFacets()(Code)(Java Doc)
public Iterator<UIComponent> getFacetsAndChildren()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public UIComponent getParent()(Code)(Java Doc)
protected Renderer getRenderer(FacesContext context)(Code)(Java Doc)
public String getRendererType()(Code)(Java Doc)
public boolean getRendersChildren()(Code)(Java Doc)
public ValueBinding getValueBinding(String name)(Code)(Java Doc)
public boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException(Code)(Java Doc)
public boolean isRendered()(Code)(Java Doc)
public boolean isTransient()(Code)(Java Doc)
public void processDecodes(FacesContext context)(Code)(Java Doc)
public void processRestoreState(FacesContext context, Object state)(Code)(Java Doc)
public Object processSaveState(FacesContext context)(Code)(Java Doc)
public void processUpdates(FacesContext context)(Code)(Java Doc)
public void processValidators(FacesContext context)(Code)(Java Doc)
public void queueEvent(FacesEvent event)(Code)(Java Doc)
protected void removeFacesListener(FacesListener listener)(Code)(Java Doc)
public static Object restoreAttachedState(FacesContext context, Object stateObj) throws IllegalStateException(Code)(Java Doc)
public void restoreState(FacesContext context, Object state)(Code)(Java Doc)
public static Object saveAttachedState(FacesContext context, Object attachedObject)(Code)(Java Doc)
public Object saveState(FacesContext context)(Code)(Java Doc)
public void setId(String id)(Code)(Java Doc)
public void setParent(UIComponent parent)(Code)(Java Doc)
public void setRendered(boolean rendered)(Code)(Java Doc)
public void setRendererType(String rendererType)(Code)(Java Doc)
public void setTransient(boolean transientFlag)(Code)(Java Doc)
public void setValueBinding(String name, ValueBinding binding)(Code)(Java Doc)
|
|
|