org.markysoft.vani.core.annotation

Annotation Type JavaScript

@Target(value=TYPE)
 @Inherited
 @Retention(value=RUNTIME)
public @interface JavaScript

This annotation marks an interface to handle it as javascript-interface and bound it's methods to corresponding js-functions. The binding will be automatically done by vani. So you only have to declare the interface and the javascript source path.

Declaration of java source code

You create a js-file for the javascript code and tell vani the path to that file. This is done by source() or sources() when you have multiple files. The path could be declared as filesystem lookup or classpath. The classpath lookup also supports wildcards. For example the declaration of JQuery, vani will look for a classpath resource with the name jquery-2.2.1.js:

 
 @JavaScript(source = "classpath:jquery-2.2.1.js")
 public interface JQuery{
        ...
 }
 
 

The following declaration shows using multiple sources. The file my.js, which path starts in the current working directory, will be appended to the classpath resource jquery-2.2.1.js:

 
 @JavaScript(sources = {"classpath:org/vani/javascript/jquery-2.2.1.js","website/scripts/my.js"})
 public interface JQuery{
        ...
 }
 
 

Injection Process

At context startup, all javascript sources will be loaded. The injection into the page will be done before each method call of the js-interface. If you don't want that, you have to declare a detection script (see DetectionScript). This will be executed to check whether the source must be injected or not.

After the execution in the browser (see JavascriptExecutor for more details), the return value will be converted. If you need a custom handling of this value, you can define a @TypeHandler with @JsTypeHandler.

The call of your javascript function or code bound to a method of js-interface will be done by a call function. You can define your own function (see JsCallFunction).

Dependency

A javascript can depends on other scripts. This means, that these scripts must be injected into the page before the current one is sent. For example, the jquery-interface depends on VaniUtils, because for handling jquery elements, a uuid is used for caching. Therefore the VaniUtils.uuid4() will be needed:

 
 @JavaScriptDependency(VaniUtils.class)
 @JavaScript(source = "classpath:jquery-regex-selector.js")
 public interface JQueryRegexSelectorPlugin {
        ...
 } 
 
 

Plugins

You can extend the underlying javascript-source, if you declare the interface by extending an plugin-interface. For example, the jquery-interface is extending JQueryRegexSelectorPlugin to provide a regex-selector:

 
 @JavaScript(source = "classpath:jquery-regex-selector.js")
 public interface JQueryRegexSelectorPlugin {
        ...
 } 
 
 

 
 @JavaScript(source = "classpath:jquery-2.2.1.js")
 public interface JQuery extends JQueryRegexSelectorPlugin {
        ...
 }
 
 

In the above example, the source code of JQueryRegexSelectorPlugin will be append to the one of JQuery.

Author:

Thomas

See Also:

JsCallFunction, JsTypeHandler, JavascriptExecutor, TypeHandler

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name
String	source
String[]	sources

Element Detail

name

public abstract String name

Default:

"vaniJS"

sources

public abstract String[] sources

Default:

{}

source

public abstract String source

Default:

""