Class UISheet

java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUIData
org.apache.myfaces.tobago.internal.component.AbstractUISheet
org.apache.myfaces.tobago.component.UISheet
All Implemented Interfaces:
EventListener, Visual, SheetStateChangeSource, SortActionSource
@Generated("component.stg") public class UISheet extends AbstractUISheet
Render a sheet element. UIComponent class, generated from template component.stg with class SheetTagDeclaration.

  • Field Details

  • Constructor Details

    • UISheet

      public UISheet()

  • Method Details

    • getEventNames

      public Collection<String> getEventNames()

    • getDefaultEventName

      public String getDefaultEventName()

    • getFamily

      public String getFamily()

    • getShowPageRange

      @Deprecated public ShowPosition getShowPageRange()
      Deprecated.
      Flag indicating whether and where the range pages should be rendered in the sheet's footer. Rendering this range also offers the capability to enter the index displayed page directly.
      Default: right
      Allowed Values: left,center,right,none
      Specified by:
      getShowPageRange in class AbstractUISheet

    • setShowPageRange

      @Deprecated public void setShowPageRange(ShowPosition showPageRange)
      Deprecated.

    • getColumns

      public String getColumns()

      LayoutConstraints for column layout. Contains a space separated list of layout tokens '<n>fr', '<x>px', '<x>%' or 'auto', where x is a number and n is an integer.

      Specified by:
      getColumns in class AbstractUISheet

    • setColumns

      public void setColumns(String columns)

    • isLazy

      public boolean isLazy()
      Lazy loading by scroll event.
      Default: false
      Specified by:
      isLazy in class AbstractUISheet

    • setLazy

      public void setLazy(boolean lazy)

    • getSelectable

      public Selectable getSelectable()
      Indicating the selection mode of the sheet.
      Default: multi
      Allowed Values: none,single,singleOrNone,multi
      Specified by:
      getSelectable in class AbstractUIData

    • setSelectable

      public void setSelectable(Selectable selectable)

    • getShowDirectLinks

      @Deprecated public ShowPosition getShowDirectLinks()
      Deprecated.
      Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
      Default: center
      Allowed Values: left,center,right,none
      Specified by:
      getShowDirectLinks in class AbstractUISheet

    • setShowDirectLinks

      @Deprecated public void setShowDirectLinks(ShowPosition showDirectLinks)
      Deprecated.

    • getLazyRows

      public Integer getLazyRows()
      Indicate how many rows must be loaded when lazy loading is enabled and how many rows are loaded at once. Default is 50.
      Default: 50
      Specified by:
      getLazyRows in class AbstractUISheet

    • setLazyRows

      public void setLazyRows(Integer lazyRows)

    • getStateChangeListenerExpression

      public jakarta.el.MethodExpression getStateChangeListenerExpression()

    • setStateChangeListenerExpression

      public void setStateChangeListenerExpression(jakarta.el.MethodExpression stateChangeListener)

    • getPaginator

      public PaginatorMode getPaginator()
      Create paginator components automatically or do it manually.
      • custom: no paginator is created automatically, you have to do it manually. This can be done using a <tc:paginatorPanel> with e.g. a <tc:paginatorList> and/or some other paginator components.
      • auto: a appropriate paginator is used.
      • list: a <tc:paginatorList> is used.
      • page: a <tc:paginatorPage> is used.
      • row: a <tc:paginatorRow> is used.
      • useShowAttributes (default): is deprecated, use for compatibility. The used paginators are defined by the show-attributes: showDirectLinks, showPageRange, showRowRange, directLinkCount, showDirectLinksArrows, showPageRangeArrows, showPagingAlways.

      Default: useShowAttributes
      Allowed Values: auto,custom,list,page,row,useShowAttributes
      Specified by:
      getPaginator in class AbstractUISheet

    • setPaginator

      public void setPaginator(PaginatorMode paginator)

    • getMarkup

      public Markup getMarkup()

    • setMarkup

      public void setMarkup(Markup markup)

    • isShowPagingAlways

      @Deprecated public boolean isShowPagingAlways()
      Deprecated.
      Flag indicating whether or not the paging panel should be display, if it is not needed for paging.
      • showPagingAlways="false" which is the default means, that the paging footer should be displayed, only when it is needed.
        • When the rows="0" paging is not needed, so the footer will not be rendered,
        • when rows="N", N > 0 and the size of the data value is <= N paging is not needed and the footer will not be rendered,
        • in any other case the paging footer will be displayed.
      • showPagingAlways="true" means, that the paging footer should be displayed in any case.

      Default: false
      Specified by:
      isShowPagingAlways in class AbstractUISheet

    • setShowPagingAlways

      @Deprecated public void setShowPagingAlways(boolean showPagingAlways)
      Deprecated.

    • getDirectLinkCount

      @Deprecated public Integer getDirectLinkCount()
      Deprecated.
      The count of rendered direct paging links in the sheet's footer.
      Default: 9
      Specified by:
      getDirectLinkCount in class AbstractUISheet

    • setDirectLinkCount

      @Deprecated public void setDirectLinkCount(Integer directLinkCount)
      Deprecated.

    • isShowRootJunction

      public boolean isShowRootJunction()
      Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.
      Default: false
      Overrides:
      isShowRootJunction in class AbstractUIData

    • setShowRootJunction

      public void setShowRootJunction(boolean showRootJunction)

    • isShowHeader

      public boolean isShowHeader()
      Flag indicating the header should be rendered.
      Default: true
      Specified by:
      isShowHeader in class AbstractUISheet

    • setShowHeader

      public void setShowHeader(boolean showHeader)

    • isShowPageRangeArrows

      @Deprecated public boolean isShowPageRangeArrows()
      Deprecated.
      Flag indicating if paging arrows are shown near page range
      Default: true
      Specified by:
      isShowPageRangeArrows in class AbstractUISheet

    • setShowPageRangeArrows

      @Deprecated public void setShowPageRangeArrows(boolean showPageRangeArrows)
      Deprecated.

    • getSortActionListenerExpression

      public jakarta.el.MethodExpression getSortActionListenerExpression()

    • setSortActionListenerExpression

      public void setSortActionListenerExpression(jakarta.el.MethodExpression sortActionListener)

    • isShowDirectLinksArrows

      @Deprecated public boolean isShowDirectLinksArrows()
      Deprecated.
      Flag indicating if paging arrows are shown near direct links
      Default: false
      Specified by:
      isShowDirectLinksArrows in class AbstractUISheet

    • setShowDirectLinksArrows

      @Deprecated public void setShowDirectLinksArrows(boolean showDirectLinksArrows)
      Deprecated.

    • isReadonlyRows

      public boolean isReadonlyRows()
      Flag indicating that the rows of the sheet are readonly. The readonly attribute is a performance optimization hint used during {
      Default: false
      Specified by:
      isReadonlyRows in class AbstractUISheet

    • setReadonlyRows

      public void setReadonlyRows(boolean readonlyRows)

    • isShowRoot

      public boolean isShowRoot()
      Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.
      Default: false
      Specified by:
      isShowRoot in class AbstractUIData

    • setShowRoot

      public void setShowRoot(boolean showRoot)

    • getShowRowRange

      @Deprecated public ShowPosition getShowRowRange()
      Deprecated.
      Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index of the start row directly.
      Default: left
      Allowed Values: left,center,right,none
      Specified by:
      getShowRowRange in class AbstractUISheet

    • setShowRowRange

      @Deprecated public void setShowRowRange(ShowPosition showRowRange)
      Deprecated.

    • getMaxSortColumns

      public Integer getMaxSortColumns()
      The maximum count of multi-sorted columns to indicate.
      Default: 0
      Specified by:
      getMaxSortColumns in class AbstractUISheet

    • setMaxSortColumns

      public void setMaxSortColumns(Integer maxSortColumns)

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

    • restoreState

      public void restoreState(jakarta.faces.context.FacesContext context, Object state)
      Overrides:
      restoreState in class AbstractUISheet

    • addClientBehavior

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

    • getClientBehaviors

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

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

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

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