somewhat intelligle support for paginated menus

Author: KodySimpson

README.md

@@ -1,4 +1,4 @@
-# SimpAPI v4.1.8
+# SimpAPI v4.1.9
 ****
 SimpAPI, finally a good API that can make coding MC Plugins much easier and less painful.
 This API includes all of my primary utilities like *Menu Manager*, *Command Manager*, *ColorTranslator*, and more.
@@ -25,7 +25,7 @@ JavaDocs: https://kodysimpson.github.io/SimpAPI/index.html
 <dependency>
     <groupId>com.github.KodySimpson</groupId>
     <artifactId>SimpAPI</artifactId>
-    <version>4.1.8</version>
+    <version>4.1.9</version>
 </dependency>
 ```
 
@@ -51,7 +51,7 @@ repositories {
 Groovy/Kotlin:
 ```groovy
 dependencies {
-    implementation 'com.github.KodySimpson:SimpAPI:4.1.8'
+    implementation 'com.github.KodySimpson:SimpAPI:4.1.9'
 }
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>me.kodysimpson</groupId>
     <artifactId>SimpAPI</artifactId>
-    <version>4.1.85</version>
+    <version>4.1.9</version>
     <packaging>jar</packaging>
 
     <name>SimpAPI</name>

src/main/java/me/kodysimpson/simpapi/menu/Menu.java

@@ -66,9 +66,11 @@ public void back() throws MenuManagerException, MenuManagerNotSetupException {
         MenuManager.openMenu(playerMenuUtility.lastMenu().getClass(), playerMenuUtility.getOwner());
     }
 
-    protected void reload() throws MenuManagerException, MenuManagerNotSetupException {
-        p.closeInventory();
-        MenuManager.openMenu(this.getClass(), playerMenuUtility.getOwner());
+    protected void reload() {
+        for (int i = 0; i < inventory.getSize(); i++){
+            inventory.setItem(i, null);
+        }
+        setMenuItems();
     }
 
     //Overridden method from the InventoryHolder interface

src/main/java/me/kodysimpson/simpapi/menu/PaginatedMenu.java

@@ -7,6 +7,7 @@
 
 public abstract class PaginatedMenu extends Menu {
 
+    //The items being paginated
     protected List<Object> data;
 
     //Keep track of what page the menu is on
@@ -22,11 +23,21 @@ public PaginatedMenu(PlayerMenuUtility playerMenuUtility) {
         super(playerMenuUtility);
     }
 
+    /**
+     * @param <T> The datatype of the data in the list
+     * @return A list of the data being paginated. usually this is a list of items but it can be anything
+     */
     public abstract <T> List<T> getData();
 
+    /**
+     * @param object A single element of the data list that you do something with. It is recommended that you turn this into an item if it is not already and then put it into the inventory as you would with a normal Menu. You can execute any other logic in here as well.
+     */
     public abstract void loopCode(Object object);
 
-    //Set the border and menu buttons for the menu
+
+    /**
+     * Set the border and menu buttons for the menu. Override this method to provide a custom menu border
+     */
     protected void addMenuBorder(){
         inventory.setItem(48, makeItem(Material.DARK_OAK_BUTTON, ChatColor.GREEN + "Left"));
 
@@ -54,6 +65,9 @@ protected void addMenuBorder(){
         }
     }
 
+    /**
+     * Place each item in the paginated menu, automatically coded by default but override if you want custom functionality. Calls the loopCode() method you define for each item returned in the getData() method
+     */
     @Override
     public void setMenuItems() {
 
@@ -64,6 +78,7 @@ public void setMenuItems() {
         if (data != null && !data.isEmpty()) {
             for (int i = 0; i < getMaxItemsPerPage(); i++) {
                 index = getMaxItemsPerPage() * page + i;
+                System.out.println(index);
                 if (index >= data.size()) break;
                 if (data.get(index) != null) {
                     loopCode(data.get(index)); //run the code defined by the user
@@ -74,6 +89,32 @@ public void setMenuItems() {
 
     }
 
+    /**
+     * @return true if successful, false if already on the first page
+     */
+    public boolean prevPage(){
+        if (page == 0){
+            return false;
+        }else{
+            page = page - 1;
+            reload();
+            return true;
+        }
+    }
+
+    /**
+     * @return true if successful, false if already on the last page
+     */
+    public boolean nextPage(){
+        if (!((index + 1) >= getData().size())) {
+            page = page + 1;
+            reload();
+            return true;
+        } else {
+            return false;
+        }
+    }
+
     public int getMaxItemsPerPage() {
         return maxItemsPerPage;
     }