Klasse UISheet

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
Alle implementierten Schnittstellen:
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

@Generated("component.stg") public class UISheet extends AbstractUISheet
Render a sheet element. UIComponent class, generated from template component.stg with class SheetTagDeclaration.
  • Felddetails

    • COMPONENT_TYPE

      public static final String COMPONENT_TYPE
    • COMPONENT_FAMILY

      public static final String COMPONENT_FAMILY
      Siehe auch:
  • Konstruktordetails

    • UISheet

      public UISheet()
  • Methodendetails

    • getEventNames

      public Collection<String> getEventNames()
      Angegeben von:
      getEventNames in Schnittstelle javax.faces.component.behavior.ClientBehaviorHolder
      Setzt außer Kraft:
      getEventNames in Klasse javax.faces.component.UIComponentBase
    • getDefaultEventName

      public String getDefaultEventName()
      Angegeben von:
      getDefaultEventName in Schnittstelle javax.faces.component.behavior.ClientBehaviorHolder
      Setzt außer Kraft:
      getDefaultEventName in Klasse javax.faces.component.UIComponentBase
    • getFamily

      public String getFamily()
      Setzt außer Kraft:
      getFamily in Klasse javax.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
      Angegeben von:
      getShowPageRange in Klasse 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
      Angegeben von:
      isShowPagingAlways in Klasse 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
      Setzt außer Kraft:
      isShowRootJunction in Klasse 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.

      Angegeben von:
      getColumns in Klasse AbstractUISheet
    • setColumns

      public void setColumns(String columns)
    • isShowHeader

      public boolean isShowHeader()
      Flag indicating the header should be rendered.
      Default: true
      Angegeben von:
      isShowHeader in Klasse AbstractUISheet
    • setShowHeader

      public void setShowHeader(boolean showHeader)
    • isLazy

      public boolean isLazy()
      Lazy loading by scroll event.
      Default: false
      Angegeben von:
      isLazy in Klasse AbstractUISheet
    • setLazy

      public void setLazy(boolean lazy)
    • isShowPageRangeArrows

      public boolean isShowPageRangeArrows()
      Flag indicating if paging arrows are shown near page range
      Default: true
      Angegeben von:
      isShowPageRangeArrows in Klasse 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
      Angegeben von:
      getSelectable in Klasse AbstractUIData
    • setSelectable

      public void setSelectable(Selectable selectable)
    • getSortActionListenerExpression

      public javax.el.MethodExpression getSortActionListenerExpression()
    • setSortActionListenerExpression

      public void setSortActionListenerExpression(javax.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
      Angegeben von:
      getShowDirectLinks in Klasse AbstractUISheet
    • setShowDirectLinks

      public void setShowDirectLinks(ShowPosition showDirectLinks)
    • isShowDirectLinksArrows

      public boolean isShowDirectLinksArrows()
      Flag indicating if paging arrows are shown near direct links
      Default: false
      Angegeben von:
      isShowDirectLinksArrows in Klasse 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
      Angegeben von:
      isShowRoot in Klasse 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
      Angegeben von:
      getShowRowRange in Klasse AbstractUISheet
    • setShowRowRange

      public void setShowRowRange(ShowPosition showRowRange)
    • getMaxSortColumns

      public Integer getMaxSortColumns()
      The maximum count of multi-sorted columns to indicate.
      Default: 0
      Angegeben von:
      getMaxSortColumns in Klasse AbstractUISheet
    • 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
      Angegeben von:
      getLazyRows in Klasse 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 javax.el.MethodExpression getStateChangeListenerExpression()
    • setStateChangeListenerExpression

      public void setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener)
    • restoreState

      public void restoreState(javax.faces.context.FacesContext context, Object state)
      Angegeben von:
      restoreState in Schnittstelle javax.faces.component.StateHolder
      Setzt außer Kraft:
      restoreState in Klasse AbstractUISheet