com.extjs.gxt.ui.client.binding

Class FieldBinding

java.lang.Object

com.extjs.gxt.ui.client.binding.FieldBinding

Direct Known Subclasses:

DelayedBindingBase, ImageHrefFieldBinding, ResetButtonBinding

public class FieldBinding
extends Object

A two-way binding between a ModelData and Field instance. The binding will be 1-way when the bound model does not support change events.

See Also:

ModelData, Field

Field Summary

Fields

Modifier and Type	Field and Description
protected com.extjs.gxt.ui.client.widget.form.Field	field
protected com.extjs.gxt.ui.client.data.ModelData	model
protected String	property
protected com.extjs.gxt.ui.client.store.Store	store

Constructor Summary

Constructors

Constructor and Description
FieldBinding(com.extjs.gxt.ui.client.widget.form.Field field, String property) Creates a new binding instance.

Method Summary

Modifier and Type	Method and Description
void	bind(com.extjs.gxt.ui.client.data.ModelData model) Binds the model and field.
com.extjs.gxt.ui.client.binding.Converter	getConverter() Returns the bindings converter.
com.extjs.gxt.ui.client.widget.form.Field<Object>	getField() Returns the bound field.
com.extjs.gxt.ui.client.data.ModelData	getModel() Returns the bound model instance.
String	getProperty() Returns the model's bound property name.
com.extjs.gxt.ui.client.store.Store	getStore() Returns the binding's store.
boolean	isUpdateOriginalValue() Returns true if the field's original value is updated when the field is bound.
protected Object	onConvertFieldValue(Object value)
protected Object	onConvertModelValue(Object value)
protected void	onFieldChange(com.extjs.gxt.ui.client.event.FieldEvent e)
protected void	onModelChange(com.extjs.gxt.ui.client.data.PropertyChangeEvent event)
void	setConverter(com.extjs.gxt.ui.client.binding.Converter converter) Sets the converter which is used to translate data types when updating either the field or model.
void	setStore(com.extjs.gxt.ui.client.store.Store<? extends com.extjs.gxt.ui.client.data.ModelData> store) Sets the store for the binding.
void	setUpdateOriginalValue(boolean updateOriginalValue) True to update the field's original value when bound (defaults to false).
void	unbind() Unbinds the model and field by removing all listeners.
void	updateField() Updates the field's value with the model value.
void	updateField(boolean updateOriginalValue) Updates the field's value and original value with the model value.
void	updateModel() Updates the model's value with the field value.

Methods inherited from class java.lang.Object

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

Field Detail

field

protected com.extjs.gxt.ui.client.widget.form.Field field

model

protected com.extjs.gxt.ui.client.data.ModelData model

property

protected String property

store

protected com.extjs.gxt.ui.client.store.Store store

Constructor Detail

FieldBinding

public FieldBinding(com.extjs.gxt.ui.client.widget.form.Field field,
                    String property)

Creates a new binding instance.

Parameters:

field - the bound field for the binding

Method Detail

bind

public void bind(com.extjs.gxt.ui.client.data.ModelData model)

Binds the model and field. This method also updates the fields original value which controls the dirty state of the field.

Parameters:

model - the model to be bound

getConverter

public com.extjs.gxt.ui.client.binding.Converter getConverter()

Returns the bindings converter.

Returns:

the converter

getField

public com.extjs.gxt.ui.client.widget.form.Field<Object> getField()

Returns the bound field.

Returns:

the field

getModel

public com.extjs.gxt.ui.client.data.ModelData getModel()

Returns the bound model instance.

Returns:

the model

getProperty

public String getProperty()

Returns the model's bound property name.

Returns:

the property name

getStore

public com.extjs.gxt.ui.client.store.Store getStore()

Returns the binding's store.

Returns:

the store or null

isUpdateOriginalValue

public boolean isUpdateOriginalValue()

Returns true if the field's original value is updated when the field is bound.

Returns:

true if original value is updated

setConverter

public void setConverter(com.extjs.gxt.ui.client.binding.Converter converter)

Sets the converter which is used to translate data types when updating either the field or model.

Parameters:

converter - the converter

setStore

public void setStore(com.extjs.gxt.ui.client.store.Store<? extends com.extjs.gxt.ui.client.data.ModelData> store)

Sets the store for the binding. When a store is specified edits are done via Records instances obtained from the Store.

Parameters:

store - the store

setUpdateOriginalValue

public void setUpdateOriginalValue(boolean updateOriginalValue)

True to update the field's original value when bound (defaults to false).

Parameters:

updateOriginalValue - true to update the original value

unbind

public void unbind()

Unbinds the model and field by removing all listeners.

updateField

public void updateField()

Updates the field's value with the model value.

updateField

public void updateField(boolean updateOriginalValue)

Updates the field's value and original value with the model value. Updating the original value will reset the field to a non-dirty state.

Parameters:

updateOriginalValue - true to update the original value

updateModel

public void updateModel()

Updates the model's value with the field value.

onConvertFieldValue

protected Object onConvertFieldValue(Object value)

onConvertModelValue

protected Object onConvertModelValue(Object value)

onFieldChange

protected void onFieldChange(com.extjs.gxt.ui.client.event.FieldEvent e)

onModelChange

protected void onModelChange(com.extjs.gxt.ui.client.data.PropertyChangeEvent event)