Class UIForm

All Implemented Interfaces:
NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener
Direct Known Subclasses:
HtmlForm

@JSFComponent(type="jakarta.faces.Form", family="jakarta.faces.Form") public class UIForm extends UIComponentBase implements NamingContainer, UniqueIdVendor
see Javadoc of Faces Specification
  • Field Details

  • Constructor Details

    • UIForm

      public UIForm()
  • Method Details

    • createUniqueId

      public String createUniqueId(FacesContext context, String seed)
      Specified by:
      createUniqueId in interface UniqueIdVendor
      Since:
      2.0
    • isSubmitted

      public boolean isSubmitted()
    • setSubmitted

      public void setSubmitted(boolean submitted)
    • processDecodes

      public void processDecodes(FacesContext context)
      Overrides:
      processDecodes in class UIComponentBase
    • processValidators

      public void processValidators(FacesContext context)
      Overrides:
      processValidators in class UIComponentBase
    • processUpdates

      public void processUpdates(FacesContext context)
      Description copied from class: UIComponentBase
      This isn't an input component, so just pass on the processUpdates call to child components and facets that might be input components.

      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.

      Overrides:
      processUpdates in class UIComponentBase
    • invokeOnComponent

      public boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException
      Description copied from class: UIComponentBase
      invokeOnComponent must be implemented in UIComponentBase too...
      Overrides:
      invokeOnComponent in class UIComponentBase
      Parameters:
      context - FacesContext for the current request
      clientId - the id of the desired UIComponent clazz
      callback - Implementation of the ContextCallback to be called
      Returns:
      has component been found ?
      Throws:
      FacesException
    • visitTree

      public boolean visitTree(VisitContext context, VisitCallback callback)
      Description copied from class: UIComponent
      The visit tree method, visit tree walks over a subtree and processes the callback object to perform some operation on the subtree

      there are some details in the implementation which according to the spec have to be in place: a) before calling the callback and traversing into the subtree pushComponentToEL has to be called b) after the processing popComponentFromEL has to be performed to remove the component from the el

      The tree traversal optimizations are located in the visit context and can be replaced via the VisitContextFactory in the faces-config factory section

      Overrides:
      visitTree in class UIComponentBase
      Parameters:
      context - the visit context which handles the processing details
      callback - the callback to be performed
      Returns:
      false if the processing is not done true if we can shortcut the visiting because we are done with everything
    • getFamily

      public String getFamily()
      Specified by:
      getFamily in class UIComponent
    • getContainerClientId

      public String getContainerClientId(FacesContext ctx)
      Overrides:
      getContainerClientId in class UIComponent
    • isPrependId

      @JSFProperty(defaultValue="true") public boolean isPrependId()
    • setPrependId

      public void setPrependId(boolean prependId)