Add island object to Panel for context. (#2263)

Enable Tab object to reference parent TabbedPanel in the builder. It is late assigned after building. This enables tabs to get the parent, and therefore get the Island object. default methods were used to support backward compatibility.
BentoBoxWorld · Jan 8, 2024 · c62d4f6 · c62d4f6 · IAISI · Jan 9, 2024
1 parent 29a6a51
commit c62d4f6
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 9 deletions.
diff --git a/src/main/java/world/bentobox/bentobox/api/commands/admin/AdminSettingsCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/admin/AdminSettingsCommand.java
@@ -242,8 +242,8 @@ public boolean execute(User user, String label, List<String> args) {
         new TabbedPanelBuilder()
         .user(user)
         .world(island.getWorld())
-        .tab(1, new SettingsTab(user, island, Flag.Type.PROTECTION))
-        .tab(2, new SettingsTab(user, island, Flag.Type.SETTING))
+                .island(island).tab(1, new SettingsTab(user, Flag.Type.PROTECTION))
+                .tab(2, new SettingsTab(user, Flag.Type.SETTING))
         .startingSlot(1)
         .size(54)
         .build().openPanel();

diff --git a/src/main/java/world/bentobox/bentobox/api/commands/island/IslandSettingsCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/island/IslandSettingsCommand.java
@@ -47,9 +47,9 @@ public boolean canExecute(User user, String label, List<String> args) {
     public boolean execute(User user, String label, List<String> args) {
         new TabbedPanelBuilder()
         .user(user)
+                .island(island)
         .world(island.getWorld())
-        .tab(1, new SettingsTab(user, island, Flag.Type.PROTECTION))
-        .tab(2, new SettingsTab(user, island, Flag.Type.SETTING))
+                .tab(1, new SettingsTab(user, Flag.Type.PROTECTION)).tab(2, new SettingsTab(user, Flag.Type.SETTING))
         .startingSlot(1)
         .size(54)
         .hideIfEmpty()

diff --git a/src/main/java/world/bentobox/bentobox/api/panels/Panel.java b/src/main/java/world/bentobox/bentobox/api/panels/Panel.java
@@ -13,6 +13,7 @@
 
 import world.bentobox.bentobox.api.panels.builders.PanelBuilder;
 import world.bentobox.bentobox.api.user.User;
+import world.bentobox.bentobox.database.objects.Island;
 import world.bentobox.bentobox.listeners.PanelListenerManager;
 import world.bentobox.bentobox.util.heads.HeadGetter;
 import world.bentobox.bentobox.util.heads.HeadRequester;
@@ -30,6 +31,7 @@ public class Panel implements HeadRequester, InventoryHolder {
     private User user;
     private String name;
     private World world;
+    private Island island;
 
     /**
      * Various types of Panels that can be created that use InventoryTypes.
@@ -234,4 +236,18 @@ public void setWorld(World world) {
         this.world = world;
     }
 
+    /**
+     * @return the island
+     */
+    public Island getIsland() {
+        return island;
+    }
+
+    /**
+     * @param island the island to set
+     */
+    protected void setIsland(Island island) {
+        this.island = island;
+    }
+
 }
diff --git a/src/main/java/world/bentobox/bentobox/api/panels/Tab.java b/src/main/java/world/bentobox/bentobox/api/panels/Tab.java
@@ -15,6 +15,19 @@
  */
 public interface Tab {
 
+    /**
+     * @return the tabbed panel that owns this tab
+     */
+    default TabbedPanel getParentPanel() {
+        return null;
+    }
+
+    /**
+     * @param parent set the tabbed panel that owns this tab
+     */
+    default void setParentPanel(TabbedPanel parent) {
+    }
+
     // The icon that should be shown at the top of the tabbed panel
     PanelItem getIcon();
 

diff --git a/src/main/java/world/bentobox/bentobox/api/panels/TabbedPanel.java b/src/main/java/world/bentobox/bentobox/api/panels/TabbedPanel.java
@@ -44,6 +44,8 @@ public class TabbedPanel extends Panel implements PanelListener {
     public TabbedPanel(TabbedPanelBuilder tpb) {
         this.tpb = tpb;
         this.setWorld(tpb.getWorld());
+        // Set island context in Panel
+        this.setIsland(tpb.getIsland());
     }
 
     /* (non-Javadoc)
@@ -208,4 +210,5 @@ public void setActivePage(int activePage) {
     public void setActiveTab(int activeTab) {
         this.activeTab = activeTab;
     }
+
 }
diff --git a/src/main/java/world/bentobox/bentobox/api/panels/builders/TabbedPanelBuilder.java b/src/main/java/world/bentobox/bentobox/api/panels/builders/TabbedPanelBuilder.java
@@ -9,6 +9,7 @@
 import world.bentobox.bentobox.api.panels.Tab;
 import world.bentobox.bentobox.api.panels.TabbedPanel;
 import world.bentobox.bentobox.api.user.User;
+import world.bentobox.bentobox.database.objects.Island;
 
 /**
  * Builds {@link TabbedPanel}'s
@@ -23,6 +24,17 @@ public class TabbedPanelBuilder {
     private World world;
     private User user;
     private boolean hideIfEmpty;
+    private Island island;
+
+    /**
+     * Set the island related to this panel
+     * @param island island
+     * @return PanelBuilder - PanelBuilder
+     */
+    public TabbedPanelBuilder island(Island island) {
+        this.island = island;
+        return this;
+    }
 
     /**
      * Forces panel to be a specific number of slots.
@@ -97,7 +109,10 @@ public TabbedPanel build() {
         if (!tabs.isEmpty() && !tabs.containsKey(startingSlot)) {
             startingSlot = ((TreeMap<Integer, Tab>)tabs).firstKey();
         }
-        return new TabbedPanel(this);
+        TabbedPanel tp = new TabbedPanel(this);
+        // Set tab parents
+        tabs.values().forEach(tab -> tab.setParentPanel(tp));
+        return tp;
     }
 
     /**
@@ -142,6 +157,12 @@ public boolean isHideIfEmpty() {
         return hideIfEmpty;
     }
 
+    /**
+     * @return the island
+     */
+    public Island getIsland() {
+        return island;
+    }
 
 
 }
diff --git a/src/main/java/world/bentobox/bentobox/listeners/flags/clicklisteners/GeoMobLimitTab.java b/src/main/java/world/bentobox/bentobox/listeners/flags/clicklisteners/GeoMobLimitTab.java
@@ -48,8 +48,10 @@ public enum EntityLimitTabType {
     private final User user;
     private final EntityLimitTabType type;
     private final World world;
+    private TabbedPanel parent;
 
     /**
+     * @param parent - tabbed panel that owns this panel
      * @param user - user viewing the tab
      * @param type - type of tab to show - Geo limit or Mob limit
      * @param world - world where this tab is being used
@@ -61,7 +63,6 @@ public GeoMobLimitTab(@NonNull User user, @NonNull EntityLimitTabType type, Worl
         this.world = world;
     }
 
-
     @Override
     public boolean onClick(Panel panel, User user, ClickType clickType, int slot) {
         // Case panel to Tabbed Panel to get the active page
@@ -140,4 +141,14 @@ private PanelItem getPanelItem(EntityType c, User user) {
         return pib.build();
     }
 
+    @Override
+    public TabbedPanel getParentPanel() {
+        return parent;
+    }
+
+    @Override
+    public void setParentPanel(TabbedPanel parent) {
+        this.parent = parent;
+    }
+
 }
diff --git a/src/main/java/world/bentobox/bentobox/panels/settings/SettingsTab.java b/src/main/java/world/bentobox/bentobox/panels/settings/SettingsTab.java
@@ -44,16 +44,17 @@ public class SettingsTab implements Tab, ClickHandler {
     protected User user;
     protected World world;
     protected Island island;
+    protected TabbedPanel parent;
 
     /**
      * Show a tab of settings
      * @param user - user who is viewing the tab
      * @param island - the island
      * @param type - flag type
      */
-    public SettingsTab(User user, Island island, Type type) {
+    public SettingsTab(User user, Type type) {
         this.user = user;
-        this.island = island;
+        this.island = parent.getIsland();
         this.type = type;
         this.world = island.getWorld();
     }
@@ -124,7 +125,9 @@ public String getName() {
             plugin.getPlayers().setFlagsDisplayMode(user.getUniqueId(), plugin.getPlayers().getFlagsDisplayMode(user.getUniqueId()).getNext());
             flags = getFlags();
         }
-        return flags.stream().map((f -> f.toPanelItem(plugin, user, island, plugin.getIWM().getHiddenFlags(world).contains(f.getID())))).toList();
+        return flags.stream().map(
+                (f -> f.toPanelItem(plugin, user, island, plugin.getIWM().getHiddenFlags(world).contains(f.getID()))))
+                .toList();
     }
 
     @Override
@@ -223,4 +226,14 @@ public boolean onClick(Panel panel, User user, ClickType clickType, int slot) {
         return true;
     }
 
+    @Override
+    public TabbedPanel getParentPanel() {
+        return parent;
+    }
+
+    @Override
+    public void setParentPanel(TabbedPanel parent) {
+        this.parent = parent;
+    }
+
 }