com.smartgwt.mobile.client.widgets.form

Class DynamicForm

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.smartgwt.mobile.client.widgets.Canvas

com.smartgwt.mobile.client.widgets.layout.Layout

com.smartgwt.mobile.client.widgets.layout.VLayout

com.smartgwt.mobile.client.widgets.DataBoundComponent<D>

com.smartgwt.mobile.client.internal.widgets.DataBoundEditorComponent<RecordList>

com.smartgwt.mobile.client.widgets.form.DynamicForm

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.smartgwt.mobile.client.internal.data.HasSortSpecifiers, com.smartgwt.mobile.client.internal.test.AutoTestLocatable, HasClickHandlers, HasDragMoveHandlers, HasShowContextMenuHandlers, DataManager, HasFormSubmitFailedHandlers, HasItemChangedHandlers, HasSubmitValuesHandlers, HasSelectionUpdatedHandlers, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class DynamicForm
extends com.smartgwt.mobile.client.internal.widgets.DataBoundEditorComponent<RecordList>
implements DataManager, HasFormSubmitFailedHandlers, HasItemChangedHandlers, HasSubmitValuesHandlers

A form component that displays a collection of form items (widgets implementing the HasDataValue interface) which represent user input controls. The most common items added to a DynamicForm are TextItems or other components extending FormItem, but SmartGWT.mobile also supports adding a TableView to a DynamicForm with no additional configuration. See the Forms → Inputs Showcase sample for an example of a basic form, and the Forms → Embedded TableView sample for an example of adding a TableView to a DynamicForm.

Just like Smart GWT, a DynamicForm can be bound to a DataSource. When using DataSource binding, you can also add additional form items not specified by the DataSource, or rely on autoconfiguration of fields from the DataSource, optionally overriding any properties on the automatically generated form items without having to re-declare any information that comes from the DataSource. To better accommodate mobile devices, DynamicForm autoconfiguration may display certain HTML5 input types by default according to the rules:

Field editorType	Field type	Result
"TextItem"	"date"	HTML5 date picker (input type="date")
"TextItem"	"time"	HTML5 time picker (input type="time")
"TextItem"	"datetime"	HTML5 date & time picker (input type="datetime")

Note that certain mobile platforms do not support all of the HTML5 input types. See the Forms → Autoconfigured from DataSource Showcase sample for an example of autoconfiguration.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
static FormCssResource	_CSS

Fields inherited from class com.smartgwt.mobile.client.widgets.DataBoundComponent

_sortSpecifiers

Fields inherited from class com.smartgwt.mobile.client.widgets.layout.Layout

alignment, enforcePolicy, hPolicy, members, membersMargin, minMemberSize, momentumScroll, overflow, paddingAsLayoutMargin, reverseOrder, valign, vertical

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas

_CONTENT_CHANGED_EVENT_TYPE, _HISTORY_ENABLED, _REQUEST_SCROLL_TO_EVENT_TYPE, id, touched

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
DynamicForm()

Method Summary

Modifier and Type	Method and Description
void	_clearItemValue(HasDataValue item)
static boolean	_compareLists(java.util.List<?> value1, java.util.List<?> value2)
static boolean	_compareValues(java.lang.Object value1, java.lang.Object value2) Do two field values match? Used wherever we need to compare field values.
com.google.gwt.dom.client.FormElement	_getForm()
java.lang.Boolean	_handleNativeSubmit()
<T extends java.util.Map<java.lang.String,java.lang.Object>> T	_putValues(T values)
static boolean	_valuesHaveChanged(DynamicForm form, java.util.Map<?,?> values, java.util.Map<?,?> oldValues)
com.google.gwt.event.shared.HandlerRegistration	addFormSubmitFailedHandler(FormSubmitFailedHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addItemChangedHandler(ItemChangedHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addSubmitValuesHandler(SubmitValuesHandler handler)
void	clearErrors()
void	clearValue(java.lang.String fieldName)
void	clearValue(java.lang.String fieldName, boolean updateField) Clears this DataManager's stored value for the named field.
void	clearValues()
void	clearValues(boolean updateFields) Clears all stored values.
void	destroy()
void	editNewRecord()
void	editNewRecord(java.util.Map<java.lang.String,?> initialValues)
void	editNewRecord(Record initialValues)
void	editRecord(Record record)
java.lang.String	getAction()
java.lang.Boolean	getCanEdit()
DateDisplayFormat	getDateFormatter()
DateDisplayFormat	getDatetimeFormatter()
Encoding	getEncoding()
Canvas	getField(java.lang.String name)
Canvas[]	getFields()
FormStyle	getFormStyle() The display style of this DynamicForm.
Canvas	getItem(java.lang.String name)
Canvas[]	getItems()
FormMethod	getMethod()
DSOperationType	getSaveOperationType()
java.lang.String	getTarget()
TimeDisplayFormat	getTimeFormatter()
java.util.Map<java.lang.String,java.lang.Object>	getValues()
Criteria	getValuesAsCriteria()
Record	getValuesAsRecord()
void	rememberValues()
void	saveData()
void	saveData(DSCallback callback)
void	setAction(java.lang.String action)
void	setCanEdit(java.lang.Boolean canEdit)
void	setDataSource(DataSource dataSource)
void	setDateFormatter(DateDisplayFormat dateFormatter)
void	setDatetimeFormatter(DateDisplayFormat datetimeFormatter)
void	setEncoding(Encoding encoding)
void	setErrors(java.util.Map<java.lang.String,?> errors, boolean showErrors)
void	setFields(Canvas... fields) Sets the form's fields.
void	setFormStyle(FormStyle formStyle)
void	setItems(Canvas... fields) Alias for setFields(Canvas...).
void	setMethod(FormMethod method)
void	setSaveOperationType(DSOperationType saveOperationType)
void	setTarget(java.lang.String target)
void	setTimeFormatter(TimeDisplayFormat timeFormatter)
void	setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
void	setValue(java.lang.String fieldName, java.lang.Object value) Sets the value of a field, storing the value in the DataManager's values map and calling HasDataValue.showValue(Object) to update the corresponding HasDataValue.
void	setValues(java.util.Map<java.lang.String,?> values)
void	storeValue(java.lang.String fieldName, java.lang.Object value) Stores the given value in the DataManager's values map.
void	submitForm()
boolean	valuesHaveChanged()

Methods inherited from class com.smartgwt.mobile.client.internal.widgets.DataBoundEditorComponent

_fetchDataReply, fetchData

Methods inherited from class com.smartgwt.mobile.client.widgets.DataBoundComponent

_buildRequest, _cloneComponentValues, _createDataModel, _createSelectionModel, _destroySelectionModel, _duplicateValues, _filter, _filterWithCriteria, _fireSelectionUpdated, _getData, _getDeepCloneOnEdit, _getInitialCriteria, _getInnerAttributeFromSplitLocator, _getSelection, _getSelectionObject, _resolveStopOnError, _setDeepCloneOnEdit, _updateDataModel, _validateField, _validateFieldAndDependencies, addSelectionUpdatedHandler, deselectAllRecords, deselectRecord, deselectRecords, fetchData, fetchData, fetchData, filterData, getCriteria, getDataFetchMode, getDataField, getDataPageSize, getDataSource, getDescriptionField, getFetchOperation, getIconField, getInfoField, getRecordList, getResultSet, getSelectedRecord, getSelectedRecords, getSort, getStopOnError, getTitleField, getUseAllDataSourceFields, invalidateCache, isPartiallySelected, isSelected, selectRecord, selectRecord, selectRecords, selectRecords, selectSingleRecord, setCriteria, setData, setDataFetchMode, setDataField, setDataPageSize, setDescriptionField, setFetchOperation, setIconField, setInfoField, setSort, setStopOnError, setTitleField

Methods inherited from class com.smartgwt.mobile.client.widgets.layout.VLayout

addMember, addMember

Methods inherited from class com.smartgwt.mobile.client.widgets.layout.Layout

addDragMoveHandler, addMember, addMember, addMembers, addMembers, addMembers, clear, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getManagePercentBreadth, getMember, getMember, getMemberNumber, getMemberNumber, getMembers, getMembersMargin, getMinMemberSize, getMomentumScroll, getOverflow, getPaddingAsLayoutMargin, getReverseOrder, getVertical, getVPolicy, hasMember, hideMember, hideMember, reflow, removeMember, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setDefaultLayoutAlign, setDefaultLayoutAlign, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setManagePercentBreadth, setMembers, setMembersMargin, setMinMemberSize, setMomentumScroll, setOverflow, setPaddingAsLayoutMargin, setReverseOrder, setVertical, setVisibleMember, setVPolicy, showMember, showMember

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas

_add, _booleanValue, _fireContentChangedEvent, _fireContentChangedEvent, _fireRequestScrollToEvent, _getAndroidWindowSoftInputMode, _getAttributeFromSplitLocator, _getChildFromLocatorSubstring, _getFixNavigationBarPositionDuringKeyboardFocus, _getHideTabBarDuringKeyboardFocus, _getInnerElement, _hideAddressBar, _hideAddressBarNow, _insert, _isDifferent, _isHDPIDisplay, _isIOS4OrOlder, _isIOS5, _isIOSMin6_0, _isStandaloneMode, _nativeParseFloat, _removeClassName, _setClassName, _setHandleDisabled, _sinkAnimationEndEvent, _sinkContentChangedEvent, _sinkFocusInEvent, _sinkFocusOutEvent, _sinkInputEvent, _sinkRequestScrollToEvent, _sinkTransitionEndEvent, _triggerDebugger, addChild, addChild, addChild, addClickHandler, addShowContextMenuHandler, disable, enable, getContextMenu, getID, getInnerHTML, getMargin, hasChild, hasChild, isAndroid, isDisabled, isEnabled, isIPad, isIPhone, isSafari, isStandAlone, isUIWebView, onBrowserEvent, parseDimension, removeChild, removeChild, setContents, setContextMenu, setDisabled, setElement, setID, setMargin, setStyleName, split, useIOSNativeScrolling

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_CSS

@SGWTInternal
public static final FormCssResource _CSS

Constructor Detail

DynamicForm

public DynamicForm()

Method Detail

_compareLists

@SGWTInternal
public static boolean _compareLists(java.util.List<?> value1,
                                                  java.util.List<?> value2)

_compareValues

@SGWTInternal
public static boolean _compareValues(java.lang.Object value1,
                                                   java.lang.Object value2)

Do two field values match? Used wherever we need to compare field values. Handles all expected data types. Used to detect changes to values (e.g. valuesHaveChanged()).

_valuesHaveChanged

public static boolean _valuesHaveChanged(DynamicForm form,
                                         java.util.Map<?,?> values,
                                         java.util.Map<?,?> oldValues)

destroy

public void destroy()

Overrides:

destroy in class DataBoundComponent<RecordList>

getAction

public final java.lang.String getAction()

setAction

public void setAction(java.lang.String action)

setDataSource

public void setDataSource(DataSource dataSource)

Overrides:

setDataSource in class DataBoundComponent<RecordList>

setUseAllDataSourceFields

public void setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)

Overrides:

setUseAllDataSourceFields in class DataBoundComponent<RecordList>

getDateFormatter

public final DateDisplayFormat getDateFormatter()

setDateFormatter

public void setDateFormatter(DateDisplayFormat dateFormatter)

getDatetimeFormatter

public final DateDisplayFormat getDatetimeFormatter()

setDatetimeFormatter

public void setDatetimeFormatter(DateDisplayFormat datetimeFormatter)

getEncoding

public final Encoding getEncoding()

setEncoding

public void setEncoding(Encoding encoding)

_getForm

@SGWTInternal
public final com.google.gwt.dom.client.FormElement _getForm()

getFormStyle

public final FormStyle getFormStyle()

The display style of this DynamicForm.

FormStyle.STYLE1 makes the form look like a grouped TableView. FormStyle.STYLE2 makes the form look like the Edit Info form of the iPhone Contacts app.

Returns:

the display style. Default value: FormStyle.STYLE1

setFormStyle

public void setFormStyle(FormStyle formStyle)

getCanEdit

public final java.lang.Boolean getCanEdit()

Specified by:

getCanEdit in interface DataManager

setCanEdit

public void setCanEdit(java.lang.Boolean canEdit)

getField

public final Canvas getField(java.lang.String name)

getItem

public final Canvas getItem(java.lang.String name)

getFields

public final Canvas[] getFields()

getItems

public final Canvas[] getItems()

setFields

public void setFields(Canvas... fields)

Sets the form's fields.

NOTE: Each Canvas instance must implement the HasDataValue interface.

Parameters:

fields - the form's fields.

Throws:

java.lang.IllegalArgumentException - if one of the fields does not implement the HasDataValue interface or if two different fields have the same name.

java.lang.NullPointerException - if one of the fields does not have a name.

setItems

public final void setItems(Canvas... fields)

Alias for setFields(Canvas...).

Parameters:

items - the form's fields.

getMethod

public final FormMethod getMethod()

setMethod

public void setMethod(FormMethod method)

getSaveOperationType

public final DSOperationType getSaveOperationType()

setSaveOperationType

public void setSaveOperationType(DSOperationType saveOperationType)

getTarget

public final java.lang.String getTarget()

setTarget

public void setTarget(java.lang.String target)

getTimeFormatter

public final TimeDisplayFormat getTimeFormatter()

setTimeFormatter

public void setTimeFormatter(TimeDisplayFormat timeFormatter)

_putValues

@SGWTInternal
public <T extends java.util.Map<java.lang.String,java.lang.Object>> T _putValues(T values)

getValues

public final java.util.Map<java.lang.String,java.lang.Object> getValues()

Specified by:

getValues in interface DataManager

getValuesAsCriteria

public final Criteria getValuesAsCriteria()

getValuesAsRecord

public final Record getValuesAsRecord()

rememberValues

public void rememberValues()

clearErrors

public void clearErrors()

setValue

public void setValue(java.lang.String fieldName,
                     java.lang.Object value)

Description copied from interface: DataManager

Sets the value of a field, storing the value in the DataManager's values map and calling HasDataValue.showValue(Object) to update the corresponding HasDataValue.

Specified by:

setValue in interface DataManager

Parameters:

fieldName - field name.

value - new value of the field.

See Also:

DataManager.storeValue(String, Object)

setValues

public void setValues(java.util.Map<java.lang.String,?> values)

Specified by:

setValues in interface DataManager

storeValue

public void storeValue(java.lang.String fieldName,
                       java.lang.Object value)

Description copied from interface: DataManager

Stores the given value in the DataManager's values map.

NOTE: This method will not update the corresponding HasDataValue by calling the HasDataValue.showValue(Object) method. storeValue() is intended to be used by the HasDataValue objects to notify this DataManager of a change in value. For the variants that do call HasDataValue.showValue(), see DataManager.setValue(String, Object) and DataManager.setValues(Map).

Specified by:

storeValue in interface DataManager

See Also:

DataManager.setValue(String, Object), DataManager.setValues(Map)

_clearItemValue

@SGWTInternal
public void _clearItemValue(HasDataValue item)

clearValue

public final void clearValue(java.lang.String fieldName)

clearValue

public void clearValue(java.lang.String fieldName,
                       boolean updateField)

Description copied from interface: DataManager

Clears this DataManager's stored value for the named field. If updateField is true, then showValue(null) will be called on the corresponding HasDataValue.

Specified by:

clearValue in interface DataManager

Parameters:

fieldName - field name.

updateField - whether to call showValue() on the corresponding HasDataValue.

clearValues

public final void clearValues()

clearValues

public void clearValues(boolean updateFields)

Description copied from interface: DataManager

Clears all stored values.

Specified by:

clearValues in interface DataManager

Parameters:

updateFields - whether to call showValue(null) on each HasDataValue.

setErrors

public void setErrors(java.util.Map<java.lang.String,?> errors,
                      boolean showErrors)

editRecord

public void editRecord(Record record)

Specified by:

editRecord in class com.smartgwt.mobile.client.internal.widgets.DataBoundEditorComponent<RecordList>

editNewRecord

public final void editNewRecord()

editNewRecord

public void editNewRecord(java.util.Map<java.lang.String,?> initialValues)

editNewRecord

public final void editNewRecord(Record initialValues)

_handleNativeSubmit

@SGWTInternal
public java.lang.Boolean _handleNativeSubmit()

saveData

public void saveData()

saveData

public void saveData(DSCallback callback)

submitForm

public void submitForm()

valuesHaveChanged

public boolean valuesHaveChanged()

addFormSubmitFailedHandler

public com.google.gwt.event.shared.HandlerRegistration addFormSubmitFailedHandler(FormSubmitFailedHandler handler)

Specified by:

addFormSubmitFailedHandler in interface HasFormSubmitFailedHandlers

addItemChangedHandler

public com.google.gwt.event.shared.HandlerRegistration addItemChangedHandler(ItemChangedHandler handler)

Specified by:

addItemChangedHandler in interface HasItemChangedHandlers

addSubmitValuesHandler

public com.google.gwt.event.shared.HandlerRegistration addSubmitValuesHandler(SubmitValuesHandler handler)

Specified by:

addSubmitValuesHandler in interface HasSubmitValuesHandlers