diff options
author | Artur Signell <artur.signell@itmill.com> | 2009-11-23 14:15:17 +0000 |
---|---|---|
committer | Artur Signell <artur.signell@itmill.com> | 2009-11-23 14:15:17 +0000 |
commit | e5caa74cc45cdd63a0edae9989010699dfaea1be (patch) | |
tree | 26aef9bf51080fb5c94df0b1ba81dbad865c0115 /src/com/vaadin/event | |
parent | ab4e63b78dd81ccc99d81d3fc4cb9f9455d5fce6 (diff) | |
download | vaadin-framework-e5caa74cc45cdd63a0edae9989010699dfaea1be.tar.gz vaadin-framework-e5caa74cc45cdd63a0edae9989010699dfaea1be.zip |
Patch #4 from #3234 "JavaDoc and ClientEventList Update"
svn changeset:9959/svn branch:event-framework-3234
Diffstat (limited to 'src/com/vaadin/event')
-rw-r--r-- | src/com/vaadin/event/ClientEventList.java | 40 | ||||
-rw-r--r-- | src/com/vaadin/event/FieldEvents.java | 49 | ||||
-rw-r--r-- | src/com/vaadin/event/MouseEvents.java | 35 |
3 files changed, 103 insertions, 21 deletions
diff --git a/src/com/vaadin/event/ClientEventList.java b/src/com/vaadin/event/ClientEventList.java index 633026ca8b..e2008085c4 100644 --- a/src/com/vaadin/event/ClientEventList.java +++ b/src/com/vaadin/event/ClientEventList.java @@ -9,11 +9,13 @@ import java.util.Map; /**
*
- * this class is used to store the registered events so a list of the required
- * client event identifiers (that the client-side should listen for and send to
- * the server-side) can be sent to the client-side via a variable.
+ * <code>ClientEventList</code> class used to store the registered events so a
+ * list of the required client event identifiers (that the client-side should
+ * listen for and send to the server-side) can be sent to the client-side via a
+ * variable.
*
* @author davengo GmbH (Germany/Berlin, www.davengo.com)
+ * @since 6.2
*
*/
public class ClientEventList {
@@ -21,11 +23,15 @@ public class ClientEventList { /**
* the list containing the registered client events (as strings for
* client-side transfer)
+ *
+ * @since 6.2
*/
private Map<String, Integer> clientEvents = null;
/**
* initializes the list if necessary
+ *
+ * @since 6.2
*/
private void checkList() {
if (clientEvents == null) {
@@ -40,14 +46,23 @@ public class ClientEventList { *
* @param eventIdentifier
* the identifier of the event to listen for
+ *
+ * @return true, if the event is newly added to the list<br>
+ * false, if the list already contained the event (the internal
+ * counter was incremented)
+ *
+ * @since 6.2
*/
- public void listenEvent(String eventIdentifier) {
+ public boolean listenEvent(String eventIdentifier) {
checkList();
- if (!clientEvents.keySet().contains(eventIdentifier))
+ if (!clientEvents.keySet().contains(eventIdentifier)) {
clientEvents.put(eventIdentifier, 1);
- else
+ return true;
+ } else {
clientEvents.put(eventIdentifier,
clientEvents.get(eventIdentifier) + 1);
+ return false;
+ }
}
/**
@@ -58,19 +73,28 @@ public class ClientEventList { *
* @param eventIdentifier
* the identifier of the event to stop listening for
+ * @return true, if the event was removed from the list<br>
+ * false, if the event is hold in list (the internal counter was
+ * greater than zero)
*/
- public void unlistenEvent(String eventIdentifier) {
+ public boolean unlistenEvent(String eventIdentifier) {
checkList();
if (clientEvents.keySet().contains(eventIdentifier)) {
clientEvents.put(eventIdentifier,
clientEvents.get(eventIdentifier) - 1);
- if (clientEvents.get(eventIdentifier) <= 0)
+ if (clientEvents.get(eventIdentifier) <= 0) {
clientEvents.remove(eventIdentifier);
+ return true;
+ }
+ return false;
}
+ return false;
}
/**
* @return a string array containing all registered events
+ *
+ * @since 6.2
*/
public String[] getEvents() {
if (clientEvents == null) {
diff --git a/src/com/vaadin/event/FieldEvents.java b/src/com/vaadin/event/FieldEvents.java index ab81ac85c0..3becb58aef 100644 --- a/src/com/vaadin/event/FieldEvents.java +++ b/src/com/vaadin/event/FieldEvents.java @@ -1,3 +1,7 @@ +/*
+@ITMillApache2LicenseForJavaFiles@
+ */
+
package com.vaadin.event;
import java.lang.reflect.Method;
@@ -7,10 +11,12 @@ import com.vaadin.ui.Component; public interface FieldEvents {
- /*
- * component focus event and listener
+ /**
+ * <code>FocusEvent</code> class for holding additional event information.
+ * Fired when a <code>Field</code> receives keyboard focus.
+ *
+ * @since 6.2
*/
-
public class FocusEvent extends Component.Event {
private static final long serialVersionUID = -7644184999481404162L;
@@ -20,6 +26,13 @@ public interface FieldEvents { }
}
+ /**
+ * <code>FocusListener</code> interface for listening for
+ * <code>FocusEvent</code> fired by a <code>Field</code>.
+ *
+ * @see FocusEvent
+ * @since 6.2
+ */
public interface FocusListener extends ComponentEventListener {
public static final Method focusMethod = ReflectTools.findMethod(
@@ -34,10 +47,12 @@ public interface FieldEvents { public void focus(FocusEvent event);
}
- /*
- * component blur event and listener
+ /**
+ * <code>BlurEvent</code> class for holding additional event information.
+ * Fired when a <code>Field</code> loses keyboard focus.
+ *
+ * @since 6.2
*/
-
public class BlurEvent extends Component.Event {
private static final long serialVersionUID = -7644184999481404162L;
@@ -47,6 +62,13 @@ public interface FieldEvents { }
}
+ /**
+ * <code>BlurListener</code> interface for listening for
+ * <code>BlurEvent</code> fired by a <code>Field</code>.
+ *
+ * @see BlurEvent
+ * @since 6.2
+ */
public interface BlurListener extends ComponentEventListener {
public static final Method blurMethod = ReflectTools.findMethod(
@@ -61,10 +83,12 @@ public interface FieldEvents { public void blur(BlurEvent event);
}
- /*
- * component value change event
+ /**
+ * <code>ValueChangeEvent</code> class for holding additional event
+ * information. Fired when the value of a <code>Field</code> changes.
+ *
+ * @since 6.2
*/
-
public class ValueChangeEvent extends Component.Event {
private static final long serialVersionUID = -7644184999481404162L;
@@ -74,6 +98,13 @@ public interface FieldEvents { }
}
+ /**
+ * <code>ValueChangeListener</code> interface for listening for
+ * <code>ValueChangeEvent</code> fired by a <code>Field</code>.
+ *
+ * @see ValueChangeEvent
+ * @since 6.2
+ */
public interface ValueChangeListener extends ComponentEventListener {
public static final Method valueChangeMethod = ReflectTools.findMethod(
diff --git a/src/com/vaadin/event/MouseEvents.java b/src/com/vaadin/event/MouseEvents.java index 19fdff8cc4..bf417c1ebf 100644 --- a/src/com/vaadin/event/MouseEvents.java +++ b/src/com/vaadin/event/MouseEvents.java @@ -1,3 +1,7 @@ +/* +@ITMillApache2LicenseForJavaFiles@ + */ + package com.vaadin.event; import java.lang.reflect.Method; @@ -8,12 +12,18 @@ import com.vaadin.ui.Component; public interface MouseEvents { /** - * defines the clicked mouse button for a ComponentClickEvents + * defines the clicked mouse button for ClickEvents */ public enum MouseButton { LEFT, RIGHT, MIDDLE } + /** + * <code>ClickEvent</code> class for holding additional event information. + * Fired when the user clicks on a <code>Component</code>. + * + * @since 6.2 + */ public class ClickEvent extends Component.Event { private MouseButton mouseButton; @@ -37,6 +47,13 @@ public interface MouseEvents { } + /** + * <code>ClickListener</code> interface for listening for + * <code>ClickEvent</code> fired by a <code>Component</code>. + * + * @see ClickEvent + * @since 6.2 + */ public interface ClickListener extends ComponentEventListener { public static final Method clickMethod = ReflectTools.findMethod( @@ -51,10 +68,13 @@ public interface MouseEvents { public void click(ClickEvent event); } - /* - * component double click event + /** + * <code>DoubleClickEvent</code> class for holding additional event + * information. Fired when the user double-clicks on a + * <code>Component</code>. + * + * @since 6.2 */ - public class DoubleClickEvent extends Component.Event { private static final long serialVersionUID = -7644184999481404162L; @@ -64,6 +84,13 @@ public interface MouseEvents { } } + /** + * <code>DoubleClickListener</code> interface for listening for + * <code>DoubleClickEvent</code> fired by a <code>Component</code>. + * + * @see DoubleClickEvent + * @since 6.2 + */ public interface DoubleClickListener extends ComponentEventListener { public static final Method doubleClickMethod = ReflectTools.findMethod( |