Interface SheetTagDeclaration

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void setColumns​(String columns)
      LayoutConstraints for column layout.
      void setDirectLinkCount​(String directLinkCount)
      The count of rendered direct paging links in the sheet's footer.
      void setFirst​(String first)
      Zero-relative row number of the first row to be displayed.
      void setLazy​(String lazy)
      Lazy loading by scroll event.
      void setLazyRows​(String lazy)
      Indicate how many rows are loaded at once when lazy loading is enabled.
      void setMaxSortColumns​(String maxSortColumns)
      The maximum count of multi-sorted columns to indicate.
      void setRows​(String rows)
      The number of rows to display, starting with the one identified by the "first" property.
      void setSelectable​(String selectable)
      Indicating the selection mode of the sheet.
      void setShowDirectLinks​(String showDirectLinks)
      Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
      void setShowDirectLinksArrows​(String showDirectLinksArrows)
      Flag indicating if paging arrows are shown near direct links
      void setShowHeader​(String showHeader)
      Flag indicating the header should be rendered.
      void setShowPageRange​(String showPageRange)
      Flag indicating whether and where the range pages should rendered in the sheet's footer.
      void setShowPageRangeArrows​(String showPageRangeArrows)
      Flag indicating if paging arrows are shown near page range
      void setShowPagingAlways​(String showPagingAlways)
      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.
      void setShowRowRange​(String showRowRange)
      Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer.
      void setSortActionListener​(String sortActionListener)
      Method binding representing an actionListener method that will be invoked when sorting was requested by the user.
      void setState​(String state)
      Sheet state saving object.
      void setStateChangeListener​(String stateChangeListener)
      Method binding representing a stateChangeListener method that will be notified when the state was changed by the user.
      void setValue​(String value)
      The sheet's data.
      • Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding

        setBinding
      • Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasId

        setId
      • Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasVar

        setVar
      • Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsRendered

        setRendered
      • Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsShowRoot

        setShowRoot
    • Method Detail

      • setColumns

        void setColumns​(String columns)

        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.

      • setShowHeader

        void setShowHeader​(String showHeader)
        Flag indicating the header should be rendered.
      • setRows

        void setRows​(String rows)
        The number of rows to display, starting with the one identified by the "first" property.
        The default has been changed from 100 to 0 because this is the default in the JSF standard (since Tobago 1.5).
      • setFirst

        void setFirst​(String first)
        Zero-relative row number of the first row to be displayed.
      • setValue

        void setValue​(String value)
        The sheet's data.
      • setShowPagingAlways

        void setShowPagingAlways​(String showPagingAlways)
        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.
      • setDirectLinkCount

        void setDirectLinkCount​(String directLinkCount)
        The count of rendered direct paging links in the sheet's footer.
      • setShowDirectLinks

        void setShowDirectLinks​(String showDirectLinks)
        Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
      • setShowPageRange

        void setShowPageRange​(String showPageRange)
        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.
      • setShowRowRange

        void setShowRowRange​(String showRowRange)
        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.
      • setSelectable

        void setSelectable​(String selectable)
        Indicating the selection mode of the sheet.
      • setState

        void setState​(String state)
        Sheet state saving object.
      • setStateChangeListener

        void setStateChangeListener​(String stateChangeListener)
        Method binding representing a stateChangeListener method that will be notified when the state was changed by the user. The expression must evaluate to a public method that takes a SheetStateChangeEvent parameter, with a return type of void.
      • setSortActionListener

        void setSortActionListener​(String sortActionListener)
        Method binding representing an actionListener method that will be invoked when sorting was requested by the user. Use this if your application needs special handling for sorting columns. If this is not set and the sortable attribute column is set to true the sheet implementation will use a default sort method. The expression must evaluate to a public method which takes an ActionEvent as parameter and with a return type of void. The method will receive a SortActionEvent. The method should sort according to the sortColumnId and direction getting from the sheet's SheetState object.
      • setLazy

        void setLazy​(String lazy)
        Lazy loading by scroll event.
      • setLazyRows

        void setLazyRows​(String lazy)
        Indicate how many rows are loaded at once when lazy loading is enabled. Default is 50.
      • setShowDirectLinksArrows

        void setShowDirectLinksArrows​(String showDirectLinksArrows)
        Flag indicating if paging arrows are shown near direct links
        Since:
        2.0.0
      • setShowPageRangeArrows

        void setShowPageRangeArrows​(String showPageRangeArrows)
        Flag indicating if paging arrows are shown near page range
        Since:
        2.0.0
      • setMaxSortColumns

        void setMaxSortColumns​(String maxSortColumns)
        The maximum count of multi-sorted columns to indicate.
        Since:
        5.3.0