blob: 5400475fed9237a0b4ece1e986dfbb9bd04bd9fc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*
* Copyright 2000-2021 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.vaadin.server.ClientConnector;
/**
* If this annotation is present on a {@link ClientConnector} class, the
* framework ensures the referenced JavaScript files are loaded before the init
* method for the corresponding client-side connector is invoked.
* <p>
* Absolute URLs including protocol and host are used as is on the client-side.
* Relative URLs are mapped to APP/PUBLISHED/[url] which are by default served
* from the classpath relative to the class where the annotation is defined.
* <p>
* The file is only loaded if it has not already been loaded, determined as
* follows:
* <ul>
* <li>For absolute URLs, the URL is considered loaded if the same URL has
* previously been loaded using {@code @JavaScript} or if a script tag loaded
* from the same URL was present in the DOM when the Vaadin client-side was
* initialized.
* <li>For relative URLs, the URL is considered loaded if another file with the
* same name has already been loaded using {@code @JavaScript}, even if that
* file was loaded from a different folder.
* </ul>
* <p>
* Special Vaadin urls are also supported. The most useful is vaadin:// which
* maps to the location of the automatically published VAADIN folder located on
* your classpath in your resources. Using the VAADIN folder and vaadin:// you
* can publish JavaScript files which use images or other files with relative
* paths. Another example is the theme:// url which maps to the location of your
* current theme.
* <p>
* Example: <code>@JavaScript({"https://host.com/file1.js", "file2.js"})</code>
* on the class com.example.MyConnector would load the file
* https://host.com/file1.js as is and file2.js from /com/example/file2.js on
* the server's classpath using the ClassLoader that was used to load
* com.example.MyConnector.
* <p>
* For adding multiple JavaScript files for a single component, you can use this
* annotation multiple times.
*
* @author Vaadin Ltd
* @since 7.0.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(InternalContainerAnnotationForJS.class)
public @interface JavaScript {
/**
* JavaScript files to load before initializing the client-side connector.
*
* @return an array of JavaScript file URLs
*/
public String[] value();
}
|
