Changeset 837 for trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/guimodel/WindowTree.java

Timestamp:

09/20/12 12:03:03 (12 years ago)

Author:

sherbold

Message:

• code documentation and clean-up

File:

• trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/guimodel/WindowTree.java (modified) (16 diffs)

trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/guimodel/WindowTree.java

@@ +1 @@
+
 package de.ugoe.cs.quest.plugin.mfc.guimodel;
 
@@ -12 +13 @@
 import de.ugoe.cs.quest.eventcore.guimodel.GUIModelException;
 import de.ugoe.cs.quest.eventcore.guimodel.IGUIElementFactory;
-
 
 /**
@@ -30 +30 @@
     /**
      * <p>
-     * Maintains a set of all the targets of all widgets that were at some point part of the
-     * window tree.
+     * Maintains a set of all the targets of all widgets that were at some point part of the window
+     * tree.
      * </p>
      */
@@ -38 +38 @@
     /**
      * <p>
-     * Map of all GUI element specifications that are part of the tree for efficient searching.
-     * The keys of the map are the hwnd's of the GUI elements.
+     * Map of all GUI element specifications that are part of the tree for efficient searching. The
+     * keys of the map are the hwnd's of the GUI elements.
      * </p>
      */
@@ -46 +46 @@
     /**
      * <p>
-     * Map of all children of GUI elements that are part of the tree. The keys of the map are
-     * the hwnd's of the parent GUI elements.
+     * Map of all children of GUI elements that are part of the tree. The keys of the map are the
+     * hwnd's of the parent GUI elements.
      * </p>
      */
@@ -54 +54 @@
     /**
      * <p>
-     * Map of all parents of GUI elements that are part of the tree. The keys of the map are
-     * the hwnd's of the child GUI elements.
+     * Map of all parents of GUI elements that are part of the tree. The keys of the map are the
+     * hwnd's of the child GUI elements.
      * </p>
      */
@@ -66 +66 @@
      */
     private GUIModel guiModel = new GUIModel();
-    
+
     /**
      * <p>
@@ -114 +114 @@
      *            class name of the window to be created
      */
-    public void add(long    parentHwnd,
-                    long    childHwnd,
-                    String  childWindowName,
-                    int     resourceId,
-                    String  className,
+    public void add(long parentHwnd,
+                    long childHwnd,
+                    String childWindowName,
+                    int resourceId,
+                    String className,
                     boolean isModal)
     {
@@ -128 +128 @@
             if (parent != null) {
                 List<MFCGUIElementSpec> otherChildren = childRelations.get(parentHwnd);
-                
+
                 if (otherChildren == null) {
                     otherChildren = new ArrayList<MFCGUIElementSpec>();
                     childRelations.put(parentHwnd, otherChildren);
                 }
-                
+
                 otherChildren.add(child);
-                
+
                 parentRelations.put(childHwnd, parent);
             }
@@ -145 +145 @@
     /**
      * <p>
-     * Searches the tree for a window with the specified hwnd and returns its {@link MFCGUIElementSpec}
-     * .
+     * Searches the tree for a window with the specified hwnd and returns its
+     * {@link MFCGUIElementSpec} .
      * </p>
      * 
@@ -157 +157 @@
         if (guiElement == null) {
             List<MFCGUIElementSpec> guiElementPath = new ArrayList<MFCGUIElementSpec>();
-            
+
             MFCGUIElementSpec child = guiElementSpecs.get(hwnd);
-            
+
             if (child == null) {
                 throw new RuntimeException("no GUI element found with id " + hwnd);
             }
-            
+
             while (child != null) {
                 guiElementPath.add(0, child);
                 child = parentRelations.get(child.getHwnd());
             }
-            
+
             try {
-                guiElement = (MFCGUIElement)
-                    guiModel.integratePath(guiElementPath, guiElementFactory);
+                guiElement =
+                    (MFCGUIElement) guiModel.integratePath(guiElementPath, guiElementFactory);
             }
             catch (GUIModelException e) {
@@ -183 +183 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
+     * Sets the name of a GUI element given its HWND.
+     * </p>
+     * 
      * @param hwnd
+     *            HWND of the GUI element
      * @param windowName
+     *            new name of the GUI element
      */
     public void setName(long hwnd, String windowName) {
@@ -201 +203 @@
         }
     }
-    
+
     /**
      * <p>
@@ -215 +217 @@
         MFCGUIElementSpec node = guiElementSpecs.remove(hwnd);
         int removedCounter = 1;
-        
+
         if (node != null) {
             List<MFCGUIElementSpec> nodesToBeRemoved = childRelations.remove(hwnd);
-            
+
             // remove all children and sub-children, if any
             if (nodesToBeRemoved != null) {
@@ -225 +227 @@
                     List<MFCGUIElementSpec> children =
                         childRelations.remove(nodeToBeRemoved.getHwnd());
-                    
+
                     if (children != null) {
                         nodesToBeRemoved.addAll(children);
                     }
-                    
+
                     guiElementSpecs.remove(nodeToBeRemoved.getHwnd());
                     parentRelations.remove(nodeToBeRemoved.getHwnd());
@@ -248 +250 @@
                         }
                     }
-                    
+
                     if (children.size() <= 0) {
                         childRelations.remove(parent.getHwnd());