lots of minor fixes with lists and abstract builders

Author: isXander

changelogs/2.1.1.md

@@ -0,0 +1,8 @@
+- Remove padding between list items
+- No longer hide add and reset buttons when lists are collapsed, but automatically expand them when clicked
+- Fix removing items from lists didn't update up and down buttons
+- Fix lists not updating properly when removing the final item from a list
+- Refactor some gui list code to abstract all list functionality from main gui classes
+- Fix option entries sometimes overlapping due to the reset button
+- Fix string elements cropping 1px off the top of the text
+- Abstracted builders to restrict API usage

src/client/java/dev/isxander/yacl/api/ButtonOption.java

@@ -20,31 +20,16 @@ public interface ButtonOption extends Option<BiConsumer<YACLScreen, ButtonOption
     BiConsumer<YACLScreen, ButtonOption> action();
 
     static Builder createBuilder() {
-        return new Builder();
+        return new ButtonOptionImpl.BuilderImpl();
     }
 
-    class Builder {
-        private Text name;
-        private final List<Text> tooltipLines = new ArrayList<>();
-        private boolean available = true;
-        private Function<ButtonOption, Controller<BiConsumer<YACLScreen, ButtonOption>>> controlGetter;
-        private BiConsumer<YACLScreen, ButtonOption> action;
-
-        private Builder() {
-
-        }
-
+    interface Builder {
         /**
          * Sets the name to be used by the option.
          *
          * @see Option#name()
          */
-        public Builder name(@NotNull Text name) {
-            Validate.notNull(name, "`name` cannot be null");
-
-            this.name = name;
-            return this;
-        }
+        Builder name(@NotNull Text name);
 
         /**
          * Sets the tooltip to be used by the option.
@@ -53,71 +38,33 @@ public Builder name(@NotNull Text name) {
          *
          * @param tooltips text lines - merged with a new-line on {@link Option.Builder#build()}.
          */
-        public Builder tooltip(@NotNull Text... tooltips) {
-            Validate.notNull(tooltips, "`tooltips` cannot be empty");
-
-            tooltipLines.addAll(List.of(tooltips));
-            return this;
-        }
-
-        public Builder action(@NotNull BiConsumer<YACLScreen, ButtonOption> action) {
-            Validate.notNull(action, "`action` cannot be null");
+        Builder tooltip(@NotNull Text... tooltips);
 
-            this.action = action;
-            return this;
-        }
+        Builder action(@NotNull BiConsumer<YACLScreen, ButtonOption> action);
 
         /**
          * Action to be executed upon button press
          *
          * @see ButtonOption#action()
          */
         @Deprecated
-        public Builder action(@NotNull Consumer<YACLScreen> action) {
-            Validate.notNull(action, "`action` cannot be null");
-
-            this.action = (screen, button) -> action.accept(screen);
-            return this;
-        }
+        Builder action(@NotNull Consumer<YACLScreen> action);
 
         /**
          * Sets if the option can be configured
          *
          * @see Option#available()
          */
-        public Builder available(boolean available) {
-            this.available = available;
-            return this;
-        }
+        Builder available(boolean available);
 
         /**
          * Sets the controller for the option.
          * This is how you interact and change the options.
          *
          * @see dev.isxander.yacl.gui.controllers
          */
-        public Builder controller(@NotNull Function<ButtonOption, Controller<BiConsumer<YACLScreen, ButtonOption>>> control) {
-            Validate.notNull(control, "`control` cannot be null");
-
-            this.controlGetter = control;
-            return this;
-        }
-
-        public ButtonOption build() {
-            Validate.notNull(name, "`name` must not be null when building `Option`");
-            Validate.notNull(controlGetter, "`control` must not be null when building `Option`");
-            Validate.notNull(action, "`action` must not be null when building `Option`");
-
-            MutableText concatenatedTooltip = Text.empty();
-            boolean first = true;
-            for (Text line : tooltipLines) {
-                if (!first) concatenatedTooltip.append("\n");
-                first = false;
-
-                concatenatedTooltip.append(line);
-            }
+        Builder controller(@NotNull Function<ButtonOption, Controller<BiConsumer<YACLScreen, ButtonOption>>> control);
 
-            return new ButtonOptionImpl(name, concatenatedTooltip, action, available, controlGetter);
-        }
+        ButtonOption build();
     }
 }

src/client/java/dev/isxander/yacl/api/ConfigCategory.java

@@ -39,32 +39,16 @@ public interface ConfigCategory {
      * Creates a builder to construct a {@link ConfigCategory}
      */
     static Builder createBuilder() {
-        return new Builder();
+        return new ConfigCategoryImpl.BuilderImpl();
     }
 
-    class Builder {
-        private Text name;
-
-        private final List<Option<?>> rootOptions = new ArrayList<>();
-        private final List<OptionGroup> groups = new ArrayList<>();
-
-        private final List<Text> tooltipLines = new ArrayList<>();
-
-        private Builder() {
-
-        }
-
+    interface Builder {
         /**
          * Sets name of the category
          *
          * @see ConfigCategory#name()
          */
-        public Builder name(@NotNull Text name) {
-            Validate.notNull(name, "`name` cannot be null");
-
-            this.name = name;
-            return this;
-        }
+        Builder name(@NotNull Text name);
 
         /**
          * Adds an option to the root group of the category.
@@ -74,17 +58,7 @@ public Builder name(@NotNull Text name) {
          * @see ConfigCategory#groups()
          * @see OptionGroup#isRoot()
          */
-        public Builder option(@NotNull Option<?> option) {
-            Validate.notNull(option, "`option` must not be null");
-
-            if (option instanceof ListOption<?> listOption) {
-                YACLConstants.LOGGER.warn("Adding list option as an option is not supported! Rerouting to group!");
-                return group(listOption);
-            }
-
-            this.rootOptions.add(option);
-            return this;
-        }
+        Builder option(@NotNull Option<?> option);
 
         /**
          * Adds multiple options to the root group of the category.
@@ -94,39 +68,21 @@ public Builder option(@NotNull Option<?> option) {
          * @see ConfigCategory#groups()
          * @see OptionGroup#isRoot()
          */
-        public Builder options(@NotNull Collection<Option<?>> options) {
-            Validate.notNull(options, "`options` must not be null");
-
-            if (options.stream().anyMatch(ListOption.class::isInstance))
-                throw new UnsupportedOperationException("List options must not be added as an option but a group!");
-
-            this.rootOptions.addAll(options);
-            return this;
-        }
+        Builder options(@NotNull Collection<Option<?>> options);
 
         /**
          * Adds an option group.
          * To add an option to the root group, use {@link Builder#option(Option)}
          * To construct a group, use {@link OptionGroup#createBuilder()}
          */
-        public Builder group(@NotNull OptionGroup group) {
-            Validate.notNull(group, "`group` must not be null");
-
-            this.groups.add(group);
-            return this;
-        }
+        Builder group(@NotNull OptionGroup group);
 
         /**
          * Adds multiple option groups.
          * To add multiple options to the root group, use {@link Builder#options(Collection)}
          * To construct a group, use {@link OptionGroup#createBuilder()}
          */
-        public Builder groups(@NotNull Collection<OptionGroup> groups) {
-            Validate.notEmpty(groups, "`groups` must not be empty");
-
-            this.groups.addAll(groups);
-            return this;
-        }
+        Builder groups(@NotNull Collection<OptionGroup> groups);
 
         /**
          * Sets the tooltip to be used by the category.
@@ -135,32 +91,8 @@ public Builder groups(@NotNull Collection<OptionGroup> groups) {
          *
          * @param tooltips text lines - merged with a new-line on {@link Builder#build()}.
          */
-        public Builder tooltip(@NotNull Text... tooltips) {
-            Validate.notEmpty(tooltips, "`tooltips` cannot be empty");
-
-            tooltipLines.addAll(List.of(tooltips));
-            return this;
-        }
-
-        public ConfigCategory build() {
-            Validate.notNull(name, "`name` must not be null to build `ConfigCategory`");
-
-            List<OptionGroup> combinedGroups = new ArrayList<>();
-            combinedGroups.add(new OptionGroupImpl(Text.empty(), Text.empty(), ImmutableList.copyOf(rootOptions), false, true));
-            combinedGroups.addAll(groups);
-
-            Validate.notEmpty(combinedGroups, "at least one option must be added to build `ConfigCategory`");
-
-            MutableText concatenatedTooltip = Text.empty();
-            boolean first = true;
-            for (Text line : tooltipLines) {
-                if (!first) concatenatedTooltip.append("\n");
-                first = false;
-
-                concatenatedTooltip.append(line);
-            }
+        Builder tooltip(@NotNull Text... tooltips);
 
-            return new ConfigCategoryImpl(name, ImmutableList.copyOf(combinedGroups), concatenatedTooltip);
-        }
+        ConfigCategory build();
     }
 }