4.2.10 Changelog:

+ Added Scroll Browser (Vertical Browser)
+ Added GUIUpdateEvent
* Fixed issues with Browser Search Feature not working

Author: Im-Fran

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v4.2.10 Changelog:
+```
++ Added Scroll Browser (Vertical Browser)
++ Added GUIUpdateEvent
+* Fixed issues with Browser Search Feature not working
+```
+
 ## v4.2.9 Changelog:
 ```
 * Now SimpleItem#getDisplayName() and SimpleItem#getLore() doesn't return null to avoid errors 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>xyz.theprogramsrc</groupId>
     <artifactId>SuperCoreAPI</artifactId>
-    <version>4.2.10_BETA4</version>
+    <version>4.2.10</version>
     <packaging>jar</packaging>
 
     <name>SuperCoreAPI</name>

src/main/java/xyz/theprogramsrc/supercoreapi/spigot/guis/BrowserGUI.java

@@ -1,21 +1,23 @@
 package xyz.theprogramsrc.supercoreapi.spigot.guis;
 
-import org.bukkit.ChatColor;
 import org.bukkit.entity.Player;
 import xyz.theprogramsrc.supercoreapi.global.translations.Base;
 import xyz.theprogramsrc.supercoreapi.spigot.dialog.Dialog;
 import xyz.theprogramsrc.supercoreapi.spigot.guis.action.ClickAction;
+import xyz.theprogramsrc.supercoreapi.spigot.guis.events.GUIEvent;
+import xyz.theprogramsrc.supercoreapi.spigot.guis.events.GUIOpenEvent;
 import xyz.theprogramsrc.supercoreapi.spigot.guis.objects.GUIRows;
 import xyz.theprogramsrc.supercoreapi.spigot.items.SimpleItem;
 
-import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
 
 public abstract class BrowserGUI<OBJ> extends GUI {
 
     private String searchTerm = null;
     public int maxItemsPerPage = 36;
+    public boolean backEnabled = false;
     private int page = 0;
 
     /**
@@ -32,39 +34,33 @@ protected GUIRows getRows() {
     }
 
     @Override
-    public GUIButton[] getButtons() {
-        OBJ[] objs = this.getObjects();
-        List<OBJ> objectsFound = new ArrayList<>();
-        for (OBJ obj : objs) {
-            if(obj != null){
-                if(this.searchTerm == null){
-                    objectsFound.add(obj);
-                }else{
-                    GUIButton button = this.getButton(obj);
-                    String name = ChatColor.stripColor(new SimpleItem(button.getItemStack()).getDisplayName()).toLowerCase();
-                    if(name.contains(ChatColor.stripColor(this.searchTerm.toLowerCase()))){
-                        objectsFound.add(obj);
-                    }
+    public void onEvent(GUIEvent event) {
+        if(event instanceof GUIOpenEvent){
+            this.clearButtons();
+            OBJ[] objs = this.getObjects();
+            List<OBJ> objectsFound = Arrays.stream(this.getObjects()).filter(obj->{
+                if(this.searchTerm != null){
+                    String itemName = this.getSuperUtils().removeColor(new SimpleItem(this.getButton(obj).getItemStack()).getDisplayName()).toLowerCase();
+                    String search = this.getSuperUtils().removeColor(this.searchTerm).toLowerCase();
+                    return itemName.contains(search);
                 }
+
+                return true;
+            }).collect(Collectors.toList());
+            int index0 = this.page * this.maxItemsPerPage;
+            int index1 = Math.min(index0 + this.maxItemsPerPage, objectsFound.size());
+            int maxPages = (int)Math.round(Math.ceil((double)objectsFound.size() / (double)maxItemsPerPage));
+            List<GUIButton> buttons =  objectsFound.subList(index0, index1).stream().map(this::getButton).collect(Collectors.toList());
+            int i = 0;
+            for(int o = 0; o < buttons.size(); ++o){
+                buttons.set(o, buttons.get(o).setSlot(i));
+                i++;
             }
-        }
-        int index0 = this.page * this.maxItemsPerPage;
-        int index1 = Math.min(index0 + this.maxItemsPerPage, objectsFound.size());
-        int maxPages = (int)Math.round(Math.ceil((double)objectsFound.size() / (double)maxItemsPerPage));
-        List<GUIButton> buttons1 = new ArrayList<>();
-        int slot = 0;
-        for (GUIButton b : objectsFound.subList(index0, index1).stream().map(this::getButton).collect(Collectors.toList())) {
-            b.setSlot(slot);
-            buttons1.add(b);
-            slot++;
-        }
-        List<GUIButton> buttons = new ArrayList<>(buttons1);
-        buttons1.clear(); // Save memory
-        objectsFound.clear(); // Save memory
 
-        buttons.add(new GUIButton(49, this.searchTerm == null ? this.getPreloadedItems().getSearchItem() : this.getPreloadedItems().getEndSearchItem()).setAction(a -> {
+            this.addButtons(buttons);
+            this.removeButtons(43, 44,45,46,47,48,49,50,51,52,53);
             if(this.searchTerm == null){
-                new Dialog(this.getPlayer()){
+                this.addButton(new GUIButton(49, this.getPreloadedItems().getSearchItem(), a-> new Dialog(this.getPlayer()){
 
                     @Override
                     public String getTitle() {
@@ -88,32 +84,33 @@ public boolean onResult(String playerInput) {
                     }
                 }.setRecall(player ->{
                     this.page = 0;
-                    this.open();
-                });
+                    this.getSpigotTasks().runTask(this::open);
+                })));
             }else{
-                this.searchTerm = null;
-                this.page = 0;
-                this.open();
+                this.addButton(new GUIButton(49, this.getPreloadedItems().getEndSearchItem(), a->{
+                    this.searchTerm = null;
+                    this.page = 0;
+                    this.open();
+                }));
+            }
+
+            if(this.page != 0){
+                this.addButton(new GUIButton(52, this.getPreloadedItems().getPreviousItem()).setAction(a -> {
+                    this.page -= 1;
+                    this.open();
+                }));
+            }
+            if(this.page+1 < maxPages){
+                this.addButton(new GUIButton(53, this.getPreloadedItems().getNextItem()).setAction(a -> {
+                    this.page += 1;
+                    this.open();
+                }));
             }
-        }));
-        buttons.add(new GUIButton(45, this.getPreloadedItems().getBackItem()).setAction(this::onBack));
-
-        if(this.page != 0){
-            buttons.add(new GUIButton(52, this.getPreloadedItems().getPreviousItem()).setAction(a -> {
-                this.page--;
-                this.open();
-            }));
-        }
-        if(this.page+1 < maxPages){
-            buttons.add(new GUIButton(53, this.getPreloadedItems().getNextItem()).setAction(a -> {
-                this.page++;
-                this.open();
-            }));
-        }
 
-        GUIButton[] guiButtons = new GUIButton[buttons.size()];
-        guiButtons = buttons.toArray(guiButtons);
-        return guiButtons;
+            if(this.backEnabled){
+                this.addButton(new GUIButton(45, this.getPreloadedItems().getBackItem()).setAction(this::onBack));
+            }
+        }
     }
 
     /**
@@ -133,5 +130,9 @@ public boolean onResult(String playerInput) {
      * Executed when the back button is clicked
      * @param clickAction The ClickAction
      */
-    public abstract void onBack(ClickAction clickAction);
+    public void onBack(ClickAction clickAction){
+
+    }
+
+
 }

src/main/java/xyz/theprogramsrc/supercoreapi/spigot/guis/GUI.java

@@ -22,7 +22,9 @@
 import xyz.theprogramsrc.supercoreapi.spigot.guis.objects.GUIRows;
 import xyz.theprogramsrc.supercoreapi.spigot.utils.xseries.XMaterial;
 
+import java.util.Collection;
 import java.util.LinkedHashMap;
+import java.util.Map;
 import java.util.UUID;
 
 public abstract class GUI extends SpigotModule {
@@ -48,8 +50,8 @@ public GUI(Player player){
      * Opens the {@link GUI GUI}
      */
     public void open(){
-        HandlerList.unregisterAll(this);
-        this.listener(this);
+        if(this.inv == null)
+            this.listener(this);
         this.inv = Bukkit.createInventory(null, this.getRows().getSize(), this.getSuperUtils().color(this.isTitleCentered() ? this.getCenteredTitle() : this.getTitle()));
         this.player.openInventory(this.inv);
     }
@@ -72,6 +74,28 @@ public void close(){
         });
     }
 
+    /**
+     * Adds the specified buttons to the GUI
+     * @param buttons the buttons to add
+     *
+     * @see #addButton(GUIButton)
+     */
+    public void addButtons(Collection<GUIButton> buttons){
+        for(GUIButton button : buttons)
+            this.addButton(button);
+    }
+
+    /**
+     * Adds the specified buttons to the GUI
+     * @param buttons the buttons to add
+     *
+     * @see #addButton(GUIButton)
+     */
+    public void addButtons(GUIButton... buttons){
+        for(GUIButton button : buttons)
+            this.addButton(button);
+    }
+
     /**
      * Adds a button inside the {@link GUI GUI} using the last empty slot if there is no slot specified inside the {@link GUIButton button}
      * @param button the button to add inside the {@link GUI GUI}
@@ -86,15 +110,63 @@ public void addButton(GUIButton button){
      * @param button the button to add inside the {@link GUI GUI}
      */
     public void setButton(int slot, GUIButton button){
-        if(slot < 0 || slot > 53){
+        if(slot < 0){
             while(this.buttons.containsKey(slot)){
                 slot++;
             }
             button.setSlot(slot);
         }
+
+        if(this.buttons.containsKey(slot)){
+            if(this.buttons.get(slot).equals(button)){
+                return;
+            }
+        }
         this.buttons.put(slot, button);
     }
 
+    /**
+     * Gets a button from the GUI
+     * @param slot the slot
+     * @return the button located in the slot or null if there is no button
+     */
+    public GUIButton getButton(int slot){
+        return this.buttons.get(slot);
+    }
+
+    /**
+     * Removes all the buttons in the specified slots
+     * @param slots the slots of the buttons to remove
+     */
+    public void removeButtons(int... slots){
+        for(int slot : slots)
+            this.removeButton(slot);
+    }
+
+    /**
+     * Removes a button from the GUI
+     * @param slot the slot of the button to remove
+     */
+    public void removeButton(int slot){
+        this.buttons.remove(slot);
+    }
+
+    /**
+     * Removes all the buttons from the GUI
+     */
+    public void clearButtons(){
+        this.buttons.clear();
+    }
+
+    /**
+     * Checks if there is a button in the given slot
+     * @param slot the slot to check
+     * @return true if there is a button, otherwise false
+     */
+    public boolean containsButton(int slot){
+        return this.buttons.containsKey(slot);
+    }
+
     /**
      * Alternative method to add items into a {@link GUI GUI}
      * @return the buttons to add inside the {@link GUI GUI}
@@ -237,7 +309,7 @@ public void onQuit(PlayerQuitEvent event){
     public void syncItems(TimerEvent event){
         if(event.getTime() == Time.TICK){
             if(this.inv != null && this.player != null){
-                this.inv.clear();
+                this.onEvent(new GUIUpdateEvent(this));
                 GUIButton[] buttonsArray = this.getButtons();
                 if(buttonsArray != null){
                     for (GUIButton button : buttonsArray) {
@@ -247,16 +319,13 @@ public void syncItems(TimerEvent event){
                     }
                 }
 
-                for (GUIButton button : this.buttons.values()) {
-                    int slot = button.getSlot();
-                    ItemStack item = button.getItemStack();
-                    if(item != null){
-                        if(slot <= this.getRows().getSize() && slot >= 0){
-                            this.inv.setItem(slot, item);
-                        }
-                    }
+                this.inv.clear();
+                for(Map.Entry<Integer, GUIButton> entry : new LinkedHashMap<>(this.buttons).entrySet()){
+                    int slot = entry.getKey();
+                    if(this.inv.getSize() < slot || slot > this.inv.getSize()) continue;
+                    GUIButton button = entry.getValue();
+                    this.inv.setItem(slot, button.getItemStack());
                 }
-
                 this.player.updateInventory();
             }
         }