Class AbstractUISheet

java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUIData
org.apache.myfaces.tobago.internal.component.AbstractUISheet
All Implemented Interfaces:
EventListener, Visual, SheetStateChangeSource, SortActionSource
Direct Known Subclasses:
UISheet
public abstract class AbstractUISheet extends AbstractUIData implements SheetStateChangeSource, SortActionSource, Visual
SheetTagDeclaration

  • Field Details

  • Constructor Details

    • AbstractUISheet

      public AbstractUISheet()

  • Method Details

    • encodeAll

      public void encodeAll(jakarta.faces.context.FacesContext facesContext) throws IOException
      Throws:
      IOException

    • encodeBegin

      public void encodeBegin(jakarta.faces.context.FacesContext facesContext) throws IOException
      Overrides:
      encodeBegin in class AbstractUIData
      Throws:
      IOException

    • setState

      public void setState(SheetState state)

    • getState

      public SheetState getState()

    • getSheetState

      public SheetState getSheetState(jakarta.faces.context.FacesContext facesContext)

    • getColumns

      public abstract String getColumns()

    • processEvent

      public void processEvent(jakarta.faces.event.ComponentSystemEvent event) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • getColumnLayout

      public MeasureList getColumnLayout()

    • isAutoLayout

      public boolean isAutoLayout()

    • getLastRowIndexOfCurrentPage

      public int getLastRowIndexOfCurrentPage()
      The rowIndex of the last row on the current page plus one (because of zero based iterating).
      Throws:
      IllegalArgumentException - If the number of rows in the model returned by getRowCount() is -1 (undefined).

    • getCurrentPage

      public int getCurrentPage()
      Returns:
      returns the current page (based by 0).

    • getPages

      public int getPages()
      The number of pages to render.
      Throws:
      IllegalArgumentException - If the number of rows in the model returned by getRowCount() is -1 (undefined).

    • getRenderedChildrenOf

      public List<jakarta.faces.component.UIComponent> getRenderedChildrenOf(jakarta.faces.component.UIColumn column)

    • isAtBeginning

      public boolean isAtBeginning()
      Returns:
      Is the interval to display starting with the first row?

    • hasRowCount

      public boolean hasRowCount()
      Returns:
      Does the data model knows the number of rows?

    • isPagingVisible

      public boolean isPagingVisible()
      Returns:
      Should the paging controls be rendered? Either because of the need of paging or because the show is enforced by isShowPagingAlways()

    • needMoreThanOnePage

      public boolean needMoreThanOnePage()
      Returns:
      Is panging needed to display all rows? If the number of rows is unknown this method returns true.

    • isShowPagingAlways

      public abstract boolean isShowPagingAlways()

    • isAtEnd

      public boolean isAtEnd()

    • getFirstRowIndexOfLastPage

      public int getFirstRowIndexOfLastPage()
      Determines the beginning of the last page in the model. If the number of rows to display on one page is unlimited, the value is 0 (there is only one page).
      Returns:
      The index of the first row of the last paging page.
      Throws:
      IllegalArgumentException - If the number of rows in the model returned by getRowCount() is -1 (undefined).

    • processDecodes

      public void processDecodes(jakarta.faces.context.FacesContext context)

    • processValidators

      public void processValidators(jakarta.faces.context.FacesContext context)

    • processUpdates

      public void processUpdates(jakarta.faces.context.FacesContext context)

    • saveState

      public Object saveState(jakarta.faces.context.FacesContext context)

    • restoreState

      public void restoreState(jakarta.faces.context.FacesContext context, Object savedState)

    • getAllColumns

      public List<AbstractUIColumnBase> getAllColumns()

    • queueEvent

      public void queueEvent(jakarta.faces.event.FacesEvent facesEvent)

    • broadcast

      public void broadcast(jakarta.faces.event.FacesEvent facesEvent) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • visitTree

      public boolean visitTree(jakarta.faces.component.visit.VisitContext context, jakarta.faces.component.visit.VisitCallback callback)

    • isLazyUpdate

      public boolean isLazyUpdate(jakarta.faces.context.FacesContext facesContext)

    • init

      public void init(jakarta.faces.context.FacesContext facesContext)

    • sort

      protected void sort(jakarta.faces.context.FacesContext facesContext, SortActionEvent event)

    • addStateChangeListener

      public void addStateChangeListener(SheetStateChangeListener listener)
      Specified by:
      addStateChangeListener in interface SheetStateChangeSource

    • getStateChangeListeners

      public SheetStateChangeListener[] getStateChangeListeners()
      Specified by:
      getStateChangeListeners in interface SheetStateChangeSource

    • removeStateChangeListener

      public void removeStateChangeListener(SheetStateChangeListener listener)
      Specified by:
      removeStateChangeListener in interface SheetStateChangeSource

    • performPaging

      public void performPaging(PageActionEvent pageEvent)

    • getLazyUpdate

      public boolean getLazyUpdate()

    • setLazyUpdate

      public void setLazyUpdate(boolean lazyUpdate)

    • getLazyFirstRow

      public int getLazyFirstRow()

    • setLazyFirstRow

      public void setLazyFirstRow(int lazyFirstRow)

    • getLazyLastRow

      public int getLazyLastRow()

    • setLazyLastRow

      public void setLazyLastRow(int lazyLastRow)

    • createReloadBehavior

      public jakarta.faces.component.behavior.AjaxBehavior createReloadBehavior(AbstractUISheet sheet)

    • getColumnSelector

      public AbstractUIColumnSelector getColumnSelector()

    • isRendersRowContainer

      public boolean isRendersRowContainer()
      Description copied from class: AbstractUIData
      The value describes, if the UIData renderer creates container elements to hold the row information. This information is important for the TreeNodeRenderer to set the visible state in the output or not. Typically the Sheet returns true and a Tree returns false, because the sheet renders the HTML TR tags, the the sheet also is responsible for the visible state.
      Overrides:
      isRendersRowContainer in class AbstractUIData

    • isShowHeader

      public abstract boolean isShowHeader()

    • getExpandedState

      public ExpandedState getExpandedState()
      Specified by:
      getExpandedState in class AbstractUIData

    • getSelectedState

      public SelectedState getSelectedState()
      Specified by:
      getSelectedState in class AbstractUIData

    • getHeaderGrid

      public Grid getHeaderGrid()

    • setHeaderGrid

      public void setHeaderGrid(Grid headerGrid)

    • isShowDirectLinksArrows

      @Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract boolean isShowDirectLinksArrows()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isShowPageRangeArrows

      @Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract boolean isShowPageRangeArrows()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getShowRowRange

      @Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract ShowPosition getShowRowRange()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getShowPageRange

      @Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract ShowPosition getShowPageRange()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getShowDirectLinks

      @Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract ShowPosition getShowDirectLinks()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getDirectLinkCount

      @Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract Integer getDirectLinkCount()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isLazy

      public abstract boolean isLazy()

    • getMaxSortColumns

      public abstract Integer getMaxSortColumns()

    • getLazyRows

      public abstract Integer getLazyRows()

    • getPaginator

      public abstract PaginatorMode getPaginator()

    • isReadonlyRows

      public abstract boolean isReadonlyRows()

    • addClientBehavior

      void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • getClientBehaviors

      Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getDefaultEventName

      String getDefaultEventName()

    • getEventNames

      Collection<String> getEventNames()

    • setFooter

      public void setFooter(jakarta.faces.component.UIComponent arg0)

    • getFooter

      public jakarta.faces.component.UIComponent getFooter()

    • setHeader

      public void setHeader(jakarta.faces.component.UIComponent arg0)

    • getHeader

      public jakarta.faces.component.UIComponent getHeader()

    • isRowAvailable

      public boolean isRowAvailable()

    • getRowCount

      public int getRowCount()

    • getRowData

      public Object getRowData()

    • getRowIndex

      public int getRowIndex()

    • setRowIndex

      public void setRowIndex(int arg0)

    • markInitialState

      public void markInitialState()

    • setValueExpression

      public void setValueExpression(String arg0, jakarta.el.ValueExpression arg1)

    • getContainerClientId

      public String getContainerClientId(jakarta.faces.context.FacesContext arg0)

    • createUniqueId

      public String createUniqueId(jakarta.faces.context.FacesContext arg0, String arg1)

    • encodeEnd

      public void encodeEnd(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • setDataModel

      protected void setDataModel(jakarta.faces.model.DataModel arg0)

    • getValue

      public Object getValue()

    • setValue

      public void setValue(Object arg0)

    • getFirst

      public int getFirst()

    • setFirst

      public void setFirst(int arg0)

    • getRows

      public int getRows()

    • setRows

      public void setRows(int arg0)

    • getVar

      public String getVar()

    • setVar

      public void setVar(String arg0)

    • isRowStatePreserved

      public boolean isRowStatePreserved()

    • setRowStatePreserved

      public void setRowStatePreserved(boolean arg0)

    • getFamily

      public String getFamily()

    • setId

      public void setId(String arg0)

    • setParent

      public void setParent(jakarta.faces.component.UIComponent arg0)

    • addClientBehavior

      public void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • clearInitialState

      public void clearInitialState()

    • decode

      public void decode(jakarta.faces.context.FacesContext arg0)

    • encodeChildren

      public void encodeChildren(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • getAttributes

      public Map<String,Object> getAttributes()

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes(boolean arg0)

    • getChildCount

      public int getChildCount()

    • getChildren

      public List<jakarta.faces.component.UIComponent> getChildren()

    • getClientBehaviors

      public Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getClientId

      public String getClientId(jakarta.faces.context.FacesContext arg0)

    • getDefaultEventName

      public String getDefaultEventName()

    • getEventNames

      public Collection<String> getEventNames()

    • getFacet

      public jakarta.faces.component.UIComponent getFacet(String arg0)

    • getFacetCount

      public int getFacetCount()

    • getFacets

      public Map<String, jakarta.faces.component.UIComponent> getFacets()

    • getFacetsAndChildren

      public Iterator<jakarta.faces.component.UIComponent> getFacetsAndChildren()

    • getId

      public String getId()

    • getParent

      public jakarta.faces.component.UIComponent getParent()

    • getRendererType

      public String getRendererType()

    • getRendersChildren

      public boolean getRendersChildren()

    • isRendered

      public boolean isRendered()

    • isTransient

      public boolean isTransient()

    • addFacesListener

      protected void addFacesListener(jakarta.faces.event.FacesListener arg0)

    • getFacesContext

      protected jakarta.faces.context.FacesContext getFacesContext()

    • getFacesListeners

      protected jakarta.faces.event.FacesListener[] getFacesListeners(Class arg0)

    • getRenderer

      protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0)

    • removeFacesListener

      protected void removeFacesListener(jakarta.faces.event.FacesListener arg0)

    • processSaveState

      public Object processSaveState(jakarta.faces.context.FacesContext arg0)

    • processRestoreState

      public void processRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • setTransient

      public void setTransient(boolean arg0)

    • saveAttachedState

      public static Object saveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • restoreAttachedState

      public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException
      Throws:
      IllegalStateException

    • setRendered

      public void setRendered(boolean arg0)

    • setRendererType

      public void setRendererType(String arg0)

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes()

    • initialStateMarked

      public boolean initialStateMarked()

    • isCompositeComponent

      public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0)

    • isInView

      public boolean isInView()

    • isVisitable

      protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0)

    • getClientId

      public String getClientId()

    • getCompositeComponentParent

      public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0)

    • getCurrentComponent

      public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0)

    • getCurrentCompositeComponent

      public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0)

    • getListenersForEventClass

      public List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0)

    • getNamingContainer

      public jakarta.faces.component.UIComponent getNamingContainer()

    • setInView

      public void setInView(boolean arg0)

    • getResourceBundleMap

      public Map<String,String> getResourceBundleMap()

    • getValueExpression

      public jakarta.el.ValueExpression getValueExpression(String arg0)

    • subscribeToEvent

      public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • unsubscribeFromEvent

      public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper()

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0)

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper()

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0)

    • restoreTransientState

      public void restoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • saveTransientState

      public Object saveTransientState(jakarta.faces.context.FacesContext arg0)

    • popComponentFromEL

      public void popComponentFromEL(jakarta.faces.context.FacesContext arg0)

    • pushComponentToEL

      public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)