Package com.kamikazejam.kamicommon.menu.api.struct.paginated.layout

Interface PaginationLayout

All Known Implementing Classes:
GridPaginationLayout, SimplePaginationLayout
public interface PaginationLayout
Represents the layout of a PaginatedMenu

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull PaginationLayout
    copy()
     
    @NotNull IconSlot
    getNextIconSlot(@NotNull MenuSize size)
    Get the slot that the next icon (if needed) will be placed into.
    If this slot is invalid (outside the menu), the icon will not be placed.
    @NotNull IconSlot
    getPrevIconSlot(@NotNull MenuSize size)
    Get the slot that the previous icon (if needed) will be placed into.
    If this slot is invalid (outside the menu), the icon will not be placed.
    @NotNull Collection<Integer>
    getSlots(@NotNull MenuSize size)
    Get the slots of the menu that are used for the pages.

  • Method Details

    • getSlots

      @NotNull @NotNull Collection<Integer> getSlots(@NotNull @NotNull MenuSize size)
      Get the slots of the menu that are used for the pages. Will use the ordering of the collection to place slots.
      Any slots that do not fall within the confines of the menu will be ignored.
      Parameters:
      size - The MenuSize for generating an appropriate range of slots.
      Returns:
      The slots of the menu to place page items into.

    • getPrevIconSlot

      @NotNull @NotNull IconSlot getPrevIconSlot(@NotNull @NotNull MenuSize size)
      Get the slot that the previous icon (if needed) will be placed into.
      If this slot is invalid (outside the menu), the icon will not be placed.

    • getNextIconSlot

      @NotNull @NotNull IconSlot getNextIconSlot(@NotNull @NotNull MenuSize size)
      Get the slot that the next icon (if needed) will be placed into.
      If this slot is invalid (outside the menu), the icon will not be placed.

    • copy

      @NotNull @NotNull PaginationLayout copy()