Class Pagination

java.lang.Object
org.patternfly.component.BaseComponent<elemental2.dom.HTMLElement, Pagination>
org.patternfly.component.pagination.Pagination
All Implemented Interfaces:
ElementAttributeMethods<elemental2.dom.HTMLElement, Pagination>, ElementClassListMethods<elemental2.dom.HTMLElement, Pagination>, ElementConsumerMethods<elemental2.dom.HTMLElement, Pagination>, ElementContainerMethods<elemental2.dom.HTMLElement, Pagination>, ElementEventMethods<elemental2.dom.HTMLElement, Pagination>, ElementIdMethods<elemental2.dom.HTMLElement, Pagination>, ElementQueryMethods<elemental2.dom.HTMLElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, Pagination>, HTMLElementDataMethods<elemental2.dom.HTMLElement, Pagination>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, Pagination>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, Pagination>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, Pagination>, Component, OuiaSupport<elemental2.dom.HTMLElement, Pagination>, Modifiers.Compact<elemental2.dom.HTMLElement, Pagination>, Modifiers.Disabled<elemental2.dom.HTMLElement, Pagination>, Modifiers.PageInsets<elemental2.dom.HTMLElement, Pagination>, Modifiers.Static<elemental2.dom.HTMLElement, Pagination>, Modifiers.Sticky<elemental2.dom.HTMLElement, Pagination>

public class Pagination extends BaseComponent<elemental2.dom.HTMLElement, Pagination> implements Modifiers.Compact<elemental2.dom.HTMLElement, Pagination>, Modifiers.Disabled<elemental2.dom.HTMLElement, Pagination>, Modifiers.PageInsets<elemental2.dom.HTMLElement, Pagination>, Modifiers.Static<elemental2.dom.HTMLElement, Pagination>, Modifiers.Sticky<elemental2.dom.HTMLElement, Pagination>
A pagination component allows users to navigate through large content views that have been split across multiple pages.
See Also:
  • Method Details

    • pagination

      public static Pagination pagination()
      Creates a pagination with an indeterminate total (unknown number of items).
    • pagination

      public static Pagination pagination(PageInfo pageInfo)
      Creates a pagination with the given page info.
    • bottom

      public Pagination bottom()
      Same as bottom(true)
    • bottom

      public Pagination bottom(boolean bottom)
      Adds/removes modifier(bottom). Bottom variant hides the range info text.
    • chars

      public Pagination chars(int chars)
      Sets the width of the page number input field in characters.
    • disabled

      public Pagination disabled(boolean disabled)
      Description copied from interface: Modifiers.Disabled
      Adds/removes modifier(disabled)
      Specified by:
      disabled in interface Modifiers.Disabled<elemental2.dom.HTMLElement, Pagination>
    • display

      public Pagination display(Display display)
      Same as display(breakpoints(default_, display))
    • display

      public Pagination display(Breakpoints<Display> display)
      Controls which pagination elements are visible at various breakpoints.
    • inset

      public Pagination inset(Inset inset)
      Same as inset(breakpoints(default_, inset))
    • inset

      public Pagination inset(Breakpoints<Inset> inset)
      Insets at various breakpoints.
    • stickyBase

      public Pagination stickyBase()
    • stickyBase

      public Pagination stickyBase(boolean stickyBase)
      Flag indicating the pagination should have sticky positioning relative to its container.
    • stickyStuck

      public Pagination stickyStuck()
    • stickyStuck

      public Pagination stickyStuck(boolean stickyStuck)
      Flag indicating the pagination should have stuck styling, when the pagination is not at the top (for top variant) or bottom (for bottom variant) of the scroll container.
    • that

      public Pagination that()
      Specified by:
      that in interface TypedBuilder<elemental2.dom.HTMLElement, Pagination>
    • onFirst

      public Pagination onFirst(PaginationHandler handler)
      Registers a handler called when the user navigates to the first page.
    • onPrevious

      public Pagination onPrevious(PaginationHandler handler)
      Registers a handler called when the user navigates to the previous page.
    • onNext

      public Pagination onNext(PaginationHandler handler)
      Registers a handler called when the user navigates to the next page.
    • onLast

      public Pagination onLast(PaginationHandler handler)
      Registers a handler called when the user navigates to the last page.
    • onPageSize

      public Pagination onPageSize(PaginationHandler handler)
      Registers a handler called when the user changes the page size.
    • onPageInput

      public Pagination onPageInput(PaginationHandler handler)
      Registers a handler called when the user enters a page number in the input field.
    • onChange

      public Pagination onChange(PaginationHandler handler)
      Registers a handler called when the user changes anything related to pagination (combines all other handlers).
    • isDisabled

      public boolean isDisabled()
      Specified by:
      isDisabled in interface Modifiers.Disabled<elemental2.dom.HTMLElement, Pagination>
    • pageInfo

      public void pageInfo(PageInfo pageInfo)
      Updates the pagination state and refreshes all UI elements (range text, button states, page input).
    • pageInfo

      public PageInfo pageInfo()
      Returns the current pagination state, including the current page, page size, and total item count.
      Returns:
      the current page information