Class Paginator

java.lang.Object
com.vaadin.flow.component.Component
org.vaadin.addons.antlerflow.grid.pagination.Paginator
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable
@Tag("af-paginator") @JsModule("./antlerflow/advanced-grid/pagination/paginator.ts") public class Paginator extends com.vaadin.flow.component.Component
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Paginator.PageChangeEvent
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PAGE_CHANGE_EVENT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Paginator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addPageChangeListener(com.vaadin.flow.component.ComponentEventListener<Paginator.PageChangeEvent> listener)
     
    int
    getOffset()
     
    int
    getPage()
     
    int
    getPageSize()
     
    String
    getPageSizeOptions()
     
    long
    getTotalItems()
     
    int
    getTotalPages()
     
    void
    gotoPage(int page)
     
    void
    setEnabled(boolean enabled)
     
    void
    setHideEdges(boolean hideEdges)
     
    void
    setMaxButtons(int maxButtons)
     
    void
    setPage(int page)
     
    void
    setPageSize(int pageSize)
     
    void
    setPageSizeOptions(String pageSizeOptions)
     
    void
    setTotalItems(long totalItems)
     
    void
    setTotalPages(int totalPages)
     
    void
    showPageJump(boolean showPageJump)
     
    void
    showPageSize(boolean showPageSize)
     
    void
    showSummaryText(boolean showSummaryText)
     

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Field Details

  • Constructor Details

    • Paginator

      public Paginator()

  • Method Details

    • getPage

      @Synchronize("page-change") public int getPage()

    • setPage

      public void setPage(int page)

    • getPageSize

      @Synchronize("page-change") public int getPageSize()

    • setPageSize

      public void setPageSize(int pageSize)

    • gotoPage

      public void gotoPage(int page)

    • getPageSizeOptions

      @Synchronize("page-change") public String getPageSizeOptions()

    • setPageSizeOptions

      public void setPageSizeOptions(String pageSizeOptions)

    • getOffset

      @Synchronize("page-change") public int getOffset()

    • getTotalItems

      @Synchronize("page-change") public long getTotalItems()

    • setTotalItems

      public void setTotalItems(long totalItems)

    • getTotalPages

      @Synchronize("page-change") public int getTotalPages()

    • setTotalPages

      public void setTotalPages(int totalPages)

    • setMaxButtons

      public void setMaxButtons(int maxButtons)

    • setHideEdges

      public void setHideEdges(boolean hideEdges)

    • showPageSize

      public void showPageSize(boolean showPageSize)

    • showSummaryText

      public void showSummaryText(boolean showSummaryText)

    • showPageJump

      public void showPageJump(boolean showPageJump)

    • setEnabled

      public void setEnabled(boolean enabled)

    • addPageChangeListener

      public com.vaadin.flow.shared.Registration addPageChangeListener(com.vaadin.flow.component.ComponentEventListener<Paginator.PageChangeEvent> listener)