Package org.apache.myfaces.tobago.component

Class UIFooter

  • All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Visual
    @Generated("component.stg")
public class UIFooter
extends AbstractUIFooter
implements javax.faces.component.behavior.ClientBehaviorHolder
    Defines a footer of its parent (like page, box, ...) UIComponent class, generated from template component.stg with class FooterTagDeclaration.

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      UIFooter()  

    • 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 getFamily()  
      Markup getMarkup()  
      String getTip()
      Text value to display as tooltip.
      boolean isFixed()
      Flag indicating that this element is fixed on its position, e. g. it will not scroll with the neighbour elements.
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setFixed​(boolean fixed)  
      void setMarkup​(Markup markup)  
      void setTip​(String tip)  

      • Methods inherited from class javax.faces.component.UIComponentBase

        addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

      • Methods inherited from class javax.faces.component.UIComponent

        getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

      • Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

    • Constructor Detail

      • UIFooter

        public UIFooter()

    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.faces.component.UIPanel

      • 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.
        Specified by:
        getCustomClass in interface Visual

      • setTip

        public void setTip​(String tip)

      • isFixed

        public boolean isFixed()
        Flag indicating that this element is fixed on its position, e. g. it will not scroll with the neighbour elements.
        Default: false
        Specified by:
        isFixed in class AbstractUIFooter

      • setFixed

        public void setFixed​(boolean fixed)

      • 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