Package me.bimmr.bimmcore.gui.inventory

Class Menu

  • public class Menu
extends java.lang.Object
    A Utilities class for creating a Inventory GUI

    • Field Detail

      • MAXITEMSPERPAGE

        public static final int MAXITEMSPERPAGE
        The constant MAXITEMSPERPAGE.
        See Also:
        Constant Field Values

      • MAXITEMSPERPAGEBORDERED

        public static final int MAXITEMSPERPAGEBORDERED
        The constant MAXITEMSPERPAGEBORDERED.
        See Also:
        Constant Field Values

      • PREVIOUSPAGEITEM

        public static org.bukkit.inventory.ItemStack PREVIOUSPAGEITEM
        The constant PREVIOUSPAGEITEM.

      • NEXTPAGEITEM

        public static org.bukkit.inventory.ItemStack NEXTPAGEITEM
        The constant NEXTPAGEITEM.

    • Constructor Detail

      • Menu

        public Menu​(java.lang.String name)
        Create a MenuGUI Size is automatic, ClickEvent is null, No borders, No corners
        Parameters:
        name - The menu's name

      • Menu

        public Menu​(java.lang.String name,
            int size)
        Create a MenuGUI ClickEvent is null, No borders, No corners
        Parameters:
        name - The menu's name
        size - The menu's size (-1 will make it automatic)

      • Menu

        public Menu​(java.lang.String name,
            ClickEvent clickEvent)
        Create a MenuGUI Size is automatic, No borders, No corners
        Parameters:
        name - The menu's name
        clickEvent - The ClickEvent

      • Menu

        public Menu​(java.lang.String name,
            int size,
            ClickEvent clickEvent)
        Create a MenuGUI No borders, No corners
        Parameters:
        name - The menu's name
        size - The Size
        clickEvent - The ClickEvent

      • Menu

        public Menu​(java.lang.String name,
            org.bukkit.inventory.ItemStack borderCorners,
            org.bukkit.inventory.ItemStack borderSides)
        Create a MenuGUI Size is automatic, ClickEvent is null
        Parameters:
        name - The menu's name
        borderCorners - The ItemStack for the corners
        borderSides - The ItemStack for the borders

      • Menu

        public Menu​(java.lang.String name,
            int size,
            org.bukkit.inventory.ItemStack borderCorners,
            org.bukkit.inventory.ItemStack borderSides)
        Create a MenuGUI ClickEvent is null
        Parameters:
        name - The menu's name
        size - The menu's size (-1 will make it automatic)
        borderCorners - The ItemStack for the corners
        borderSides - The ItemStack for the borders

      • Menu

        public Menu​(java.lang.String name,
            ClickEvent clickEvent,
            org.bukkit.inventory.ItemStack borderCorners,
            org.bukkit.inventory.ItemStack borderSides)
        Create a MenuGUI Size is automatic
        Parameters:
        name - The menu's name
        clickEvent - The ClickEvent
        borderCorners - The ItemStack for the corners
        borderSides - The ItemStack for the borders

      • Menu

        public Menu​(java.lang.String name,
            int size,
            ClickEvent clickEvent,
            org.bukkit.inventory.ItemStack borderCorners,
            org.bukkit.inventory.ItemStack borderSides)
        Create a MenuGUI
        Parameters:
        name - The menu's name
        size - The menu's size (-1 will make it automatic)
        clickEvent - The ClickEvent
        borderCorners - The ItemStack for the corners
        borderSides - The ItemStack for the borders

    • Method Detail

      • willClose

        public boolean willClose()

      • setCloseOnClick

        @Deprecated
public void setCloseOnClick​(boolean close)
        Deprecated.

      • setClose

        public Menu setClose​(boolean close)

      • willDestroy

        public boolean willDestroy()

      • setDestroyOnClick

        @Deprecated
public void setDestroyOnClick​(boolean destroy)
        Deprecated.

      • setDestroy

        public Menu setDestroy​(boolean destroy)

      • getName

        public java.lang.String getName()
        Gets name.
        Returns:
        Get The MenuGUI's name

      • setName

        public Menu setName​(java.lang.String name)
        Set the MenuGUI's name
        Parameters:
        name - The Menu's name
        Returns:
        The MenuGUI

      • getBorderCorners

        public org.bukkit.inventory.ItemStack getBorderCorners()
        Gets border corners.
        Returns:
        Get the border corner ItemStack

      • setBorderCorners

        public Menu setBorderCorners​(org.bukkit.inventory.ItemStack borderCorners)
        Set the border corner's ItemStack
        Parameters:
        borderCorners - The ItemStack for the border corners
        Returns:
        The MenuGUI

      • clear

        public void clear()

      • getPlayerPage

        public java.util.HashMap<java.lang.String,​java.lang.Integer> getPlayerPage()
        Gets player page.
        Returns:
        Get the HashMap of page's each player is on

      • getPages

        public java.util.ArrayList<java.util.ArrayList<org.bukkit.inventory.ItemStack>> getPages()
        Gets pages.
        Returns:
        Get the Pages for the MenuGUI

      • getInventories

        public java.util.ArrayList<org.bukkit.inventory.Inventory> getInventories()
        Gets inventories.
        Returns:
        Get The Inventory's in the MenuGUI

      • getBorderSides

        public org.bukkit.inventory.ItemStack getBorderSides()
        Gets border sides.
        Returns:
        Get the border's ItemStack

      • setBorderSides

        public Menu setBorderSides​(org.bukkit.inventory.ItemStack borderSides)
        Set the border's ItemStack
        Parameters:
        borderSides - The ItemStack to set as the border
        Returns:
        The MenuGUI

      • border

        public Menu border​(org.bukkit.inventory.ItemStack borderCorners,
                   org.bukkit.inventory.ItemStack borderSides)
        Border the MenuGUI
        Parameters:
        borderCorners - The corner's ItemStack
        borderSides - The side's ItemStack
        Returns:
        The MenuGUI

      • setCentered

        public Menu setCentered​(boolean centered)
        Set the MenuGUI's centered value
        Parameters:
        centered - If the MenuGUI is centered
        Returns:
        The MenuGUI

      • addItem

        public Menu addItem​(int page,
                    org.bukkit.inventory.ItemStack itemStack)
        Add an Item to the MenuGUI Calls addItem(int, ItemStack, ClickEvent)
        Parameters:
        page - The page to add the Item to
        itemStack - The ItemStack to add
        Returns:
        The MenuGUI

      • addItem

        public Menu addItem​(int page,
                    org.bukkit.inventory.ItemStack itemStack,
                    ClickEvent clickEvent)
        Add an Item to the MenuGUI
        Parameters:
        page - The page to add the item to
        itemStack - The ItemStack to add
        clickEvent - The ClickEvent
        Returns:
        The MenuGUI

      • addItem

        public Menu addItem​(int page,
                    Items items)
        Add a formatted Item ClickEvent is null Call addItem(int, ItemStack, ClickEvent)
        Parameters:
        page - The page to add the item to
        items - The ItemStack
        Returns:
        The MenuGUI

      • addItem

        public Menu addItem​(org.bukkit.inventory.ItemStack itemStack)
        Add an ItemStack ClickEvent is null Call addItem(int, ItemStack, ClickEvent)
        Parameters:
        itemStack - The ItemStack
        Returns:
        The MenuGUI

      • addItem

        public Menu addItem​(org.bukkit.inventory.ItemStack itemStack,
                    ClickEvent clickEvent)
        Add an ItemStack Call addItem(int, ItemStack, ClickEvent)
        Parameters:
        itemStack - The ItemStack
        clickEvent - The ClickEvent
        Returns:
        The MenuGUI

      • setItem

        public Menu setItem​(int page,
                    int slot,
                    org.bukkit.inventory.ItemStack item,
                    ClickEvent clickEvent)
        Set an Item in the Menu
        Parameters:
        page - The page
        slot - The slot number
        item - The ItemStack
        clickEvent - The ClickEvent
        Returns:
        The MenuGUI

      • setItem

        public Menu setItem​(int page,
                    int slot,
                    org.bukkit.inventory.ItemStack item)
        Set an Item in the Menu ClickEvent is null Calls setItem(int, int, ItemStack, ClickEvent)
        Parameters:
        page - The page
        slot - The slot number
        item - The ItemStack
        Returns:
        The MenuGUI

      • setItem

        public Menu setItem​(int slot,
                    org.bukkit.inventory.ItemStack item)
        Set an Item in the Menu Page is 0, ClickEvent is null Calls setItem(int, int, ItemStack, ClickEvent)
        Parameters:
        slot - The slot number
        item - The ItemStack
        Returns:
        The MenuGUI

      • setItem

        public Menu setItem​(int slot,
                    org.bukkit.inventory.ItemStack item,
                    ClickEvent clickEvent)
        Set an Item in the Menu Page is 0 Calls setItem(int, int, ItemStack, ClickEvent)
        Parameters:
        slot - The slot number
        item - The ItemStack
        clickEvent - The ClickEvent
        Returns:
        The MenuGUI

      • build

        public Menu build()
        Build the MenuGUI
        Returns:
        The MenuGUI

      • open

        public void open​(org.bukkit.entity.Player player)
        Open the inventory for the player Page is 0 Calls open(int, Player)
        Parameters:
        player - The player

      • open

        public void open​(int page,
                 org.bukkit.entity.Player player)
        Open the inventory for the player Will build() if not ran
        Parameters:
        page - The page to open
        player - The player

      • openNextPage

        public void openNextPage​(org.bukkit.entity.Player player)
        Open the next page of the MenuGUI Calls open(int, Player)
        Parameters:
        player - The player

      • openPreviousPage

        public void openPreviousPage​(org.bukkit.entity.Player player)
        Open the previous page of the MenuGUI Calls open(int, Player)
        Parameters:
        player - The player

      • getCurrentPage

        public int getCurrentPage​(org.bukkit.entity.Player player)
        Gets current page.
        Parameters:
        player - The player
        Returns:
        The current page

      • destroy

        public void destroy()
        Destroy the MenuGUI

      • getRows

        public int getRows​(int numberOfItems,
                   double itemsPerRow)
        Get the Rows based on the number of items with a specific number of items per row
        Parameters:
        numberOfItems - The total number of items
        itemsPerRow - the amount of items per row
        Returns:
        The total Rows

      • getClickEvent

        public ClickEvent getClickEvent()
        Gets click event.
        Returns:
        Get the ClickEvent

      • setClickEvent

        public void setClickEvent​(ClickEvent clickEvent)
        Set the ClickEvent
        Parameters:
        clickEvent - the click event

      • getClickEvent

        public ClickEvent getClickEvent​(org.bukkit.inventory.ItemStack itemStack)
        Gets click event.
        Parameters:
        itemStack - The ItemStack
        Returns:
        Get the ClickEvent for an item

      • getSize

        public int getSize()
        Gets size.
        Returns:
        Get the MenuGUI's size

      • setSize

        public void setSize​(int size)
        Set the MenuGUI's size
        Parameters:
        size - The size

      • isBordered

        public boolean isBordered()

      • setBordered

        public Menu setBordered​(boolean bordered)
        Set the MenuGUI being bordered - includes corners
        Parameters:
        bordered - If being bordered
        Returns:
        The MenuGUI