Package org.primefaces.component.api

Class UIData

  • All Implemented Interfaces:
    EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
    Direct Known Subclasses:
    ColumnsBase, DataScrollerBase, RingBase, UIPageableData
    public class UIData
extends javax.faces.component.UIData
    Enhanced version of the JSF UIData. It also contains some methods of the Mojarra impl (e.g. setRowIndexRowStatePreserved), maybe can remove it in the future.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UIData.PropertyKeys  

    • Field Summary

      • Fields inherited from class javax.faces.component.UIData

        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
      UIData()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void encodeBegin​(javax.faces.context.FacesContext context)  
      String getClientId​(javax.faces.context.FacesContext context)  
      String getContainerClientId​(javax.faces.context.FacesContext context)  
      protected javax.faces.model.DataModel getDataModel()  
      protected List<javax.faces.component.UIComponent> getIterableChildren()  
      int getRowIndex()  
      String getRowIndexVar()  
      boolean invokeOnComponent​(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)  
      boolean isLazy()  
      protected boolean isNestedWithinIterator()  
      boolean isRowStatePreserved()  
      void markInitialState()  
      protected void preDecode​(javax.faces.context.FacesContext context)  
      protected void preEncode​(javax.faces.context.FacesContext context)  
      protected void preUpdate​(javax.faces.context.FacesContext context)  
      protected void preValidate​(javax.faces.context.FacesContext context)  
      protected void process​(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId)  
      protected void processChildren​(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)  
      protected void processColumnFacets​(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)  
      void processDecodes​(javax.faces.context.FacesContext context)  
      protected void processFacets​(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)  
      protected void processPhase​(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)  
      void processUpdates​(javax.faces.context.FacesContext context)  
      void processValidators​(javax.faces.context.FacesContext context)  
      protected boolean requiresColumns()  
      protected void restoreDescendantState()  
      protected void restoreDescendantState​(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)  
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      protected void saveDescendantState()  
      protected void saveDescendantState​(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)  
      Object saveState​(javax.faces.context.FacesContext context)  
      protected void setDataModel​(javax.faces.model.DataModel dataModel)  
      void setId​(String id)  
      void setLazy​(boolean lazy)  
      void setRowIndex​(int rowIndex)  
      void setRowIndexVar​(String rowIndexVar)  
      void setRowModel​(int rowIndex)  
      void setRowStatePreserved​(boolean rowStatePreserved)  
      protected boolean shouldProcessChild​(javax.faces.context.FacesContext context, int rowIndex, javax.faces.event.PhaseId phaseId)  
      protected boolean shouldSkipChildren​(javax.faces.context.FacesContext context)  
      protected boolean shouldVisitChildren​(javax.faces.component.visit.VisitContext context, boolean visitRows)  
      protected boolean visitColumnContent​(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)  
      protected boolean visitColumnFacets​(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)  
      protected boolean visitColumnGroup​(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, ColumnGroup group)  
      protected boolean visitColumnsAndColumnFacets​(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows)  
      protected boolean visitFacets​(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows)  
      protected boolean visitRows​(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows)  
      boolean visitTree​(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)  

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

        broadcast, createUniqueId, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRows, getValue, getVar, isRowAvailable, queueEvent, setFirst, setFooter, setHeader, setRows, setValue, setValueBinding, setValueExpression, setVar

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

        addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, 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

    • Constructor Detail

      • UIData

        public UIData()

    • Method Detail

      • isLazy

        public boolean isLazy()

      • setLazy

        public void setLazy​(boolean lazy)

      • getRowIndexVar

        public String getRowIndexVar()

      • setRowIndexVar

        public void setRowIndexVar​(String rowIndexVar)

      • isRowStatePreserved

        public boolean isRowStatePreserved()
        Overrides:
        isRowStatePreserved in class javax.faces.component.UIData

      • setRowStatePreserved

        public void setRowStatePreserved​(boolean rowStatePreserved)
        Overrides:
        setRowStatePreserved in class javax.faces.component.UIData

      • processDecodes

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

      • processValidators

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

      • processUpdates

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

      • processPhase

        protected void processPhase​(javax.faces.context.FacesContext context,
                            javax.faces.event.PhaseId phaseId)

      • processFacets

        protected void processFacets​(javax.faces.context.FacesContext context,
                             javax.faces.event.PhaseId phaseId)

      • processColumnFacets

        protected void processColumnFacets​(javax.faces.context.FacesContext context,
                                   javax.faces.event.PhaseId phaseId)

      • shouldProcessChild

        protected boolean shouldProcessChild​(javax.faces.context.FacesContext context,
                                     int rowIndex,
                                     javax.faces.event.PhaseId phaseId)

      • processChildren

        protected void processChildren​(javax.faces.context.FacesContext context,
                               javax.faces.event.PhaseId phaseId)

      • process

        protected void process​(javax.faces.context.FacesContext context,
                       javax.faces.component.UIComponent component,
                       javax.faces.event.PhaseId phaseId)

      • getClientId

        public String getClientId​(javax.faces.context.FacesContext context)
        Overrides:
        getClientId in class javax.faces.component.UIData

      • getContainerClientId

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

      • setId

        public void setId​(String id)
        Overrides:
        setId in class javax.faces.component.UIComponentBase

      • setRowModel

        public void setRowModel​(int rowIndex)

      • getRowIndex

        public int getRowIndex()
        Overrides:
        getRowIndex in class javax.faces.component.UIData

      • setRowIndex

        public void setRowIndex​(int rowIndex)
        Overrides:
        setRowIndex in class javax.faces.component.UIData

      • saveDescendantState

        protected void saveDescendantState()

      • saveDescendantState

        protected void saveDescendantState​(javax.faces.component.UIComponent component,
                                   javax.faces.context.FacesContext context)

      • restoreDescendantState

        protected void restoreDescendantState()

      • restoreDescendantState

        protected void restoreDescendantState​(javax.faces.component.UIComponent component,
                                      javax.faces.context.FacesContext context)

      • getDataModel

        protected javax.faces.model.DataModel getDataModel()
        Overrides:
        getDataModel in class javax.faces.component.UIData

      • setDataModel

        protected void setDataModel​(javax.faces.model.DataModel dataModel)
        Overrides:
        setDataModel in class javax.faces.component.UIData

      • shouldSkipChildren

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

      • shouldVisitChildren

        protected boolean shouldVisitChildren​(javax.faces.component.visit.VisitContext context,
                                      boolean visitRows)

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

      • visitFacets

        protected boolean visitFacets​(javax.faces.component.visit.VisitContext context,
                              javax.faces.component.visit.VisitCallback callback,
                              boolean visitRows)

      • visitColumnsAndColumnFacets

        protected boolean visitColumnsAndColumnFacets​(javax.faces.component.visit.VisitContext context,
                                              javax.faces.component.visit.VisitCallback callback,
                                              boolean visitRows)

      • visitColumnGroup

        protected boolean visitColumnGroup​(javax.faces.component.visit.VisitContext context,
                                   javax.faces.component.visit.VisitCallback callback,
                                   ColumnGroup group)

      • visitColumnFacets

        protected boolean visitColumnFacets​(javax.faces.component.visit.VisitContext context,
                                    javax.faces.component.visit.VisitCallback callback,
                                    javax.faces.component.UIComponent component)

      • visitRows

        protected boolean visitRows​(javax.faces.component.visit.VisitContext context,
                            javax.faces.component.visit.VisitCallback callback,
                            boolean visitRows)

      • visitColumnContent

        protected boolean visitColumnContent​(javax.faces.component.visit.VisitContext context,
                                     javax.faces.component.visit.VisitCallback callback,
                                     javax.faces.component.UIComponent component)

      • requiresColumns

        protected boolean requiresColumns()

      • getIterableChildren

        protected List<javax.faces.component.UIComponent> getIterableChildren()

      • markInitialState

        public void markInitialState()
        Specified by:
        markInitialState in interface javax.faces.component.PartialStateHolder
        Overrides:
        markInitialState in class javax.faces.component.UIData

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

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

      • isNestedWithinIterator

        protected boolean isNestedWithinIterator()

      • preDecode

        protected void preDecode​(javax.faces.context.FacesContext context)

      • preValidate

        protected void preValidate​(javax.faces.context.FacesContext context)

      • preUpdate

        protected void preUpdate​(javax.faces.context.FacesContext context)

      • preEncode

        protected void preEncode​(javax.faces.context.FacesContext context)

      • encodeBegin

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