- * Returns the events of which this {@link TextInput} consists. + * Returns the events of which this {@link TextInput} consists. The returned list is immutable. *
* @@ -144,6 +145,5 @@ */ public List- * The text input detector iterates a list of events and searches for subsequent key events. - * Those are replaced by a single text input event representing the text entered through the key - * events. The replacement is only done, if the key events have a text field or text area as target + * The text input detector iterates a list of events and searches for subsequent key events. Those + * are replaced by a single text input event representing the text entered through the key events. + * The replacement is only done, if the key events have a text field or text area as target *
* @@ -29,23 +30,33 @@ */ public class TextInputDetector { - - /** the keyboard map to use for character recognition*/ + + /** the keyboard map to use for character recognition */ private KeyboardMap keyboardMap = KeyboardMapFactory.createKeyboardMap(Locale.GERMAN); - + /** the keys pressed in parallel */ List- * TODO: comment - *
- * + + /** + *+ * Constructor. Creates a new TextInputDectector that generates {@link TextInput} with + * {@link TextEquality#LEXICAL} equality. + *
+ * */ public TextInputDetector() { this(TextEquality.LEXICAL); } - + + /** + *+ * Constructor. Creates a new TextInputDectector that generates {@link TextInput} with a given + * {@link TextEquality} type. + *
+ * + * @param textEqualityType + * equality type of the generated events + */ public TextInputDetector(TextEquality textEqualityType) { this.textEqualityType = textEqualityType; @@ -54,10 +65,11 @@ /** *- * in the provided list of events, this method detects any event sequences that consists of - * key interactions and replaces them with a single text input interaction. This contains - * the entered text as well as the replaced key interaction events - *
- * - * @param sequence the event sequence to search for text input events + * in the provided list of events, this method detects any event sequences that consists of key + * interactions and replaces them with a single text input interaction. This contains the + * entered text as well as the replaced key interaction events + * + * + * @param sequence + * the event sequence to search for text input events * * @return the resulting sequence, in which key interactions on text fields and areas are @@ -66,5 +78,5 @@ public List* creates a single text input event as replacement for key interactions being part of the - * subsequence of events denoted by the start and end index in the provide event sequence. If - * no text was entered, because the subsequence only contained key released events, then no - * text input event is generated (the method returns null). + * subsequence of events denoted by the start and end index in the provide event sequence. If no + * text was entered, because the subsequence only contained key released events, then no text + * input event is generated (the method returns null). *
* @@ -157,13 +173,13 @@ * the event target to be used for the new event * - * @return a text input event representing the text input resulting from the events of - * the provided subsequence + * @return a text input event representing the text input resulting from the events of the + * provided subsequence * * @throws IllegalArgumentException * if the denoted subsequence contains other events than key interactions */ - private Event handleTextEntrySequence(List+ * Event type for selecting text. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class TextSelection implements IInteraction { - /** */ + /** + *+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; @@ -48,5 +55,5 @@ return false; } - + /* * (non-Javadoc) Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/ValueSelection.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/ValueSelection.java (revision 829) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/ValueSelection.java (revision 830) @@ -1,22 +1,36 @@ + package de.ugoe.cs.quest.eventcore.gui; /** - * TODO comment + *+ * Event type for selecting a value. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class ValueSelection+ * Id for object serialization. + *
+ */ private static final long serialVersionUID = 1L; - /** */ + /** + *+ * The selected value. + *
+ */ private T selectedValue; /** - * TODO: comment + *+ * Constructor. Creates a new ValueSelection. + *
* * @param selectedValue + * the selected value */ public ValueSelection(T selectedValue) { @@ -62,4 +76,8 @@ /** + *+ * Returns the selected value associated with this event. + *
+ * * @return the selectedValue */ @@ -81,12 +99,11 @@ ValueSelection otherValueSelection = (ValueSelection) obj; - return - ((otherValueSelection != null) && - ((selectedValue == otherValueSelection.selectedValue) || - ((selectedValue != null) && - (selectedValue.equals(otherValueSelection.selectedValue))))); + return ((otherValueSelection != null) && ((selectedValue == otherValueSelection.selectedValue) || ((selectedValue != null) && (selectedValue + .equals(otherValueSelection.selectedValue))))); } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see java.lang.Object#hashCode() */