Package org.primefaces.component.api

Class UITabPanel

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIPanel
org.primefaces.component.api.UITabPanel
All Implemented Interfaces:
EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
Direct Known Subclasses:
AccordionPanelBase, CarouselBase, GalleriaBase, TabViewBase
public class UITabPanel extends javax.faces.component.UIPanel implements javax.faces.component.NamingContainer
UITabPanel is a specialized version of UIRepeat focusing on components that repeat tabs like tabView and accordionPanel. Most of the code is copied from MyFaces.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    UITabPanel.PropertyKeys
     

  • Field Summary

    Fields inherited from class javax.faces.component.UIPanel

    COMPONENT_FAMILY, COMPONENT_TYPE

    Fields inherited from class javax.faces.component.UIComponent

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

    Fields inherited from interface javax.faces.component.NamingContainer

    SEPARATOR_CHAR

  • Constructor Summary

    Constructors
    Constructor
    Description
    UITabPanel()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    broadcast(javax.faces.event.FacesEvent event)
     
    void
    encodeBegin(javax.faces.context.FacesContext context)
     
    void
    encodeChildren(javax.faces.context.FacesContext faces)
     
    void
    forEachTab(ConsumerTwo<Tab,Integer> callback)
     
    void
    forEachTab(ConsumerTwo<Tab,Integer> callback, boolean skipUnrendered)
     
    String
    getContainerClientId(javax.faces.context.FacesContext context)
     
    protected javax.faces.model.DataModel<?>
    getDataModel()
     
    Tab
    getDynamicTab()
     
    int
    getIndex()
    Returns the current index.
    Object
    getIndexData()
    Returns the rowCount of the underlying DataModel.
    int
    getOffset()
     
    boolean
    getRendersChildren()
     
    int
    getRowCount()
    Returns the rowCount of the underlying DataModel.
    int
    getSize()
     
    int
    getStep()
     
    Object
    getValue()
     
    String
    getVar()
     
    String
    getVarStatus()
     
    boolean
    invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
     
    boolean
    isDynamic()
     
    boolean
    isPrependId()
     
    boolean
    isRepeating()
     
    void
    process(javax.faces.context.FacesContext faces, javax.faces.event.PhaseId phase)
     
    void
    processDecodes(javax.faces.context.FacesContext context)
     
    void
    processUpdates(javax.faces.context.FacesContext context)
     
    void
    processValidators(javax.faces.context.FacesContext context)
     
    void
    queueEvent(javax.faces.event.FacesEvent event)
     
    void
    resetLoadedTabsState()
     
    Object
    saveState(javax.faces.context.FacesContext context)
     
    void
    setDynamic(boolean _dynamic)
     
    void
    setIndex(int index)
     
    void
    setOffset(int offset)
     
    void
    setPrependId(boolean _prependId)
     
    void
    setSize(int size)
     
    void
    setStep(int step)
     
    void
    setValue(Object value)
     
    void
    setValueExpression(String name, javax.el.ValueExpression binding)
     
    void
    setVar(String var)
     
    void
    setVarStatus(String varStatus)
     
    protected boolean
    shouldSkipChildren(javax.faces.context.FacesContext context)
     
    boolean
    visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
     

    Methods inherited from class javax.faces.component.UIPanel

    getFamily

    Methods inherited from class javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, clearInitialState, decode, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

    Methods inherited from class javax.faces.component.UIComponent

    encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • UITabPanel

      public UITabPanel()

  • Method Details

    • getOffset

      public int getOffset()

    • setOffset

      public void setOffset(int offset)

    • getSize

      public int getSize()

    • setSize

      public void setSize(int size)

    • getStep

      public int getStep()

    • setStep

      public void setStep(int step)

    • getVar

      public String getVar()

    • setVar

      public void setVar(String var)

    • getVarStatus

      public String getVarStatus()

    • setVarStatus

      public void setVarStatus(String varStatus)

    • isDynamic

      public boolean isDynamic()

    • setDynamic

      public void setDynamic(boolean _dynamic)

    • isPrependId

      public boolean isPrependId()

    • setPrependId

      public void setPrependId(boolean _prependId)

    • getDataModel

      protected javax.faces.model.DataModel<?> getDataModel()

    • setValueExpression

      public void setValueExpression(String name, javax.el.ValueExpression binding)
      Overrides:
      setValueExpression in class javax.faces.component.UIComponent

    • getValue

      public Object getValue()

    • setValue

      public void setValue(Object value)

    • getContainerClientId

      public String getContainerClientId(javax.faces.context.FacesContext context)
      Overrides:
      getContainerClientId in class javax.faces.component.UIComponent

    • getRowCount

      public int getRowCount()
      Returns the rowCount of the underlying DataModel.
      Returns:

    • getIndexData

      public Object getIndexData()
      Returns the rowCount of the underlying DataModel.
      Returns:

    • getIndex

      public int getIndex()
      Returns the current index.

    • setIndex

      public void setIndex(int index)

    • process

      public void process(javax.faces.context.FacesContext faces, javax.faces.event.PhaseId phase)

    • invokeOnComponent

      public boolean invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
      Overrides:
      invokeOnComponent in class javax.faces.component.UIComponentBase
      Throws:
      javax.faces.FacesException

    • visitTree

      public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
      Overrides:
      visitTree in class javax.faces.component.UIComponent

    • processDecodes

      public void processDecodes(javax.faces.context.FacesContext context)
      Overrides:
      processDecodes in class javax.faces.component.UIComponentBase

    • processValidators

      public void processValidators(javax.faces.context.FacesContext context)
      Overrides:
      processValidators in class javax.faces.component.UIComponentBase

    • processUpdates

      public void processUpdates(javax.faces.context.FacesContext context)
      Overrides:
      processUpdates in class javax.faces.component.UIComponentBase

    • broadcast

      public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
      Overrides:
      broadcast in class javax.faces.component.UIComponentBase
      Throws:
      javax.faces.event.AbortProcessingException

    • queueEvent

      public void queueEvent(javax.faces.event.FacesEvent event)
      Overrides:
      queueEvent in class javax.faces.component.UIComponentBase

    • saveState

      public Object saveState(javax.faces.context.FacesContext context)
      Specified by:
      saveState in interface javax.faces.component.StateHolder
      Overrides:
      saveState in class javax.faces.component.UIComponentBase

    • encodeBegin

      public void encodeBegin(javax.faces.context.FacesContext context) throws IOException
      Overrides:
      encodeBegin in class javax.faces.component.UIComponentBase
      Throws:
      IOException

    • encodeChildren

      public void encodeChildren(javax.faces.context.FacesContext faces) throws IOException
      Overrides:
      encodeChildren in class javax.faces.component.UIComponentBase
      Throws:
      IOException

    • getRendersChildren

      public boolean getRendersChildren()
      Overrides:
      getRendersChildren in class javax.faces.component.UIComponentBase

    • isRepeating

      public boolean isRepeating()

    • resetLoadedTabsState

      public void resetLoadedTabsState()

    • shouldSkipChildren

      protected boolean shouldSkipChildren(javax.faces.context.FacesContext context)

    • forEachTab

      public void forEachTab(ConsumerTwo<Tab,Integer> callback)

    • forEachTab

      public void forEachTab(ConsumerTwo<Tab,Integer> callback, boolean skipUnrendered)

    • getDynamicTab

      public Tab getDynamicTab()