aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/vaadin/annotations
diff options
context:
space:
mode:
authorLeif Åstrand <leif@vaadin.com>2012-06-27 17:12:49 +0300
committerLeif Åstrand <leif@vaadin.com>2012-06-27 17:12:49 +0300
commit48cc0f3973579ee6c5893b27e484afc3c87692ec (patch)
tree14f12c3d0b168c3af01b9bcea59832b2806e171f /src/com/vaadin/annotations
parent236fd821354b6906c9100c13f7912738ac19c70a (diff)
downloadvaadin-framework-48cc0f3973579ee6c5893b27e484afc3c87692ec.tar.gz
vaadin-framework-48cc0f3973579ee6c5893b27e484afc3c87692ec.zip
Javadocs for @StyleSheet and @JavaScript (#9044)
Diffstat (limited to 'src/com/vaadin/annotations')
-rw-r--r--src/com/vaadin/annotations/JavaScript.java16
-rw-r--r--src/com/vaadin/annotations/StyleSheet.java16
2 files changed, 32 insertions, 0 deletions
diff --git a/src/com/vaadin/annotations/JavaScript.java b/src/com/vaadin/annotations/JavaScript.java
index 8e0bc09958..3abe7467ba 100644
--- a/src/com/vaadin/annotations/JavaScript.java
+++ b/src/com/vaadin/annotations/JavaScript.java
@@ -9,8 +9,24 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+import com.vaadin.terminal.gwt.server.ClientConnector;
+
+/**
+ * If this annotation is present on a {@link ClientConnector} class, the
+ * framework ensures the referenced JavaScript files are loaded before the
+ * corresponding client-side connector is initialized.
+ *
+ * @author Vaadin Ltd
+ * @version @VERSION@
+ * @since 7.0.0
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface JavaScript {
+ /**
+ * JavaScript files to load before initializing the client-side connector.
+ *
+ * @return an array of JavaScript file urls
+ */
public String[] value();
}
diff --git a/src/com/vaadin/annotations/StyleSheet.java b/src/com/vaadin/annotations/StyleSheet.java
index 40f75511dd..7056853ff4 100644
--- a/src/com/vaadin/annotations/StyleSheet.java
+++ b/src/com/vaadin/annotations/StyleSheet.java
@@ -9,8 +9,24 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+import com.vaadin.terminal.gwt.server.ClientConnector;
+
+/**
+ * If this annotation is present on a {@link ClientConnector} class, the
+ * framework ensures the referenced style sheets are loaded before the
+ * corresponding client-side connector is initialized.
+ *
+ * @author Vaadin Ltd
+ * @version @VERSION@
+ * @since 7.0.0
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface StyleSheet {
+ /**
+ * Style sheets to load before initializing the client-side connector.
+ *
+ * @return an array of style sheet urls
+ */
public String[] value();
}