Package org.apache.myfaces.tobago.component

Class UITab

  • All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportsAccessKey, Visual
    @Generated("component.stg")
public class UITab
extends AbstractUITab
    Renders a tab within a tab group. UIComponent class, generated from template component.stg with class TabTagDeclaration.

    • 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
      UITab()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Character getAccessKey()
      The access key of this control.
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getDefaultEventName()  
      Collection<String> getEventNames()  
      String getFamily()  
      String getImage()
      Url to an image to display.
      String getLabel()
      A localized user presentable label for this component.
      Markup getMarkup()  
      String getTip()
      Text value to display as tooltip.
      boolean isDisabled()
      Flag indicating that this element is disabled.
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setAccessKey​(Character accessKey)  
      void setCustomClass​(CustomClass customClass)  
      void setDisabled​(boolean disabled)  
      void setImage​(String image)  
      void setLabel​(String label)  
      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, 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

    • Constructor Detail

      • UITab

        public UITab()

    • 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.UIPanel

      • setImage

        public void setImage​(String image)

      • getMarkup

        public Markup getMarkup()

      • setMarkup

        public void setMarkup​(Markup markup)

      • getAccessKey

        public Character getAccessKey()
        The access key of this control.

      • setAccessKey

        public void setAccessKey​(Character accessKey)

      • 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)

      • setTip

        public void setTip​(String tip)

      • isDisabled

        public boolean isDisabled()
        Flag indicating that this element is disabled.
        Default: false
        Specified by:
        isDisabled in class AbstractUITab

      • setDisabled

        public void setDisabled​(boolean disabled)

      • setLabel

        public void setLabel​(String label)

      • 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