org.apidesign.html.json.spi

Interface Technology<Data>

All Known Subinterfaces:

Technology.BatchInit<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.

Author:

Jaroslav Tulach

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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 expose(org.apidesign.html.json.spi.FunctionBinding, java.lang.Object, java.lang.Object) and bind(org.apidesign.html.json.spi.PropertyBinding, java.lang.Object, java.lang.Object).

Method Summary

Methods

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) Run given runnable in a safe mode.
<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.

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

void runSafe(Runnable r)

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