org.netbeans.spi.knockout

Class Bindings

java.lang.Object

org.netbeans.spi.knockout.Bindings

public final class Bindings
extends Object

Allows structural description of a ko.applyBindings parameter. Register as BindingsProvider. When called build description of JSON types using methods like Bindings.stringProperty(java.lang.String, boolean) and then pass the result into Response#applyBindings(org.netbeans.spi.knockout.Bindings) method.

Method Summary

Modifier and Type	Method and Description
Bindings	booleanProperty(String name, boolean array) Generates a boolean property (with value true) into the JSON class.
static Bindings	create(String name) Defines new variable with provided name and assigns a JSON object into it.
Bindings	doubleProperty(String name, boolean array) Generates a floating point property (with value 0.1) into the JSON class.
static String	findBindings(FileObject htmlFile, int versionOfFormat) Queries registered providers for additional knockout.js bindings for given file.
Bindings	function(String name) Generates a function (empty) into the JSON class.
Bindings	intProperty(String name, boolean array) Generates a integer property (with value 0) into the JSON class.
Bindings	modelProperty(String name, Bindings binding, boolean array) Generates complex subtype based on another Bindings class.
Bindings	stringProperty(String name, boolean array) Generates a string property (with value '') into the JSON class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Bindings create(String name)

Defines new variable with provided name and assigns a JSON object into it. The created instance is a builder - continue calling its various builder methods like Bindings.intProperty(java.lang.String, boolean).

Parameters:

name - name of variable (must be valid JavaScript identifier)

Returns:

empty JSON object ready to be filled using Bindings.doubleProperty(java.lang.String, boolean), and other methods

booleanProperty

public final Bindings booleanProperty(String name,
                                      boolean array)

Generates a boolean property (with value true) into the JSON class.

Parameters:

name - name of variable (must be valid JavaScript identifier)

array - should this property be an array of just a single value

Returns:

this object

stringProperty

public final Bindings stringProperty(String name,
                                     boolean array)

Generates a string property (with value '') into the JSON class.

Parameters:

name - name of variable (must be valid JavaScript identifier)

array - should this property be an array of just a single value

Returns:

this object

intProperty

public final Bindings intProperty(String name,
                                  boolean array)

Generates a integer property (with value 0) into the JSON class.

Parameters:

name - name of variable (must be valid JavaScript identifier)

array - should this property be an array of just a single value

Returns:

this object

doubleProperty

public final Bindings doubleProperty(String name,
                                     boolean array)

Generates a floating point property (with value 0.1) into the JSON class.

Parameters:

name - name of variable (must be valid JavaScript identifier)

array - should this property be an array of just a single value

Returns:

this object

function

public final Bindings function(String name)

Generates a function (empty) into the JSON class.

Parameters:

name - name of variable (must be valid JavaScript identifier)

Returns:

this object

Since:

1.1

modelProperty

public final Bindings modelProperty(String name,
                                    Bindings binding,
                                    boolean array)

Generates complex subtype based on another Bindings class.

Parameters:

name - name of variable (must be valid JavaScript identifier)

binding - another description of a JSON like object

array - should this property be an array of just a single value

Returns:

this object

findBindings

public static String findBindings(FileObject htmlFile,
                                  int versionOfFormat)

Queries registered providers for additional knockout.js bindings for given file. Generates a JavaScript code describing JSON-like structures used by knockout.js that can be used to enhance code-completion for HTML files using knockout.js bindings.

Parameters:

htmlFile - the HTML file opened in editor

versionOfFormat - the format of the output. Use 1 for now.

Returns:

either null if no provider or format has been found for given file or a JavaScript code formated accordingly