- * An interaction is a special event type which represents the interaction of a user with an - * element of a GUI. An example is a mouse click on a button. + * An interaction is a special event type which represents the interaction of a user with an element + * of a GUI. An example is a mouse click on a button. *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ -public interface IInteraction extends IEventType -{ +public interface IInteraction extends IEventType { /** - * @return + *+ * Determines whether an event type starts a logical sequence, i.e., a task. + *
+ * + * @return true if a logical sequence is started; false otherwise */ public boolean startsLogicalSequence(); /** - * @return + *+ * Determines whether an event type finishes a logical sequence, i.e., a task. + *
+ * + * @return true if a logical sequence is finished; false otherwise */ public boolean finishesLogicalSequence(); Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyInteraction.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyInteraction.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyInteraction.java (revision 786) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.eventcore.gui; @@ -4,19 +5,34 @@ /** - * TODO comment + *+ * Base class for all keyboard interaction event types. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public abstract class KeyInteraction implements IInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; - /** the key, that was actually pressed */ + /** + *+ * the key associated with the interaction + *
+ */ private VirtualKey key; /** + *+ * Constructor. Creates a new KeyInteraction. + *
+ * * @param key + * key associated with the interaction */ public KeyInteraction(VirtualKey key) { @@ -26,5 +42,9 @@ /** + *+ * Returns the key associated with the interaction. + *
* + * @return the key */ public VirtualKey getKey() { Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyPressed.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyPressed.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyPressed.java (revision 786) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.eventcore.gui; @@ -4,16 +5,26 @@ /** - * TODO comment + *+ * Event type for pressing down a key. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class KeyPressed extends KeyInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; /** - * @param key + *+ * Constructor. Creates a new {@link KeyPressed} event type. + *
+ * + * @see KeyInteraction#KeyInteraction(VirtualKey) */ public KeyPressed(VirtualKey key) { @@ -74,5 +85,7 @@ } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see java.lang.Object#hashCode() */ Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyReleased.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyReleased.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyReleased.java (revision 786) @@ -4,16 +4,26 @@ /** - * TODO comment + *+ * Event type for releasing a key. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Steffen Herbold */ public class KeyReleased extends KeyInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; /** - * @param key + *+ * Constructor. Creates a new {@link KeyReleased} event type. + *
+ * + * @see KeyInteraction#KeyInteraction(VirtualKey) */ public KeyReleased(VirtualKey key) { Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyTyped.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyTyped.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyTyped.java (revision 786) @@ -4,11 +4,27 @@ import de.ugoe.cs.tasktree.keyboardmaps.VirtualKey; +/** + *+ * Event type for typing a key, i.e., pressing and releasing it right away. + *
+ * + * @version 1.0 + * @author Steffen Herbold + */ public class KeyTyped extends KeyInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; /** - * @param key + *+ * Constructor. Creates a new {@link KeyTyped} event type. + *
+ * + * @see KeyInteraction#KeyInteraction(VirtualKey) */ public KeyTyped(VirtualKey key) { @@ -51,5 +67,6 @@ */ public boolean finishesLogicalSequence() { - return false; + // TODO handle lock keys correctly + return super.getKey().isCombinationKey(); } Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyboardFocusChange.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyboardFocusChange.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/KeyboardFocusChange.java (revision 786) @@ -3,12 +3,19 @@ /** - * TODO comment + *+ * Event type for keyboard focus changes. The target of the respective event has obtained the + * keyboard focus of the application. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class KeyboardFocusChange implements IInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonDown.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonDown.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonDown.java (revision 786) @@ -1,17 +1,28 @@ + package de.ugoe.cs.quest.eventcore.gui; /** - * TODO comment + *+ * Event type for pressing a mouse button. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class MouseButtonDown extends MouseButtonInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; /** - * @param button + *+ * Constructor. Creates a new {@link MouseButtonDown} event type. + *
+ * + * @see MouseButtonInteraction#MouseButtonInteraction(Button) */ public MouseButtonDown(Button button) { @@ -77,5 +88,5 @@ return false; } - + /* * (non-Javadoc) Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonInteraction.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonInteraction.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonInteraction.java (revision 786) @@ -1,25 +1,48 @@ + package de.ugoe.cs.quest.eventcore.gui; /** - * TODO comment + *+ * Base class for all mouse interaction event types. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public abstract class MouseButtonInteraction extends MouseInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; - /** */ + /** + *+ * Describes the pressed mouse button. + *
+ * + * @version 1.0 + * @author Patrick Harms + */ public static enum Button { LEFT, MIDDLE, RIGHT, X; } - /** the button used for mouse interaction */ + /** + *+ * The button used for mouse interaction + *
+ */ private Button button; /** + *+ * Constructor. Creates a new {@link MouseButtonInteraction} + *
* + * @param button + * the button associated with the interaction */ public MouseButtonInteraction(Button button) { @@ -28,10 +51,14 @@ /** - * @return Returns the button. + *+ * Returns the button associated with the interaction. + *
+ * + * @return the button */ public Button getButton() { return button; } - + /* * (non-Javadoc) Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonUp.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonUp.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonUp.java (revision 786) @@ -1,17 +1,28 @@ + package de.ugoe.cs.quest.eventcore.gui; /** - * TODO comment + *+ * Event type for releasing a mouse button. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class MouseButtonUp extends MouseButtonInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; /** - * @param button + *+ * Constructor. Creates a new {@link MouseButtonUp} event type. + *
+ * + * @see MouseButtonInteraction#MouseButtonInteraction(Button) */ public MouseButtonUp(Button button) { Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClick.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClick.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClick.java (revision 786) @@ -1,17 +1,28 @@ + package de.ugoe.cs.quest.eventcore.gui; /** - * TODO comment + *+ * Event type for a mouse click, i.e., pressing and releasing it right away. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class MouseClick extends MouseButtonInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; /** - * @param button + *+ * Constructor. Creates a new {@link MouseClick} event type. + *
+ * + * @see MouseButtonInteraction#MouseButtonInteraction(Button) */ public MouseClick(Button button) { Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClickCondenser.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClickCondenser.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClickCondenser.java (revision 786) @@ -1,7 +1,3 @@ -// Module : $RCSfile: MouseClickCondenser.java,v $ -// Version : $Revision: 0.0 $ $Author: pharms $ $Date: 31.08.2012 $ -// Project : quest-core-events -// Creation : 2012 by pharms -// Copyright : Patrick Harms, 2012 + package de.ugoe.cs.quest.eventcore.gui; @@ -14,13 +10,13 @@ /** *- * This class condenses mouse clicks, i.e. it reduces a sequence of mouse button down, - * mouse button up and mouse click with the same button on the same event target to a single - * mouse click with that button on that target. The mouse button down and mouse button up events - * are discarded. For this, it iterates the provided sequence and identifies any match of the named - * event sequence pattern. This match is condensed to the mouse click event. + * This class condenses mouse clicks, i.e. it reduces a sequence of mouse button down, mouse button + * up and mouse click with the same button on the same event target to a single mouse click with + * that button on that target. The mouse button down and mouse button up events are discarded. For + * this, it iterates the provided sequence and identifies any match of the named event sequence + * pattern. This match is condensed to the mouse click event. *
* - * @version $Revision: $ $Date: 31.08.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ public class MouseClickCondenser { @@ -29,10 +25,11 @@ ** This method performs the work described in the description of the class. A new list is - * instantiated and returned. This list is filled with the events provided by the sequence - * being the parameter of the method except for mouse button down and mouse button up events - * which are followed by a mouse click event with the same button on the same target. + * instantiated and returned. This list is filled with the events provided by the sequence being + * the parameter of the method except for mouse button down and mouse button up events which are + * followed by a mouse click event with the same button on the same target. *
* - * @param sequence the event sequence to condense the mouse clicks in + * @param sequence + * the event sequence to condense the mouse clicks in * * @return the resulting sequence, in which mouse clicks are condensed to single mouse click @@ -41,5 +38,5 @@ public List+ * Event type for a double click, i.e., pressing the mouse, releasing it, pressing it, and releasing + * it again right away. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class MouseDoubleClick extends MouseButtonInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; /** - * @param button + *+ * Constructor. Creates a new {@link MouseDoubleClick} event type. + *
+ * + * @see MouseButtonInteraction#MouseButtonInteraction(Button) */ public MouseDoubleClick(Button button) { Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseInteraction.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseInteraction.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseInteraction.java (revision 786) @@ -2,12 +2,18 @@ /** - * TODO comment + *+ * Base class for all mouse interaction event types. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public abstract class MouseInteraction implements IInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/TextInput.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/TextInput.java (revision 785) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/TextInput.java (revision 786) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.eventcore.gui; @@ -7,46 +8,95 @@ /** *- * A text input represents a list of key events that together represent entering text into a - * text field or text area. + * A text input represents a list of key events that together represent entering text into a text + * field or text area. *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms, Steffen Herbold */ public class TextInput implements IInteraction { - - public enum TextEquality {LEXICAL, SYNTACTICAL, SEMANTICAL}; - - /** */ + + /** + *+ * Defines how the {@link TextInput}s are evaluated as equal. + *
+ * + * @version 1.0 + * @author Steffen Herbold + */ + public enum TextEquality { + /** + *+ * Two text inputs are equal if their {@link TextInput#textInputEvents} are equal. + *
+ */ + LEXICAL, + /** + *+ * Two text inputs are equal if their {@link TextInput#enteredText}s are equal. + *
+ */ + SYNTACTICAL, + /** + *+ * All text inputs are equal. + *
+ */ + SEMANTICAL + }; + + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; - - /** the text resulting from the text input events */ + + /** + *+ * The text resulting from the text input events. + *
+ */ private String enteredText; - /** the text input events that caused the entering of the text */ + /** + *+ * The text input events that caused the entering of the text. + *
+ */ private List+ * Defines how this TextInput event evaluates the equality. + *
+ */ private final TextEquality equalityType; /** *- * TODO: comment - *
- * + * Constructor. Creates a new {@link TextInput} with {@link TextEquality#LEXICAL} equality. + * + * * @param enteredText + * text resulting from the inputs * @param textInputEvents + * text input events of which this input consists */ public TextInput(String enteredText, List- * TODO: comment - *
- * + + /** + *+ * Constructor. Creates a new {@link TextInput}.. + *
+ * * @param enteredText + * text resulting from the inputs * @param textInputEvents + * text input events of which this input consists * @param equalityType + * defines how this event evaluates the equality (@see {@link TextEquality}) */ public TextInput(String enteredText, List+ * Returns the entered text. + *
+ * + * @return the entered text */ public String getEnteredText() { @@ -83,7 +137,12 @@ /** + *+ * Returns the events of which this {@link TextInput} consists. + *
+ * * @return the textInputEvents */ public List+ * TODO: comment + *
+ * + */ public TextInputDetector() { this(TextEquality.LEXICAL);