org.netbeans.html.json.spi

Interface Technology<Data>

Type Parameters:

Data - technology internal type that keeps internal data for each instance of .

All Known Subinterfaces:

Technology.ApplyId<D>, Technology.BatchCopy<D>, Technology.BatchInit<D>, Technology.ToJavaScript<D>, Technology.ValueMutated<D>

public interface Technology<Data>

An implementation of a binding between model classes (see Model) and particular technology like knockout.js in a browser window, etc.Since introduction of technology identifiers one can choose between different background implementations to handle the conversion and communication requests. The currently known provider is org.netbeans.html:ko4j module which registers a knockout.js implementation called ko4j.

Author:

Jaroslav Tulach

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Technology.ApplyId<D> Apply technology bindings at selected subtree of the HTML page.
static interface	Technology.BatchCopy<D> Extension of Technology.BatchInit with enhanced support for copying values.
static interface	Technology.BatchInit<D> For certain rendering technologies it may be more efficient to register property and function bindings for one instance of the model at once, rather then doing it incrementally via Technology.expose(org.netbeans.html.json.spi.FunctionBinding, java.lang.Object, java.lang.Object) and Technology.bind(org.netbeans.html.json.spi.PropertyBinding, java.lang.Object, java.lang.Object).
static interface	Technology.ToJavaScript<D> Convertor of the internal data type to object suitable as a JavaScript representation.
static interface	Technology.ValueMutated<D> Some technologies are more effective when number of calls between Java and JavaScript is limited - to do that when a value of property is changed they should implement this additional interface.

Method Summary

Modifier and Type	Method and Description
void	applyBindings(Data data) Applies given data to current context (usually an HTML page).
void	bind(PropertyBinding b, Object model, Data data) Binds a property between the model and the data as used by the technology.
void	expose(FunctionBinding fb, Object model, Data d)
void	runSafe(Runnable r) Deprecated. Use BrwsrCtx.execute(java.lang.Runnable)
<M> M	toModel(Class<M> modelClass, Object data) Converts an element potentially representing a model into the model.
void	valueHasMutated(Data data, String propertyName) Model for given data has changed its value.
Object	wrapArray(Object[] arr) Some technologies may require wrapping a Java array into a special object.
Data	wrapModel(Object model) Creates an object to wrap the provided model object.

Method Detail

wrapModel

Data wrapModel(Object model)

Creates an object to wrap the provided model object. The model has previously been generated by annotation processor associated with Model annotation.

Parameters:

model - the model generated from Model

Returns:

internal object representing the model

toModel

<M> M toModel(Class<M> modelClass,
              Object data)

Converts an element potentially representing a model into the model.

Type Parameters:

M - the type of the modelClass

Parameters:

modelClass - expected class to convert the data to

data - the current data provided from the browser

Returns:

the instance of modelClass somehow extracted from the data, may return null

bind

void bind(PropertyBinding b,
          Object model,
          Data data)

Binds a property between the model and the data as used by the technology.

Parameters:

b - the description of the requested binding

model - the original instance of the model

data - the data to bind with the model

valueHasMutated

void valueHasMutated(Data data,
                     String propertyName)

Model for given data has changed its value. The technology is supposed to update its state (for example DOM nodes associated with the model). The update usually happens asynchronously.

Parameters:

data - technology's own representation of the model

propertyName - name of the model property that changed

expose

void expose(FunctionBinding fb,
            Object model,
            Data d)

applyBindings

void applyBindings(Data data)

Applies given data to current context (usually an HTML page).

Parameters:

data - the data to apply

wrapArray

Object wrapArray(Object[] arr)

Some technologies may require wrapping a Java array into a special object. In such case they may return it from this method.

Parameters:

arr - original array

Returns:

wrapped array

runSafe

@Deprecated
void runSafe(Runnable r)

Deprecated. Use BrwsrCtx.execute(java.lang.Runnable)

Run given runnable in a safe mode. If the runnable can be executed immediately, do it. If we need to switch to some other thread, do it and invoke r asynchronously immediately returning from the call to runSafe method.

Parameters:

r - the runnable to execute