com.smartgwt.mobile.client.widgets

Class DataBoundComponent<D extends java.util.List<Record> & HasDataChangedHandlers>

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>

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, HasSelectionUpdatedHandlers, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

com.smartgwt.mobile.client.internal.widgets.DataBoundEditorComponent, ListGrid

public abstract class DataBoundComponent<D extends java.util.List<Record> & HasDataChangedHandlers>
extends VLayout
implements HasSelectionUpdatedHandlers, com.smartgwt.mobile.client.internal.data.HasSortSpecifiers

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
protected SortSpecifier[]	_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, _CSS, _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
DataBoundComponent()

Method Summary

Modifier and Type	Method and Description
DSRequest	_buildRequest(DSRequest context, DSOperationType operationType, DSCallback callback)
static void	_cloneComponentValues(DataBoundComponent component, java.lang.Object storedValues, java.lang.Object values, DataSource dataSource, java.lang.String dataPath, java.util.List<java.lang.String> defaultPaths)
D	_createDataModel(Criteria filterCriteria, java.lang.Object operation, DSRequest context)
protected void	_createSelectionModel()
protected void	_destroySelectionModel()
static void	_duplicateValues(DataBoundComponent component, java.util.Map values, java.util.Map targetVals, java.util.List<java.lang.String> defaultPaths)
void	_filter(DSOperationType type, Criteria criteria, DSCallback callback, DSRequest requestProperties)
void	_filterWithCriteria(Criteria criteria, java.lang.Object operation, DSRequest context)
protected void	_fireSelectionUpdated()
D	_getData()
java.lang.Boolean	_getDeepCloneOnEdit()
Criteria	_getInitialCriteria()
java.lang.Object	_getInnerAttributeFromSplitLocator(java.util.List<java.lang.String> locatorArray, com.smartgwt.mobile.client.internal.test.GetAttributeConfiguration configuration)
protected Record[]	_getSelection(boolean excludePartialSelections)
protected com.smartgwt.mobile.client.internal.Selection<Record>	_getSelectionObject()
java.lang.Boolean	_resolveStopOnError(java.lang.Boolean stopOnError, java.lang.Boolean fieldStopOnError, java.lang.Boolean formStopOnError)
void	_setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
D	_updateDataModel(Criteria filterCriteria, java.lang.Object operation, DSRequest context)
com.smartgwt.mobile.client.internal.widgets.ValidationResult	_validateField(HasDataValue field, Validator[] validators, java.lang.Object value, Record record, com.smartgwt.mobile.client.internal.widgets.ValidationOptions options)
com.smartgwt.mobile.client.internal.widgets.ValidationResult	_validateFieldAndDependencies(HasDataValue field, Validator[] validators, java.lang.Object newValue, Record record, com.smartgwt.mobile.client.internal.widgets.ValidationOptions options)
com.google.gwt.event.shared.HandlerRegistration	addSelectionUpdatedHandler(SelectionUpdatedHandler handler)
void	deselectAllRecords()
void	deselectRecord(Record record)
void	deselectRecords(Record[] records)
void	destroy()
void	fetchData()
void	fetchData(Criteria criteria)
void	fetchData(Criteria criteria, DSCallback callback)
void	fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
void	filterData()
Criteria	getCriteria()
FetchMode	getDataFetchMode()
java.lang.String	getDataField()
int	getDataPageSize()
DataSource	getDataSource()
java.lang.String	getDescriptionField()
java.lang.String	getFetchOperation()
java.lang.String	getIconField()
java.lang.String	getInfoField()
RecordList	getRecordList()
ResultSet	getResultSet()
Record	getSelectedRecord()
Record[]	getSelectedRecords()
SortSpecifier[]	getSort()
java.lang.Boolean	getStopOnError()
java.lang.String	getTitleField()
java.lang.Boolean	getUseAllDataSourceFields()
void	invalidateCache()
boolean	isPartiallySelected(Record record)
boolean	isSelected(Record record)
void	selectRecord(Record record)
void	selectRecord(Record record, boolean state)
void	selectRecords(Record[] records)
void	selectRecords(Record[] records, boolean state)
void	selectSingleRecord(Record record)
void	setCriteria(Criteria criteria)
void	setData(D newData)
void	setDataFetchMode(FetchMode fetchMode)
void	setDataField(java.lang.String dataField)
void	setDataPageSize(java.lang.Integer dataPageSize)
void	setDataSource(DataSource dataSource)
void	setDescriptionField(java.lang.String descriptionField)
void	setFetchOperation(java.lang.String fetchOperation)
void	setIconField(java.lang.String iconField) Sets the name of the field to use for the icon of a record.
void	setInfoField(java.lang.String infoField)
void	setSort(SortSpecifier... sortSpecifiers)
void	setStopOnError(java.lang.Boolean stopOnError)
void	setTitleField(java.lang.String titleField)
void	setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)

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

_sortSpecifiers

@SGWTInternal
protected SortSpecifier[] _sortSpecifiers

Constructor Detail

DataBoundComponent

public DataBoundComponent()

Method Detail

_cloneComponentValues

@SGWTInternal
public static void _cloneComponentValues(DataBoundComponent component,
                                                       java.lang.Object storedValues,
                                                       java.lang.Object values,
                                                       DataSource dataSource,
                                                       java.lang.String dataPath,
                                                       java.util.List<java.lang.String> defaultPaths)

_duplicateValues

@SGWTInternal
public static void _duplicateValues(DataBoundComponent component,
                                                  java.util.Map values,
                                                  java.util.Map targetVals,
                                                  java.util.List<java.lang.String> defaultPaths)

destroy

public void destroy()

Overrides:

destroy in class Canvas

getDataFetchMode

public final FetchMode getDataFetchMode()

setDataFetchMode

public void setDataFetchMode(FetchMode fetchMode)

getDataPageSize

public final int getDataPageSize()

setDataPageSize

public void setDataPageSize(java.lang.Integer dataPageSize)

_getInnerAttributeFromSplitLocator

public java.lang.Object _getInnerAttributeFromSplitLocator(java.util.List<java.lang.String> locatorArray,
                                                           com.smartgwt.mobile.client.internal.test.GetAttributeConfiguration configuration)

Specified by:

_getInnerAttributeFromSplitLocator in interface com.smartgwt.mobile.client.internal.test.AutoTestLocatable

Overrides:

_getInnerAttributeFromSplitLocator in class Canvas

_createSelectionModel

@SGWTInternal
protected void _createSelectionModel()

_destroySelectionModel

@SGWTInternal
protected void _destroySelectionModel()

setDataSource

public void setDataSource(DataSource dataSource)

getDataSource

public final DataSource getDataSource()

getUseAllDataSourceFields

public final java.lang.Boolean getUseAllDataSourceFields()

setUseAllDataSourceFields

public void setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)

_getInitialCriteria

@SGWTInternal
public Criteria _getInitialCriteria()

getCriteria

public final Criteria getCriteria()

setCriteria

public void setCriteria(Criteria criteria)

_getData

@SGWTInternal
public final D _getData()

_getDeepCloneOnEdit

@SGWTInternal
public final java.lang.Boolean _getDeepCloneOnEdit()

_setDeepCloneOnEdit

@SGWTInternal
public void _setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)

getRecordList

public final RecordList getRecordList()

getResultSet

public final ResultSet getResultSet()

setData

public void setData(D newData)

setTitleField

public void setTitleField(java.lang.String titleField)

getTitleField

public final java.lang.String getTitleField()

setInfoField

public void setInfoField(java.lang.String infoField)

getInfoField

public final java.lang.String getInfoField()

setDataField

public void setDataField(java.lang.String dataField)

getDataField

public final java.lang.String getDataField()

setDescriptionField

public void setDescriptionField(java.lang.String descriptionField)

getDescriptionField

public final java.lang.String getDescriptionField()

setIconField

public void setIconField(java.lang.String iconField)

Sets the name of the field to use for the icon of a record. The value should be a String containing the URI of the icon. Alternatively, the field value may be an instance of ImageResource or Image.

In the case of TableView, this only applies if showIcons is true.

Parameters:

iconField - the name of the field containing the icon's URI.

getIconField

public final java.lang.String getIconField()

_getSelectionObject

@SGWTInternal
protected final com.smartgwt.mobile.client.internal.Selection<Record> _getSelectionObject()

getSort

public SortSpecifier[] getSort()

Specified by:

getSort in interface com.smartgwt.mobile.client.internal.data.HasSortSpecifiers

setSort

public void setSort(SortSpecifier... sortSpecifiers)

Specified by:

setSort in interface com.smartgwt.mobile.client.internal.data.HasSortSpecifiers

getStopOnError

public final java.lang.Boolean getStopOnError()

setStopOnError

public void setStopOnError(java.lang.Boolean stopOnError)

isSelected

public boolean isSelected(Record record)

isPartiallySelected

public boolean isPartiallySelected(Record record)

selectRecord

public final void selectRecord(Record record)

selectRecord

public final void selectRecord(Record record,
                               boolean state)

selectSingleRecord

public final void selectSingleRecord(Record record)

deselectRecord

public final void deselectRecord(Record record)

selectRecords

public final void selectRecords(Record[] records)

selectRecords

public void selectRecords(Record[] records,
                          boolean state)

deselectRecords

public final void deselectRecords(Record[] records)

deselectAllRecords

public void deselectAllRecords()

_fireSelectionUpdated

@SGWTInternal
protected void _fireSelectionUpdated()

_getSelection

@SGWTInternal
protected Record[] _getSelection(boolean excludePartialSelections)

getSelectedRecords

public Record[] getSelectedRecords()

getSelectedRecord

public Record getSelectedRecord()

_buildRequest

@SGWTInternal
public DSRequest _buildRequest(DSRequest context,
                                             DSOperationType operationType,
                                             DSCallback callback)

getFetchOperation

public final java.lang.String getFetchOperation()

setFetchOperation

public void setFetchOperation(java.lang.String fetchOperation)

fetchData

public final void fetchData()

fetchData

public final void fetchData(Criteria criteria)

fetchData

public final void fetchData(Criteria criteria,
                            DSCallback callback)

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback,
                      DSRequest requestProperties)

invalidateCache

public void invalidateCache()

filterData

public void filterData()

_filter

@SGWTInternal
public void _filter(DSOperationType type,
                                  Criteria criteria,
                                  DSCallback callback,
                                  DSRequest requestProperties)

_filterWithCriteria

@SGWTInternal
public void _filterWithCriteria(Criteria criteria,
                                              java.lang.Object operation,
                                              DSRequest context)

_createDataModel

@SGWTInternal
public D _createDataModel(Criteria filterCriteria,
                                        java.lang.Object operation,
                                        DSRequest context)

_resolveStopOnError

@SGWTInternal
public java.lang.Boolean _resolveStopOnError(java.lang.Boolean stopOnError,
                                                           java.lang.Boolean fieldStopOnError,
                                                           java.lang.Boolean formStopOnError)

_updateDataModel

@SGWTInternal
public D _updateDataModel(Criteria filterCriteria,
                                        java.lang.Object operation,
                                        DSRequest context)

_validateField

@SGWTInternal
public com.smartgwt.mobile.client.internal.widgets.ValidationResult _validateField(HasDataValue field,
                                                                                                 Validator[] validators,
                                                                                                 java.lang.Object value,
                                                                                                 Record record,
                                                                                                 com.smartgwt.mobile.client.internal.widgets.ValidationOptions options)

_validateFieldAndDependencies

@SGWTInternal
public com.smartgwt.mobile.client.internal.widgets.ValidationResult _validateFieldAndDependencies(HasDataValue field,
                                                                                                                Validator[] validators,
                                                                                                                java.lang.Object newValue,
                                                                                                                Record record,
                                                                                                                com.smartgwt.mobile.client.internal.widgets.ValidationOptions options)

addSelectionUpdatedHandler

public com.google.gwt.event.shared.HandlerRegistration addSelectionUpdatedHandler(SelectionUpdatedHandler handler)

Specified by:

addSelectionUpdatedHandler in interface HasSelectionUpdatedHandlers