Add an optional callback to be ran when a menu is opened via the back button

Author: Sammster10

menus/src/main/java/net/staticstudios/menus/action/GoBackAction.java

@@ -17,5 +17,9 @@ public void invoke(MenuViewer viewer) {
             return;
         }
         menuToOpen.open(false, false);
+        ViewerAction onComeBack = menuToOpen.getOptions().onComeBack();
+        if (onComeBack != null) {
+            onComeBack.invoke(viewer);
+        }
     }
 }

menus/src/main/java/net/staticstudios/menus/button/ButtonBuilder.java

@@ -1,5 +1,10 @@
 package net.staticstudios.menus.button;
 
+import net.kyori.adventure.text.Component;
+import net.staticstudios.menus.action.ButtonAction;
+
+import java.util.List;
+
 public interface ButtonBuilder {
 
     /**
@@ -22,4 +27,27 @@ default Button buildAndRegister(String namespace, String id) {
         return button;
     }
 
+    ButtonBuilder name(String name);
+
+    ButtonBuilder name(Component name);
+
+    ButtonBuilder description(String... description);
+
+    ButtonBuilder description(List<String> description);
+
+    ButtonBuilder componentDescription(List<Component> description);
+
+    ButtonBuilder description(String description);
+
+    ButtonBuilder amount(int amount);
+
+    ButtonBuilder enchanted(boolean enchanted);
+
+    ButtonBuilder onLeftClick(ButtonAction action);
+
+    ButtonBuilder onRightClick(ButtonAction action);
+
+    ButtonBuilder onClick(ButtonAction action);
+
+
 }

menus/src/main/java/net/staticstudios/menus/menu/MenuBuilder.java

@@ -1,6 +1,7 @@
 package net.staticstudios.menus.menu;
 
 
+import net.staticstudios.menus.action.ViewerAction;
 import net.staticstudios.menus.viewer.MenuViewer;
 
 public interface MenuBuilder {
@@ -11,4 +12,11 @@ public interface MenuBuilder {
      * @return The menu
      */
     Menu build(MenuViewer viewer);
+
+    /**
+     * Specify a callback to be called when the menu is opened via the back button
+     *
+     * @param callback the callback to be called
+     */
+    MenuBuilder onComeBack(ViewerAction callback);
 }

menus/src/main/java/net/staticstudios/menus/menu/PagedMenuBuilder.java

@@ -228,6 +228,13 @@ public PagedMenuBuilder marker(char marker, Button fallback) {
         return builder;
     }
 
+    @Override
+    public PagedMenuBuilder onComeBack(ViewerAction callback) {
+        PagedMenuBuilder builder = clone();
+        builder.options = builder.options.onComeBack(callback);
+        return builder;
+    }
+
     @Override
     public PagedMenu build(MenuViewer viewer) {
         if (id == null) throw new IllegalStateException("ID must be set");

menus/src/main/java/net/staticstudios/menus/menu/SimpleMenuBuilder.java

@@ -6,6 +6,7 @@
 import net.staticstudios.menus.button.Button;
 import net.staticstudios.menus.options.MenuOptions;
 import net.staticstudios.menus.viewer.MenuViewer;
+import org.jspecify.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -21,6 +22,7 @@ public class SimpleMenuBuilder implements Cloneable, MenuBuilder {
     private Component title;
     private List<Button> buttons;
     private MenuOptions options = new MenuOptions();
+    private @Nullable ViewerAction onComeBack;
 
 
     protected SimpleMenuBuilder(boolean mutable) {
@@ -161,6 +163,14 @@ public SimpleMenuBuilder defaultPlaceholder(Button defaultPlaceholder) {
         return builder;
     }
 
+    @Override
+    public SimpleMenuBuilder onComeBack(ViewerAction callback) {
+        SimpleMenuBuilder builder = clone();
+        builder.options = builder.options.onComeBack(callback);
+        return builder;
+    }
+
+
     @Override
     public Menu build(MenuViewer viewer) {
         if (id == null) throw new IllegalStateException("ID must be set");

menus/src/main/java/net/staticstudios/menus/menu/TemplatedMenuBuilder.java

@@ -6,6 +6,7 @@
 import net.staticstudios.menus.button.Button;
 import net.staticstudios.menus.options.MenuOptions;
 import net.staticstudios.menus.viewer.MenuViewer;
+import org.jspecify.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -22,6 +23,7 @@ public class TemplatedMenuBuilder implements Cloneable, MenuBuilder {
     private String id;
     private Component title;
     private MenuOptions options = new MenuOptions();
+    private @Nullable ViewerAction onComeBack;
 
     protected TemplatedMenuBuilder(boolean mutable, String template) {
         this.mutable = mutable;
@@ -137,6 +139,14 @@ public TemplatedMenuBuilder button(char character, Button button) {
         return builder;
     }
 
+    @Override
+    public TemplatedMenuBuilder onComeBack(ViewerAction callback) {
+        TemplatedMenuBuilder builder = clone();
+        builder.options = builder.options.onComeBack(callback);
+        return builder;
+    }
+
+
     @Override
     public Menu build(MenuViewer viewer) {
         if (id == null) throw new IllegalStateException("ID must be set");

menus/src/main/java/net/staticstudios/menus/options/MenuOptions.java

@@ -1,10 +1,13 @@
 package net.staticstudios.menus.options;
 
+import net.staticstudios.menus.action.ViewerAction;
 import net.staticstudios.menus.button.Button;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public class MenuOptions implements Cloneable {
     private @NotNull Button defaultPlaceholder = Button.EMPTY;
+    private ViewerAction onComeBack = null;
 
     public MenuOptions() {
     }
@@ -19,6 +22,16 @@ public MenuOptions defaultPlaceholder(@NotNull Button defaultPlaceholder) {
         return defaultPlaceholder;
     }
 
+    public MenuOptions onComeBack(ViewerAction onComeBack) {
+        MenuOptions opts = clone();
+        opts.onComeBack = onComeBack;
+        return opts;
+    }
+
+    public @Nullable ViewerAction onComeBack() {
+        return onComeBack;
+    }
+
     public MenuOptions clone() {
         try {
             return (MenuOptions) super.clone();