public class TileGrid extends TileLayout implements DataBoundComponent, HasDataArrivedHandlers, HasRecordClickHandlers, HasRecordContextClickHandlers, HasRecordDoubleClickHandlers, HasSelectionChangedHandlers
DataBoundComponent that displays a list of objects as a set of
"tiles", where each tile represents one object, and the tiles are laid out in a grid with multiple tiles per row. Each
tile displays one or more properties of the object it represents.config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
TileGrid() |
TileGrid(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
void |
addData(Record newRecord)
Perform a DataSource "add" operation to add new records to this component's DataSource.
|
void |
addData(Record newRecord,
DSCallback callback) |
void |
addData(Record newRecord,
DSCallback callback,
DSRequest requestProperties)
Perform a DataSource "add" operation to add new records to this component's DataSource.
|
com.google.gwt.event.shared.HandlerRegistration |
addDataArrivedHandler(DataArrivedHandler handler)
Add a dataArrived handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragCompleteHandler(DragCompleteHandler handler)
Add a
com.smartgwt.client.widgets.DragCompleteHandler. |
com.google.gwt.event.shared.HandlerRegistration |
addDropCompleteHandler(DropCompleteHandler handler)
Add a
com.smartgwt.client.widgets.DropCompleteHandler. |
com.google.gwt.event.shared.HandlerRegistration |
addFetchDataHandler(FetchDataHandler handler)
Add a fetchData handler.
|
void |
addFormulaField()
Convenience method to display a
com.smartgwt.client..FormulaBuilder to create a new Formula Field. |
com.google.gwt.event.shared.HandlerRegistration |
addRecordClickHandler(RecordClickHandler handler)
Add a recordClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordContextClickHandler(RecordContextClickHandler handler)
Add a recordContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordDoubleClickHandler(RecordDoubleClickHandler handler)
Add a recordDoubleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addSelectionChangedHandler(SelectionChangedHandler handler)
Add a selectionChanged handler.
|
void |
addSummaryField()
Convenience method to display a
com.smartgwt.client..SummaryBuilder to create a new Summary Field. |
void |
addTile()
This is not allowed for tileGrid.
|
java.lang.Boolean |
anySelected()
Whether at least one item is selected
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
deselectAllRecords()
Deselect all records
|
void |
deselectRange(int startRow,
int endRow)
Deselect a contiguous range of records by index.
|
void |
deselectRecord(int record)
Deselect a
Record passed in explicitly, or by index. |
void |
deselectRecord(Record record)
Deselect a
Record passed in explicitly, or by index. |
void |
deselectRecords(int[] records)
Deselect a list of
Records passed in explicitly, or by index. |
void |
deselectRecords(Record[] records)
Deselect a list of
Records passed in explicitly, or by index. |
void |
disableHilite(java.lang.String hiliteID)
Disable a hilite
|
void |
disableHiliting()
Disable all hilites.
|
void |
editFields()
Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility
of the fields in the associated DataBoundComponent.
|
void |
editHilites()
Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.
|
void |
enableHilite(java.lang.String hiliteID)
Enable / disable a
hilites
|
void |
enableHilite(java.lang.String hiliteID,
boolean enable)
Enable / disable a
hilites
|
void |
enableHiliting()
Enable all hilites.
|
void |
enableHiliting(boolean enable)
Enable all hilites.
|
void |
exportData()
|
void |
exportData(DSRequest requestProperties)
|
void |
exportData(DSRequest requestProperties,
RPCCallback callback)
Uses a "fetch" operation on the current
DataSource
to retrieve data that matches the current filter and sort criteria for this component,
then exports the resulting data to a file or window in the requested format. |
void |
fetchData()
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
filterData()
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria,
DSCallback callback)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
Record |
find(AdvancedCriteria adCriteria)
Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found
|
Record[] |
findAll(AdvancedCriteria adCriteria)
Filters all objects according to the AdvancedCriteria passed
|
int |
findIndex(AdvancedCriteria adCriteria)
Finds the index of the first Record that matches with the AdvacendCriteria passed.
|
int |
findNextIndex(int startIndex,
AdvancedCriteria adCriteria)
Like
RecordList.findIndex(java.util.Map), but considering the startIndex parameter. |
int |
findNextIndex(int startIndex,
AdvancedCriteria adCriteria,
int endIndex)
Like
RecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters. |
java.lang.Boolean |
getAddDropValues()
Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to
different DataSources that are related via a foreign key.
|
java.lang.String |
getAddFormulaFieldText()
Text for a menu item allowing users to add a formula field
|
java.lang.String |
getAddOperation()
operationId this component
should use when performing add operations. |
java.lang.String |
getAddSummaryFieldText()
Text for a menu item allowing users to add a formula field
|
java.lang.Boolean |
getAnimateTileChange()
If set, when the dataset changes due to filtering, sorting or other actions, any tiles that were showing before and
after the change will animate from their old positions to their new positions.
|
java.lang.Boolean |
getAutoFetchAsFilter()
If
DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData() |
java.lang.Boolean |
getAutoFetchData()
If true, when this component is first drawn, automatically call
DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . |
TextMatchStyle |
getAutoFetchTextMatchStyle()
If
autoFetchData is true, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call. |
java.lang.Boolean |
getCanAcceptDroppedRecords()
Indicates whether records can be dropped into this TileGrid.
|
java.lang.Boolean |
getCanAddFormulaFields()
Adds an item to the header context menu allowing users to launch a dialog to define a new
field based on values present in other fields, using the
com.smartgwt.client..FormulaBuilder.
|
java.lang.Boolean |
getCanAddSummaryFields()
Adds an item to the header context menu allowing users to launch a dialog to define a new
text field that can contain both user-defined text and the formatted values present in other
fields, using the
com.smartgwt.client..SummaryBuilder.
|
java.lang.Boolean |
getCanDragTilesOut()
Indicates whether tiles can be dragged from this
TileGrid and dropped elsewhere. |
java.lang.Boolean |
getCanReorderTiles()
Indicates whether tiles can be reordered by dragging within this
TileGrid. |
SimpleTile |
getCurrentTile()
Returns the tile currently under the mouse.
|
Record[] |
getData()
A List of TileRecord objects, specifying the data to be used to create the tiles.
|
java.lang.String |
getDataArity()
A TileGrid is a
dataArity:multiple component. |
com.google.gwt.core.client.JavaScriptObject |
getDataAsJSList() |
RecordList |
getDataAsRecordList()
Return the tileGrid data as a
RecordList. |
FetchMode |
getDataFetchMode()
How to fetch and manage records retrieve from the server.
|
int |
getDataPageSize()
When using
data
paging, how many records to fetch at a time. |
DataSource |
getDataSource()
The DataSource that this component should bind to for default fields and for performing
DataSource requests. |
java.lang.Boolean |
getDeepCloneOnEdit()
Before we start editing values in this DataBoundComponent, should we perform a deep clone
of the underlying values.
|
DetailViewer |
getDetailViewer()
Automatically genereated DetailViewer instance used to render the content shown in Tiles by default.
|
DetailViewer |
getDetailViewerProperties()
Properties for the
DetailViewer that is automatically created to render the
contents of tiles by default. |
Record[] |
getDragData()
During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.
|
DragDataAction |
getDragDataAction()
Indicates what to do with data dragged into another DataBoundComponent.
|
java.lang.String |
getDragTrackerStyle()
CSS Style to apply to the drag tracker when dragging occurs on this component.
|
java.lang.String |
getDragTrackerTitle(ListGridRecord record,
int rowNum)
Return "title" HTML to display as a drag tracker when the user drags some record.
Default implementation will display the cell value for the title field (see ListGrid.getTitleField()) for the record(s) being dragged (including any icons / custom formatting / styling, etc). |
java.lang.Integer |
getDrawAllMaxTiles()
If drawing all tiles would cause no more than
drawAllMaxTiles tiles to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
incremental rendering would have otherwise been used. |
int |
getDropIndex()
Returns the record index of the tile that would currently be dropped on by the drag in process.
|
java.util.Map |
getDropValues()
When an item is dropped on this component, and
addDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it. |
java.lang.String |
getDuplicateDragMessage()
Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled. |
java.lang.String |
getEditFormulaFieldText()
Text for a menu item allowing users to edit a formula field
|
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
java.lang.String |
getEditSummaryFieldText()
Text for a menu item allowing users to edit the formatter for a field
|
java.lang.String |
getEmptyMessage()
The string to display in the body of a tileGrid with an empty data array, if
showEmptyMessage is true. |
java.lang.String |
getEmptyMessageStyle()
The CSS style name applied to the
emptyMessage if
displayed. |
java.lang.Boolean |
getExportAll()
Setting exportAll to true prevents the component from passing its list of fields to the
export call.
|
java.lang.String[] |
getExportFields()
The list of field-names to export.
|
java.lang.Boolean |
getExportIncludeSummaries()
If Summary rows exist for this component, whether to include them when exporting client data.
|
java.lang.String |
getFetchOperation()
Operation ID this component should use when performing fetch operations.
|
DSRequest |
getFetchRequestProperties()
If
autoFetchData is true, this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. |
Alignment[] |
getFieldAlignments()
Returna an array of field alignments for this grid
|
int |
getFieldCount()
Return the number of fields.
|
com.google.gwt.core.client.JavaScriptObject[] |
getFieldsAsJavaScriptObjects()
Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field
class type
(e.g.
|
java.lang.String |
getFieldState()
Returns a snapshot of the current presentation of this grid's fields as a
ListGridFieldState object. |
java.lang.String |
getFieldState(java.lang.Boolean sparse)
Returns a snapshot of the current presentation of this grid's fields as a
ListGridFieldState object. |
java.lang.String |
getHiliteProperty()
Marker that can be set on a record to flag that record as hilited.
|
Hilite[] |
getHilites()
Return the set of hilite-objects currently applied to this DataBoundComponent.
|
java.lang.String |
getHiliteState()
Get the current hilites encoded as a String, for saving.
|
Criteria |
getImplicitCriteria()
Criteria that are never shown to or edited by the user and are cumulative with any
criteria provided via
DataBoundComponent.initialCriteria,
DataBoundComponent.setCriteria() etc. |
Criteria |
getInitialCriteria()
Criteria to use when
DataBoundComponent.setAutoFetchData(Boolean) is used. |
java.lang.String |
getLoadingDataMessage()
The string to display in the body of a tileGrid while data is being loaded.
|
java.lang.String |
getLoadingDataMessageStyle()
The CSS style name applied to the loadingDataMessage string if displayed.
|
java.lang.String |
getLoadingMessage()
If you have a databound tileGrid and you scroll out of the currently loaded dataset, by default you will see blank tiles
until the server returns the data for those rows.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
static TileGrid |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getPreventDuplicates()
If set, detect and prevent duplicate records from being transferred to this component, either via
drag and drop or via
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). |
java.lang.Integer |
getPrintTilesPerLine()
How many tiles should be present in a line when printing?
|
java.lang.Boolean |
getProgressiveLoading()
Indicates whether or not this component will load its data
progressively |
int |
getRecordIndex(Record record)
Get the index of the provided record.
|
RecordList |
getRecordList()
Return the underlying data of this DataBoundComponent as a
RecordList. |
java.lang.Boolean |
getRecycleTiles()
This property determines whether tiles that are no longer visible (due to scrolling) are recycled, allowing a large
number of records to be displayed using a (potentially) much smaller set of tiles.
|
java.lang.String |
getRemoveOperation()
operationId this component
should use when performing remove operations. |
boolean |
getReselectOnUpdate()
If true, when an update operation occurs on a selected tile's record in a
databound tileGrid, ensure the updated tile is re-selected when
the operation completes. |
SelectionNotificationType |
getReselectOnUpdateNotifications()
if
reselectOnUpdate is true, this property governs
what selection changed notifications should be triggered when a selected tile's record is edited then automatically
reselected when the edited data is merged into the data set. |
ResultSet |
getResultSet()
Return the underlying data of this DataBoundComponent as a
ResultSet. |
java.lang.String |
getSavedSearchId()
Optional identifier for saved searches that should be applied to this component.
|
TileRecord |
getSelectedRecord()
Returns the first selected record in this component.
|
Record[] |
getSelection()
Returns all selected records, as an Array.
|
SelectionStyle |
getSelectionType()
Defines a tileGrid's clickable-selection behavior.
|
java.lang.Boolean |
getShowAllRecords()
Whether tiles are created and drawn for all records, or only for those currently visible.
|
java.lang.Boolean |
getShowComplexFields()
Whether to show fields of non-atomic types when a DataBoundComponent is given a
DataSource but no
component.fields.
|
java.lang.Boolean |
getShowDetailFields()
By default, TileGrids will not show fields marked
detail:true
in the DataSource. |
java.lang.Boolean |
getShowEmptyMessage()
Indicates whether the text of the emptyMessage property should be displayed if no data is available.
|
java.lang.Boolean |
getShowHiddenFields()
Whether to show fields marked
hidden:true when a DataBoundComponent is given a
DataSource but no component.fields.
|
boolean |
getShowSavedSearchesByDS()
Whether to associate saved searches by default with the current
DataSource
of a component when a
savedSearchId is
not provided. |
SortSpecifier[] |
getSort()
Returns the current
SortSpecifiers for
this component. |
java.lang.Boolean |
getSparseFieldState()
If true,
ListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String) will omit state
information for hidden fields by default. |
java.lang.String |
getStyleName()
Style for the overall TileGrid component.
|
SimpleTile |
getTile()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
Canvas |
getTile(int recordNum)
Returns the tile for the passed record or record index.
|
Canvas |
getTile(Record record)
Returns the tile for the passed record or record index.
|
java.lang.String |
getTileConstructor()
Class-name of a Smart GWT component to use for each tile rendered by this TileGrid.
|
DragAppearance |
getTileDragAppearance()
Visual appearance to show when the tile is being dragged.
|
protected java.lang.String |
getTileHTML(Record record)
This method provides the HTML to
be displayed within each tile.
|
int |
getTileIndex(Canvas tile)
Returns the index of the specified tile.
|
Canvas |
getTileProperties()
Common properties to use when creating every tile.
|
TileRecord |
getTileRecord(Canvas tile)
Given a tile within this this tile-grid, this method will return the associated record.
|
Canvas[] |
getTiles()
List of tiles that may be used by the TileGrid to show its current data set.
|
java.lang.String |
getTileScreen()
Screen to create (via
createScreen()) for the tile in lieu of
calling getTile(). |
java.lang.String |
getTileValueAlign()
Horizontal alignment for tile values: "left", "right" or "center".
|
java.lang.String |
getTileValueStyle()
When using the default
SimpleTile, CSS style for each value shown within a
tile. |
java.lang.String |
getTitleField()
Method to return the fieldName which represents the "title" for records in this
Component.
If this.titleField is explicitly specified it will always be used. Otherwise, default implementation will check titleField for databound
components.For non databound components returns the first defined field name of "title",
"name", or "id". |
java.lang.String |
getTitleFieldValue(Record record)
Get the value of the titleField for the passed record
|
java.lang.String |
getUpdateOperation()
operationId this component
should use when performing update operations. |
java.lang.Boolean |
getUseAllDataSourceFields()
If true, the set of fields given by the "default binding" (see
fields) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
|
java.lang.Boolean |
getUseFlatFields()
The
useFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding. |
boolean |
getValuesShowDown()
Should tile values change state when the mouse goes down on them?
|
boolean |
getValuesShowRollOver()
Should tile values change state when the mouse goes over them?
|
boolean |
getValuesShowSelected()
Should tile values change state when they are selected?
|
java.lang.Boolean |
getWrapValues()
Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.
|
void |
invalidateCache()
Invalidate the current data cache for this databound component via a call to the dataset's
invalidateCache() method, for example,
ResultSet.invalidateCache(). |
java.lang.Boolean |
loadAllRecords()
Loads all records that match this grid's current filter-criteria, optionally firing a callback when the data arrives.
|
java.lang.Boolean |
loadAllRecords(java.lang.Integer maxRecords) |
java.lang.Boolean |
loadAllRecords(java.lang.Integer maxRecords,
DSCallback callback)
Loads all records that match this grid's current filter-criteria, optionally firing a callback when the data arrives.
|
protected void |
onInit_TileGrid() |
protected void |
onInit() |
void |
removeData(Record data)
Perform a DataSource "remove" operation to remove records from this component's DataSource.
|
void |
removeData(Record data,
DSCallback callback) |
void |
removeData(Record data,
DSCallback callback,
DSRequest requestProperties)
Perform a DataSource "remove" operation to remove records from this component's DataSource.
|
void |
removeSelectedData()
Remove the currently selected records from this component.
|
boolean |
removeTile(Canvas tileID)
This is not allowed for tileGrid.
|
boolean |
removeTile(int tileID)
This is not allowed for tileGrid.
|
boolean |
removeTile(java.lang.String tileID)
This is not allowed for tileGrid.
|
void |
selectAllRecords()
Select all records
|
void |
selectRange(int startRow,
int endRow)
Select a contiguous range of records by index
|
void |
selectRange(int startRow,
int endRow,
boolean newState)
Select a contiguous range of records by index
|
void |
selectRecord(int record)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecord(int record,
boolean newState)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecord(Record record)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecord(Record record,
boolean newState)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecords(int[] records)
Select/deselect a list of
Records passed in explicitly, or by index. |
void |
selectRecords(int[] records,
boolean newState)
Select/deselect a list of
Records passed in explicitly, or by index. |
void |
selectRecords(Record[] records)
Select/deselect a list of
Records passed in explicitly, or by index. |
void |
selectRecords(Record[] records,
boolean newState)
Select/deselect a list of
Records passed in explicitly, or by index. |
TileGrid |
setAddDropValues(java.lang.Boolean addDropValues)
Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to
different DataSources that are related via a foreign key.
|
TileGrid |
setAddFormulaFieldText(java.lang.String addFormulaFieldText)
Text for a menu item allowing users to add a formula field
|
TileGrid |
setAddOperation(java.lang.String addOperation)
operationId this component
should use when performing add operations. |
TileGrid |
setAddSummaryFieldText(java.lang.String addSummaryFieldText)
Text for a menu item allowing users to add a formula field
|
TileGrid |
setAnimateTileChange(java.lang.Boolean animateTileChange)
If set, when the dataset changes due to filtering, sorting or other actions, any tiles that were showing before and
after the change will animate from their old positions to their new positions.
|
TileGrid |
setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter)
If
DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData() |
TileGrid |
setAutoFetchData(java.lang.Boolean autoFetchData)
If true, when this component is first drawn, automatically call
DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . |
TileGrid |
setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
If
autoFetchData is true, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call. |
TileGrid |
setCanAcceptDroppedRecords(java.lang.Boolean canAcceptDroppedRecords)
Indicates whether records can be dropped into this TileGrid.
|
TileGrid |
setCanAddFormulaFields(java.lang.Boolean canAddFormulaFields)
Adds an item to the header context menu allowing users to launch a dialog to define a new
field based on values present in other fields, using the
com.smartgwt.client..FormulaBuilder.
|
TileGrid |
setCanAddSummaryFields(java.lang.Boolean canAddSummaryFields)
Adds an item to the header context menu allowing users to launch a dialog to define a new
text field that can contain both user-defined text and the formatted values present in other
fields, using the
com.smartgwt.client..SummaryBuilder.
|
TileGrid |
setCanDragTilesOut(java.lang.Boolean canDragTilesOut)
Indicates whether tiles can be dragged from this
TileGrid and dropped elsewhere. |
TileGrid |
setCanReorderTiles(java.lang.Boolean canReorderTiles)
Indicates whether tiles can be reordered by dragging within this
TileGrid. |
void |
setCreateTileCustomizer(CreateTileCustomizer customizer)
Set customizer that defines
createTile. |
TileGrid |
setData(Record... data)
A List of TileRecord objects, specifying the data to be used to create the tiles.
|
TileGrid |
setData(RecordList data)
A List of TileRecord objects, specifying the data to be used to create the tiles.
|
TileGrid |
setData(TileRecord... data)
A List of TileRecord objects, specifying the data to be used to create the tiles.
|
TileGrid |
setDataArity(java.lang.String dataArity)
A TileGrid is a
dataArity:multiple component. |
TileGrid |
setDataFetchMode(FetchMode dataFetchMode)
How to fetch and manage records retrieve from the server.
|
TileGrid |
setDataPageSize(int dataPageSize)
When using
data
paging, how many records to fetch at a time. |
TileGrid |
setDataSource(DataSource dataSource)
The DataSource that this component should bind to for default fields and for performing
DataSource requests. |
void |
setDataSource(DataSource dataSource,
DetailViewerField... fields)
Bind to a DataSource.
|
TileGrid |
setDataSource(java.lang.String dataSource)
The DataSource that this component should bind to for default fields and for performing
DataSource requests. |
TileGrid |
setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
Before we start editing values in this DataBoundComponent, should we perform a deep clone
of the underlying values.
|
static void |
setDefaultProperties(TileGrid tileGridProperties)
Class level method to set the default properties of this class.
|
TileGrid |
setDetailViewerProperties(DetailViewer detailViewerProperties)
Properties for the
DetailViewer that is automatically created to render the
contents of tiles by default. |
TileGrid |
setDragDataAction(DragDataAction dragDataAction)
Indicates what to do with data dragged into another DataBoundComponent.
|
TileGrid |
setDragDataCustomizer(DragDataCustomizer customizer)
During a drag-and-drop interaction, this method returns the set of records being dragged
out of the component.
|
TileGrid |
setDragTrackerStyle(java.lang.String dragTrackerStyle)
CSS Style to apply to the drag tracker when dragging occurs on this component.
|
TileGrid |
setDrawAllMaxTiles(java.lang.Integer drawAllMaxTiles)
If drawing all tiles would cause no more than
drawAllMaxTiles tiles to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
incremental rendering would have otherwise been used. |
TileGrid |
setDropValues(java.util.Map dropValues)
When an item is dropped on this component, and
addDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it. |
TileGrid |
setDuplicateDragMessage(java.lang.String duplicateDragMessage)
Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled. |
TileGrid |
setEditFormulaFieldText(java.lang.String editFormulaFieldText)
Text for a menu item allowing users to edit a formula field
|
TileGrid |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
TileGrid |
setEditSummaryFieldText(java.lang.String editSummaryFieldText)
Text for a menu item allowing users to edit the formatter for a field
|
TileGrid |
setEmptyMessage(java.lang.String emptyMessage)
The string to display in the body of a tileGrid with an empty data array, if
showEmptyMessage is true. |
TileGrid |
setEmptyMessageStyle(java.lang.String emptyMessageStyle)
The CSS style name applied to the
emptyMessage if
displayed. |
TileGrid |
setExportAll(java.lang.Boolean exportAll)
Setting exportAll to true prevents the component from passing its list of fields to the
export call.
|
TileGrid |
setExportFields(java.lang.String[] exportFields)
The list of field-names to export.
|
TileGrid |
setExportIncludeSummaries(java.lang.Boolean exportIncludeSummaries)
If Summary rows exist for this component, whether to include them when exporting client data.
|
TileGrid |
setFetchOperation(java.lang.String fetchOperation)
Operation ID this component should use when performing fetch operations.
|
TileGrid |
setFetchRequestProperties(DSRequest fetchRequestProperties)
If
autoFetchData is true, this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. |
TileGrid |
setFields(DetailViewerField... fields)
Array of field definitions to control the default rendering of tiles.
|
TileGrid |
setFields(com.google.gwt.core.client.JavaScriptObject... fields)
Field setter variant (alternative to
setFields(FormItem...),
setFields(ListGridField...),
etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT
Java wrappers of the field class type (e.g. |
void |
setFieldState(java.lang.String fieldState)
Sets some presentation properties (visibility, width, userFormula and userSummary) of the grid fields based on the
ListGridFieldState object passed in.Used to restore previous state retrieved from the grid by a call to getFieldState(). |
void |
setFieldState(java.lang.String fieldState,
java.lang.Boolean isSparse)
Sets some presentation properties (visibility, width, userFormula and userSummary) of the grid fields based on the
ListGridFieldState object passed in.Used to restore previous state retrieved from the grid by a call to getFieldState(). |
TileGrid |
setHiliteProperty(java.lang.String hiliteProperty)
Marker that can be set on a record to flag that record as hilited.
|
TileGrid |
setHilites(Hilite[] hilites)
Accepts an array of hilite objects and applies them to this DataBoundComponent.
|
TileGrid |
setHiliteState(java.lang.String hiliteState)
Set the current hilites based on a hiliteState String previously returned from getHilitesState.
|
TileGrid |
setImplicitCriteria(Criteria implicitCriteria)
Criteria that are never shown to or edited by the user and are cumulative with any
criteria provided via
DataBoundComponent.initialCriteria,
DataBoundComponent.setCriteria() etc. |
java.lang.Boolean |
setImplicitCriteria(Criteria implicitCriteria,
DSCallback callback) |
java.lang.Boolean |
setImplicitCriteria(Criteria criteria,
DSCallback callback,
java.lang.Boolean initialFetch) |
TileGrid |
setInitialCriteria(Criteria initialCriteria)
Criteria to use when
DataBoundComponent.setAutoFetchData(Boolean) is used. |
TileGrid |
setLoadingDataMessage(java.lang.String loadingDataMessage)
The string to display in the body of a tileGrid while data is being loaded.
|
TileGrid |
setLoadingDataMessageStyle(java.lang.String loadingDataMessageStyle)
The CSS style name applied to the loadingDataMessage string if displayed.
|
TileGrid |
setLoadingMessage(java.lang.String loadingMessage)
If you have a databound tileGrid and you scroll out of the currently loaded dataset, by default you will see blank tiles
until the server returns the data for those rows.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.tile.TileGridLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
TileGrid |
setPreventDuplicates(java.lang.Boolean preventDuplicates)
If set, detect and prevent duplicate records from being transferred to this component, either via
drag and drop or via
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). |
TileGrid |
setPrintTilesPerLine(java.lang.Integer printTilesPerLine)
How many tiles should be present in a line when printing?
|
TileGrid |
setProgressiveLoading(java.lang.Boolean progressiveLoading)
Indicates whether or not this component will load its data
progressively |
TileGrid |
setRecycleTiles(java.lang.Boolean recycleTiles)
This property determines whether tiles that are no longer visible (due to scrolling) are recycled, allowing a large
number of records to be displayed using a (potentially) much smaller set of tiles.
|
TileGrid |
setRemoveOperation(java.lang.String removeOperation)
operationId this component
should use when performing remove operations. |
TileGrid |
setReselectOnUpdate(boolean reselectOnUpdate)
If true, when an update operation occurs on a selected tile's record in a
databound tileGrid, ensure the updated tile is re-selected when
the operation completes. |
TileGrid |
setReselectOnUpdateNotifications(SelectionNotificationType reselectOnUpdateNotifications)
if
reselectOnUpdate is true, this property governs
what selection changed notifications should be triggered when a selected tile's record is edited then automatically
reselected when the edited data is merged into the data set. |
TileGrid |
setSavedSearchId(java.lang.String savedSearchId)
Optional identifier for saved searches that should be applied to this component.
|
TileGrid |
setSelectionType(SelectionStyle selectionType)
Defines a tileGrid's clickable-selection behavior.
|
TileGrid |
setShowAllRecords(java.lang.Boolean showAllRecords)
Whether tiles are created and drawn for all records, or only for those currently visible.
|
TileGrid |
setShowComplexFields(java.lang.Boolean showComplexFields)
Whether to show fields of non-atomic types when a DataBoundComponent is given a
DataSource but no
component.fields.
|
TileGrid |
setShowDetailFields(java.lang.Boolean showDetailFields)
By default, TileGrids will not show fields marked
detail:true
in the DataSource. |
TileGrid |
setShowEmptyMessage(java.lang.Boolean showEmptyMessage)
Indicates whether the text of the emptyMessage property should be displayed if no data is available.
|
TileGrid |
setShowHiddenFields(java.lang.Boolean showHiddenFields)
Whether to show fields marked
hidden:true when a DataBoundComponent is given a
DataSource but no component.fields.
|
TileGrid |
setShowSavedSearchesByDS(boolean showSavedSearchesByDS)
Whether to associate saved searches by default with the current
DataSource
of a component when a
savedSearchId is
not provided. |
TileGrid |
setSort(SortSpecifier... sortSpecifiers)
Sort the component on one or more fields.
|
TileGrid |
setSparseFieldState(java.lang.Boolean sparseFieldState)
If true,
ListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String) will omit state
information for hidden fields by default. |
void |
setStyleName(java.lang.String styleName)
Style for the overall TileGrid component.
|
TileGrid |
setTileConstructor(java.lang.String tileConstructor)
Class-name of a Smart GWT component to use for each tile rendered by this TileGrid.
|
TileGrid |
setTileDragAppearance(DragAppearance tileDragAppearance)
Visual appearance to show when the tile is being dragged.
|
TileGrid |
setTileProperties(Canvas tileProperties)
Common properties to use when creating every tile.
|
TileGrid |
setTiles(Canvas... tiles)
List of tiles that may be used by the TileGrid to show its current data set.
|
TileGrid |
setTileScreen(java.lang.String tileScreen)
Screen to create (via
createScreen()) for the tile in lieu of
calling getTile(). |
TileGrid |
setTileValueAlign(java.lang.String tileValueAlign)
Horizontal alignment for tile values: "left", "right" or "center".
|
TileGrid |
setTileValueStyle(java.lang.String tileValueStyle)
When using the default
SimpleTile, CSS style for each value shown within a
tile. |
TileGrid |
setTitleField(java.lang.String titleField)
Sets the best field to use for a user-visible title for an individual record from this component.
|
TileGrid |
setUpdateOperation(java.lang.String updateOperation)
operationId this component
should use when performing update operations. |
void |
setUpdateTileCustomizer(UpdateTileCustomizer customizer)
Set customizer that defines
updateTile. |
TileGrid |
setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
If true, the set of fields given by the "default binding" (see
fields) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
|
TileGrid |
setUseFlatFields(java.lang.Boolean useFlatFields)
The
useFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding. |
TileGrid |
setValuesShowDown(boolean valuesShowDown)
Should tile values change state when the mouse goes down on them?
|
TileGrid |
setValuesShowRollOver(boolean valuesShowRollOver)
Should tile values change state when the mouse goes over them?
|
TileGrid |
setValuesShowSelected(boolean valuesShowSelected)
Should tile values change state when they are selected?
|
TileGrid |
setWrapValues(java.lang.Boolean wrapValues)
Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.
|
void |
sortByProperty(java.lang.String property,
boolean ascending)
Deprecated.
Use
setSort(com.smartgwt.client.data.SortSpecifier...) instead. |
void |
transferRecords(Record[] records,
Record targetRecord,
java.lang.Integer index,
Canvas sourceWidget,
TransferRecordsCallback callback)
Transfer a list of
Records from another component
(does not have to be a databound component) into this component. |
void |
transferSelectedData(DataBoundComponent source)
Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
|
void |
transferSelectedData(DataBoundComponent source,
int index)
Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
|
void |
viewSelectedData(ListGrid selectionComponent)
Displays the currently selected record(s) of the selectionComponent widget (typically a listGrid) in this component.
|
void |
viewSelectedData(java.lang.String selectionComponent)
Displays the currently selected record(s) of the selectionComponent widget (typically a listGrid) in this component.
|
void |
viewSelectedData(TileGrid selectionComponent)
Displays the currently selected record(s) of the selectionComponent widget (typically a listGrid) in this component.
|
addTile, addTile, getAutoWrapLines, getDragLine, getDragLineStyle, getDragLineThickness, getExpandMargins, getLayoutMargin, getOrientation, getOverflow, getPaddingAsLayoutMargin, getShowDragLine, getTileHeight, getTileHMargin, getTileMargin, getTileSize, getTilesPerLine, getTileVMargin, getTileWidth, layoutTiles, setAutoWrapLines, setDefaultProperties, setDragLineStyle, setDragLineThickness, setExpandMargins, setLayoutMargin, setLayoutPolicy, setLogicalStructure, setOrientation, setOverflow, setPaddingAsLayoutMargin, setShowDragLine, setTileHeight, setTileHMargin, setTileMargin, setTileSize, setTilesPerLine, setTileVMargin, setTileWidth, transformTileRectaddChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropaddDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetOrCreateJsObjpublic TileGrid()
public TileGrid(com.google.gwt.core.client.JavaScriptObject jsObj)
public static TileGrid getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
create in class TileLayoutpublic TileGrid setAnimateTileChange(java.lang.Boolean animateTileChange)
Note : This is an advanced setting
setAnimateTileChange in class TileLayoutanimateTileChange - New animateTileChange value. Default value is trueTileGrid instance, for chaining setter callsAppearance overview and related methodspublic java.lang.Boolean getAnimateTileChange()
getAnimateTileChange in class TileLayoutAppearance overview and related methodspublic TileGrid setCanAcceptDroppedRecords(java.lang.Boolean canAcceptDroppedRecords)
canAcceptDroppedRecords.canAcceptDroppedRecords - New canAcceptDroppedRecords value. Default value is falseTileGrid instance, for chaining setter callspublic java.lang.Boolean getCanAcceptDroppedRecords()
public TileGrid setCanDragTilesOut(java.lang.Boolean canDragTilesOut)
TileGrid and dropped elsewhere. NOTE:
If canDragTilesOut is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a tile starts a drag operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag and drop of tiles out of the grid.
If this method is called after the component has been drawn/initialized:
Setter for canDragTilesOut.
canDragTilesOut - New canDragTilesOut value. Default value is falseTileGrid instance, for chaining setter callspublic java.lang.Boolean getCanDragTilesOut()
TileGrid and dropped elsewhere. NOTE:
If canDragTilesOut is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a tile starts a drag operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag and drop of tiles out of the grid.
public TileGrid setCanReorderTiles(java.lang.Boolean canReorderTiles)
TileGrid. NOTE: If
canReorderTiles is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a tile starts a reorder operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag-reordering of tiles.
If this method is called after the component has been drawn/initialized:
Setter for canReorderTiles.
canReorderTiles - New canReorderTiles value. Default value is falseTileGrid instance, for chaining setter callspublic java.lang.Boolean getCanReorderTiles()
TileGrid. NOTE: If
canReorderTiles is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a tile starts a reorder operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag-reordering of tiles.
public TileGrid setData(TileRecord... data)
This property will typically not
be explicitly specified for databound TileGrids, where the data is returned from the server via databound component
methods such as fetchData(). In this case the data objects
will be set to a resultSet rather than a simple array.
If this method is called after the component has been drawn/initialized:
Provides a new data set to the TileGrid after the grid has been created or drawn. The TileGrid will redraw to show the new data automatically.
data - data to show in the list. Default value is nullTileGrid instance, for chaining setter callsTileRecordpublic TileGrid setData(Record... data)
This property will typically not
be explicitly specified for databound TileGrids, where the data is returned from the server via databound component
methods such as fetchData(). In this case the data objects
will be set to a resultSet rather than a simple array.
If this method is called after the component has been drawn/initialized:
Provides a new data set to the TileGrid after the grid has been created or drawn. The TileGrid will redraw to show the new data automatically.
data - data to show in the list. Default value is nullTileGrid instance, for chaining setter callsTileRecordpublic TileGrid setData(RecordList data)
This property will typically not
be explicitly specified for databound TileGrids, where the data is returned from the server via databound component
methods such as fetchData(). In this case the data objects
will be set to a resultSet rather than a simple array.
If this method is called after the component has been drawn/initialized:
Provides a new data set to the TileGrid after the grid has been created or drawn. The TileGrid will redraw to show the new data automatically.
data - data to show in the list. Default value is nullTileGrid instance, for chaining setter callsTileRecordpublic TileGrid setDataArity(java.lang.String dataArity)
dataArity:multiple component.
Note : This is an advanced setting
dataArity - New dataArity value. Default value is "multiple"TileGrid instance, for chaining setter callsDataBindingpublic java.lang.String getDataArity()
dataArity:multiple component.DataBindingpublic TileGrid setDataFetchMode(FetchMode dataFetchMode)
FetchMode. This
setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData()
instead, it's existing setting for ResultSet.fetchMode applies.
setDataFetchMode in interface DataBoundComponentdataFetchMode - New dataFetchMode value. Default value is "paged"TileGrid instance, for chaining setter callssetShowAllRecords(java.lang.Boolean),
DataBindingpublic FetchMode getDataFetchMode()
FetchMode. This
setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData()
instead, it's existing setting for ResultSet.fetchMode applies.
getDataFetchMode in interface DataBoundComponentgetShowAllRecords(),
DataBindingpublic TileGrid setDataSource(DataSource dataSource)
DataSource requests. Can be specified as either a DataSource instance or the String ID of a DataSource.
setDataSource in interface DataBoundComponentdataSource - New dataSource value. Default value is nullTileGrid instance, for chaining setter callsDataBinding,
DataSource fields Examplepublic TileGrid setDataSource(java.lang.String dataSource)
DataSource requests. Can be specified as either a DataSource instance or the String ID of a DataSource.
setDataSource in interface DataBoundComponentdataSource - New dataSource value. Default value is nullTileGrid instance, for chaining setter callsDataBinding,
DataSource fields Examplepublic DetailViewer getDetailViewer() throws java.lang.IllegalStateException
This
detailViewer is never actually drawn or displayed to the user - it is simply used to generate the contents of
SimpleTiles as described in getTileHTML().
This component is an AutoChild named "detailViewer". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public TileGrid setDetailViewerProperties(DetailViewer detailViewerProperties) throws java.lang.IllegalStateException
DetailViewer that is automatically created to render the
contents of tiles by default.detailViewerProperties - New detailViewerProperties value. Default value is nullTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdSGWTPropertiespublic DetailViewer getDetailViewerProperties()
DetailViewer that is automatically created to render the
contents of tiles by default.public TileGrid setDrawAllMaxTiles(java.lang.Integer drawAllMaxTiles)
drawAllMaxTiles tiles to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
incremental rendering would have otherwise been used. The drawAllMaxTiles setting prevents incremental
rendering from being used in situations where it's really unnecessary, such as a 25 record dataset which happens to be
in a grid with a viewport showing only 15 or so tiles. Incremental rendering causes a brief "flash" during scrolling as
the visible portion of the dataset is redrawn, and a better scrolling experience can be obtained in this situation by
drawing the entire dataset up front, which in this example would have negligible effect on initial draw time.
drawAllMaxTiles:0 disables this features. You may want to disable this feature if performance is an issue
and:
Note : This is an advanced setting
drawAllMaxTiles - New drawAllMaxTiles value. Default value is 25TileGrid instance, for chaining setter callssetTileConstructor(java.lang.String)public java.lang.Integer getDrawAllMaxTiles()
drawAllMaxTiles tiles to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
incremental rendering would have otherwise been used. The drawAllMaxTiles setting prevents incremental
rendering from being used in situations where it's really unnecessary, such as a 25 record dataset which happens to be
in a grid with a viewport showing only 15 or so tiles. Incremental rendering causes a brief "flash" during scrolling as
the visible portion of the dataset is redrawn, and a better scrolling experience can be obtained in this situation by
drawing the entire dataset up front, which in this example would have negligible effect on initial draw time.
drawAllMaxTiles:0 disables this features. You may want to disable this feature if performance is an issue
and:
getTileConstructor()public TileGrid setEditProxyConstructor(java.lang.String editProxyConstructor) throws java.lang.IllegalStateException
EditProxy for this component when the component is
first placed into edit mode.setEditProxyConstructor in class CanvaseditProxyConstructor - New editProxyConstructor value. Default value is "GridEditProxy"TileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdSCClassNamepublic java.lang.String getEditProxyConstructor()
EditProxy for this component when the component is
first placed into edit mode.getEditProxyConstructor in class CanvasSCClassNamepublic TileGrid setEmptyMessage(java.lang.String emptyMessage)
showEmptyMessage is true.emptyMessage - New emptyMessage value. Default value is "No tiles to show."TileGrid instance, for chaining setter callssetShowEmptyMessage(java.lang.Boolean),
setEmptyMessageStyle(java.lang.String),
HTMLStringpublic java.lang.String getEmptyMessage()
showEmptyMessage is true.getShowEmptyMessage(),
getEmptyMessageStyle(),
HTMLStringpublic TileGrid setEmptyMessageStyle(java.lang.String emptyMessageStyle)
emptyMessage if
displayed.emptyMessageStyle - New emptyMessageStyle value. Default value is "emptyMessage"TileGrid instance, for chaining setter callsCSSStyleNamepublic java.lang.String getEmptyMessageStyle()
emptyMessage if
displayed.CSSStyleNamepublic TileGrid setFetchRequestProperties(DSRequest fetchRequestProperties) throws java.lang.IllegalStateException
autoFetchData is true, this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. Note that any properties governing
more specific request attributes for the initial fetch (such as autoFetchTextMatchStyle and initial sort
specifiers) will be applied on top of this properties block.
fetchRequestProperties - New fetchRequestProperties value. Default value is nullTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdDataBindingpublic DSRequest getFetchRequestProperties()
autoFetchData is true, this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. Note that any properties governing
more specific request attributes for the initial fetch (such as autoFetchTextMatchStyle and initial sort
specifiers) will be applied on top of this properties block.
DataBindingpublic TileGrid setFields(DetailViewerField... fields) throws java.lang.IllegalStateException
If not specified, if the DataSource has an iconField, only the
iconField and titleField will be shown.
Otherwise, all non-hidden
non-detail fields will be shown, similar to the default set
of
fields shown by a ListGrid.
Only applicable if using the default SimpleTile class for tiles.
(See tile for more information).
For SimpleTiles, it is possible to use DetailViewerField.getCellStyle() and
StatefulCanvas.getStateSuffix() to make a single field
statefully styled:
final TileGrid tileGrid = new TileGrid();
DetailViewerField animalNameField = new DetailViewerField("countryName");
animalNameField.setCellStyleHandler(new CellStyleHandler() {
public String execute(Object value, DetailViewerField field, Record record) {
SimpleTile tile = tileGrid.getCurrentTile();
if (value == "Tiger") return "tigerStyle" + tile.getStateSuffix();
else return "nonTigerStyle" + tile.getStateSuffix();
}
});
tileGrid.setFields(animalNameField);
fields - New fields value. Default value is nullTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic TileGrid setLoadingDataMessage(java.lang.String loadingDataMessage)
"${loadingImage}" to
include a loading image.loadingDataMessage - New loadingDataMessage value. Default value is "${loadingImage} Loading data..."TileGrid instance, for chaining setter callssetLoadingDataMessageStyle(java.lang.String),
HTMLStringpublic java.lang.String getLoadingDataMessage()
"${loadingImage}" to
include a loading image.getLoadingDataMessageStyle(),
HTMLStringpublic TileGrid setLoadingDataMessageStyle(java.lang.String loadingDataMessageStyle)
loadingDataMessageStyle - New loadingDataMessageStyle value. Default value is "loadingDataMessage"TileGrid instance, for chaining setter callsCSSStyleNamepublic java.lang.String getLoadingDataMessageStyle()
CSSStyleNamepublic TileGrid setLoadingMessage(java.lang.String loadingMessage) throws java.lang.IllegalStateException
loadingMessage - New loadingMessage value. Default value is nullTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdHTMLStringpublic java.lang.String getLoadingMessage()
HTMLStringpublic TileGrid setPrintTilesPerLine(java.lang.Integer printTilesPerLine) throws java.lang.IllegalStateException
printTilesPerLine - New printTilesPerLine value. Default value is nullTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getPrintTilesPerLine()
public TileGrid setRecycleTiles(java.lang.Boolean recycleTiles) throws java.lang.IllegalStateException
Recycling tiles may significantly reduce the number of live tile widgets needed to support a particular TileGrid, but may also result in extra work when the TileGrid is scrolled, as a scroll that brings off-screen tiles into view will require recycling tiles that have left the view, even if the new tiles have been visited before (in previous scrolling).
Recycling will occur when getTile() is called, unless the supplied record (or record specified
by index) is currently bound to an existing tile. Even if recycling is not enabled, the record associated with a given
tile may change if the TileGrid data changes.
For more control over the tile creation and recycling process, see
createTile() and updateTile().
recycleTiles - New recycleTiles value. Default value is trueTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getRecycleTiles()
Recycling tiles may significantly reduce the number of live tile widgets needed to support a particular TileGrid, but may also result in extra work when the TileGrid is scrolled, as a scroll that brings off-screen tiles into view will require recycling tiles that have left the view, even if the new tiles have been visited before (in previous scrolling).
Recycling will occur when getTile() is called, unless the supplied record (or record specified
by index) is currently bound to an existing tile. Even if recycling is not enabled, the record associated with a given
tile may change if the TileGrid data changes.
For more control over the tile creation and recycling process, see
createTile() and updateTile().
public TileGrid setReselectOnUpdate(boolean reselectOnUpdate) throws java.lang.IllegalStateException
databound tileGrid, ensure the updated tile is re-selected when
the operation completes. The reselectOnUpdateNotifications attributes governs whether selectionUpdated() and CubeGrid.selectionChanged() will fire when this
occurs.
Note : This is an advanced setting
reselectOnUpdate - New reselectOnUpdate value. Default value is trueTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getReselectOnUpdate()
databound tileGrid, ensure the updated tile is re-selected when
the operation completes. The reselectOnUpdateNotifications attributes governs whether selectionUpdated() and CubeGrid.selectionChanged() will fire when this
occurs.public TileGrid setReselectOnUpdateNotifications(SelectionNotificationType reselectOnUpdateNotifications)
reselectOnUpdate is true, this property governs
what selection changed notifications should be triggered when a selected tile's record is edited then automatically
reselected when the edited data is merged into the data set.
Note : This is an advanced setting
reselectOnUpdateNotifications - New reselectOnUpdateNotifications value. Default value is "selectionChanged"TileGrid instance, for chaining setter callspublic SelectionNotificationType getReselectOnUpdateNotifications()
reselectOnUpdate is true, this property governs
what selection changed notifications should be triggered when a selected tile's record is edited then automatically
reselected when the edited data is merged into the data set.public TileGrid setSelectionType(SelectionStyle selectionType)
selectionType - New selectionType value. Default value is Selection.MULTIPLETileGrid instance, for chaining setter callsSelectionStyle,
Appearance overview and related methods,
Editing Examplepublic SelectionStyle getSelectionType()
SelectionStyle,
Appearance overview and related methods,
Editing Examplepublic TileGrid setShowAllRecords(java.lang.Boolean showAllRecords) throws java.lang.IllegalStateException
This setting is
incompatible with dataFetchMode: "paged" as it
requires all records matching the criteria to be fetched from the server at once.
showAllRecords - New showAllRecords value. Default value is falseTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowAllRecords()
This setting is
incompatible with dataFetchMode: "paged" as it
requires all records matching the criteria to be fetched from the server at once.
public TileGrid setShowDetailFields(java.lang.Boolean showDetailFields) throws java.lang.IllegalStateException
detail:true
in the DataSource. See also fields.setShowDetailFields in interface DataBoundComponentshowDetailFields - New showDetailFields value. Default value is falseTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDetailFields()
detail:true
in the DataSource. See also fields.getShowDetailFields in interface DataBoundComponentpublic TileGrid setShowEmptyMessage(java.lang.Boolean showEmptyMessage)
showEmptyMessage - New showEmptyMessage value. Default value is trueTileGrid instance, for chaining setter callssetEmptyMessage(java.lang.String)public java.lang.Boolean getShowEmptyMessage()
getEmptyMessage()public void setStyleName(java.lang.String styleName)
throws java.lang.IllegalStateException
setStyleName in class CanvasstyleName - New styleName value. Default value is "tileGrid"java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName,
Appearance overview and related methodspublic java.lang.String getStyleName()
getStyleName in class CanvasCSSStyleName,
Appearance overview and related methodspublic SimpleTile getTile()
Using AutoChildren
for details.
A TileGrid automatically creates one tile per record in the dataset, via the
com.smartgwt.client.types.AutoChild pattern.
By default, the SimpleTile class will be used. This class automatically invokes
getTileHTML() on the tileGrid to generate its content. The
standard getTileHTML()
method uses a detailViewer to render html for the
tile's record, based on the
provided fields (or on the default set of fields).
To create a completely different appearance set tileConstructor to custom Canvas
class name. You can use SmartGWT classes too with help of Reflection. For example, you can
extend a DynamicForm with any layout:
public class CarTile extends DynamicForm {
public CarTile() {
StaticTextItem name = new StaticTextItem("name");
name.setShowTitle(false);
StaticTextItem price = new StaticTextItem("price");
price.setShowTitle(false);
this.setFields(pictureItem, name, price);
}
}
Register the class factory and use it by passing it's class to tileConstructor
public interface CarTileMetaFactory extends BeanFactory.MetaFactory {
BeanFactory getCarTileFactory();
}
public void onModuleLoad() {
GWT.create(CarTileMetaFactory.class);
TileGrid tileGrid = new TileGrid();
tileGrid.setTileConstructor(CarTile.class.getName());
tileGrid.draw();
}
public TileGrid setTileConstructor(java.lang.String tileConstructor)
com.smartgwt.client.types.AutoChild pattern; see tile.
Any subclass of Canvas is allowed, but typically any custom class will derive from SimpleTile.
When using a custom component for tileConstructor, DataBoundComponents
that display multiple Records (ListGrid, DetailViewer) will have data provided via ListGrid.setData(), and components that display a single Record
(DynamicForm) will have DynamicForm.setValues() called on
them.
If the component is not a recognized DataBoundComponent subclass, the Record can be accessed via
this.getAttributeAsRecord("record").
If you implement particularly simple or particularly complex tile
interfaces, you may wish to adjust the property drawAllMaxTiles.
tileConstructor - New tileConstructor value. Default value is "SimpleTile"TileGrid instance, for chaining setter callsSCClassName,
Custom Tiles Examplepublic java.lang.String getTileConstructor()
com.smartgwt.client.types.AutoChild pattern; see tile.
Any subclass of Canvas is allowed, but typically any custom class will derive from SimpleTile.
When using a custom component for tileConstructor, DataBoundComponents
that display multiple Records (ListGrid, DetailViewer) will have data provided via ListGrid.setData(), and components that display a single Record
(DynamicForm) will have DynamicForm.setValues() called on
them.
If the component is not a recognized DataBoundComponent subclass, the Record can be accessed via
this.getAttributeAsRecord("record").
If you implement particularly simple or particularly complex tile
interfaces, you may wish to adjust the property drawAllMaxTiles.
SCClassName,
Custom Tiles Examplepublic TileGrid setTileDragAppearance(DragAppearance tileDragAppearance)
Note : This is an advanced setting
tileDragAppearance - New tileDragAppearance value. Default value is EventHandler.TRACKERTileGrid instance, for chaining setter callsCanvas.setDragAppearance(com.smartgwt.client.types.DragAppearance),
Drag and Droppublic DragAppearance getTileDragAppearance()
Canvas.getDragAppearance(),
Drag and Droppublic TileGrid setTileProperties(Canvas tileProperties)
tileProperties - New tileProperties value. Default value is nullTileGrid instance, for chaining setter callsSGWTPropertiespublic Canvas getTileProperties()
public TileGrid setTiles(Canvas... tiles) throws java.lang.IllegalStateException
recycleTiles is set or
not. The number of records in the TileGrid's current data set may be determined by calling getLength() on it.
setTiles in class TileLayouttiles - New tiles value. Default value is nullTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetRecycleTiles(java.lang.Boolean),
setTileConstructor(java.lang.String)public Canvas[] getTiles()
recycleTiles is set or
not. The number of records in the TileGrid's current data set may be determined by calling getLength() on it.
getRecycleTiles(),
getTileConstructor()public TileGrid setTileScreen(java.lang.String tileScreen) throws java.lang.IllegalStateException
createScreen()) for the tile in lieu of
calling getTile(). If this grid has a dataSource, the created screen is provided with a Canvas.dataContext that includes the record being expanded. Be sure
the tile screen meets these requirements to utilize the
dataContext.
tileScreen - New tileScreen value. Default value is nullTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getTileScreen()
createScreen()) for the tile in lieu of
calling getTile(). If this grid has a dataSource, the created screen is provided with a Canvas.dataContext that includes the record being expanded. Be sure
the tile screen meets these requirements to utilize the
dataContext.
public TileGrid setTileValueAlign(java.lang.String tileValueAlign) throws java.lang.IllegalStateException
tileValueAlign - New tileValueAlign value. Default value is "center"TileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getTileValueAlign()
public TileGrid setTileValueStyle(java.lang.String tileValueStyle) throws java.lang.IllegalStateException
SimpleTile, CSS style for each value shown within a
tile.tileValueStyle - New tileValueStyle value. Default value is "tileValue"TileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleNamepublic java.lang.String getTileValueStyle()
SimpleTile, CSS style for each value shown within a
tile.CSSStyleNamepublic TileGrid setValuesShowDown(boolean valuesShowDown) throws java.lang.IllegalStateException
valuesShowDown - New valuesShowDown value. Default value is falseTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getValuesShowDown()
public TileGrid setValuesShowRollOver(boolean valuesShowRollOver) throws java.lang.IllegalStateException
valuesShowRollOver - New valuesShowRollOver value. Default value is falseTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getValuesShowRollOver()
public TileGrid setValuesShowSelected(boolean valuesShowSelected) throws java.lang.IllegalStateException
valuesShowSelected - New valuesShowSelected value. Default value is trueTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getValuesShowSelected()
public TileGrid setWrapValues(java.lang.Boolean wrapValues) throws java.lang.IllegalStateException
wrapValues - New wrapValues value. Default value is falseTileGrid instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getWrapValues()
public void addData(Record newRecord)
newRecord - new recordDataBound Component Methods,
Databound add Examplepublic void addData(Record newRecord, DSCallback callback)
addData(com.smartgwt.client.data.Record)public void addData(Record newRecord, DSCallback callback, DSRequest requestProperties)
newRecord - new recordcallback - method to call on operation completionrequestProperties - additional properties to set on the DSRequest that will be issuedDataBound Component Methods,
Databound add Examplepublic void addTile()
addData().public com.google.gwt.event.shared.HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)
Notification method fired when new data arrives from the server to be displayed in this tileGrid, (for example in
response to the user scrolling a new set of tiles into view). Only applies to databound tileGrid where the data attribute is a ResultSet. This
method is fired directly in response to dataArrived()
firing on the data object.
addDataArrivedHandler in interface HasDataArrivedHandlershandler - the dataArrived handlerHandlerRegistration used to remove this handlerpublic void deselectRange(int startRow,
int endRow)
This is a synonym for selectRange(startRow, endRow,
false);
startRow - start of selection rangeendRow - end of selection range (non-inclusive)Selectionpublic SimpleTile getCurrentTile()
public java.lang.String getDragTrackerTitle(ListGridRecord record, int rowNum)
ListGrid.getTitleField()) for the record(s) being dragged (including any icons / custom formatting / styling, etc).
Note: Only called if ListGrid.dragTrackerMode is
set to "title".
record - First selected record being draggedrowNum - row index of first record being draggedpublic int getDropIndex()
getTile() to get the corresponding
visible tile.getDropIndex in class TileLayoutTileLayout.transformTileRect(int, int, int, int)public java.lang.String getFieldState()
ListGridFieldState object. This object can be passed to setFieldState() to reset this grid's fields to the current
state.
Note that the information stored includes the current width and visibility of each of this grid's fields.
The optional sparse parameter governs whether the returned field state should omit state information
for hidden fields. If this parameter is not passed explicitly, field state will be sparse if DataBoundComponent.sparseFieldState is true.
When applying sparse field state to a component via setFieldState(), any explicitly defined fields on the component that were not captured in the stored state object will
be hidden.
ListGridFieldStatesetFieldState(java.lang.String)public java.lang.String getFieldState(java.lang.Boolean sparse)
ListGridFieldState object. This object can be passed to setFieldState() to reset this grid's fields to the current
state.
Note that the information stored includes the current width and visibility of each of this grid's fields.
The optional sparse parameter governs whether the returned field state should omit state information
for hidden fields. If this parameter is not passed explicitly, field state will be sparse if DataBoundComponent.sparseFieldState is true.
When applying sparse field state to a component via setFieldState(), any explicitly defined fields on the component that were not captured in the stored state object will
be hidden.
sparse - If true, field state will be ommitted for hidden fields.ListGridFieldStatesetFieldState(java.lang.String)public TileRecord getSelectedRecord()
NOTE: If a record is returned, it should be treated as read-only and not modified.
Selection,
Databound remove Examplepublic int getTileIndex(Canvas tile)
tile - Tile you want to get the index forpublic TileRecord getTileRecord(Canvas tile)
tile - Tile you want to get the record forpublic java.lang.Boolean loadAllRecords()
If the length of the data is not known, or is greater than
the passed maxRecords, this call returns false. No fetch is issued and the callback, if passed, is not
fired.
If all data is already loaded, no fetch is
issued and this call returns true. The callback, if passed, will be fired, but its parameters will be null,
since there was no fetch to provide the values from.
In all other cases, this call returns true and a fetch is issued for all necessary records. When the data arrives, the callback is fired.
DataBound Component Methodspublic java.lang.Boolean loadAllRecords(java.lang.Integer maxRecords)
loadAllRecords()public java.lang.Boolean loadAllRecords(java.lang.Integer maxRecords,
DSCallback callback)
If the length of the data is not known, or is greater than
the passed maxRecords, this call returns false. No fetch is issued and the callback, if passed, is not
fired.
If all data is already loaded, no fetch is
issued and this call returns true. The callback, if passed, will be fired, but its parameters will be null,
since there was no fetch to provide the values from.
In all other cases, this call returns true and a fetch is issued for all necessary records. When the data arrives, the callback is fired.
maxRecords - optional maximum record count - if passed, no fetch takes place if maxRecords is below
the known length of the datacallback - callback to fire if a fetch is issued - if all data was already loaded, the callback is
fired with no parametersDataBound Component Methodspublic com.google.gwt.event.shared.HandlerRegistration addRecordClickHandler(RecordClickHandler handler)
Executed when the tileGrid receives a 'click' event on a tile. The default implementation does nothing -- override to
perform some action when any record is clicked.
A record event handler can be specified either as a function to
execute, or as a string of script to evaluate. If the handler is defined as a string of script, all the parameters below
will be available as variables for use in the script.
If you want to cancel the click based on the parameters, Call
com.smartgwt.client.widgets.tile.events.RecordClickEvent#cancel() from within RecordClickHandler.onRecordClick(com.smartgwt.client.widgets.tile.events.RecordClickEvent). Otherwise, return true so that the click
event be registered with the tile.
addRecordClickHandler in interface HasRecordClickHandlershandler - the recordClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRecordContextClickHandler(RecordContextClickHandler handler)
Executed when the tileGrid receives a context-click (right mouse button) event on a tile. The default implementation
does nothing -- override to perform some action when any record is right-clicked.
Cancel the event to suppress the
native browser context menu.
A record event handler can be specified either as a function to execute, or as a string
of script to evaluate. If the handler is defined as a string of script, all the parameters below will be available as
variables for use in the script.
If you want to cancel the click based on the parameters, Call RecordContextClickEvent.cancel() from within RecordContextClickHandler.onRecordContextClick(com.smartgwt.client.widgets.tile.events.RecordContextClickEvent). Otherwise, return true so that
the click event be registered with the tile.
addRecordContextClickHandler in interface HasRecordContextClickHandlershandler - the recordContextClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRecordDoubleClickHandler(RecordDoubleClickHandler handler)
Executed when the tileGrid receives a 'doubleclick' event on a tile. The default implementation does nothing -- override
to perform some action when any record is doubleclicked.
A record event handler can be specified either as a
function to execute, or as a string of script to evaluate. If the handler is defined as a string of script, all the
parameters below will be available as variables for use in the script.
If you want to cancel the doubleclick based
on the parameters, Call com.smartgwt.client.widgets.tile.events.RecordDoubleClickEvent#cancel() from within
RecordDoubleClickHandler.onRecordDoubleClick(com.smartgwt.client.widgets.tile.events.RecordDoubleClickEvent). Otherwise, return true so
that the doubleclick event be registered with the tile.
addRecordDoubleClickHandler in interface HasRecordDoubleClickHandlershandler - the recordDoubleClick handlerHandlerRegistration used to remove this handlerpublic void removeData(Record data)
data - primary key values of record to delete, (or complete record)DataBound Component Methods,
Databound remove Examplepublic void removeData(Record data, DSCallback callback)
public void removeData(Record data, DSCallback callback, DSRequest requestProperties)
data - primary key values of record to delete, (or complete record)callback - method to call on operation completionrequestProperties - additional properties to set on the DSRequest that will be issuedDataBound Component Methods,
Databound remove Examplepublic boolean removeTile(Canvas tileID)
removeData().removeTile in class TileLayouttileID - index or String ID of the tilepublic boolean removeTile(int tileID)
removeData().removeTile in class TileLayouttileID - index or String ID of the tilepublic boolean removeTile(java.lang.String tileID)
removeData().removeTile in class TileLayouttileID - index or String ID of the tilepublic com.google.gwt.event.shared.HandlerRegistration addSelectionChangedHandler(SelectionChangedHandler handler)
Called when selection changes within this tileGrid. Note this method fires for each record for which selection is modified - so when a user clicks inside a tileGrid this method will typically fire twice (once for the old record being deselected, and once for the new record being selected).
addSelectionChangedHandler in interface HasSelectionChangedHandlershandler - the selectionChanged handlerHandlerRegistration used to remove this handlerpublic void selectRange(int startRow,
int endRow)
startRow - start of selection rangeendRow - end of selection range (non-inclusive)Selectionpublic void selectRange(int startRow,
int endRow,
boolean newState)
startRow - start of selection rangeendRow - end of selection range (non-inclusive)newState - new selection state (if null, defaults to true)Selectionpublic void setFieldState(java.lang.String fieldState)
ListGridFieldState object passed in.getFieldState(). The optional
isSparse parameter may be passed to indicate whether the fieldState object is "sparse" - whether it
includes explicit state information for hidden fields. In this case any fields defined on the component not explicitly
included in the fieldState object will be hidden.
If isSparse is not explicitly passed as a parameter,
sparseness will be assumed if DataBoundComponent.sparseFieldState is true.
fieldState - state to apply to the grid's fields.
See ListGridFieldStategetFieldState(),
ListGridFieldStatepublic void setFieldState(java.lang.String fieldState,
java.lang.Boolean isSparse)
ListGridFieldState object passed in.getFieldState(). The optional
isSparse parameter may be passed to indicate whether the fieldState object is "sparse" - whether it
includes explicit state information for hidden fields. In this case any fields defined on the component not explicitly
included in the fieldState object will be hidden.
If isSparse is not explicitly passed as a parameter,
sparseness will be assumed if DataBoundComponent.sparseFieldState is true.
fieldState - state to apply to the grid's fields.
See ListGridFieldStateisSparse - If true, the fieldState passed in is assumed to be "sparse". Any fields defined on this component without explicit
field state values will be hidden.getFieldState()public void viewSelectedData(ListGrid selectionComponent)
For a DynamicForm the first record of the selection is shown after the form is placed into read-only mode. A subsequent call to DynamicForm.editRecord() or similar will return the form to
editability.
Note that since field-level canEdit:true settings override the form-level canEdit setting
the automatic change to read-only may not change every field.
selectionComponent - the ListGrid or TileGrid or ID of a ListGrid/TileGrid whose currently selected record(s) is/are to be viewedDataBound Component Methodspublic void viewSelectedData(TileGrid selectionComponent)
For a DynamicForm the first record of the selection is shown after the form is placed into read-only mode. A subsequent call to DynamicForm.editRecord() or similar will return the form to
editability.
Note that since field-level canEdit:true settings override the form-level canEdit setting
the automatic change to read-only may not change every field.
selectionComponent - the ListGrid or TileGrid or ID of a ListGrid/TileGrid whose currently selected record(s) is/are to be viewedDataBound Component Methodspublic void viewSelectedData(java.lang.String selectionComponent)
For a DynamicForm the first record of the selection is shown after the form is placed into read-only mode. A subsequent call to DynamicForm.editRecord() or similar will return the form to
editability.
Note that since field-level canEdit:true settings override the form-level canEdit setting
the automatic change to read-only may not change every field.
selectionComponent - the ListGrid or TileGrid or ID of a ListGrid/TileGrid whose currently selected record(s) is/are to be viewedDataBound Component Methodspublic static void setDefaultProperties(TileGrid tileGridProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
tileGridProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiesprotected void onInit_TileGrid()
protected java.lang.String getTileHTML(Record record)
tile.
This is an override point.record - the tile for which HTML should be retrievedpublic Canvas getTile(Record record)
Note that this method may be overridden but developers should be aware that this method may be called repeatedly for the same record each time the TileGrid refreshes that row. If you override this API, you will need to cache and re-use the same tile objects per record. Typically this would be achieved by storing a pool of Tile objects that are re-used if a Record with the same primaryKey is passed to getTile().
When calling this method directly, if com.smartgwt.client.widgets.tile.TileGrid@showAllRecords is false, this may
return null for records that are not currently visible.
tile - (TileRecord) recordpublic Canvas getTile(int recordNum)
Note that this method may be overridden but developers should be aware that this method may be called repeatedly for the same record each time the TileGrid refreshes that row. If you override this API, you will need to cache and re-use the same tile objects per record. Typically this would be achieved by storing a pool of Tile objects that are re-used if a Record with the same primaryKey is passed to getTile().
When calling this method directly, if +link{showAllRecords} is false, this may return null for records that are not currently visible.
This is an override point
getTile in class TileLayouttile - (int) index of record in this.datapublic RecordList getDataAsRecordList()
RecordList. If the component is
bound to a DataSource,
the actual type of the RecordList instance will be a ResultSet.public void sortByProperty(java.lang.String property,
boolean ascending)
setSort(com.smartgwt.client.data.SortSpecifier...) instead.property - propertyascending - directionpublic void removeSelectedData()
If no records are selected, no action is taken. The grid will automatically be updated if the record deletion succeeds.
public Record[] getSelection()
public void setDataSource(DataSource dataSource, DetailViewerField... fields)
Binding to a DataSource means that the component will use the DataSource to provide default data for its fields.
When binding to a new DataSource, if the component has any existing "fields" or has a dataset, these will be discarded by default, since it is assumed the new DataSource may represent a completely unrelated set of objects. If the old "fields" are still relevant, pass them to setDataSource().
dataSource - fields - public void setCreateTileCustomizer(CreateTileCustomizer customizer)
createTile.
That method will be called when a new tile is required.CreateTileCustomizer - customizerCreateTileCustomizer.createTile(com.smartgwt.client.data.Record, java.lang.Integer),
getRecycleTiles()public void setUpdateTileCustomizer(UpdateTileCustomizer customizer)
updateTile.
If both that method and
createTile
have been defined and
recycleTiles is true,
this customizer method will be called when the framework needs to recycle a tile to be
used with a new record. This notification provides an opportunity to update any widget
properties that depend on the specifics of the record.UpdateTileCustomizer - customizercom.smartgwt.client.widgets.tile.CreateTileCustomizer#updateTile,
getRecycleTiles()public Record[] getData()
This property will typically not be explicitly specified for databound TileGrids, where
the data is returned from the server via databound component methods such as fetchData(). In this case the data
objects will be set to a resultSet rather
than a simple array.
TileRecordpublic TileGrid setDataPageSize(int dataPageSize)
DataBoundComponentdata
paging, how many records to fetch at a time. If set to a positive integer,
dataPageSize will override the default resultSize for ResultSets
automatically created when you call fetchData() (and similarly for
the resultSize of
ResultTrees). The default of 0 means to just use the default page size of the data
container. Note that regardless of the dataPageSize setting,
a component will always fetch all of data that it needs to draw. Settings such as showAllRecords:true, drawAllMaxCells and drawAheadRatio can cause
more rows than the configured dataPageSize to be fetched.
setDataPageSize in interface DataBoundComponentdataPageSize - dataPageSize Default value is 0DataBoundComponent
instance, for chaining setter callsDatabinding overview and related methodspublic int getDataPageSize()
DataBoundComponentdata
paging, how many records to fetch at a time. If set to a positive integer,
dataPageSize will override the default resultSize for ResultSets
automatically created when you call fetchData() (and similarly for
the resultSize of
ResultTrees). The default of 0 means to just use the default page size of the data
container. Note that regardless of the dataPageSize setting,
a component will always fetch all of data that it needs to draw. Settings such as showAllRecords:true, drawAllMaxCells and drawAheadRatio can cause
more rows than the configured dataPageSize to be fetched.
getDataPageSize in interface DataBoundComponentDatabinding overview and related methodspublic TileGrid setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
DataBoundComponentfields) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
If component.fields contains fields that are not found in the DataSource,
they will be shown after the most recently referred to DataSource field. If the new
fields appear first, they will be shown first.
setUseAllDataSourceFields in interface DataBoundComponentuseAllDataSourceFields - useAllDataSourceFields Default value is falseDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getUseAllDataSourceFields()
DataBoundComponentfields) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
If component.fields contains fields that are not found in the DataSource,
they will be shown after the most recently referred to DataSource field. If the new
fields appear first, they will be shown first.
getUseAllDataSourceFields in interface DataBoundComponentpublic TileGrid setSparseFieldState(java.lang.Boolean sparseFieldState)
DataBoundComponentListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String) will omit state
information for hidden fields by default.setSparseFieldState in interface DataBoundComponentsparseFieldState - sparseFieldState Default value is falseDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getSparseFieldState()
DataBoundComponentListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String) will omit state
information for hidden fields by default.getSparseFieldState in interface DataBoundComponentpublic TileGrid setShowHiddenFields(java.lang.Boolean showHiddenFields)
DataBoundComponenthidden:true when a DataBoundComponent is given a
DataSource but no component.fields.
The hidden property is used on DataSource fields to mark fields that are
never of meaning to an end user.
setShowHiddenFields in interface DataBoundComponentshowHiddenFields - showHiddenFields Default value is falseDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getShowHiddenFields()
DataBoundComponenthidden:true when a DataBoundComponent is given a
DataSource but no component.fields.
The hidden property is used on DataSource fields to mark fields that are
never of meaning to an end user.
getShowHiddenFields in interface DataBoundComponentpublic TileGrid setShowComplexFields(java.lang.Boolean showComplexFields)
DataBoundComponentcomponent.fields.
If true, the component will show fields that declare a complex type, for example, a field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a DataSource that declares the fields of a shipping address (city, street name, etc).
Such fields may need custom formatters or editors in order to create a usable interface, for example, an Address field in a ListGrid might use a custom formatter to combine the relevant fields of an address into one column, and might use a pop-up dialog for editing.
Note : This is an advanced setting
setShowComplexFields in interface DataBoundComponentshowComplexFields - showComplexFields Default value is trueDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getShowComplexFields()
DataBoundComponentcomponent.fields.
If true, the component will show fields that declare a complex type, for example, a field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a DataSource that declares the fields of a shipping address (city, street name, etc).
Such fields may need custom formatters or editors in order to create a usable interface, for example, an Address field in a ListGrid might use a custom formatter to combine the relevant fields of an address into one column, and might use a pop-up dialog for editing.
getShowComplexFields in interface DataBoundComponentpublic TileGrid setFetchOperation(java.lang.String fetchOperation)
DataBoundComponentsetFetchOperation in interface DataBoundComponentfetchOperation - fetchOperation Default value is nullDataBoundComponent
instance, for chaining setter callspublic java.lang.String getFetchOperation()
DataBoundComponentgetFetchOperation in interface DataBoundComponentpublic TileGrid setUpdateOperation(java.lang.String updateOperation)
DataBoundComponentoperationId this component
should use when performing update operations.setUpdateOperation in interface DataBoundComponentupdateOperation - Default value is nullDataBoundComponent
instance, for chaining setter callsOperations overview and related methodspublic java.lang.String getUpdateOperation()
DataBoundComponentoperationId this component
should use when performing update operations.getUpdateOperation in interface DataBoundComponentOperations overview and related methodspublic TileGrid setAddOperation(java.lang.String addOperation)
DataBoundComponentoperationId this component
should use when performing add operations.setAddOperation in interface DataBoundComponentaddOperation - Default value is nullDataBoundComponent
instance, for chaining setter callsOperations overview and related methodspublic java.lang.String getAddOperation()
DataBoundComponentoperationId this component
should use when performing add operations.getAddOperation in interface DataBoundComponentOperations overview and related methodspublic TileGrid setRemoveOperation(java.lang.String removeOperation)
DataBoundComponentoperationId this component
should use when performing remove operations.setRemoveOperation in interface DataBoundComponentremoveOperation - Default value is nullDataBoundComponent
instance, for chaining setter callsOperations overview and related methodspublic java.lang.String getRemoveOperation()
DataBoundComponentoperationId this component
should use when performing remove operations.getRemoveOperation in interface DataBoundComponentOperations overview and related methodspublic TileGrid setExportFields(java.lang.String[] exportFields)
DataBoundComponentIf exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.
setExportFields in interface DataBoundComponentexportFields - exportFields Default value is nullDataBoundComponent
instance, for chaining setter callspublic java.lang.String[] getExportFields()
DataBoundComponentIf exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.
getExportFields in interface DataBoundComponentpublic TileGrid setExportAll(java.lang.Boolean exportAll)
DataBoundComponentfields.
If exportAll is false, an export operation will first consider
exportFields, if it's set, and fall back on all visible fields from
fields otherwise.
setExportAll in interface DataBoundComponentexportAll - exportAll Default value is falseDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getExportAll()
DataBoundComponentfields.
If exportAll is false, an export operation will first consider
exportFields, if it's set, and fall back on all visible fields from
fields otherwise.
getExportAll in interface DataBoundComponentpublic TileGrid setExportIncludeSummaries(java.lang.Boolean exportIncludeSummaries)
DataBoundComponentsetExportIncludeSummaries in interface DataBoundComponentexportIncludeSummaries - exportIncludeSummaries Default value is trueDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getExportIncludeSummaries()
DataBoundComponentgetExportIncludeSummaries in interface DataBoundComponentpublic TileGrid setPreventDuplicates(java.lang.Boolean preventDuplicates) throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
When a duplicate transfer is detected,
a dialog will appear showing the duplicateDragMessage.
If the component either does not have a DataSource or has a DataSource with no
primaryKey
declared, duplicate checking is off by
default. If duplicate checking is enabled, it looks for an existing record in the dataset
that has all of the
properties of the dragged record, and considers that a duplicate.
For DragDataAction:"copy" where the target DataSource is related to the source
DataSource by foreignKey, a duplicate means that
the target list, as filtered by the current
criteria, already has a record whose value for the foreignKey field matches the
primaryKey of the record being
transferred.
For example, consider dragging "employees" to "teams", where "teams" has a field "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target grid has search criteria causing it to show all the members of one team. A duplicate - adding an employee to the same team twice - is when the target grid's dataset contains an record with "employeeId" matching the "id" field of the dropped employee.
setPreventDuplicates in interface DataBoundComponentpreventDuplicates - preventDuplicates Default value is nullDataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getPreventDuplicates()
DataBoundComponentDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
When a duplicate transfer is detected,
a dialog will appear showing the duplicateDragMessage.
If the component either does not have a DataSource or has a DataSource with no
primaryKey
declared, duplicate checking is off by
default. If duplicate checking is enabled, it looks for an existing record in the dataset
that has all of the
properties of the dragged record, and considers that a duplicate.
For DragDataAction:"copy" where the target DataSource is related to the source
DataSource by foreignKey, a duplicate means that
the target list, as filtered by the current
criteria, already has a record whose value for the foreignKey field matches the
primaryKey of the record being
transferred.
For example, consider dragging "employees" to "teams", where "teams" has a field "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target grid has search criteria causing it to show all the members of one team. A duplicate - adding an employee to the same team twice - is when the target grid's dataset contains an record with "employeeId" matching the "id" field of the dropped employee.
getPreventDuplicates in interface DataBoundComponentpublic TileGrid setDuplicateDragMessage(java.lang.String duplicateDragMessage) throws java.lang.IllegalStateException
DataBoundComponentpreventDuplicates
is enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.setDuplicateDragMessage in interface DataBoundComponentduplicateDragMessage - duplicateDragMessage Default value is "Duplicates not allowed"DataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getDuplicateDragMessage()
DataBoundComponentpreventDuplicates
is enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.getDuplicateDragMessage in interface DataBoundComponentpublic TileGrid setAddDropValues(java.lang.Boolean addDropValues)
DataBoundComponent
If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item
dropped on this grid, and an update performed on the item
setAddDropValues in interface DataBoundComponentaddDropValues - addDropValues Default value is trueDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getAddDropValues()
DataBoundComponent
If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item
dropped on this grid, and an update performed on the item
getAddDropValues in interface DataBoundComponentpublic TileGrid setDropValues(java.util.Map dropValues)
DataBoundComponentaddDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
setDropValues in interface DataBoundComponentdropValues - dropValues Default value is nullDataBoundComponent
instance, for chaining setter callspublic java.util.Map getDropValues()
DataBoundComponentaddDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
getDropValues in interface DataBoundComponentdropValues for more details. If multiple records
are being dropped, this method is called for each of them in turn.
This method returns the following:
addDropValues is falseYou can override this method if you need more complex setting of drop values than can be provided by simply supplying a dropValues object.
public TileGrid setProgressiveLoading(java.lang.Boolean progressiveLoading)
progressivelyprogressiveLoading - DataBoundComponent
instance, for chaining setter callsProgressiveLoading,
DataSource.setProgressiveLoading(java.lang.Boolean)public java.lang.Boolean getProgressiveLoading()
progressivelyProgressiveLoading,
DataSource.getProgressiveLoading()public TileGrid setUseFlatFields(java.lang.Boolean useFlatFields) throws java.lang.IllegalStateException
DataBoundComponentuseFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
useFlatFields is typically used with imported metadata, such as
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback) from a
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
nesting that aren't meaningful in a user interface, without the cumbersome and fragile
process of mapping form fields to XML structures.
For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message
schema for a web service operation whose input message looks like this:
<FindServices>
<searchFor>search text</searchFor>
<Options>
<caseSensitive>false</caseSensitive>
</Options>
<IncludeInSearch>
<serviceName>true</serviceName>
<documentation>true</documentation>
<keywords>true</keywords>
</IncludeInSearch>
</FindServices>
Setting useFlatFields on a DynamicForm that is bound to this input
message schema would result in 5 FormItem reflecting the 5 simple type
fields in the message.
For this form, the result of DynamicForm.getValues() might look
like:
{
searchFor: "search text",
caseSensitive: false,
serviceName: true,
documentation : true,
keywords : true
}
When contacting a WebService, these values can be automatically
mapped to the structure of the input message for a web service operation by setting
useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields (for use with a DataSource that is
'bound to a WSDL web service' via
wsOperation).
Using these two facilities in conjunction (component.useFlatFields and request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user presentation and when providing the data for XML messages.
You can also set useFlatFields to automatically enable
"flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
particular operationType.
Note that useFlatFields is not generally recommended for use with structures
where multiple simple type fields exist with the same name, however if used with such a
structure, the first field to use a given name wins. "first" means the first field
encountered in a depth first search. "wins" means only the first field will be present as a
field when data binding.
setUseFlatFields in interface DataBoundComponentuseFlatFields - useFlatFields Default value is nullDataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseFlatFields()
DataBoundComponentuseFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
useFlatFields is typically used with imported metadata, such as
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback) from a
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
nesting that aren't meaningful in a user interface, without the cumbersome and fragile
process of mapping form fields to XML structures.
For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message
schema for a web service operation whose input message looks like this:
<FindServices>
<searchFor>search text</searchFor>
<Options>
<caseSensitive>false</caseSensitive>
</Options>
<IncludeInSearch>
<serviceName>true</serviceName>
<documentation>true</documentation>
<keywords>true</keywords>
</IncludeInSearch>
</FindServices>
Setting useFlatFields on a DynamicForm that is bound to this input
message schema would result in 5 FormItem reflecting the 5 simple type
fields in the message.
For this form, the result of DynamicForm.getValues() might look
like:
{
searchFor: "search text",
caseSensitive: false,
serviceName: true,
documentation : true,
keywords : true
}
When contacting a WebService, these values can be automatically
mapped to the structure of the input message for a web service operation by setting
useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields (for use with a DataSource that is
'bound to a WSDL web service' via
wsOperation).
Using these two facilities in conjunction (component.useFlatFields and request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user presentation and when providing the data for XML messages.
You can also set useFlatFields to automatically enable
"flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
particular operationType.
Note that useFlatFields is not generally recommended for use with structures
where multiple simple type fields exist with the same name, however if used with such a
structure, the first field to use a given name wins. "first" means the first field
encountered in a depth first search. "wins" means only the first field will be present as a
field when data binding.
getUseFlatFields in interface DataBoundComponentpublic TileGrid setHiliteProperty(java.lang.String hiliteProperty)
DataBoundComponentid for a hilite defined on this component.setHiliteProperty in interface DataBoundComponenthiliteProperty - hiliteProperty Default value is "_hilite"DataBoundComponent
instance, for chaining setter callspublic java.lang.String getHiliteProperty()
DataBoundComponentid for a hilite defined on this component.getHiliteProperty in interface DataBoundComponentpublic void editFields()
public void editHilites()
DataBoundComponenteditHilites in interface DataBoundComponentpublic java.lang.String getHiliteState()
DataBoundComponentgetHiliteState in interface DataBoundComponentpublic TileGrid setHiliteState(java.lang.String hiliteState)
DataBoundComponentsetHiliteState in interface DataBoundComponenthiliteState - hilites state encoded as a StringDataBoundComponent
instance, for chaining setter callspublic TileGrid setHilites(Hilite[] hilites)
DataBoundComponentgetHilites for a method of retrieving the hilite array for storage,
including hilites manually added by the user.
NOTE: This is only supported on
ListGrid for now.
setHilites in interface DataBoundComponenthilites - array of hilite objectsDataBoundComponent
instance, for chaining setter callspublic Hilite[] getHilites()
DataBoundComponentgetHilites in interface DataBoundComponentpublic TileGrid setDragDataAction(DragDataAction dragDataAction)
TileLayoutsetDragDataAction in interface DataBoundComponentsetDragDataAction in class TileLayoutdragDataAction - New dragDataAction value. Default value is Canvas.MOVETileLayout instance, for chaining setter callspublic DragDataAction getDragDataAction()
TileLayoutgetDragDataAction in interface DataBoundComponentgetDragDataAction in class TileLayoutpublic TileGrid setDragTrackerStyle(java.lang.String dragTrackerStyle)
DataBoundComponentsetDragTrackerStyle in interface DataBoundComponentdragTrackerStyle - dragTrackerStyle Default value is "gridDragTracker"DataBoundComponent
instance, for chaining setter callspublic java.lang.String getDragTrackerStyle()
DataBoundComponentgetDragTrackerStyle in interface DataBoundComponentpublic TileGrid setCanAddFormulaFields(java.lang.Boolean canAddFormulaFields)
DataBoundComponentcom.smartgwt.client..FormulaBuilder.
User-added formula fields can be persisted via ListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String).
setCanAddFormulaFields in interface DataBoundComponentcanAddFormulaFields - canAddFormulaFields Default value is falseDataBoundComponent
instance, for chaining setter callspublic void addSummaryField()
DataBoundComponentcom.smartgwt.client..SummaryBuilder to create a new Summary Field. This
is equivalent to calling DataBoundComponentGen#editSummaryField with
no parameter.
addSummaryField in interface DataBoundComponentpublic void addFormulaField()
DataBoundComponentcom.smartgwt.client..FormulaBuilder to create a new Formula Field. This
is equivalent to calling DataBoundComponentGen#editFormulaField with
no parameter.
addFormulaField in interface DataBoundComponentpublic java.lang.Boolean getCanAddFormulaFields()
DataBoundComponentcom.smartgwt.client..FormulaBuilder.
User-added formula fields can be persisted via ListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String).
getCanAddFormulaFields in interface DataBoundComponentpublic TileGrid setAddFormulaFieldText(java.lang.String addFormulaFieldText)
DataBoundComponentsetAddFormulaFieldText in interface DataBoundComponentaddFormulaFieldText - addFormulaFieldText Default value is "Add formula column..."DataBoundComponent
instance, for chaining setter callspublic java.lang.String getAddFormulaFieldText()
DataBoundComponentgetAddFormulaFieldText in interface DataBoundComponentpublic TileGrid setEditFormulaFieldText(java.lang.String editFormulaFieldText)
DataBoundComponentsetEditFormulaFieldText in interface DataBoundComponenteditFormulaFieldText - editFormulaFieldText Default value is "Edit formula..."DataBoundComponent
instance, for chaining setter callspublic java.lang.String getEditFormulaFieldText()
DataBoundComponentgetEditFormulaFieldText in interface DataBoundComponentpublic TileGrid setCanAddSummaryFields(java.lang.Boolean canAddSummaryFields)
DataBoundComponentcom.smartgwt.client..SummaryBuilder.
User-added summary fields can be persisted via ListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String).
setCanAddSummaryFields in interface DataBoundComponentcanAddSummaryFields - canAddSummaryFields Default value is falseDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean getCanAddSummaryFields()
DataBoundComponentcom.smartgwt.client..SummaryBuilder.
User-added summary fields can be persisted via ListGrid.getFieldState() and
ListGrid.setFieldState(java.lang.String).
getCanAddSummaryFields in interface DataBoundComponentpublic TileGrid setAddSummaryFieldText(java.lang.String addSummaryFieldText)
DataBoundComponentsetAddSummaryFieldText in interface DataBoundComponentaddSummaryFieldText - addSummaryFieldText Default value is "Add summary column..."DataBoundComponent
instance, for chaining setter callspublic java.lang.String getAddSummaryFieldText()
DataBoundComponentgetAddSummaryFieldText in interface DataBoundComponentpublic TileGrid setEditSummaryFieldText(java.lang.String editSummaryFieldText)
DataBoundComponentsetEditSummaryFieldText in interface DataBoundComponenteditSummaryFieldText - editSummaryFieldText Default value is "Edit summary format..."DataBoundComponent
instance, for chaining setter callspublic java.lang.String getEditSummaryFieldText()
DataBoundComponentgetEditSummaryFieldText in interface DataBoundComponentpublic TileGrid setSavedSearchId(java.lang.String savedSearchId)
DataBoundComponent
By default
SavedSearches are associated with a component via its
local ID and
DataSource ID. This
property allows developers to override this behavior and explicitly associate a
component with a set of saved searches. This can provide a couple of benefits:
Firstly this ensures that saved searches will be unambiguously associated with the
particular component even if the page changes such that a stored minimal locator would
no longer applied to the component, without requiring an explicit
Canvas.ID.
Secondly this allows the same set of saved searches to be applied to more than one
component on a page. This may be valueable for cases where the same information from the
same dataSource is presented to users in multiple places.
Note: This is an advanced setting.
setSavedSearchId in interface DataBoundComponentsavedSearchId - New savedSearchId value. Default value is nullDataBoundComponent
instance, for chaining setter callspublic java.lang.String getSavedSearchId()
DataBoundComponent
By default
SavedSearches are associated with a component via its
local ID and
DataSource ID. This
property allows developers to override this behavior and explicitly associate a
component with a set of saved searches. This can provide a couple of benefits:
Firstly this ensures that saved searches will be unambiguously associated with the
particular component even if the page changes such that a stored minimal locator would
no longer applied to the component, without requiring an explicit
Canvas.ID.
Secondly this allows the same set of saved searches to be applied to more than one
component on a page. This may be valueable for cases where the same information from the
same dataSource is presented to users in multiple places.
getSavedSearchId in interface DataBoundComponentpublic TileGrid setShowSavedSearchesByDS(boolean showSavedSearchesByDS) throws java.lang.IllegalStateException
DataBoundComponentDataSource
of a component when a
savedSearchId is
not provided. If this property is true, then when the DataSource is changed, existing
saved searches will disappear and only be available if the DataSource is set back to its
original value.
If this property is false, saved searches will persist across DataSource changes so that searches that aren't applicable to the current DataSource might still be shown.
Note: This is an advanced setting
setShowSavedSearchesByDS in interface DataBoundComponentshowSavedSearchesByDS - New showSavedSearchesByDS value. Default value is trueDataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has
been createdpublic boolean getShowSavedSearchesByDS()
DataBoundComponentDataSource
of a component when a
savedSearchId is
not provided. If this property is true, then when the DataSource is changed, existing
saved searches will disappear and only be available if the DataSource is set back to its
original value.
If this property is false, saved searches will persist across DataSource changes so that searches that aren't applicable to the current DataSource might still be shown.
getShowSavedSearchesByDS in interface DataBoundComponentpublic Record[] findAll(AdvancedCriteria adCriteria)
adCriteria - AdvancedCriteria to use to filter resultspublic Record find(AdvancedCriteria adCriteria)
adCriteria - AdvancedCriteria to use to filter resultspublic int findIndex(AdvancedCriteria adCriteria)
adCriteria - AdvancedCriteria to use to filter resultspublic int findNextIndex(int startIndex,
AdvancedCriteria adCriteria,
int endIndex)
RecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters.startIndex - first index to consideradCriteria - AdvancedCriteria to use to filter resultsendIndex - last index to considerpublic int findNextIndex(int startIndex,
AdvancedCriteria adCriteria)
RecordList.findIndex(java.util.Map), but considering the startIndex parameter.startIndex - first index to consideradCriteria - AdvancedCriteria to use to filter resultspublic void selectRecord(Record record)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectpublic void selectRecord(int record)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectpublic void selectRecord(int record,
boolean newState)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectnewState - new selection state (if null, defaults to true)public void selectRecord(Record record, boolean newState)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectnewState - new selection state (if null, defaults to true)public void selectRecords(int[] records)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectpublic void selectRecords(int[] records,
boolean newState)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectnewState - new selection statepublic void selectRecords(Record[] records)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectpublic void selectRecords(Record[] records, boolean newState)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectnewState - new selection state (if null, defaults to true)public void deselectRecord(Record record)
DataBoundComponentRecord passed in explicitly, or by index. Synonym for
selectRecord(record, false)
deselectRecord in interface DataBoundComponentrecord - record (or row number) to deselectpublic void deselectRecord(int record)
DataBoundComponentRecord passed in explicitly, or by index. Synonym for
selectRecord(record, false)
deselectRecord in interface DataBoundComponentrecord - record (or row number) to deselectpublic void deselectRecords(int[] records)
DataBoundComponentRecords passed in explicitly, or by index. Synonym
for selectRecords(records, false)
deselectRecords in interface DataBoundComponentrecords - records (or row numbers) to deselectpublic void deselectRecords(Record[] records)
DataBoundComponentRecords passed in explicitly, or by index. Synonym
for selectRecords(records, false)
deselectRecords in interface DataBoundComponentrecords - records (or row numbers) to deselectpublic void selectAllRecords()
DataBoundComponentselectAllRecords in interface DataBoundComponentpublic void deselectAllRecords()
DataBoundComponentdeselectAllRecords in interface DataBoundComponentpublic java.lang.Boolean anySelected()
DataBoundComponentanySelected in interface DataBoundComponentpublic void enableHilite(java.lang.String hiliteID)
DataBoundComponenthilites
enableHilite in interface DataBoundComponenthiliteID - ID of hilite to enablepublic void enableHilite(java.lang.String hiliteID,
boolean enable)
DataBoundComponenthilites
enableHilite in interface DataBoundComponenthiliteID - ID of hilite to enableenable - new enabled state to apply - if null, defaults to truepublic void disableHilite(java.lang.String hiliteID)
DataBoundComponentdisableHilite in interface DataBoundComponenthiliteID - ID of hilite to disablepublic void enableHiliting()
DataBoundComponentenableHiliting in interface DataBoundComponentpublic void enableHiliting(boolean enable)
DataBoundComponentenableHiliting in interface DataBoundComponentenable - new enabled state to apply - if null, defaults to truepublic void disableHiliting()
DataBoundComponentdisableHiliting in interface DataBoundComponentpublic Record[] getDragData()
DataBoundComponent
This method is consulted by
ListGrid.willAcceptDrop().
getDragData in interface DataBoundComponentRecords that are currently selected.public void transferSelectedData(DataBoundComponent source)
DataBoundComponentDataBoundComponent.getDropValues() for each dropped record.
To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.
Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether
dropped records already exist in the target component. Therefore, it is possible to issue a call to transferSelectedData() and/or the drop()
method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs
them one after the other. If you want to be notified when a transfer process has actually completed, use addDropCompleteHandler.
See the Dragging documentation for an overview of list grid drag/drop data transfer.
transferSelectedData in interface DataBoundComponentsource - source component from which the records will be tranferredpublic void transferSelectedData(DataBoundComponent source, int index)
DataBoundComponentDataBoundComponent.getDropValues() for each dropped record.
To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.
Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether
dropped records already exist in the target component. Therefore, it is possible to issue a call to transferSelectedData() and/or the drop()
method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs
them one after the other. If you want to be notified when a transfer process has actually completed, use addDropCompleteHandler.
See the Dragging documentation for an overview of list grid drag/drop data transfer.
transferSelectedData in interface DataBoundComponentsource - source component from which the records will be transferredindex - target index (drop position) of the rows within this grid.public int getRecordIndex(Record record)
DataBoundComponentOverride in subclasses to provide more specific behaviour, for instance, when data holds a large number of records
getRecordIndex in interface DataBoundComponentrecord - the record whose index is to be retrievedpublic java.lang.String getTitleFieldValue(Record record)
DataBoundComponentOverride in subclasses
getTitleFieldValue in interface DataBoundComponentrecord - the record whose index is to be retrievedpublic TileGrid setTitleField(java.lang.String titleField)
DataBoundComponentsetTitleField in interface DataBoundComponentDataBoundComponent
instance, for chaining setter callspublic java.lang.String getTitleField()
DataBoundComponenttitleField for databound
components."title",
"name", or "id". If we dont find any field-names that match these
titles, the first field in the component will be used instead.
getTitleField in interface DataBoundComponentpublic DataSource getDataSource()
DataBoundComponentDataSource requests.getDataSource in interface DataBoundComponentpublic TileGrid setAutoFetchData(java.lang.Boolean autoFetchData) throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria
and textMatchStyle may be specified via DataBoundComponent.getAutoFetchTextMatchStyle().
NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be
issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteria and not any other criteria or settings from the first request. Generally, turn off
autoFetchData if you are going to manually call fetchData() at any time.
setAutoFetchData in interface DataBoundComponentautoFetchData - autoFetchDataDataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateExceptionpublic java.lang.Boolean getAutoFetchData()
DataBoundComponentDataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria
and textMatchStyle may be specified via DataBoundComponent.getAutoFetchTextMatchStyle().
NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be
issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteria and not any other criteria or settings from the first request. Generally, turn off
autoFetchData if you are going to manually call fetchData() at any time.
getAutoFetchData in interface DataBoundComponentpublic TileGrid setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle) throws java.lang.IllegalStateException
DataBoundComponentautoFetchData is true, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call.setAutoFetchTextMatchStyle in interface DataBoundComponentDataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateExceptionpublic TextMatchStyle getAutoFetchTextMatchStyle()
DataBoundComponentautoFetchData is true, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call.getAutoFetchTextMatchStyle in interface DataBoundComponentpublic TileGrid setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter) throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()setAutoFetchAsFilter in interface DataBoundComponentautoFetchAsFilter - autoFetchAsFilterDataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateExceptionpublic java.lang.Boolean getAutoFetchAsFilter()
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()getAutoFetchAsFilter in interface DataBoundComponentpublic TileGrid setInitialCriteria(Criteria initialCriteria) throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is used.setInitialCriteria in interface DataBoundComponentinitialCriteria - the initial criteriaDataBoundComponent
instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic Criteria getInitialCriteria()
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is used.getInitialCriteria in interface DataBoundComponentpublic TileGrid setImplicitCriteria(Criteria implicitCriteria)
DataBoundComponentDataBoundComponent.initialCriteria,
DataBoundComponent.setCriteria() etc.setImplicitCriteria in interface DataBoundComponentimplicitCriteria - New implicitCriteria value. Default value is nullDataBoundComponent
instance, for chaining setter callspublic java.lang.Boolean setImplicitCriteria(Criteria implicitCriteria, DSCallback callback)
public java.lang.Boolean setImplicitCriteria(Criteria criteria, DSCallback callback, java.lang.Boolean initialFetch)
public Criteria getImplicitCriteria()
DataBoundComponentDataBoundComponent.initialCriteria,
DataBoundComponent.setCriteria() etc.getImplicitCriteria in interface DataBoundComponentpublic void fetchData()
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentpublic void fetchData(Criteria criteria)
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object, will be
derived by calling DynamicForm.getValuesAsCriteria()public void fetchData(Criteria criteria, DSCallback callback)
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object, will be
derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires only
if server contact was requiredpublic void fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object,
will be derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires
only if server contact was requiredrequestProperties - additional properties to set on the DSRequest
that will be issuedpublic void filterData()
DataBoundComponent This
method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentpublic void filterData(Criteria criteria)
DataBoundComponent This
method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object, will be
derived by calling DynamicForm.getValuesAsCriteria()public void filterData(Criteria criteria, DSCallback callback)
DataBoundComponent This
method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object,
will be derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires
only if server contact was required; see
DataBoundComponent.fetchData() for detailspublic void filterData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
DataBoundComponent This
method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object,
will be derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires
only if server contact was required; see
DataBoundComponent.fetchData() for detailsrequestProperties - for databound components only - optional additional
properties to set on the DSRequest that will be issuedpublic void invalidateCache()
DataBoundComponentinvalidateCache() method, for example,
ResultSet.invalidateCache().
NOTE: there is no need to call invalidateCache() when a save operation
is performed on a DataSource. Automatic cache synchronization features will automatically
update caches - see ResultSet for details. If automatic
cache synchronization isn't working, troubleshoot the problem using the steps suggested
in the FAQ rather than just calling invalidateCache(). Calling
invalidateCache() unnecessarily causes extra server load and added code
complexity.
Calling invalidateCache() will automatically cause a new
fetch to be performed with the current set of criteria if data had been previously
fetched and the component is currently drawn with data visible - there is no need to
manually call fetchData() after invalidateCache() and this could result in duplicate
fetches.
While data is being re-loaded after a call to invalidateCache(), the widget
is in a state similar to initial data load - it doesn't know the total length of the
dataset and any APIs that act on records or row indices will necessarily fail and should
not be called. To detect that the widget is in this state, call
ResultSet.lengthIsKnown().
invalidateCache() only has an effect if this component's dataset is a data
manager class that manages a cache (eg ResultSet or ResultTree). If data was provided as
a simple Array or List, invalidateCache() does nothing.
invalidateCache in interface DataBoundComponentListGrid.refreshData(),
DataBoundComponentMethods
overview and related methodspublic ResultSet getResultSet()
DataBoundComponentResultSet.
Note that this method should only be called after initial data has been fetched by this DataBoundComponent.
getResultSet in interface DataBoundComponentDataBoundComponent.fetchData()public RecordList getRecordList()
DataBoundComponentRecordList.
Depending on the component configuration, the actual JavaScript instance of the returned RecordList may be one of several types:
DataSource,
the instance is generally an Array of Record.ResultSet.Tree.
To access the ungrouped record list regardless of grouping status, use
isGrouped() ? getOriginalRecordList() : getRecordList()
TreeGrid,
the instance is a ResultTree.getRecordList in interface DataBoundComponentpublic com.google.gwt.core.client.JavaScriptObject getDataAsJSList()
getDataAsJSList in interface DataBoundComponentpublic void exportData()
DataBoundComponentexportData in interface DataBoundComponentpublic void exportData(DSRequest requestProperties)
DataBoundComponentexportData in interface DataBoundComponentpublic void exportData(DSRequest requestProperties, RPCCallback callback)
DataBoundComponentDataSource
to retrieve data that matches the current filter and sort criteria for this component,
then exports the resulting data to a file or window in the requested format.
A variety of DSRequest settings, such as
exportAs and
exportFilename, affect the
exporting process: see
exportResults for further
detail.
Note that data exported via this method does not include any client-side formatting and
relies on both the Smart GWT server and server-side DataSources. To export client-data
with formatters applied, see
exportClientData,
which still requires the Smart GWT server but does not rely on server-side DataSources.
For more information on exporting data, see
DataSource.exportData.
exportData in interface DataBoundComponentrequestProperties - additional properties to set on DSRequest that will be issuedcallback - Optional callback. Note that this parameter only applies if you specify
exportToClient: false in
the request properties, because file downloads don't provide ordinary framework callbacksDataBoundComponentMethods
overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addFetchDataHandler(FetchDataHandler handler)
Notification function fired on fetchData() or filterData()
addFetchDataHandler in interface HasFetchDataHandlershandler - the filterData handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDropCompleteHandler(DropCompleteHandler handler)
com.smartgwt.client.widgets.DropCompleteHandler. See that class's documentation for a definition of "drop complete",
and how it differs from "drag complete" (com.smartgwt.client.widgets.DragCompleteHandler).addDropCompleteHandler in interface HasDropCompleteHandlershandler - the DropCompleteHandlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDragCompleteHandler(DragCompleteHandler handler)
com.smartgwt.client.widgets.DragCompleteHandler. See that class's documentation for a definition of "drag complete",
and how it differs from "drop complete" (com.smartgwt.client.widgets.DropCompleteHandler).addDragCompleteHandler in interface HasDragCompleteHandlershandler - the DropCompleteHandlerHandlerRegistration used to remove this handlerpublic Alignment[] getFieldAlignments()
DataBoundComponentgetFieldAlignments in interface DataBoundComponentpublic java.lang.Boolean getDeepCloneOnEdit()
DataBoundComponentDataSource.getDeepCloneOnEdit() for details of what this means.
If this value is not explicitly set, it defaults to the DataSource deepCloneOnEdit value.
This value can also be overridden per-field with DataSourceField.setDeepCloneOnEdit(java.lang.Boolean).
Like the other deepCloneOnEdit settings, this flag only has an effect if you are
editing a values object that contains nested objects or arrays, using Canvas.setDataPath(java.lang.String)
getDeepCloneOnEdit in interface DataBoundComponentpublic TileGrid setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
DataBoundComponentDataSource.getDeepCloneOnEdit() for details of what this means.
If this value is not explicitly set, it defaults to the DataSource deepCloneOnEdit value.
This value can also be overridden per-field with DataSourceField.setDeepCloneOnEdit(java.lang.Boolean).
Like the other deepCloneOnEdit settings, this flag only has an effect if you are
editing a values object that contains nested objects or arrays, using Canvas.setDataPath(java.lang.String)
setDeepCloneOnEdit in interface DataBoundComponentDataBoundComponent
instance, for chaining setter callspublic TileGrid setFields(com.google.gwt.core.client.JavaScriptObject... fields)
DataBoundComponentsetFields(FormItem...),
setFields(ListGridField...),
etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT
Java wrappers of the field class type (e.g.
FormItem,
ListGridField, etc.)
This is an advanced method and only for cases where you have the JavaScriptObject for
each field but want to avoid having to create each associated SmartGWT Java wrapper.
Note: use toArray() to create a Java
array of JavaScriptObject if you only have the array itself as a single JavaScriptObject.
setFields in interface DataBoundComponentfields - the component fieldsDataBoundComponent
instance, for chaining setter callspublic com.google.gwt.core.client.JavaScriptObject[] getFieldsAsJavaScriptObjects()
DataBoundComponentFormItem,
ListGridField, etc.)
This avoids building the SmartGWT Java wrappers for the fields in situations where they
aren't needed - and for FormItems in particular - where there may not be enough
information to determine the correct subclass, such as before the SmartClient instance
underlying the DynamicForm has been
created.getFieldsAsJavaScriptObjects in interface DataBoundComponentpublic int getFieldCount()
DataBoundComponentgetFieldCount in interface DataBoundComponentpublic void transferRecords(Record[] records, Record targetRecord, java.lang.Integer index, Canvas sourceWidget, TransferRecordsCallback callback)
DataBoundComponentRecords from another component
(does not have to be a databound component) into this component. This method is only
applicable to list-type components, such as ListGrid
or com.smartgwt.client.widgets.tile.TileGridTileGrid. Notably, it does not apply to
TreeGrid; the equivalent for treeGrids is
transferNodes.
This method implements the automatic drag-copy and drag-move behaviors of components like
ListGrid, and calling it is equivalent to completing a drag and drop of the
dropRecords (the default record drop behavior is simply to call
transferRecords(), passing in the dropped nodes)
Note that this method is asynchronous - it may need to perform server turnarounds to prevent
duplicates in the target component's data. If you wish to be notified when the transfer
process has completed, you can either pass a non-null callback to this method or add a
DropCompleteHandler to this component.
See also transferSelectedData()
transferRecords in interface DataBoundComponentrecords - Recordss to transfer to this componenttargetRecord - The target record (eg, of a drop interaction), for contextindex - Insert point relative to the target record for the transferred recordssourceWidget - The databound or non-databound component from which the records
are to be transferred.callback - optional TransferRecordsCallback to be fired when the transfer process has
completed (pass null if your code does not need to be called back).
The callback will be passed the list of records actually transferred
to this componentpublic TileGrid setDragDataCustomizer(DragDataCustomizer customizer)
This method is consulted by
willAcceptDrop().
DragDataCustomizer - customizerDataBoundComponent
instance, for chaining setter callspublic SortSpecifier[] getSort()
DataBoundComponentSortSpecifiers for
this component. Will return null if this component has never been sorted, or the
underlying SmartClient widget does not exist.getSort in interface DataBoundComponentpublic TileGrid setSort(SortSpecifier... sortSpecifiers)
DataBoundComponent
Pass in an array of SortSpecifiers to have the
component's data sorted by the fields in each
specifier.property and
in the directions specified. The component can be sorted by any combination of fields,
including fields specified in the fields array and
unused fields from the underlying
dataSource, if there is one.
If setSort() is called on a component which doesn't yet have a SmartClient widget, the
widget will be created. If autoFetchData is set and a
DataSource has been set, this will result in data being fetched.
setSort in interface DataBoundComponentsortSpecifiers - Array of SortSpecifier objectspublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.tile.TileGridLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class TileLayout