aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/terminal/VariableOwner.java
diff options
context:
space:
mode:
authorMarc Englund <marc.englund@itmill.com>2007-11-19 14:03:05 +0000
committerMarc Englund <marc.englund@itmill.com>2007-11-19 14:03:05 +0000
commitf2e3722df9676436680afc0f1991e91e1696fb99 (patch)
tree6f255ff78abaf96f1e71a1f2c9ecd3b66647f4a2 /src/com/itmill/toolkit/terminal/VariableOwner.java
parent93291f532db9d545cf2a8dd98e2671f27cd197b0 (diff)
downloadvaadin-framework-f2e3722df9676436680afc0f1991e91e1696fb99.tar.gz
vaadin-framework-f2e3722df9676436680afc0f1991e91e1696fb99.zip
MASS REFORMAT.
According to http://toolkit.intra.itmill.com/trac/itmilltoolkit/wiki/CodingConventions svn changeset:2864/svn branch:trunk
Diffstat (limited to 'src/com/itmill/toolkit/terminal/VariableOwner.java')
-rw-r--r--src/com/itmill/toolkit/terminal/VariableOwner.java175
1 files changed, 89 insertions, 86 deletions
diff --git a/src/com/itmill/toolkit/terminal/VariableOwner.java b/src/com/itmill/toolkit/terminal/VariableOwner.java
index b730125d34..93bdb7d780 100644
--- a/src/com/itmill/toolkit/terminal/VariableOwner.java
+++ b/src/com/itmill/toolkit/terminal/VariableOwner.java
@@ -61,90 +61,93 @@ import java.util.Set;
*/
public interface VariableOwner {
- /**
- * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit 5.
- * *
- * @return Set of <code>VariableOwners</code> this component directly
- * depend on, <code>null</code> if this component does not depend
- * on anybody.
- * @deprecated
- */
- public Set getDirectDependencies();
-
- /**
- * Called when one or more variables handled by the implementing class are
- * changed.
- *
- * @param source
- * the Source of the variable change. This is the origin of the
- * event. For example in Web Adapter this is the request.
- * @param variables
- * the Mapping from variable names to new variable values.
- */
- public void changeVariables(Object source, Map variables);
-
- /**
- * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit 5.
- *
- * @param depended
- * the <code>VariableOwner</code> component who this component
- * depends on.
- * @deprecated
- */
- public void dependsOn(VariableOwner depended);
-
- /**
- * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit 5.
- *
- * @param depended
- * the component to be removed from this component's dependency
- * list.
- * @deprecated
- */
- public void removeDirectDependency(VariableOwner depended);
-
- /**
- * <p>
- * Tests if the variable owner is enabled or not. The terminal should not
- * send any variable changes to disabled variable owners.
- * </p>
- *
- * @return <code>true</code> if the variable owner is enabled,
- * <code>false</code> if not
- */
- public boolean isEnabled();
-
- /**
- * <p>
- * Tests if the variable owner is in immediate mode or not. Being in
- * immediate mode means that all variable changes are required to be sent
- * back from the terminal immediately when they occur.
- * </p>
- *
- * <p>
- * <strong>Note:</strong> <code>VariableOwner</code> does not include a
- * set- method for the immediateness property. This is because not all
- * VariableOwners wish to offer the functionality. Such VariableOwners are
- * never in the immediate mode, thus they always return <code>false</code>
- * in {@link #isImmediate()}.
- * </p>
- *
- * @return <code>true</code> if the component is in immediate mode,
- * <code>false</code> if not.
- */
- public boolean isImmediate();
-
- /**
- * VariableOwner error event.
- */
- public interface ErrorEvent extends Terminal.ErrorEvent {
-
- /**
- * Gets the source VariableOwner.
- *
- * @return the variable owner.
- */
- public VariableOwner getVariableOwner();
-
- }
+ /**
+ * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit
+ * 5. *
+ *
+ * @return Set of <code>VariableOwners</code> this component directly
+ * depend on, <code>null</code> if this component does not depend
+ * on anybody.
+ * @deprecated
+ */
+ public Set getDirectDependencies();
+
+ /**
+ * Called when one or more variables handled by the implementing class are
+ * changed.
+ *
+ * @param source
+ * the Source of the variable change. This is the origin of
+ * the event. For example in Web Adapter this is the request.
+ * @param variables
+ * the Mapping from variable names to new variable values.
+ */
+ public void changeVariables(Object source, Map variables);
+
+ /**
+ * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit
+ * 5.
+ *
+ * @param depended
+ * the <code>VariableOwner</code> component who this
+ * component depends on.
+ * @deprecated
+ */
+ public void dependsOn(VariableOwner depended);
+
+ /**
+ * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit
+ * 5.
+ *
+ * @param depended
+ * the component to be removed from this component's
+ * dependency list.
+ * @deprecated
+ */
+ public void removeDirectDependency(VariableOwner depended);
+
+ /**
+ * <p>
+ * Tests if the variable owner is enabled or not. The terminal should not
+ * send any variable changes to disabled variable owners.
+ * </p>
+ *
+ * @return <code>true</code> if the variable owner is enabled,
+ * <code>false</code> if not
+ */
+ public boolean isEnabled();
+
+ /**
+ * <p>
+ * Tests if the variable owner is in immediate mode or not. Being in
+ * immediate mode means that all variable changes are required to be sent
+ * back from the terminal immediately when they occur.
+ * </p>
+ *
+ * <p>
+ * <strong>Note:</strong> <code>VariableOwner</code> does not include a
+ * set- method for the immediateness property. This is because not all
+ * VariableOwners wish to offer the functionality. Such VariableOwners are
+ * never in the immediate mode, thus they always return <code>false</code>
+ * in {@link #isImmediate()}.
+ * </p>
+ *
+ * @return <code>true</code> if the component is in immediate mode,
+ * <code>false</code> if not.
+ */
+ public boolean isImmediate();
+
+ /**
+ * VariableOwner error event.
+ */
+ public interface ErrorEvent extends Terminal.ErrorEvent {
+
+ /**
+ * Gets the source VariableOwner.
+ *
+ * @return the variable owner.
+ */
+ public VariableOwner getVariableOwner();
+
+ }
}