diff options
| author | Matti Tahvonen <matti.tahvonen@itmill.com> | 2010-11-09 09:37:00 +0000 |
|---|---|---|
| committer | Matti Tahvonen <matti.tahvonen@itmill.com> | 2010-11-09 09:37:00 +0000 |
| commit | 204748a6bdaeb46483ec1e225df43aeb10bdc99a (patch) | |
| tree | cbc77a354571dd3cc6bad7807fd3ca5a79c0518e /src/com/vaadin/event | |
| parent | d9759417af2859995f4c3eaf407edc904a3bfa0b (diff) | |
| download | vaadin-framework-204748a6bdaeb46483ec1e225df43aeb10bdc99a.tar.gz vaadin-framework-204748a6bdaeb46483ec1e225df43aeb10bdc99a.zip | |
fixes #2387: added TextChangeEvent that can be used to listen text changes while the user is typing or otherwise modifying the text
svn changeset:15923/svn branch:6.5
Diffstat (limited to 'src/com/vaadin/event')
| -rw-r--r-- | src/com/vaadin/event/FieldEvents.java | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/src/com/vaadin/event/FieldEvents.java b/src/com/vaadin/event/FieldEvents.java index 202b079536..818341a5d1 100644 --- a/src/com/vaadin/event/FieldEvents.java +++ b/src/com/vaadin/event/FieldEvents.java @@ -11,6 +11,8 @@ import com.vaadin.terminal.gwt.client.EventId; import com.vaadin.tools.ReflectTools;
import com.vaadin.ui.Component;
import com.vaadin.ui.Field;
+import com.vaadin.ui.Field.ValueChangeEvent;
+import com.vaadin.ui.TextField;
/**
* Interface that serves as a wrapper for {@link Field} related events.
@@ -173,4 +175,76 @@ public interface FieldEvents { public void blur(BlurEvent event);
}
+ /**
+ * TextChangeEvents are fired when the user is editing the text content of a
+ * field. Most commonly text change events are triggered by typing text with
+ * keyboard, but e.g. pasting content from clip board to a text field also
+ * triggers an event.
+ * <p>
+ * TextChangeEvents differ from {@link ValueChangeEvent}s so that they are
+ * triggered repeatedly while the end user is filling the field.
+ * ValueChangeEvents are not fired until the user for example hits enter or
+ * focuses another field. Also note the difference that TextChangeEvents are
+ * only fired if the change is triggered from the user, while
+ * ValueChangeEvents are also fired if the field value is set by the
+ * application code.
+ * <p>
+ * The {@link TextChangeNotifier}s implementation may decide when exactly
+ * TextChangeEvents are fired. TextChangeEvents are not necessary fire for
+ * example on each key press, but buffered with a small delay. The
+ * {@link TextField} component supports different modes for triggering
+ * TextChangeEvents.
+ *
+ * @see TextChangeListener
+ * @see TextChangeNotifier
+ * @see TextField#setTextChangeEventMode(com.vaadin.ui.TextField.TextChangeEventMode)
+ * @since 6.5
+ */
+ public static abstract class TextChangeEvent extends Component.Event {
+ public TextChangeEvent(Component source) {
+ super(source);
+ }
+
+ /**
+ * @return the text content of the field after the
+ * {@link TextChangeEvent}
+ */
+ public abstract String getCurrentTextContent();
+
+ /**
+ * @return the cursor position during after the {@link TextChangeEvent}
+ */
+ public abstract int getCursorPosition();
+ }
+
+ /**
+ * A listener for {@link TextChangeEvent}s.
+ *
+ * @since 6.5
+ */
+ public interface TextChangeListener extends ComponentEventListener {
+
+ public static String EVENT_ID = "ie";
+ public static Method EVENT_METHOD = ReflectTools.findMethod(
+ TextChangeListener.class, "textChange", TextChangeEvent.class);
+
+ /**
+ * This method is called repeatedly while the text is edited by a user.
+ *
+ * @param event
+ * the event providing details of the text change
+ */
+ public void textChange(TextChangeEvent event);
+ }
+
+ /**
+ * An interface implemented by a {@link Field} supporting
+ * {@link TextChangeEvent}s. An example a {@link TextField} supports
+ * {@link TextChangeListener}s.
+ */
+ public interface TextChangeNotifier extends Serializable {
+ public void addListener(TextChangeListener listener);
+
+ public void removeListener(TextChangeListener listener);
+ }
}
|