Package org.apache.myfaces.tobago.component

Class UIPage

  • All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, 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 javax.faces.component.UIComponent

        BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

      • Fields inherited from interface javax.faces.component.NamingContainer

        SEPARATOR_CHAR

    • Constructor Summary

      Constructors 
      Constructor Description
      UIPage()  

    • Constructor Detail

      • UIPage

        public UIPage()

    • Method Detail

      • getEventNames

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

      • getDefaultEventName

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

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.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)

      • getApplicationIcon

        @Deprecated
public String getApplicationIcon()
        Deprecated.
        Absolute URL to an image or image name to lookup in tobago resource path representing the application. In HTML it is used as a favicon.
        Specified by:
        getApplicationIcon in class AbstractUIPage

      • setApplicationIcon

        @Deprecated
public void setApplicationIcon​(String applicationIcon)
        Deprecated.

      • 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​(javax.faces.context.FacesContext context,
                         Object state)
        Specified by:
        restoreState in interface javax.faces.component.StateHolder
        Overrides:
        restoreState in class javax.faces.component.UIComponentBase