org.cruxframework.crux.core.client.screen.binding

Interface BindableContainer

All Known Implementing Classes:

BindableView, View

public interface BindableContainer

Any class that implements this interface will support data binding between classes annotated with @DataObject annotation and widgets inserted into this container.

Author:

Thiago da Rosa de Bustamante

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataObjectBinder(DataObjectBinder<?> dataObjectBinder, String dataObjectAlias) Add a new binding configuration for a DataValue object
void	copyTo(Object dataObject) Update the given dataObject with the values contained on UI elements of this bindable container.
<T> DataObjectBinder<T>	getDataObjectBinder(Class<T> dataObjectClass) Retrieve the configuration object for a DataValue object
<T> DataObjectBinder<T>	getDataObjectBinder(String dataObjectAlias) Retrieve the configuration object for a DataValue object
com.google.gwt.user.client.ui.Widget	getLoadedWidget(String id) Retrieve a widget from the container if it is already loaded into it.
<T> T	read(Class<T> dataObjectClass) Read the dataObject bound to the given class from this bindable container.
<T> T	read(String dataObjectAlias) Read the dataObject bound to the given alias from this bindable container.
void	write(Object dataObject) Write the given dataObject into this bindable container.
void	writeAll(Object... dataObjects) Write the given dataObjects into this bindable container.

Method Detail

addDataObjectBinder

void addDataObjectBinder(DataObjectBinder<?> dataObjectBinder,
                       String dataObjectAlias)

Add a new binding configuration for a DataValue object

Parameters:

dataObjectBinder - the binder class

dataObjectAlias - the binder alias

copyTo

void copyTo(Object dataObject)

Update the given dataObject with the values contained on UI elements of this bindable container.

Parameters:

dataObject - the object that will be updated

getDataObjectBinder

<T> DataObjectBinder<T> getDataObjectBinder(Class<T> dataObjectClass)

Retrieve the configuration object for a DataValue object

Parameters:

dataObjectClass - the DataValue class.

Returns:

the configuration object for a DataValue object

getDataObjectBinder

<T> DataObjectBinder<T> getDataObjectBinder(String dataObjectAlias)

Retrieve the configuration object for a DataValue object

Parameters:

dataObjectAlias - the binder alias.

Returns:

the configuration object for a DataValue object

getLoadedWidget

com.google.gwt.user.client.ui.Widget getLoadedWidget(String id)

Retrieve a widget from the container if it is already loaded into it. If the widget is no yet loaded, this method does not initialize it and just return null.

Parameters:

id - the widget identifier.

Returns:

the widget or null.

read

<T> T read(Class<T> dataObjectClass)

Read the dataObject bound to the given class from this bindable container. Its state is updated according to any value binding declaration to this dataObject

Parameters:

dataObjectClass - dataObject class

Returns:

an updated dataObject

read

<T> T read(String dataObjectAlias)

Read the dataObject bound to the given alias from this bindable container. Its state is updated according to any value binding declaration to this dataObject

Parameters:

dataObjectAlias - dataObject alias

Returns:

an updated dataObject

write

void write(Object dataObject)

Write the given dataObject into this bindable container. Any UI element bound to any property of this object will be updated.

Parameters:

dataObject - the data object to write

writeAll

void writeAll(Object... dataObjects)

Write the given dataObjects into this bindable container. Any UI element bound to any property of these objects will be updated.

Parameters:

dataObjects - the data objects to write