Implements jakarta.faces.component.UniqueIdVendor.createUniqueId.

Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id.

If the prependId property has the value false, this method must call createUniqueId on the next ancestor UniqueIdVendor.

Parameters

context:FacesContext

FacesContext

seed:String

an optional seed value - e.g. based on the position of the component in the VDL-template

Returns:String

a unique-id in this component-container

Annotations

@Override

Overrides jakarta.faces.component.UIComponent.getContainerClientId.

Override the UIComponent#getContainerClientId to allow users to disable this form from prepending its clientId to its descendent's clientIds depending on the value of this form's isPrependId property.

Parameters

context:FacesContext

Doc from jakarta.faces.component.UIComponent.getContainerClientId.

the Faces context.

Returns:String

Doc from jakarta.faces.component.UIComponent.getContainerClientId.

the container client id.

Annotations

@Override

Implements abstract jakarta.faces.component.UIComponent.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.UIComponentBase.invokeOnComponent.

Doc from jakarta.faces.component.UIComponentBase.invokeOnComponent.

Starting at this component in the View hierarchy, search for a component with a clientId equal to the argument clientId and, if found, call the ContextCallback#invokeContextCallback method on the argument callback, passing the current FacesContext and the found component as arguments. This method is similar to findComponent but it does not support the leading UINamingContainer#getSeparatorChar syntax for searching from the root of the View.

The default implementation will first check if this.getClientId() is equal to the argument clientId. If so, first call pushComponentToEL, then call the ContextCallback#invokeContextCallback method on the argument callback, passing through the FacesContext argument and passing this as the component argument. Then call popComponentFromEL. If an Exception is thrown by the callback, wrap it in a FacesException and re-throw it. Otherwise, return true.

Otherwise, for each component returned by getFacetsAndChildren, call invokeOnComponent() passing the arguments to this method, in order. The first time invokeOnComponent() returns true, abort traversing the rest of the Iterator and return true.

When calling ContextCallback#invokeContextCallback the implementation of this method must guarantee that the state of the component passed to the callback correctly reflects the component's position in the View hierarchy with respect to any state found in the argument clientId. For example, an iterating component such as UIData will need to set its row index to correctly reflect the argument clientId before finding the appropriate child component backed by the correct row. When the callback returns, either normally or by throwing an Exception the implementation of this method must restore the state of the view to the way it was before invoking the callback.

If none of the elements from getFacetsAndChildren returned true from invokeOnComponent(), return false.

Simple usage example to find a component by clientId.

   private UIComponent found = null;

   private void doFind(FacesContext context, String clientId) {
     context.getViewRoot().invokeOnComponent(context, clientId,
         new ContextCallback() {
            public void invokeContextCallback(FacesContext context,
                                          UIComponent component) {
              found = component;
            }
         });
   }

Parameters

context:FacesContext

Doc from jakarta.faces.component.UIComponent.invokeOnComponent.

the FacesContext for the current request

clientId:String

Doc from jakarta.faces.component.UIComponent.invokeOnComponent.

the client identifier of the component to be passed to the argument callback.

callback:ContextCallback

Doc from jakarta.faces.component.UIComponent.invokeOnComponent.

an implementation of the Callback interface.

Returns:boolean

Doc from jakarta.faces.component.UIComponent.invokeOnComponent.

true if the a component with the given clientId is found, the callback method was successfully invoked passing that component as an argument, and no Exception was thrown. Returns false if no component with the given clientId is found.

Annotations

@Override

Exceptions

FacesException:

if the argument Callback throws an Exception, it is wrapped in a FacesException and re-thrown.

See Also

UIComponent#invokeOnComponent

Is the id prepended.

Returns:boolean

true if it is, false otherwise.

Returns the current value of the submitted property. The default value is false. See setSubmitted for details.

This property must be kept as a transient property using the UIComponent#getTransientStateHelper.

Returns:boolean

true if the form was submitted, false otherwise.

Overrides jakarta.faces.component.UIComponentBase.processDecodes.

Override UIComponent#processDecodes to ensure that the form is decoded before its children. This is necessary to allow the submitted property to be correctly set.

Parameters

context:FacesContext

Doc from jakarta.faces.component.UIComponent.processDecodes.

FacesContext for the request we are processing

Annotations

@Override

Exceptions

NullPointerException:

if context is null

Overrides jakarta.faces.component.UIComponentBase.processUpdates.

Override UIComponent#processUpdates to ensure that the children of this UIForm instance are only processed if isSubmitted returns true.

Parameters

context:FacesContext

Doc from jakarta.faces.component.UIComponent.processUpdates.

FacesContext for the request we are processing

Annotations

@Override

Exceptions

NullPointerException:

if context is null

Overrides jakarta.faces.component.UIComponentBase.processValidators.

Override UIComponent#processValidators to ensure that the children of this UIForm instance are only processed if isSubmitted returns true.

Parameters

context:FacesContext

Doc from jakarta.faces.component.UIComponent.processValidators.

FacesContext for the request we are processing

Annotations

@Override

Exceptions

NullPointerException:

if context is null

See Also

jakarta.faces.event.PreValidateEvent, jakarta.faces.event.PostValidateEvent

Set whether the id should be prepended.

Parameters

prependId:boolean

true if it is, false otherwise.

If this UIForm instance (as opposed to other forms in the page) is experiencing a submit during this request processing lifecycle, this method must be called, with true as the argument, during the UIComponent#decode for this UIForm instance. If this UIForm instance is not experiencing a submit, this method must be called, with false as the argument, during the UIComponent#decode for this UIForm instance.

The value of a UIForm's submitted property must not be saved as part of its state.

This property must be kept as a transient property using the UIComponent#getTransientStateHelper.

Parameters

submitted:boolean

the new value of the submitted flag.

Overrides jakarta.faces.component.UIComponent.visitTree.

Doc from jakarta.faces.component.UIComponent.visitTree.

Perform a tree visit starting at this node in the tree.

Parameters

context:VisitContext

the VisitContext for this visit

callback:VisitCallback

the VisitCallback instance whose visit method will be called for each node visited.

Returns:boolean

component implementations may return true to indicate that the tree visit is complete (eg. all components that need to be visited have been visited). This results in the tree visit being short-circuited such that no more components are visited.

Annotations

@Override

See Also

UIComponent#visitTree