Changeset 32700

Timestamp:

2018-12-16T22:49:11+13:00 (5 years ago)

Author:

ak19

Message:

1. I'm hoping that setNamesRecursively now properly deals with cyclical references to GUI components (especially GLI's custom GUI components) by skipping those whose names are already set. The code should have set the entire subbranch (all descendants) of an already named GUI component, so skipping should be fine. 2. printComponentNames() sadly wasn't printing all components: submenu items of a menubar were missed out. This seems to have to do with how getComponents() is implemented on a MenuBar? Rather than calling the getSubElements() in the case of MenuBars and Menu(Item)s, I'm now just printing Component names out from within setNamesRecursively() instead as soon as a name has been set (or is known to have been set).

File:

• main/trunk/gli/src/org/greenstone/gatherer/gui/TestingPreparation.java (modified) (6 diffs)

main/trunk/gli/src/org/greenstone/gatherer/gui/TestingPreparation.java

@@ -34 +34 @@
     root.setName(className);
 
-    setNamesRecursively("", root);
-    if (DEBUGGING_TEST_MODE) printComponentNames(root, "");
+    setNamesRecursively("", root, "", true);
+    //if (DEBUGGING_TEST_MODE) printComponentNames(root, "");
     }
     
-    public static void setNamesRecursively(String prefix, Component root) {
-    if(!TEST_MODE) return;
-    
+    private static void setNamesRecursively(String prefix, Component root, String tabSpace, boolean isTrueRoot) {
+    if(!TEST_MODE) return;  
+        
     // root starts off as GLI's JFrame, so we know that all its GUI children are specifically JComponents
     
@@ -50 +50 @@
         if(root.getName() == null || root.getName().equals("")) { // if name not already set
         if(!prefix.equals("")){
-            // TODO: fix this
-            root.setName(prefix + "." + className);
+            // TODO: set this to something more meaningful?
+            root.setName(prefix + "." + className);         
         }
         else {
@@ -57 +57 @@
         }
         } // else swing Component name already set
-        
+
+        // now we can print out this element's name for debugging
+        if (DEBUGGING_TEST_MODE) System.err.println(tabSpace + root.getName());
     } else { // root is in GLI GUI package, use its classname for name
         
         if(root.getName() == null || root.getName().equals("")) {
         root.setName(className);
+        } else if(!isTrueRoot) {        
+        // then the name of this GLI GUI element (i.e. of GLI GUI package) was already set
+        // we've recursively dealt with this GLI element and its children already
+        // Prevents cyclic widget references being processed in a cyclic loop ending
+        // in a StackOverflowError
+        return;
         }
+        // now we can print out this element's name for debugging
+        if (DEBUGGING_TEST_MODE) System.err.println(tabSpace + root.getName());
+        
         prefix = className;
         
         // check member vars
-        Field[] memberVars = root.getClass().getDeclaredFields(); // private to public member vars, but not inherited ones      
+        Field[] memberVars = root.getClass().getDeclaredFields(); // private to public member vars, but not inherited ones
+        
         for(int i = 0; i < memberVars.length; i++) {
         memberVars[i].setAccessible(true); // make private/protected etc fields accessible
@@ -73 +85 @@
         Class jCompClass = Container.class;
         Class memberVarClass = memberVars[i].getType();
-
-        // memberVarClass is a JComponen (subclass)
+        
+        // memberVarClass is a JComponent (JComponent or subclass)
         if(jCompClass.isAssignableFrom(memberVarClass)) {
             
@@ -90 +102 @@
                 if(!memberVarClass.getPackage().getName().contains("org.greenstone.gatherer.gui")) {
                 String memberprefix = prefix + "." + memberVars[i].getName(); // append member var name
+                
                 // now can call setName() on the actual member variable
                 memberComponent.setName(memberprefix);
-                setNamesRecursively(memberprefix, memberComponent);
+                setNamesRecursively(memberprefix, memberComponent, tabSpace+"  ", false);
                 }
 
                 //else  the member variable is a GLI GUI class, use its className as prefix for child components
                 // Skip this step to avoid circular references to our own member vars
-                /*else { // member variable is a GLI GUI class, use its className as prefix for child components
-                String memberprefix = memberVarClass.getSimpleName();
-                memberComponent.setName(memberprefix);
-                setNamesRecursively(memberprefix, memberComponent);
-                }*/
-            
+                
+                else { // member variable is a GLI GUI class.
+                // will be using its className as prefix for child components
+                
+                //String memberprefix = memberVarClass.getSimpleName();
+                //memberComponent.setName(memberprefix);
+                setNamesRecursively("", memberComponent, tabSpace+"  ", false);
+                }
+                            
                 
             }
@@ -117 +133 @@
     // No worries about AWT tree lock: setNamesRecursively is called by openGUI
     // which is specifically called by GathererProg on the Event Dispatch Thread (EDT)
+    
+        
     Component[] children = ((Container)root).getComponents();
+    
     for(int i = 0; i < children.length; i++) {
         // if we haven't already set a name for any child JComponents with the above,
         // then the following will do so now
-        setNamesRecursively(className, children[i]);
-    }
-    
+        setNamesRecursively(className, children[i], tabSpace+"  ", false);
+    }    
+
     }
 
     
-    // For debugging swing Component names assigned with Container's setName()    
+    // For debugging swing Component names assigned with Container's setName()
+    // Wasted a lot of my time debugging why menu bar items' names weren't set by setNamesRecursively().
+    // Turns out they were being set, but that sadly
+    // this method doesn't seem to print all components, e.g. JMenuItems of JMenus of a JMenuBar
+    // Perhaps because those are available only through getSubElements() rather than
+    // through getComponents()?
+    // So have now shifted the printing of elements that we manually set into setNamesRecursively() above.
+    // I'd have preferred this printing method since it prints out the component names in
+    // hierarchical order rather than the sometimes arbitrary order that GUI member vars are
+    // declared in GLI's own GUI classes.
     public static void printComponentNames(Component root, String tabbing) {
     if(!TEST_MODE) return;