Changeset 2146 for trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/guimodel/GUIElementGroup.java

Timestamp:

05/19/17 11:31:29 (7 years ago)

Author:

pharms

Message:

• refactored GUI model so that hierarchical event target structures can also be used and created by plugins not being strictly for GUIs

File:

• trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/guimodel/GUIElementGroup.java (modified) (8 diffs, 1 prop)

trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/guimodel/GUIElementGroup.java

@@ -1 @@
-//   Copyright 2012 Georg-August-Universität Göttingen, Germany
+//   Copyright 2015 Georg-August-Universität Göttingen, Germany
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
@@ -15 +15 @@
 package de.ugoe.cs.autoquest.eventcore.guimodel;
 
-import java.util.Collections;
-import java.util.LinkedList;
-import java.util.List;
+import de.ugoe.cs.autoquest.eventcore.HierarchicalEventTargetGroup;
+import de.ugoe.cs.autoquest.eventcore.IEventTargetSpec;
 
 /**
  * <p>
- * This class is a dummy GUI element to represent groups of GUI elements. A group of GUI elements
- * can be integrated in any GUI model using the method
- * {@link GUIModel#groupGUIElements(java.util.List, String)}. A group has the same behavior as
- * any other parent GUI element.
+ * implementation of event target groups for GUI elements
  * </p>
  * 
  * @author Patrick Harms
  */
-public class GUIElementGroup extends AbstractDefaultGUIElement {
+public class GUIElementGroup extends HierarchicalEventTargetGroup implements IGUIElement {
 
-    /**
-     * <p>
-     * default serial version UID
-     * </p>
-     */
+    /**  */
     private static final long serialVersionUID = 1L;
     
-    /**
-     * the list of grouped GUIElements
-     */
-    private List<IGUIElement> groupedGUIElements = new LinkedList<IGUIElement>();
+    /** the internal fake event target specification */
+    private GroupSpecification groupSpecification;
+    
+    /** stores if the usage of the group was observed (just to match the implemented interface */
+    private boolean usageObserved = false;
 
     /**
@@ -48 +41 @@
      * </p>
      *
-     * @param groupName the name of the GUI element group
-     * @param parent    the optional parent GUI element of the group
-     * @param guiModel  the GUI model to which the group will belong
+     * @param groupName        the name of the GUI element group
+     * @param parent           the optional parent GUI element of the group
+     * @param eventTargetModel the GUI model to which the group will belong
      */
-    public GUIElementGroup(String groupName, IGUIElement parent, GUIModel guiModel) {
-        super(new GroupSpecification(groupName), parent);
-        super.setGUIModel(guiModel);
+    public GUIElementGroup(String      groupName,
+                           IGUIElement parent,
+                           GUIModel    guiModel)
+    {
+        super(groupName, parent, guiModel);
+        groupSpecification = new GroupSpecification(groupName);
     }
 
     /* (non-Javadoc)
-     * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElement#updateSpecification(IGUIElementSpec)
+     * @see de.ugoe.cs.autoquest.eventcore.AbstractDefaultHierarchicalEventTarget#getSpecification()
      */
     @Override
-    public final void updateSpecification(IGUIElementSpec furtherSpec) {
-        // do nothing
-    }
-
-    /* (non-Javadoc)
-     * @see de.ugoe.cs.autoquest.eventcore.IEventTarget#getPlatform()
-     */
-    @Override
-    public String getPlatform() {
-        return "none";
+    public IGUIElementSpec getSpecification() {
+        return groupSpecification;
     }
 
@@ -78 +66 @@
     @Override
     public String getStringIdentifier() {
-        return ((GroupSpecification) super.getSpecification()).name;
+        return groupSpecification.name;
     }
 
     /* (non-Javadoc)
-     * @see java.lang.Object#toString()
+     * @see de.ugoe.cs.autoquest.eventcore.AbstractDefaultHierarchicalEventTarget#getParent()
      */
     @Override
-    public String toString() {
-        return getStringIdentifier();
+    public IGUIElement getParent() {
+        return (IGUIElement) super.getParent();
     }
 
@@ -98 +86 @@
 
     /* (non-Javadoc)
+     * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElement#getGUIModel()
+     */
+    @Override
+    public GUIModel getGUIModel() {
+        return (GUIModel) super.getEventTargetModel();
+    }
+
+    /* (non-Javadoc)
+     * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElement#isUsed()
+     */
+    @Override
+    public boolean isUsed() {
+        return usageObserved;
+    }
+
+    /* (non-Javadoc)
+     * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElement#markUsed()
+     */
+    @Override
+    public void markUsed() {
+        usageObserved = true;
+    }
+
+    /* (non-Javadoc)
      * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElement#getDistanceTo(IGUIElement)
      */
@@ -105 +117 @@
             return 0.0;
         }
-        else if (super.getParent() != null) {
-            return super.getParent().getDistanceTo(otherElement);
+        else if (getParent() != null) {
+            return getParent().getDistanceTo(otherElement);
         }
         else {
             return 1.0;
         }
-    }
-
-    /**
-     * <p>
-     * returns the list of GUI elements belonging to this group.
-     * </p>
-     * 
-     * @return the GUI elements belonging to this group
-     * 
-     */
-    public List<IGUIElement> getGroupedElements() {
-        return Collections.unmodifiableList(groupedGUIElements);
-    }
-    
-    /**
-     * <p>
-     * allows adding a new GUI element to the group
-     * </p>
-     *
-     * @param guiElement the new member of the group
-     */
-    void addToGroup(IGUIElement guiElement) {
-        this.groupedGUIElements.add(guiElement);
     }
     
@@ -174 +163 @@
 
         /* (non-Javadoc)
+         * @see de.ugoe.cs.autoquest.eventcore.IEventTargetSpec#getSimilarity(IEventTargetSpec)
+         */
+        @Override
+        public boolean getSimilarity(IEventTargetSpec other) {
+            return
+                (other instanceof GroupSpecification) &&
+                name.equals(((GroupSpecification) other).name);
+        }
+
+        /* (non-Javadoc)
          * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElementSpec#getType()
          */
@@ -189 +188 @@
         }
 
-        /* (non-Javadoc)
-         * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElementSpec#getSimilarity(IGUIElementSpec)
-         */
-        @Override
-        public boolean getSimilarity(IGUIElementSpec other) {
-            return
-                (other instanceof GroupSpecification) &&
-                name.equals(((GroupSpecification) other).name);
-        }
-
     }
-
 }