Changeset 870 for trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlEvent.java

Timestamp:

10/12/12 14:04:09 (12 years ago)

Author:

pharms

Message:

• added some comments

File:

• trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlEvent.java (modified) (3 diffs)

trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlEvent.java

@@ -3 +3 @@
 /**
  * <p>
- * TODO comment
+ * represents an event caused by a user on a specific web site. An event contains the infos
+ * about the client ({@link HtmlClientInfos}, when ant where the event took place, the type of
+ * event and some additional infos such as the event coordinates or the number of the pressed
+ * key. 
  * </p>
  * 
@@ -11 +14 @@
 
     /**
-     * 
+     * infos about the client that caused the event
      */
     private HtmlClientInfos clientInfos;
 
     /**
-     * 
+     * the time stamp of the event
      */
     private Long time;
 
     /**
-     * 
+     * the path in the HTML DOM to the object on which the event was executed
      */
     private String path;
 
     /**
-     * 
+     * the type of the event, e.g. onclick
      */
     private String eventType;
 
     /**
-     * 
+     * the coordinates of the event, usually an array with two values (x and y)
      */
     private Integer[] coordinates;
 
     /**
-     * 
+     * if the event is a key event, the key that was pressed or released
      */
     private Integer key;
 
     /**
-     * 
+     * if the event is a scroll event, the resulting position of the scrolled element
      */
     private Integer scrollPosition;
@@ -47 +50 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes the event with all relevantinfos
      * </p>
      *
-     * @param clientInfos
-     * @param time
-     * @param path
-     * @param eventType
-     * @param coordinates
-     * @param key
-     * @param scrollPosition
+     * @param clientInfos    infos about the client that caused the event
+     * @param time           the time stamp of the event
+     * @param path           the path in the HTML DOM to the object on which the event was executed
+     * @param eventType      the type of the event, e.g. onclick
+     * @param coordinates    the coordinates of the event, usually an array with two values
+     *                       (x and y)
+     * @param key            if the event is a key event, the key that was pressed or released
+     * @param scrollPosition if the event is a scroll event, the resulting position of the
+     *                       scrolled element
      */
     HtmlEvent(HtmlClientInfos clientInfos,