Add functional save/load widget settings with simpler method calls - Test driven with W_Template

Author: retiutut

OpenBCI_GUI/W_Template.pde

@@ -40,42 +40,32 @@ class W_Template extends WidgetWithSettings {
         localCP5.setAutoDraw(false);
 
         createWidgetTemplateButton();
-       
     }
 
     @Override
     protected void initWidgetSettings() {
         super.initWidgetSettings();
         // Widget Settings are used to store the state of the widget.
         // This is where you can set the default values for your dropdowns and other settings.
-        widgetSettings.set(TemplateDropdown1.class, TemplateDropdown1.ITEM_A);
-        widgetSettings.set(TemplateDropdown2.class, TemplateDropdown2.ITEM_C);
-        widgetSettings.set(TemplateDropdown3.class, TemplateDropdown3.ITEM_F);
-        widgetSettings.saveDefaults();
-
-        // Get the list of Strings for the dropdowns. These are the options that will be displayed in the dropdowns.
-        List<String> dropdown1List = EnumHelper.getEnumStrings(TemplateDropdown1.class);
-        List<String> dropdown2List = EnumHelper.getEnumStrings(TemplateDropdown2.class);
-        List<String> dropdown3List = EnumHelper.getEnumStrings(TemplateDropdown3.class);
-
-        // Get the current settings for the dropdowns. This is where you can retrieve the values that were just set.
-        int dropdown1Index = widgetSettings.get(TemplateDropdown1.class).getIndex();
-        int dropdown2Index = widgetSettings.get(TemplateDropdown2.class).getIndex();
-        int dropdown3Index = widgetSettings.get(TemplateDropdown3.class).getIndex();
+        widgetSettings.set(TemplateDropdown1.class, TemplateDropdown1.ITEM_A)
+                    .set(TemplateDropdown2.class, TemplateDropdown2.ITEM_C)
+                    .set(TemplateDropdown3.class, TemplateDropdown3.ITEM_F)
+                    .saveDefaults();
 
         // This is the protocol for setting up dropdowns.
         // Note that these 3 dropdowns correspond to the 3 global functions below.
         // You just need to make sure the "id" (the 1st String) has the same name as the corresponding function.
-        addDropdown("widgetTemplateDropdown1", "Drop 1", dropdown1List, dropdown1Index);
-        addDropdown("widgetTemplateDropdown2", "Drop 2", dropdown2List, dropdown2Index);
-        addDropdown("widgetTemplateDropdown3", "Drop 3", dropdown3List, dropdown3Index);
+        // Arguments: Class, String id, String label
+        initDropdown(TemplateDropdown1.class, "widgetTemplateDropdown1", "Drop 1");
+        initDropdown(TemplateDropdown2.class, "widgetTemplateDropdown2", "Drop 2");
+        initDropdown(TemplateDropdown3.class, "widgetTemplateDropdown3", "Drop 3");
     }
 
     @Override
     protected void applySettings() {
-        //FIX ME
-        println("!!!!!!!!!!!!!!!!!!!!!!!!!Applying settings for " + widgetTitle);
-        //widgetSettings.applySettings();
+        updateDropdownLabel(TemplateDropdown1.class, "widgetTemplateDropdown1");
+        updateDropdownLabel(TemplateDropdown2.class, "widgetTemplateDropdown2");
+        updateDropdownLabel(TemplateDropdown3.class, "widgetTemplateDropdown3");
     }
 
     public void update(){

OpenBCI_GUI/Widget.pde

@@ -319,8 +319,8 @@ abstract class WidgetWithSettings extends Widget {
     }
 
     public void setWidgetSettings(WidgetSettings _widgetSettings) {
-        //FIX ME - DO I NEED THIS?
         widgetSettings = _widgetSettings;
+        applySettings();
     }
 
     public WidgetSettings getWidgetSettings() {
@@ -330,6 +330,17 @@ abstract class WidgetWithSettings extends Widget {
     protected void initWidgetSettings() {
         widgetSettings = new WidgetSettings(getWidgetTitle());
     }
+
+    protected <T extends Enum<T> & IndexingInterface> void initDropdown(Class<T> enumClass, String id, String label) {
+        List<String> options = EnumHelper.getEnumStrings(enumClass);
+        int currentIndex = widgetSettings.get(enumClass).getIndex();
+        addDropdown(id, label, options, currentIndex);
+    }
+
+    protected <T extends Enum<T> & IndexingInterface> void updateDropdownLabel(Class<T> enumClass, String controllerId) {
+        String value = widgetSettings.get(enumClass).getString();
+        cp5_widget.getController(controllerId).getCaptionLabel().setText(value);
+    }
 
     protected abstract void applySettings();
 }

OpenBCI_GUI/WidgetManager.pde

@@ -345,13 +345,21 @@ class WidgetManager {
                 continue;
             }
 
+            WidgetWithSettings widgetWithSettings = (WidgetWithSettings) widget;
             String widgetTitle = widget.getWidgetTitle();
-            if (json.hasKey(widgetTitle)) {
-                String settingsJson = json.getString(widgetTitle, "");
-                ((WidgetWithSettings) widget).getWidgetSettings().fromJSON(settingsJson);
-            } else {
+            if (!json.hasKey(widgetTitle)) {
                 println("WidgetManager:loadWidgetSettingsFromJson: No settings found for " + widgetTitle);
+                continue;
+            }
+
+            String settingsJson = json.getString(widgetTitle, "");
+            WidgetSettings widgetSettings = widgetWithSettings.getWidgetSettings();
+            boolean success = widgetSettings.loadFromJSON(settingsJson);
+            if (!success) {
+                println("WidgetManager:loadWidgetSettingsFromJson: Failed to load settings for " + widgetTitle);
+                continue;
             }
+            widgetWithSettings.applySettings();
         }
     }
 };

OpenBCI_GUI/WidgetSettings.pde

@@ -17,9 +17,11 @@ class WidgetSettings {
 
     /**
      * Store a setting using enum class as key
+     * @return this WidgetSettings instance for method chaining
      */
-    public <T extends Enum<?>> void set(Class<T> enumClass, T value) {
+    public <T extends Enum<?>> WidgetSettings set(Class<T> enumClass, T value) {
         settings.put(enumClass.getName(), value);
+        return this;
     }
 
     /**
@@ -28,9 +30,9 @@ class WidgetSettings {
      * 
      * @param enumClass The enum class to look up values
      * @param index The index of the enum constant to set
-     * @return true if successful, false if the index is out of bounds
+     * @return this WidgetSettings instance for method chaining
      */
-    public <T extends Enum<?>> boolean setByIndex(Class<T> enumClass, int index) {
+    public <T extends Enum<?>> WidgetSettings setByIndex(Class<T> enumClass, int index) {
         T[] enumConstants = enumClass.getEnumConstants();
 
         // Check if index is valid
@@ -39,12 +41,12 @@ class WidgetSettings {
             T value = enumConstants[index];
             // Set it using the regular set method
             set(enumClass, value);
-            return true;
+        } else {
+            // Index was out of bounds
+            println("Warning: Invalid index " + index + " for enum " + enumClass.getName());
         }
 
-        // Index was out of bounds
-        println("Warning: Invalid index " + index + " for enum " + enumClass.getName());
-        return false;
+        return this;
     }
 
     /**
@@ -77,16 +79,20 @@ class WidgetSettings {
 
     /**
      * Save current settings as defaults
+     * @return this WidgetSettings instance for method chaining
      */
-    public void saveDefaults() {
+    public WidgetSettings saveDefaults() {
         defaults = new HashMap<String, Enum<?>>(settings);
+        return this;
     }
 
     /**
      * Restore to default settings
+     * @return this WidgetSettings instance for method chaining
      */
-    public void restoreDefaults() {
+    public WidgetSettings restoreDefaults() {
         settings = new HashMap<String, Enum<?>>(defaults);
+        return this;
     }
 
     /**
@@ -112,9 +118,11 @@ class WidgetSettings {
     }
 
     /**
-     * Load settings from JSON string
-     */
-    public boolean fromJSON(String jsonString) {
+    * Attempts to load settings from a JSON string
+    * @param jsonString The JSON string containing settings
+    * @return true if settings were loaded successfully, false otherwise
+    */
+    public boolean loadFromJSON(String jsonString) {
         try {
             JSONObject json = parseJSONObject(jsonString);
             if (json == null) return false;