Package space.maxus.flare.ui.page

Interface PaginationProxy

All Known Implementing Classes:
PaginatedFrame, ParamPaginatedFrame
public interface PaginationProxy
A proxy interface for better accessibility.
See Also:

  • Method Details

    • getPagination

      Pagination<Consumer<PageFrame>> getPagination()
      Gets the pagination of this structure
      Returns:
      Pagination suitable for PageFrame creation

    • createPage

      default void createPage(Consumer<PageFrame> configurator)
      Creates a page with the provided configurator function
      Parameters:
      configurator - The configurator function

    • createPage

      default void createPage(String title, Consumer<PageFrame> configurator)
      Creates a page with the provided configurator function and title
      Parameters:
      configurator - The configurator function
      title - Title of the page

    • switchPage

      default void switchPage(org.bukkit.entity.Player viewer, int to)
      Switches page for viewer to certain index
      Parameters:
      viewer - Viewer of this pagination
      to - Zero-based index of page to change to

    • nextPage

      default void nextPage(org.bukkit.entity.Player viewer)
      Switches to the next page for the viewer
      Parameters:
      viewer - Viewer observing this pagination

    • previousPage

      default void previousPage(org.bukkit.entity.Player viewer)
      Switches to the previous page for the viewer
      Parameters:
      viewer - Viewer observing this pagination

    • useTabulation

      default void useTabulation(ComposableSpace space)
      Configures a Tabulation inside all page frames
      Parameters:
      space - Space reserved for the tabulation

    • useTabulation

      default void useTabulation(ComposableSpace space, @NotNull @NotNull Callable<Tabulation> tabulation)
      Configures a Tabulation inside all page frames
      Parameters:
      space - Space reserved for the tabulation
      tabulation - Producer of the tabulation

    • usePaginationDisplay

      default void usePaginationDisplay(ComposableSpace space)
      Configures a PaginationDisplay inside all page frames
      Parameters:
      space - Space reserved for the pagination display

    • usePaginationDisplay

      default void usePaginationDisplay(ComposableSpace space, @NotNull @NotNull Callable<PaginationDisplay> paginationDisplay)
      Configures a PaginationDisplay inside all page frames
      Parameters:
      space - Space reserved for the pagination display
      paginationDisplay - Producer of the pagination display