Overrides jakarta.faces.component.UIInput.addValidator.

Implements jakarta.faces.component.EditableValueHolder.addValidator.

Doc from jakarta.faces.component.UIInput.addValidator.

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

Parameters

validator:Validator<T>

The Validator to add

Annotations

@Override

Overrides jakarta.faces.component.UIInput.clearInitialState.

Implements jakarta.faces.component.PartialStateHolder.clearInitialState.

Doc from jakarta.faces.component.PartialStateHolder.clearInitialState.

Reset the PartialStateHolder to a non-delta tracking state.

Annotations

@Override

Overrides jakarta.faces.component.UIComponentBase.encodeBegin.

Doc from jakarta.faces.component.UIComponent.encodeBegin.

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. Call pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent). Call jakarta.faces.application.Application#publishEvent, passing jakarta.faces.event.PreRenderComponentEvent.class as the first argument and the component instance to be rendered as the second argument.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeBegin(FacesContext, UIComponent).

If our rendered property is false, call pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) and return immediately.

Parameters

context:FacesContext

FacesContext for the response we are creating

Annotations

@Override

Exceptions

IOException:

if an input/output error occurs while rendering

Overrides jakarta.faces.component.UIInput.getFamily.

Doc from jakarta.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations

@Override

Overrides jakarta.faces.component.UIInput.getSubmittedValue.

Implements jakarta.faces.component.EditableValueHolder.getSubmittedValue.

Doc from jakarta.faces.component.UIInput.getSubmittedValue.

Return the submittedValue value of this UIInput component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer.

Returns:Object

Doc from jakarta.faces.component.EditableValueHolder.getSubmittedValue.

the submitted value.

Annotations

@Override

Overrides jakarta.faces.component.UIComponent.initialStateMarked.

Implements jakarta.faces.component.PartialStateHolder.initialStateMarked.

Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked.

Return true if delta state changes are being tracked, otherwise false

Returns:boolean

true if the initial state is marked, false otherwise.

Annotations

@Override

Overrides jakarta.faces.component.UIComponentBase.isTransient.

Implements jakarta.faces.component.StateHolder.isTransient.

Doc from jakarta.faces.component.StateHolder.isTransient.

If true, the Object implementing this interface must not participate in state saving or restoring.

Returns:boolean

true if transient, false otherwise.

Annotations

@Override

Overrides jakarta.faces.component.UIInput.markInitialState.

Implements jakarta.faces.component.PartialStateHolder.markInitialState.

Doc from jakarta.faces.component.PartialStateHolder.markInitialState.

The runtime must ensure that the markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that initialStateMarked returns true from the time markInitialState() is called until clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState.

Annotations

@Override

Overrides jakarta.faces.component.UIInput.restoreState.

Implements jakarta.faces.component.StateHolder.restoreState.

Doc from jakarta.faces.component.StateHolder.restoreState.

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the restoreState method on all those instances as well.

If the state argument is null, take no action and return.

Parameters

context:FacesContext

the Faces context.

state:Object

the state.

Annotations

@Override

Overrides jakarta.faces.component.UIInput.saveState.

Implements jakarta.faces.component.StateHolder.saveState.

Doc from jakarta.faces.component.StateHolder.saveState.

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the saveState method on all those instances as well. This method must not save the state of children and facets. That is done via the jakarta.faces.application.StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

Object state = component.saveState(facesContext);

component should be the same as before executing it.

The return from this method must be Serializable

Parameters

context:FacesContext

the Faces context.

Returns:Object

the saved state.

Annotations

@Override

Overrides jakarta.faces.component.UIOutput.setConverter.

Implements jakarta.faces.component.ValueHolder.setConverter.

Doc from jakarta.faces.component.ValueHolder.setConverter.

Set the Converter (if any) that is registered for this UIComponent.

Parameters

converter:Converter<T>

New Converter (or null)

Annotations

@Override

Overrides jakarta.faces.component.UIComponentBase.setTransient.

Implements jakarta.faces.component.StateHolder.setTransient.

Doc from jakarta.faces.component.StateHolder.setTransient.

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Parameters

transientValue:boolean

boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

Annotations

@Override

Overrides jakarta.faces.component.UIInput.updateModel.

Doc from jakarta.faces.component.UIInput.updateModel.

Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate.

• If the valid property of this component is false, take no further action.
• If the localValueSet property of this component is false, take no further action.
• If no ValueExpression for value exists, take no further action.
• Call setValue() method of the ValueExpression to update the value that the ValueExpression points at.
• If the setValue() method returns successfully:
  • Clear the local value of this UIInput.
  • Set the localValueSet property of this UIInput to false.
• If the setValue() method throws an Exception:
  • Enqueue an error message. Create a FacesMessage with the id UPDATE_MESSAGE_ID. Create a UpdateModelException, passing the FacesMessage and the caught exception to the constructor. Create an ExceptionQueuedEventContext, passing the FacesContext, the UpdateModelException, this component instance, and PhaseId#UPDATE_MODEL_VALUES to its constructor. Call FacesContext#getExceptionHandler and then call ExceptionHandler#processEvent, passing the ExceptionQueuedEventContext.
  • Set the valid property of this UIInput to false.
  The exception must not be re-thrown. This enables tree traversal to continue for this lifecycle phase, as in all the other lifecycle phases.

Parameters

context:FacesContext

FacesContext for the request we are processing

Annotations

@Override

Overrides jakarta.faces.component.UIInput.validate.

Doc from jakarta.faces.component.UIInput.validate.

Perform the following algorithm to validate the local value of this UIInput.

• Retrieve the submitted value with getSubmittedValue. If this returns null, and the value of the ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE context-param is true (ignoring case), examine the value of the "required" property. If the value of "required" is true, continue as below. If the value of "required" is false or the required attribute is not set, exit without further processing. If the context-param is not set, or is set to false (ignoring case), exit without further processing. (This indicates that no value was submitted for this component.)
• If the jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL context parameter value is true (ignoring case), and getSubmittedValue() returns a zero-length String call setSubmittedValue, passing null as the argument and continue processing using null as the current submitted value.
• Convert the submitted value into a "local value" of the appropriate data type by calling getConvertedValue.
• If conversion fails:
  • Enqueue an appropriate error message by calling the addMessage() method on the FacesContext.
  • Set the valid property on this component to false
• Validate the property by calling validateValue.
• If the valid property of this component is still true, retrieve the previous value of the component (with getValue()), store the new local value using setValue(), and reset the submitted value to null with a call to setSubmittedValue passing null as the argument. If the local value is different from the previous value of this component, as determined by a call to compareValues, fire a ValueChangeEvent to be broadcast to all interested listeners.

Application components implementing UIInput that wish to perform validation with logic embedded in the component should perform their own correctness checks, and then call the super.validate() method to perform the standard processing described above.

Parameters

context:FacesContext

The FacesContext for the current request

Annotations

@Override