WIP

src/main/java/world/bentobox/bentobox/api/panels/TemplatedPanel.java

@@ -362,9 +362,8 @@ ItemSlot nextItemSlot() {
          * this button is present.
          * 
          * @return Map that links button type to amount in the gui.
-         * @deprecated Use {@link #amount(String)} instead.
+         * Use {@link #amount(String)} instead.
          */
-        @Deprecated
         public Map<String, Integer> amountMap() {
             return this.parentPanel.typeSlotMap;
         }

src/main/java/world/bentobox/bentobox/panels/customizable/AbstractPanel.java

@@ -0,0 +1,140 @@
+package world.bentobox.bentobox.panels.customizable;
+
+import java.io.File;
+
+import org.bukkit.event.inventory.ClickType;
+
+import world.bentobox.bentobox.BentoBox;
+import world.bentobox.bentobox.api.addons.GameModeAddon;
+import world.bentobox.bentobox.api.commands.CompositeCommand;
+import world.bentobox.bentobox.api.panels.PanelItem;
+import world.bentobox.bentobox.api.panels.TemplatedPanel;
+import world.bentobox.bentobox.api.panels.reader.ItemTemplateRecord;
+import world.bentobox.bentobox.api.user.User;
+
+/**
+ * @author tastybento
+ */
+public abstract class AbstractPanel {
+
+    // ---------------------------------------------------------------------
+    // Section: Constants
+    // ---------------------------------------------------------------------
+
+    /**
+     * This constant is used for button to indicate that it is Language type.
+     */
+    public static final String LOCALE = "LOCALE";
+
+    /**
+     * This constant is used for button to indicate that it is previous page type.
+     */
+    public static final String PREVIOUS = "PREVIOUS";
+
+    /**
+     * This constant is used for button to indicate that it is next page type.
+     */
+    public static final String NEXT = "NEXT";
+
+    /**
+     * This constant is used for indicating that pages should contain numbering.
+     */
+    public static final String INDEXING = "indexing";
+
+    /**
+     * This constant stores value for SELECT action that is used in panels.
+     */
+    public static final String SELECT_ACTION = "SELECT";
+
+    /**
+     * This constant stores value for COMMANDS action that is used in panels.
+     */
+    public static final String COMMANDS_ACTION = "COMMANDS";
+
+    /**
+     * This constant stores value for AUTHORS label that is used in panels.
+     */
+    public static final String AUTHORS = "[authors]";
+
+    /**
+     * This constant stores value for SELECTED label that is used in panels.
+     */
+    public static final String SELECTED = "[selected]";
+
+    /**
+     * This variable allows to access plugin object.
+     */
+    final BentoBox plugin;
+
+    /**
+     * This variable stores main command that was triggered.
+     */
+    final CompositeCommand command;
+
+    /**
+     * This variable holds user who opens panel. Without it panel cannot be opened.
+     */
+    final User user;
+
+    /**
+     * This variable holds world where panel is opened. Without it panel cannot be opened.
+     */
+    String mainLabel;
+
+    /**
+     * This variable holds current pageIndex for multi-page island choosing.
+     */
+    int pageIndex;
+
+    public AbstractPanel(CompositeCommand command, User user) {
+        plugin = command.getPlugin();
+        this.command = command;
+        this.user = user;
+        this.pageIndex = 0; // Start with the first page by default
+    }
+
+    // Abstract methods for creating next and previous buttons
+    protected abstract PanelItem createNextButton(ItemTemplateRecord template, TemplatedPanel.ItemSlot slot);
+
+    protected abstract PanelItem createPreviousButton(ItemTemplateRecord template, TemplatedPanel.ItemSlot slot);
+
+    // Abstract build method to allow each panel to define its own layout
+    protected abstract void build();
+
+    // Default method for pagination, can be overridden by subclasses if needed
+    protected boolean hasNextPage(int elementListSize, int itemsPerPage) {
+        return (pageIndex + 1) * itemsPerPage < elementListSize;
+    }
+
+    protected boolean hasPreviousPage() {
+        return pageIndex > 0;
+    }
+
+    // Method to handle the click event on next/previous buttons
+    protected boolean handlePageChange(ItemTemplateRecord.ActionRecords action, ClickType clickType,
+            String actionType) {
+        if ((clickType == action.clickType() || action.clickType() == ClickType.UNKNOWN)
+                && actionType.equalsIgnoreCase(action.actionType())) {
+            if (actionType.equalsIgnoreCase("NEXT")) {
+                this.pageIndex++;
+            } else if (actionType.equalsIgnoreCase("PREVIOUS")) {
+                this.pageIndex--;
+            }
+            build();
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * This method returns if panel with the requested name is located in GameModeAddon folder.
+     * @param addon GameModeAddon that need to be checked.
+     * @param name Name of the panel.
+     * @return {@code true} if panel exists, {@code false} otherwise.
+     */
+    protected boolean doesCustomPanelExists(GameModeAddon addon, String name) {
+        return addon.getDataFolder().exists() && new File(addon.getDataFolder(), "panels").exists()
+                && new File(addon.getDataFolder(), "panels" + File.separator + name + ".yml").exists();
+    }
+
+}