* dumps a GUI element to the stream. A dump contains the toString() representation of the GUI - * element as well as a indented list of its children surrounded by braces. + * element as well as a indented list of its children surrounded by braces. Therefore, not the + * GUI element itself but its tree node is provided to have an efficient access to its children *
* * @param out * {@link PrintStream} where the guiElement is dumped to - * @param guiElement - * the guiElement whos string represenation is dumped + * @param node + * the guiElement's tree node of which the string representation is dumped * @param indent * indent string of the dumping */ - private void dumpGUIElement(PrintStream out, IGUIElement guiElement, String indent) { + private void dumpGUIElement(PrintStream out, TreeNode node, String indent) { out.print(indent); - out.print(guiElement); - - List+ * Used externally for tree traversal without providing direct access to the tree nodes + *
+ * + * @version 1.0 + * @author Patrick Harms, Steffen Herbold + */ + public class Traverser { + + /** + *+ * the stack of nodes on which the traverser currently works + *
+ */ + private Stack+ * initializes the traverser by adding the root node of the GUI model to the stack + *
+ */ + private Traverser() { + nodeStack.push(new StackEntry(root, 0)); + } + + /** + *+ * returns the first child of the current GUI element. On the first call of this method on + * the traverser the first of the root GUI elements of the GUI model is returned. If the + * current GUI element does not have children, the method returns null. If the GUI model + * is empty, then a call to this method will return null. The returned GUI element is the + * next one the traverser points to. + *
+ * + * @return as described. + */ + public IGUIElement firstChild() { + return pushChild(0); + } + + /** + *+ * returns true, if the current GUI element has a first child, i.e. if the next call to the + * method {@link #firstChild()} would return a GUI element or null. + *
+ * + * @return as described + */ + public boolean hasFirstChild() { + return + (nodeStack.peek().treeNode.children != null) && + (nodeStack.peek().treeNode.children.size() > 0); + } + + /** + *+ * returns the next sibling of the current GUI element. If there is no further sibling, + * null is returned. If the current GUI element is one of the root nodes, the next root + * node of the GUI model is returned. The returned GUI element is the next one the + * traverser points to. + *
+ * + * @return as described + */ + public IGUIElement nextSibling() { + int lastIndex = nodeStack.pop().index; + + IGUIElement retval = pushChild(lastIndex + 1); + if (retval == null) { + pushChild(lastIndex); + } + + return retval; + } + + /** + *+ * returns true, if the current GUI element has a further sibling, i.e. if a call to the + * method {@link #nextSibling()} will return a GUI element; + *
+ * + * @return as described + */ + public boolean hasNextSibling() { + StackEntry entry = nodeStack.pop(); + boolean result = nodeStack.peek().treeNode.children.size() > (entry.index + 1); + pushChild(entry.index); + return result; + } + + /** + *+ * returns the parent GUI element of the current GUI element. If the current GUI element + * is a root node, null is returned. If there is no current GUI element yet as the method + * {@link #firstChild()} was not called yet, null is returned. + *
+ * + * @return as described + */ + public IGUIElement parent() { + IGUIElement retval = null; + + if (nodeStack.size() > 1) { + nodeStack.pop(); + retval = nodeStack.peek().treeNode.guiElement; + } + + return retval; + } + + /** + *+ * internal method used for changing the state of the traverser. I.e. to switch to a + * specific child GUI element of the current one. + *
+ */ + private IGUIElement pushChild(int index) { + IGUIElement retVal = null; + + if ((nodeStack.peek().treeNode.children != null) && + (nodeStack.peek().treeNode.children.size() > index)) + { + nodeStack.push + (new StackEntry(nodeStack.peek().treeNode.children.get(index), index)); + retVal = nodeStack.peek().treeNode.guiElement; + } + + return retVal; + } + + /** + *+ * internal class needed to fill the stack with nodes of the GUI models and their + * respective index in the children of the parent node. + *
+ */ + private class StackEntry { + + /** */ + private TreeNode treeNode; + + /** */ + private int index; + + /** + *+ * creates a new stack entry. + *
+ */ + private StackEntry(TreeNode treeNode, int index) { + this.treeNode = treeNode; + this.index = index; + } + } + } + + /** + ** Used internally for building up the tree of GUI elements. *
Index: /trunk/autoquest-ui-swt/src/main/java/de/ugoe/cs/autoquest/ui/swt/ShowGuiModelDialog.java =================================================================== --- /trunk/autoquest-ui-swt/src/main/java/de/ugoe/cs/autoquest/ui/swt/ShowGuiModelDialog.java (revision 1085) +++ /trunk/autoquest-ui-swt/src/main/java/de/ugoe/cs/autoquest/ui/swt/ShowGuiModelDialog.java (revision 1086) @@ -119,9 +119,30 @@ private void buildGuiTree() { - for (IGUIElement element : model.getRootElements()) { + GUIModel.Traverser traverser = model.getTraverser(); + + IGUIElement root = traverser.firstChild(); + + while (root != null) { TreeItem child = new TreeItem(guiTree, SWT.NULL); - child.setText(element.toString()); - child.setData(element); - buildGuiTree(child, model.getChildren(element)); + child.setText(root.toString()); + child.setData(root); + buildGuiTree(child, traverser); + root = traverser.nextSibling(); + } + } + + private void buildGuiTree(TreeItem currentParent, GUIModel.Traverser traverser) { + if (traverser.hasFirstChild()) { + IGUIElement childElement = traverser.firstChild(); + + while (childElement != null) { + TreeItem child = new TreeItem(currentParent, SWT.NULL); + child.setText(childElement.toString()); + child.setData(childElement); + buildGuiTree(child, traverser); + childElement = traverser.nextSibling(); + } + + traverser.parent(); } }