com.smartgwt.mobile.client.widgets.form.fields

Interface HasDataValue

All Known Implementing Classes:

AbstractHasDataValue, AutoFitTextAreaItem, ButtonItem, CheckboxItem, ColorPickerItem, DateItem, DateTimeItem, EmailItem, FormItem, HiddenItem, ListGrid, PasswordItem, PhoneItem, SearchItem, SelectItem, SliderItem, SpacerItem, StaticTextItem, SubmitItem, SwitchItem, TableView, TextAreaItem, TextItem, TimeItem, UploadItem, UrlItem

public interface HasDataValue

Defines the interface necessary for this object to be used as a field within a DynamicForm.

Any widget that implements this interface can be added directly to a DynamicForm.

See Also:

DynamicForm.setFields(com.smartgwt.mobile.client.widgets.Canvas...)

Method Summary

Modifier and Type	Method and Description
boolean	compareValues(java.lang.Object value1, java.lang.Object value2) Compares two values for equality.
java.lang.Boolean	getCanEdit()
java.lang.String	getFieldName() Returns this field's name.
java.lang.Boolean	getShowTitle() If null or Boolean.TRUE, then this field's title will be shown by the DynamicForm.
java.lang.Boolean	getStopOnError()
java.lang.String	getTitle() Returns this field's title.
Validator[]	getValidators()
void	setCanEdit(java.lang.Boolean canEdit) If non-null, explicitly sets the editability of this field.
void	setDataManager(DataManager dataManager) Sets the associated DataManager instance.
void	showValue(java.lang.Object value) Called by the DataManager to notify this HasDataValue that the DataManager's value for this HasDataValue was changed and that this HasDataValue needs to update its display field to the given value.
void	updateCanEdit() Called by the DataManager to notify this HasDataValue that the DataManager's canEdit attribute changed and that this HasDataValue's editability may have changed as a result.

Method Detail

getCanEdit

java.lang.Boolean getCanEdit()

setCanEdit

void setCanEdit(java.lang.Boolean canEdit)

If non-null, explicitly sets the editability of this field. A value of Boolean.TRUE means that this field is editable. A value of Boolean.FALSE means that this field is read-only.

If not explicitly set, then this field should consider itself editable if its DataManager is editable. See DataManager.getCanEdit().

Parameters:

canEdit - an explicit override.

setDataManager

void setDataManager(DataManager dataManager)

Sets the associated DataManager instance.

This HasDataValue instance uses the DataManager to post notifications of changes to its value caused by user action.

Parameters:

dataManager - the associated DataManager.

See Also:

DataManager.storeValue(String, Object)

getFieldName

java.lang.String getFieldName()

Returns this field's name.

Returns:

this field's name.

getShowTitle

java.lang.Boolean getShowTitle()

If null or Boolean.TRUE, then this field's title will be shown by the DynamicForm.

Returns:

whether to show a title for this field.

getStopOnError

java.lang.Boolean getStopOnError()

getTitle

java.lang.String getTitle()

Returns this field's title.

Returns:

this field's title.

getValidators

Validator[] getValidators()

compareValues

boolean compareValues(java.lang.Object value1,
                      java.lang.Object value2)

Compares two values for equality.

Parameters:

value1 - first value.

value2 - second value.

Returns:

true if value1 is equal to value2 in the context of this HasDataValue; false otherwise.

showValue

void showValue(java.lang.Object value)

Called by the DataManager to notify this HasDataValue that the DataManager's value for this HasDataValue was changed and that this HasDataValue needs to update its display field to the given value.

NOTE: An implementation must not call the associated DataManager's DataManager.storeValue(String, Object) method.

Parameters:

value - the new value.

updateCanEdit

void updateCanEdit()

Called by the DataManager to notify this HasDataValue that the DataManager's canEdit attribute changed and that this HasDataValue's editability may have changed as a result.