Class AbstractUISheet

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
org.apache.myfaces.tobago.internal.component.AbstractUISheet
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, 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, Visual, SheetStateChangeSource, SortActionSource
Direct Known Subclasses:
UISheet

public abstract class AbstractUISheet extends AbstractUIData implements SheetStateChangeSource, SortActionSource, javax.faces.component.behavior.ClientBehaviorHolder, Visual, javax.faces.event.ComponentSystemEventListener
  • Field Details

  • Constructor Details

    • AbstractUISheet

      public AbstractUISheet()
  • Method Details

    • encodeAll

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

      public void encodeBegin(javax.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(javax.faces.context.FacesContext facesContext)
    • getColumns

      public abstract String getColumns()
    • processEvent

      public void processEvent(javax.faces.event.ComponentSystemEvent event) throws javax.faces.event.AbortProcessingException
      Specified by:
      processEvent in interface javax.faces.event.ComponentSystemEventListener
      Overrides:
      processEvent in class javax.faces.component.UIComponent
      Throws:
      javax.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 UIData.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 UIData.getRowCount() is -1 (undefined).
    • getRenderedChildrenOf

      public List<javax.faces.component.UIComponent> getRenderedChildrenOf(javax.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 UIData.getRowCount() is -1 (undefined).
    • processUpdates

      public void processUpdates(javax.faces.context.FacesContext context)
      Overrides:
      processUpdates 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
    • restoreState

      public void restoreState(javax.faces.context.FacesContext context, Object savedState)
      Specified by:
      restoreState in interface javax.faces.component.StateHolder
      Overrides:
      restoreState in class javax.faces.component.UIData
    • getAllColumns

      public List<AbstractUIColumnBase> getAllColumns()
    • queueEvent

      public void queueEvent(javax.faces.event.FacesEvent facesEvent)
      Overrides:
      queueEvent in class javax.faces.component.UIData
    • broadcast

      public void broadcast(javax.faces.event.FacesEvent facesEvent) throws javax.faces.event.AbortProcessingException
      Overrides:
      broadcast in class javax.faces.component.UIData
      Throws:
      javax.faces.event.AbortProcessingException
    • init

      public void init(javax.faces.context.FacesContext facesContext)
    • sort

      protected void sort(javax.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)
    • 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

      public abstract boolean isShowDirectLinksArrows()
    • isShowPageRangeArrows

      public abstract boolean isShowPageRangeArrows()
    • getShowRowRange

      public abstract ShowPosition getShowRowRange()
    • getShowPageRange

      public abstract ShowPosition getShowPageRange()
    • getShowDirectLinks

      public abstract ShowPosition getShowDirectLinks()
    • isLazy

      public abstract boolean isLazy()
    • getMaxSortColumns

      public abstract Integer getMaxSortColumns()