Class UISheet

  • All Implemented Interfaces:
    jakarta.faces.component.behavior.ClientBehaviorHolder, jakarta.faces.component.NamingContainer, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.UniqueIdVendor, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, 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.
    • Constructor Detail

      • UISheet

        public UISheet()
    • Method Detail

      • getEventNames

        public Collection<String> getEventNames()
        Specified by:
        getEventNames in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getEventNames in class jakarta.faces.component.UIComponentBase
      • getDefaultEventName

        public String getDefaultEventName()
        Specified by:
        getDefaultEventName in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getDefaultEventName in class jakarta.faces.component.UIComponentBase
      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class jakarta.faces.component.UIData
      • getMarkup

        public Markup getMarkup()
      • setMarkup

        public void setMarkup​(Markup markup)
      • getShowPageRange

        public ShowPosition getShowPageRange()
        Flag indicating whether and where the range pages should 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

        public void setShowPageRange​(ShowPosition showPageRange)
      • isShowPagingAlways

        public boolean isShowPagingAlways()
        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

        public void setShowPagingAlways​(boolean showPagingAlways)
      • getDirectLinkCount

        public Integer getDirectLinkCount()
        The count of rendered direct paging links in the sheet's footer.

        Default: 9
      • setDirectLinkCount

        public void setDirectLinkCount​(Integer directLinkCount)
      • 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)
      • 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)
      • 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)
      • isLazy

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

        public void setLazy​(boolean lazy)
      • isShowPageRangeArrows

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

        public void setShowPageRangeArrows​(boolean showPageRangeArrows)
      • 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)
      • getSortActionListenerExpression

        public jakarta.el.MethodExpression getSortActionListenerExpression()
      • setSortActionListenerExpression

        public void setSortActionListenerExpression​(jakarta.el.MethodExpression sortActionListener)
      • getShowDirectLinks

        public ShowPosition getShowDirectLinks()
        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

        public void setShowDirectLinks​(ShowPosition showDirectLinks)
      • isShowDirectLinksArrows

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

        public void setShowDirectLinksArrows​(boolean showDirectLinksArrows)
      • 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

        public ShowPosition getShowRowRange()
        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

        public void setShowRowRange​(ShowPosition showRowRange)
      • setMaxSortColumns

        public void setMaxSortColumns​(Integer maxSortColumns)
      • getLazyRows

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

        public void setLazyRows​(Integer lazyRows)
      • 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)
      • getStateChangeListenerExpression

        public jakarta.el.MethodExpression getStateChangeListenerExpression()
      • setStateChangeListenerExpression

        public void setStateChangeListenerExpression​(jakarta.el.MethodExpression stateChangeListener)
      • restoreState

        public void restoreState​(jakarta.faces.context.FacesContext context,
                                 Object state)
        Specified by:
        restoreState in interface jakarta.faces.component.StateHolder
        Overrides:
        restoreState in class AbstractUISheet