com.smartgwt.mobile.client.widgets.grid

Class ListGrid

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<RecordList>

com.smartgwt.mobile.client.widgets.grid.ListGrid

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, com.smartgwt.mobile.client.internal.widgets.form.fields.CanCopyFieldConfiguration, HasClickHandlers, HasDragMoveHandlers, HasShowContextMenuHandlers, HasDataValue, HasSelectionUpdatedHandlers, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

TableView

public class ListGrid
extends DataBoundComponent<RecordList>
implements HasDataValue, com.smartgwt.mobile.client.internal.widgets.form.fields.CanCopyFieldConfiguration

Placeholder for the Smart GWT ListGrid type.

ListGrid implements the HasDataValue interface, so a ListGrid instance may be used as a field within a DynamicForm. When being used as a field, this ListGrid edits the list of subrecords in the subrecordsProperty attribute of the mainRecord.

Note that this class is not intended to be used directly. SmartGWT.mobile applications are encouraged to use the TableView class instead.

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 com.smartgwt.mobile.client.internal.util.NativeIntMap	fieldNums_

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, _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
ListGrid()
ListGrid(java.lang.String fieldName)
ListGrid(java.lang.String fieldName, java.lang.String title)

Method Summary

Modifier and Type	Method and Description
void	_copyFieldConfiguration(DataSourceField field)
java.lang.String	_getRecordBaseStyleProperty()
boolean	compareValues(java.lang.Object value1, java.lang.Object value2) Compares two values for equality.
java.lang.String	getBaseStyle()
protected java.lang.String	getBaseStyle(Record record, int rowNum, int colNum)
java.lang.Boolean	getCanEdit()
DataManager	getDataManager()
ListGridField	getField(java.lang.String fieldName)
java.lang.String	getFieldName() Returns the name of this ListGrid when used as a field in a DynamicForm.
java.lang.String	getFieldName(int colNum)
int	getFieldNum(java.lang.String fieldName)
ListGridField[]	getFields()
Record[]	getFieldValue()
Record	getMainRecord() When this ListGrid is being used as a field within a DynamicForm, the main Record containing the subrecords that this ListGrid is editing.
java.lang.String	getRecordBaseStyleProperty()
SelectionStyle	getSelectionType()
java.lang.Boolean	getShowTitle() If null or Boolean.TRUE, then this field's title will be shown by the DynamicForm.
java.lang.String	getSubrecordsProperty() When this ListGrid is being used as a field within a DynamicForm, the name of the subrecords property of the mainRecord that this ListGrid is editing.
java.lang.String	getTitle() Returns the title of this ListGrid when used as a field in a DynamicForm.
Validator[]	getValidators()
void	setBaseStyle(java.lang.String baseStyle)
void	setCanEdit(java.lang.Boolean canEdit) Setter for canEdit.
void	setDataManager(DataManager dataManager) Sets the associated DataManager instance.
void	setFieldName(java.lang.String fieldName) Sets the field name returned by the HasDataValue.getFieldName() API.
void	setFields(ListGridField... fields)
void	setMainRecord(Record mainRecord) Setter for mainRecord.
void	setRecordBaseStyleProperty(java.lang.String recordBaseStyleProperty)
void	setSelectionType(SelectionStyle selectionType)
void	setShowTitle(java.lang.Boolean showTitle) Setter for HasDataValue.showTitle.
void	setSubrecordsProperty(java.lang.String subrecordsProperty)
void	setTitle(java.lang.String title) Sets the field title returned by the HasDataValue.getTitle() API.
void	setValidators(Validator... validators)
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.

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, destroy, fetchData, 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, setDataSource, setDescriptionField, setFetchOperation, setIconField, setInfoField, setSort, setStopOnError, setTitleField, setUseAllDataSourceFields

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, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, 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.smartgwt.mobile.client.widgets.form.fields.HasDataValue

getStopOnError

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

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

fieldNums_

@SGWTInternal
protected transient com.smartgwt.mobile.client.internal.util.NativeIntMap fieldNums_

Constructor Detail

ListGrid

public ListGrid()

ListGrid

public ListGrid(java.lang.String fieldName)

ListGrid

public ListGrid(java.lang.String fieldName,
                java.lang.String title)

Method Detail

getBaseStyle

public final java.lang.String getBaseStyle()

setBaseStyle

public void setBaseStyle(java.lang.String baseStyle)

getBaseStyle

protected java.lang.String getBaseStyle(Record record,
                                        int rowNum,
                                        int colNum)

getCanEdit

public final java.lang.Boolean getCanEdit()

Specified by:

getCanEdit in interface HasDataValue

setCanEdit

public void setCanEdit(java.lang.Boolean canEdit)

Setter for canEdit.

Specified by:

setCanEdit in interface HasDataValue

Parameters:

canEdit - an explicit override.

getDataManager

public final DataManager getDataManager()

setDataManager

public void setDataManager(DataManager dataManager)

Description copied from interface: HasDataValue

Sets the associated DataManager instance.

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

Specified by:

setDataManager in interface HasDataValue

Parameters:

dataManager - the associated DataManager.

See Also:

DataManager.storeValue(String, Object)

getField

public final ListGridField getField(java.lang.String fieldName)

getFieldName

public final java.lang.String getFieldName()

Returns the name of this ListGrid when used as a field in a DynamicForm.

Specified by:

getFieldName in interface HasDataValue

Returns:

this field's name. Default value: "_grid"

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the field name returned by the HasDataValue.getFieldName() API.

Parameters:

fieldName - the name of this ListGrid when used as a field in a DynamicForm.

getFieldName

public java.lang.String getFieldName(int colNum)

getFieldNum

public final int getFieldNum(java.lang.String fieldName)

getFields

public final ListGridField[] getFields()

setFields

public void setFields(ListGridField... fields)

getMainRecord

public final Record getMainRecord()

When this ListGrid is being used as a field within a DynamicForm, the main Record containing the subrecords that this ListGrid is editing.

Returns:

the main record.

setMainRecord

public void setMainRecord(Record mainRecord)

Setter for mainRecord.

Parameters:

mainRecord - the main record.

getRecordBaseStyleProperty

public final java.lang.String getRecordBaseStyleProperty()

_getRecordBaseStyleProperty

@SGWTInternal
public final java.lang.String _getRecordBaseStyleProperty()

setRecordBaseStyleProperty

public void setRecordBaseStyleProperty(java.lang.String recordBaseStyleProperty)

getSelectionType

public final SelectionStyle getSelectionType()

setSelectionType

public void setSelectionType(SelectionStyle selectionType)

getShowTitle

public final java.lang.Boolean getShowTitle()

Description copied from interface: HasDataValue

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

Specified by:

getShowTitle in interface HasDataValue

Returns:

whether to show a title for this field.

setShowTitle

public void setShowTitle(java.lang.Boolean showTitle)

Setter for HasDataValue.showTitle.

Parameters:

showTitle - if null or Boolean.TRUE, show the getTitle() title for this ListGrid being used as a field in a DynamicForm.

getTitle

public final java.lang.String getTitle()

Returns the title of this ListGrid when used as a field in a DynamicForm.

Specified by:

getTitle in interface HasDataValue

Overrides:

getTitle in class com.google.gwt.user.client.ui.UIObject

Returns:

this field's title.

setTitle

public void setTitle(java.lang.String title)

Sets the field title returned by the HasDataValue.getTitle() API.

Overrides:

setTitle in class com.google.gwt.user.client.ui.UIObject

Parameters:

title - the title of this ListGrid when used as a field in a DynamicForm.

getSubrecordsProperty

public final java.lang.String getSubrecordsProperty()

When this ListGrid is being used as a field within a DynamicForm, the name of the subrecords property of the mainRecord that this ListGrid is editing.

Returns:

the subrecords property of the mainRecord. Default value: "_grid"

setSubrecordsProperty

public void setSubrecordsProperty(java.lang.String subrecordsProperty)

getFieldValue

public Record[] getFieldValue()

getValidators

public final Validator[] getValidators()

Specified by:

getValidators in interface HasDataValue

setValidators

public void setValidators(Validator... validators)

compareValues

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

Description copied from interface: HasDataValue

Compares two values for equality.

Specified by:

compareValues in interface HasDataValue

Parameters:

value1 - first value.

value2 - second value.

Returns:

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

_copyFieldConfiguration

public void _copyFieldConfiguration(DataSourceField field)

Specified by:

_copyFieldConfiguration in interface com.smartgwt.mobile.client.internal.widgets.form.fields.CanCopyFieldConfiguration

showValue

public void showValue(java.lang.Object value)

Description copied from interface: HasDataValue

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.

Specified by:

showValue in interface HasDataValue

Parameters:

value - the new value.

updateCanEdit

public void updateCanEdit()

Description copied from interface: HasDataValue

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.

Specified by:

updateCanEdit in interface HasDataValue