blob: f5c5b57545db1a73a01a3042e204354a39d6a93d (
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
|
/*
* 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 HTML imports are loaded before the init
* method for the corresponding client-side connector is invoked.
* <p>
* Note that not all browsers yet support HTML imports. If a polyfill is needed
* to load HTML imports, it must be loaded before HTML Imports can be loaded.
* There is no automatic loading of any polyfill.
* <p>
* <ul>
* <li>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.
* <li>Absolute URLs including protocol and host are used as is on the
* client-side.
* </ul>
* Note that you should (almost) always use URLs starting with
* {@literal frontend://} so that the framework can resolve the files to either
* {@literal VAADIN/frontend/es5} or {@literal VAADIN/frontend/es6} depending on
* if the browser supports ES6 classes (most browers) or not (IE11 and Safari <=
* 9). Polymer elements rely on importing dependencies using relative paths
* {@literal ../../other-element/other-element.html}, which will not work if
* they are installed in different locations.
* <p>
* HTML imports are added to the page after any {@code @JavaScript} dependencies
* added at the same time.
* <p>
* Example:
* <code>@HtmlImport("frontend://paper-slider/paper-slider.html")</code> on the
* class com.example.MyConnector would load the file
* {@literal http://host.com/VAADIN/frontend/es[56]/paper-slider/paper-slider.html}
* before the {@code init()} method of the client side connector is invoked.
*
* @author Vaadin Ltd
* @since 8.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(InternalContainerAnnotationForHtml.class)
public @interface HtmlImport {
/**
* HTML file URL(s) to load before using the annotated
* {@link ClientConnector} in the browser.
*
* @return html file URL(s) to load
*/
String[] value();
}
|
