From f8c639d1852eea846d0bb28af549e4c60e21bb5d Mon Sep 17 00:00:00 2001 From: Scott Burns Date: Mon, 20 May 2019 18:59:36 +0200 Subject: [PATCH 1/5] Parent / child configs --- .../runelite/client/config/ConfigItem.java | 1 + .../client/config/ConfigPanelItem.java | 91 +++++++++++++++++++ .../java/net/runelite/client/config/Stub.java | 5 + .../client/plugins/config/ConfigPanel.java | 71 +++++++++++++-- 4 files changed, 160 insertions(+), 8 deletions(-) create mode 100644 runelite-client/src/main/java/net/runelite/client/config/ConfigPanelItem.java create mode 100644 runelite-client/src/main/java/net/runelite/client/config/Stub.java diff --git a/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java b/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java index 44b93f2e1c..70131819fe 100644 --- a/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java +++ b/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java @@ -49,4 +49,5 @@ public @interface ConfigItem String group() default ""; + String parent() default ""; } diff --git a/runelite-client/src/main/java/net/runelite/client/config/ConfigPanelItem.java b/runelite-client/src/main/java/net/runelite/client/config/ConfigPanelItem.java new file mode 100644 index 0000000000..fa7c338ed4 --- /dev/null +++ b/runelite-client/src/main/java/net/runelite/client/config/ConfigPanelItem.java @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2018, Craftiii4 + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package net.runelite.client.config; + +import java.util.ArrayList; +import java.util.List; +import lombok.AccessLevel; +import lombok.Getter; + +public class ConfigPanelItem +{ + + @Getter(AccessLevel.PUBLIC) + private ConfigPanelItem parent; + + @Getter(AccessLevel.PUBLIC) + private List children; + + @Getter(AccessLevel.PUBLIC) + private ConfigItemDescriptor item; + + public ConfigPanelItem(ConfigPanelItem parent, ConfigItemDescriptor item) + { + this.parent = parent; + this.children = new ArrayList<>(); + this.item = item; + } + + public List getItemsAsList() + { + List items = new ArrayList<>(); + + items.add(this); + + for (ConfigPanelItem child : children) + { + items.addAll(child.getItemsAsList()); + } + return items; + } + + public int getDepth() + { + return (parent == null ? 0 : parent.getDepth() + 1); + } + + public boolean addChildIfMatchParent(ConfigItemDescriptor cid) + { + + if (item != null && item.getItem().keyName().equals(cid.getItem().parent())) + { + children.add(new ConfigPanelItem(this, cid)); + return true; + } + else + { + for (ConfigPanelItem child : children) + { + if (child.addChildIfMatchParent(cid)) + { + return true; + } + } + return false; + } + + } + +} \ No newline at end of file diff --git a/runelite-client/src/main/java/net/runelite/client/config/Stub.java b/runelite-client/src/main/java/net/runelite/client/config/Stub.java new file mode 100644 index 0000000000..be68c83b34 --- /dev/null +++ b/runelite-client/src/main/java/net/runelite/client/config/Stub.java @@ -0,0 +1,5 @@ +package net.runelite.client.config; + +public class Stub +{ +} diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java index 276be04829..d67b20b7bd 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java @@ -75,9 +75,10 @@ import net.runelite.client.config.Config; import net.runelite.client.config.ConfigDescriptor; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; -import net.runelite.client.config.ConfigItemsGroup; import net.runelite.client.config.ConfigItemDescriptor; +import net.runelite.client.config.ConfigItemsGroup; import net.runelite.client.config.ConfigManager; +import net.runelite.client.config.ConfigPanelItem; import net.runelite.client.config.Keybind; import net.runelite.client.config.ModifierlessKeybind; import net.runelite.client.config.Range; @@ -417,6 +418,10 @@ public class ConfigPanel extends PluginPanel title.setToolTipText("" + name + ":
" + listItem.getDescription() + ""); topPanel.add(title); + ConfigPanelItem mainParent = new ConfigPanelItem(null, null); + List parents = new ArrayList<>(); + List allItems = new ArrayList<>(); + for (ConfigItemsGroup cig : cd.getItemGroups()) { boolean collapsed = false; @@ -430,11 +435,13 @@ public class ConfigPanel extends PluginPanel JLabel headerLabel = new JLabel(header); headerLabel.setForeground(Color.ORANGE); - headerLabel.setPreferredSize(new Dimension(PANEL_WIDTH, (int)headerLabel.getPreferredSize().getHeight())); + headerLabel.setPreferredSize(new Dimension(PANEL_WIDTH, (int) headerLabel.getPreferredSize().getHeight())); String sCollapsed = configManager.getConfiguration(cd.getGroup().value(), cig.getGroup() + "_collapse"); if (sCollapsed != null) + { collapsed = Boolean.parseBoolean(sCollapsed); + } JButton collapse = new JButton(collapsed ? "+" : "-"); collapse.setPreferredSize(new Dimension(20, 20)); @@ -451,21 +458,65 @@ public class ConfigPanel extends PluginPanel } if (collapsed) - continue; - - for (ConfigItemDescriptor cid : cig.getItems()) { - if (cid.getItem().hidden()) + continue; + } + + allItems.addAll(cig.getItems()); + + int maxDepth = 3; + do + { + for (ConfigItemDescriptor cid : new ArrayList<>(allItems)) { - continue; + + String parent = cid.getItem().parent(); + + if (parent.equals("")) + { + mainParent.getChildren().add(new ConfigPanelItem(mainParent, cid)); + allItems.remove(cid); + } + else + { + if (mainParent.addChildIfMatchParent(cid)) + { + allItems.remove(cid); + } + } + + } + + maxDepth--; + + } while (allItems.size() > 0 && maxDepth > 0); + + List orderedList = mainParent.getItemsAsList(); + + for (ConfigPanelItem cpi : orderedList) + { + ConfigItemDescriptor cid = cpi.getItem(); + + if (cid == null) + { + continue; // Ignore main 'parent' } JPanel item = new JPanel(); item.setLayout(new BorderLayout()); item.setMinimumSize(new Dimension(PANEL_WIDTH, 0)); name = cid.getItem().name(); + + StringBuilder depthOffset = new StringBuilder(); + for (int depth = 1; depth < cpi.getDepth(); depth++) + { + depthOffset.append(" "); + } + + name = depthOffset + name; + JLabel configEntryName = new JLabel(name); - configEntryName.setPreferredSize(new Dimension(PANEL_WIDTH, (int)configEntryName.getPreferredSize().getHeight())); + configEntryName.setPreferredSize(new Dimension(PANEL_WIDTH, (int) configEntryName.getPreferredSize().getHeight())); configEntryName.setForeground(Color.WHITE); configEntryName.setToolTipText("" + name + ":
" + cid.getItem().description() + ""); item.add(configEntryName, BorderLayout.CENTER); @@ -505,7 +556,9 @@ public class ConfigPanel extends PluginPanel { configEntryName.setText(finalName.concat(": ").concat(String.valueOf(slider.getValue()))); if (!slider.getValueIsAdjusting()) + { changeConfiguration(listItem, config, slider, cd, cid); + } } ); item.add(slider, BorderLayout.EAST); @@ -726,7 +779,9 @@ public class ConfigPanel extends PluginPanel boolean collapse = true; if (sCollapsed != null) + { collapse = !Boolean.parseBoolean(sCollapsed); + } configManager.setConfiguration(cd.getGroup().value(), cig.getGroup() + "_collapse", collapse); openGroupConfigPanel(listItem, config, cd); From 888ac75b18f476c0a87326ce7414f2a5b71f0505 Mon Sep 17 00:00:00 2001 From: Scott Burns Date: Mon, 20 May 2019 19:35:33 +0200 Subject: [PATCH 2/5] Make the title look better --- .../runelite/client/plugins/config/ConfigPanel.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java index af01a3b4aa..359f80e7f3 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java @@ -64,6 +64,8 @@ import javax.swing.ScrollPaneConstants; import javax.swing.SpinnerModel; import javax.swing.SpinnerNumberModel; import javax.swing.SwingUtilities; +import javax.swing.border.Border; +import javax.swing.border.CompoundBorder; import javax.swing.border.EmptyBorder; import javax.swing.event.ChangeListener; import javax.swing.event.DocumentEvent; @@ -83,6 +85,7 @@ import net.runelite.client.config.Keybind; import net.runelite.client.config.ModifierlessKeybind; import net.runelite.client.config.Range; import net.runelite.client.config.RuneLiteConfig; +import net.runelite.client.config.Stub; import net.runelite.client.plugins.Plugin; import net.runelite.client.plugins.PluginDescriptor; import net.runelite.client.plugins.PluginInstantiationException; @@ -521,6 +524,15 @@ public class ConfigPanel extends PluginPanel configEntryName.setToolTipText("" + name + ":
" + cid.getItem().description() + ""); item.add(configEntryName, BorderLayout.CENTER); + if (cid.getType() == Stub.class) + { + Border border = item.getBorder(); + Border margin = new EmptyBorder(10,0,0,0); + item.setBorder(new CompoundBorder(border, margin)); + + configEntryName.setForeground(Color.ORANGE); + } + if (cid.getType() == boolean.class) { JCheckBox checkbox = new JCheckBox(); From 05028d4035ccde84b84b67d40366bd21137d450c Mon Sep 17 00:00:00 2001 From: Scott Burns Date: Mon, 20 May 2019 19:50:40 +0200 Subject: [PATCH 3/5] Hiding and unhiding --- .../runelite/client/config/ConfigItem.java | 2 ++ .../client/plugins/config/ConfigPanel.java | 35 +++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java b/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java index 70131819fe..df7f1d318b 100644 --- a/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java +++ b/runelite-client/src/main/java/net/runelite/client/config/ConfigItem.java @@ -49,5 +49,7 @@ public @interface ConfigItem String group() default ""; + String unhide() default ""; + String parent() default ""; } diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java index 359f80e7f3..7410a085fa 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java @@ -505,6 +505,29 @@ public class ConfigPanel extends PluginPanel continue; // Ignore main 'parent' } + if (cid.getItem().hidden()) + { + boolean show = false; + String unhideat = cid.getItem().unhide(); + + for (ConfigItemDescriptor cid2 : cd.getItems()) + { + + if (cid2.getItem().keyName().equals(unhideat)) + { + if (cid2.getType() == boolean.class) + { + show = Boolean.parseBoolean(configManager.getConfiguration(cd.getGroup().value(), cid2.getItem().keyName())); + } + } + } + + if (!show) + { + continue; + } + } + JPanel item = new JPanel(); item.setLayout(new BorderLayout()); item.setMinimumSize(new Dimension(PANEL_WIDTH, 0)); @@ -821,6 +844,18 @@ public class ConfigPanel extends PluginPanel { JCheckBox checkbox = (JCheckBox) component; configManager.setConfiguration(cd.getGroup().value(), cid.getItem().keyName(), "" + checkbox.isSelected()); + + for (ConfigItemDescriptor cid2 : cd.getItems()) + { + if (cid2.getItem().hidden()) + { + if (cid2.getItem().unhide().equals(cid.getItem().keyName())) + { // If another options visibility changes depending on the value of this checkbox, then render the entire menu again + openGroupConfigPanel(listItem, config, cd); + return; + } + } + } } else if (component instanceof JSpinner) { From 34f1596e005c708eef41767e4572867727940db7 Mon Sep 17 00:00:00 2001 From: Scott Burns Date: Mon, 20 May 2019 19:51:42 +0200 Subject: [PATCH 4/5] Make the slider a little bit shorter --- .../java/net/runelite/client/plugins/config/ConfigPanel.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java index 7410a085fa..14dfa2e725 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java @@ -585,7 +585,7 @@ public class ConfigPanel extends PluginPanel { JSlider slider = new JSlider(min, max, value); configEntryName.setText(name.concat(": ").concat(String.valueOf(slider.getValue()))); - slider.setPreferredSize(new Dimension(100, 25)); + slider.setPreferredSize(new Dimension(85, 25)); String finalName = name; slider.addChangeListener((l) -> { From 8e57433c748aee51f0ce3ca5b43f26730fe3475d Mon Sep 17 00:00:00 2001 From: Scott Burns Date: Mon, 20 May 2019 19:56:34 +0200 Subject: [PATCH 5/5] Checkstyle --- .../java/net/runelite/client/plugins/config/ConfigPanel.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java index 14dfa2e725..b7ee7d790a 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/config/ConfigPanel.java @@ -550,7 +550,7 @@ public class ConfigPanel extends PluginPanel if (cid.getType() == Stub.class) { Border border = item.getBorder(); - Border margin = new EmptyBorder(10,0,0,0); + Border margin = new EmptyBorder(10, 0, 0, 0); item.setBorder(new CompoundBorder(border, margin)); configEntryName.setForeground(Color.ORANGE);