Class UIPage

  • All Implemented Interfaces:
    jakarta.faces.component.behavior.ClientBehaviorHolder, jakarta.faces.component.NamingContainer, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.UniqueIdVendor, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, Visual

    @Generated("component.stg")
    public class UIPage
    extends AbstractUIPage

    Renders a page element.

    The markup { UIComponent class, generated from template component.stg with class PageTagDeclaration.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • Fields inherited from class jakarta.faces.component.UIComponent

        ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
      • Fields inherited from interface jakarta.faces.component.NamingContainer

        SEPARATOR_CHAR
    • Constructor Summary

      Constructors 
      Constructor Description
      UIPage()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getDefaultEventName()  
      Collection<String> getEventNames()  
      String getFamily()  
      String getFocusId()
      Contains the id of the component which should have the focus after loading the page.
      String getLabel()
      A localized user presentable label for this component.
      Markup getMarkup()  
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setFocusId​(String focusId)  
      void setLabel​(String label)  
      void setMarkup​(Markup markup)  
      • Methods inherited from class jakarta.faces.component.UIForm

        createUniqueId, getContainerClientId, invokeOnComponent, isPrependId, isSubmitted, setPrependId, visitTree
      • Methods inherited from class jakarta.faces.component.UIComponentBase

        addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient
      • Methods inherited from class jakarta.faces.component.UIComponent

        getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
      • Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors
    • Constructor Detail

      • UIPage

        public UIPage()
    • Method Detail

      • getEventNames

        public Collection<String> getEventNames()
        Specified by:
        getEventNames in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getEventNames in class jakarta.faces.component.UIComponentBase
      • getDefaultEventName

        public String getDefaultEventName()
        Specified by:
        getDefaultEventName in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getDefaultEventName in class jakarta.faces.component.UIComponentBase
      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class jakarta.faces.component.UIForm
      • getMarkup

        public Markup getMarkup()
      • setMarkup

        public void setMarkup​(Markup markup)
      • getCustomClass

        public CustomClass getCustomClass()
        Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
           <tc:in>
             <tc:style customClass="my-emphasized"/>
           </tc:in>
           
        One capability is, to used external CSS libs.
        This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
      • setCustomClass

        public void setCustomClass​(CustomClass customClass)
      • getLabel

        public String getLabel()
        A localized user presentable label for this component.
        Specified by:
        getLabel in class AbstractUIPage
      • setLabel

        public void setLabel​(String label)
      • getFocusId

        public String getFocusId()
        Contains the id of the component which should have the focus after loading the page. Set to empty string for disabling setting of focus. Default (null) enables the "auto focus" feature.
        Specified by:
        getFocusId in class AbstractUIPage
      • setFocusId

        public void setFocusId​(String focusId)
      • restoreState

        public void restoreState​(jakarta.faces.context.FacesContext context,
                                 Object state)
        Specified by:
        restoreState in interface jakarta.faces.component.StateHolder
        Overrides:
        restoreState in class jakarta.faces.component.UIComponentBase