Package org.xwiki.livedata

Class LiveDataPaginationConfiguration

  • public class LiveDataPaginationConfiguration
extends Object
    Describes the live data pagination configuration.
    Since:
    12.10
    Version:
    $Id: 8c10ae64ac65f8992779f508b4dbb1ff28fd4d5a $

    • Constructor Detail

      • LiveDataPaginationConfiguration

        public LiveDataPaginationConfiguration()

    • Method Detail

      • getMaxShownPages

        public Integer getMaxShownPages()
        Returns:
        the maximum number of page links to display in the pagination

      • setMaxShownPages

        public void setMaxShownPages​(Integer maxShownPages)
        Sets the maximum number of page links to display in the pagination.
        Parameters:
        maxShownPages - the maximum number of page links to display in the pagination

      • getPageSizes

        public List<Integer> getPageSizes()
        Returns:
        the values to display in the page size drop down

      • setPageSizes

        public void setPageSizes​(List<Integer> pageSizes)
        Sets the values to display in the page size drop down that allows the user to change the page size.
        Parameters:
        pageSizes - the values to display on the page size drop down

      • getShowEntryRange

        public Boolean getShowEntryRange()
        Returns:
        whether to show or not the current entry range

      • setShowEntryRange

        public void setShowEntryRange​(Boolean showEntryRange)
        Sets whether to show or not the current entry range.
        Parameters:
        showEntryRange - true to show the current entry range, false otherwise

      • getShowNextPrevious

        public Boolean getShowNextPrevious()
        Returns:
        whether to show or not the next / previous pagination links

      • setShowNextPrevious

        public void setShowNextPrevious​(Boolean showNextPrevious)
        Sets whether to show or not the next / previous pagination links.
        Parameters:
        showNextPrevious - true to show the next / previous pagination links, false otherwise

      • getShowFirstLast

        public Boolean getShowFirstLast()
        Returns:
        whether to show or not the first / last pagination links

      • setShowFirstLast

        public void setShowFirstLast​(Boolean showFirstLast)
        Sets whether to show or not the first / last pagination links.
        Parameters:
        showFirstLast - true to show the first / last pagination links, false otherwise

      • getShowPageSizeDropdown

        public Boolean getShowPageSizeDropdown()
        Returns:
        whether to show or not the page size drop down that the user can use to change the number of entries displayed per page

      • setShowPageSizeDropdown

        public void setShowPageSizeDropdown​(Boolean showPageSizeDropdown)
        Sets whether to show or not the page size drop down that the user can use to change the number of entries displayed per page.
        Parameters:
        showPageSizeDropdown - true to show the page size drop down, false otherwise

      • initialize

        public void initialize()
        Prevent null values where it's possible.