TileGrid

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.smartgwt.client.widgets.tile
Class TileGrid

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.smartgwt.client.widgets.BaseWidget
              com.smartgwt.client.widgets.Canvas
                  com.smartgwt.client.widgets.tile.TileLayout
                      com.smartgwt.client.widgets.tile.TileGrid

All Implemented Interfaces:: HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, DataBoundComponent, HasClickHandlers, HasDoubleClickHandlers, HasDragCompleteHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropCompleteHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFetchDataHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasDataArrivedHandlers, HasRecordClickHandlers, HasRecordContextClickHandlers, HasRecordDoubleClickHandlers, HasSelectionChangedHandlers

public class TileGrid
extends TileLayout
implements DataBoundComponent, HasDataArrivedHandlers, HasRecordClickHandlers, HasRecordDoubleClickHandlers, HasRecordContextClickHandlers, HasSelectionChangedHandlers
extends TileLayout
implements DataBoundComponent, HasDataArrivedHandlers, HasRecordClickHandlers, HasRecordDoubleClickHandlers, HasRecordContextClickHandlers, HasSelectionChangedHandlers

A TileGrid is a 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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
`UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled`

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget
`config, configOnly, id, isElementSet, nativeObject, scClassName`

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

Constructor Summary
`TileGrid()`
`TileGrid(JavaScriptObject jsObj)`

Method Summary
`void`	`addData(Record record)` Perform a DataSource "add" operation to add new records to this component's DataSource.
`void`	`addData(Record record, DSCallback callback)` Perform a DataSource "add" operation to add new records to this component's DataSource.
`void`	`addData(Record record, DSCallback callback, DSRequest requestProperties)` Perform a DataSource "add" operation to add new records to this component's DataSource.
`HandlerRegistration`	`addDataArrivedHandler(DataArrivedHandler handler)` Add a dataArrived handler.
`HandlerRegistration`	`addDragCompleteHandler(DragCompleteHandler handler)` Add a `com.smartgwt.client.widgets.DragCompleteHandler`.
`HandlerRegistration`	`addDropCompleteHandler(DropCompleteHandler handler)` Add a `com.smartgwt.client.widgets.DropCompleteHandler`.
`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.
`HandlerRegistration`	`addRecordClickHandler(RecordClickHandler handler)` Add a recordClick handler.
`HandlerRegistration`	`addRecordContextClickHandler(RecordContextClickHandler handler)` Add a recordContextClick handler.
`HandlerRegistration`	`addRecordDoubleClickHandler(RecordDoubleClickHandler handler)` Add a recordDoubleClick handler.
`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.
`Boolean`	`anySelected()` Whether at least one item is selected
`protected JavaScriptObject`	`create()`
`void`	`deselectAllRecords()` Deselect all records
`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 `Record`s passed in explicitly, or by index.
`void`	`deselectRecords(Record[] records)` Deselect a list of `Record`s passed in explicitly, or by index.
`void`	`disableHilite(String hiliteID)` Disable a hilite
`void`	`disableHiliting()` Disable all hilites.
`void`	`editHilites()` Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.
`void`	`enableHilite(String hiliteID)` Enable / disable a `hilites`
`void`	`enableHilite(String hiliteID, boolean enable)` Enable / disable a `hilites`
`void`	`enableHiliting()` Enable all hilites.
`void`	`enableHiliting(boolean enable)` Enable all hilites.
`void`	`exportClientData()` Exports this component's data with client-side formatters applied, so is suitable for direct display to users.
`void`	`exportClientData(DSRequest requestProperties)` Exports this component's data with client-side formatters applied, so is suitable for direct display to users.
`void`	`exportData()` 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`	`exportData(DSRequest requestProperties)` 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.
`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.
`String`	`getAddFormulaFieldText()` Text for a menu item allowing users to add a formula field
`String`	`getAddOperation()` Operation ID this component should use when performing add operations.
`String`	`getAddSummaryFieldText()` Text for a menu item allowing users to add a formula field
`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.
`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()`
`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.
`Boolean`	`getCanAcceptDroppedRecords()` Indicates whether records can be dropped into this TileGrid.
`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`.
`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`.
`Boolean`	`getCanDragTilesOut()` Indicates whether tiles can be dragged from this tileGrid and dropped elsewhere.
`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.
`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`.
`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.
`String`	`getDragTrackerStyle()` CSS Style to apply to the drag tracker when dragging occurs on this component.
`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).
`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.
`String`	`getDuplicateDragMessage()` Message to show when a user attempts to transfer duplicate records into this component, and `preventDuplicates` is enabled.
`String`	`getEditFormulaFieldText()` Text for a menu item allowing users to edit a formula field
`String`	`getEditSummaryFieldText()` Text for a menu item allowing users to edit the formatter for a field
`Boolean`	`getExportAll()` Setting exportAll to true prevents the component from passing its list of fields to the export call.
`String[]`	`getExportFields()` The list of field-names to export.
`String`	`getFetchOperation()` Operation ID this component should use when performing fetch operations.
`String`	`getFieldState()` Returns a snapshot of the current presentation of this grid's fields as a ListGridFieldState object.
`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.
`String`	`getHiliteState()` Get the current hilites encoded as a String, for saving.
`Criteria`	`getInitialCriteria()` Criteria to use when `DataBoundComponent.setAutoFetchData(Boolean)` is used.
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`getLogicalStructure()`
`static TileGrid`	`getOrCreateRef(JavaScriptObject jsObj)`
`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)`.
`Integer`	`getPrintTilesPerLine()` How many tiles should be present in a line when printing?
`int`	`getRecordIndex(Record record)` Get the index of the provided record.
`RecordList`	`getRecordList()` Return the underlying data of this DataBoundComponent as a `RecordList`.
`String`	`getRemoveOperation()` Operation ID this component should use when performing remove operations.
`ResultSet`	`getResultSet()` Return the underlying data of this DataBoundComponent as a `ResultSet`.
`TileRecord`	`getSelectedRecord()` Return 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.
`Boolean`	`getShowAllRecords()` Whether tiles are created and drawn for all records, or only for those currently visible.
`Boolean`	`getShowComplexFields()` Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no `component.fields`.
`Boolean`	`getShowDetailFields()` By default, TileGrids will not show fields marked `detail:true` in the DataSource.
`Boolean`	`getShowHiddenFields()` Whether to show fields marked `hidden:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`String`	`getStyleName()` Style for the overall TileGrid component.
`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.
`DragAppearance`	`getTileDragAppearance()` Visual appearance to show when the tile is being dragged.
`protected 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 from the TileGrid's data.
`String`	`getTileValueAlign()` Horizontal alignment for tile values: "left", "right" or "center".
`String`	`getTileValueStyle()` When using the default `SimpleTile`, CSS style for each value shown within a tile.
`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"`.
`String`	`getTitleFieldValue(Record record)` Get the value of the titleField for the passed record
`String`	`getUpdateOperation()` Operation ID this component should use when performing update operations.
`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.
`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`	`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 `this.data.invalidateCache()`.
`protected void`	`onInit_TileGrid()`
`protected void`	`onInit()`
`void`	`removeData(Record record)` Perform a DataSource "remove" operation to remove records from this component's DataSource.
`void`	`removeData(Record record, DSCallback callback)` Perform a DataSource "remove" operation to remove records from this component's DataSource.
`void`	`removeData(Record record, 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.
`void`	`removeTile()` This is not allowed for tileGrid.
`void`	`selectAllRecords()` Select all records
`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 `Record`s passed in explicitly, or by index.
`void`	`selectRecords(int[] records, boolean newState)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`selectRecords(Record[] records)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`selectRecords(Record[] records, boolean newState)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`setAddDropValues(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.
`void`	`setAddFormulaFieldText(String addFormulaFieldText)` Text for a menu item allowing users to add a formula field
`void`	`setAddOperation(String addOperation)` Operation ID this component should use when performing add operations.
`void`	`setAddSummaryFieldText(String addSummaryFieldText)` Text for a menu item allowing users to add a formula field
`void`	`setAnimateTileChange(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.
`void`	`setAutoFetchAsFilter(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()`
`void`	`setAutoFetchData(Boolean autoFetchData)` If true, when this component is first drawn, automatically call `DataBoundComponent.fetchData()` or `DataBoundComponent.filterData()` depending on `DataBoundComponent.getAutoFetchAsFilter()` .
`void`	`setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)` If `autoFetchData` is `true`, this attribute allows the developer to specify a textMatchStyle for the initial `DataBoundComponent.fetchData()` call.
`void`	`setCanAcceptDroppedRecords(Boolean canAcceptDroppedRecords)` Indicates whether records can be dropped into this TileGrid.
`void`	`setCanAddFormulaFields(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`.
`void`	`setCanAddSummaryFields(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`.
`void`	`setCanDragTilesOut(Boolean canDragTilesOut)` Indicates whether tiles can be dragged from this tileGrid and dropped elsewhere.
`void`	`setCanReorderTiles(Boolean canReorderTiles)` Indicates whether tiles can be reordered by dragging within this tileGrid.
`void`	`setData(Record[] data)` An array of Record objects, specifying the data to be used to populate the DataBoundComponent.
`void`	`setData(RecordList data)` An List of Record objects, specifying the data to be used to populate the DataBoundComponent.
`void`	`setData(TileRecord[] data)` A List of TileRecord objects, specifying the data to be used to create the tiles.
`void`	`setDataFetchMode(FetchMode dataFetchMode)` How to fetch and manage records retrieve from the server.
`void`	`setDataPageSize(int dataPageSize)` When using data paging, how many records to fetch at a time.
`void`	`setDataSource(DataSource dataSource)` Bind to a DataSource.
`void`	`setDataSource(DataSource dataSource, DetailViewerField... fields)` Bind to a DataSource.
`static void`	`setDefaultProperties(TileGrid tileGridProperties)` Class level method to set the default properties of this class.
`void`	`setDetailViewerProperties(DetailViewer detailViewerProperties)` Properties for the `DetailViewer` that is automatically created to render the contents of tiles by default.
`void`	`setDragDataAction(DragDataAction dragDataAction)` Indicates what to do with data dragged into another DataBoundComponent.
`void`	`setDragTrackerStyle(String dragTrackerStyle)` CSS Style to apply to the drag tracker when dragging occurs on this component.
`void`	`setDropValues(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.
`void`	`setDuplicateDragMessage(String duplicateDragMessage)` Message to show when a user attempts to transfer duplicate records into this component, and `preventDuplicates` is enabled.
`void`	`setEditFormulaFieldText(String editFormulaFieldText)` Text for a menu item allowing users to edit a formula field
`void`	`setEditSummaryFieldText(String editSummaryFieldText)` Text for a menu item allowing users to edit the formatter for a field
`void`	`setExportAll(Boolean exportAll)` Setting exportAll to true prevents the component from passing its list of fields to the export call.
`void`	`setExportFields(String[] exportFields)` The list of field-names to export.
`void`	`setFetchOperation(String fetchOperation)` Operation ID this component should use when performing fetch operations.
`void`	`setFields(DetailViewerField... fields)` Array of field definitions to control the default rendering of tiles.
`void`	`setFieldState(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 `TileGrid.getFieldState`.
`void`	`setHiliteProperty(String hiliteProperty)` Marker that can be set on a record to flag that record as hilited.
`void`	`setHilites(Hilite[] hilites)` Accepts an array of hilite objects and applies them to this DataBoundComponent.
`void`	`setHiliteState(String hiliteState)` Set the current hilites based on a hiliteState String previously returned from getHilitesState.
`void`	`setInitialCriteria(Criteria initialCriteria)` Criteria to use when `DataBoundComponent.setAutoFetchData(Boolean)` is used.
`void`	`setJavaScriptObject(JavaScriptObject jsObj)`
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`setLogicalStructure(com.smartgwt.logicalstructure.widgets.tile.TileGridLogicalStructure s)`
`void`	`setPreventDuplicates(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)`.
`void`	`setPrintTilesPerLine(Integer printTilesPerLine)` How many tiles should be present in a line when printing?
`void`	`setRemoveOperation(String removeOperation)` Operation ID this component should use when performing remove operations.
`void`	`setSelectionType(SelectionStyle selectionType)` Defines a tileGrid's clickable-selection behavior.
`void`	`setShowAllRecords(Boolean showAllRecords)` Whether tiles are created and drawn for all records, or only for those currently visible.
`void`	`setShowComplexFields(Boolean showComplexFields)` Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no `component.fields`.
`void`	`setShowDetailFields(Boolean showDetailFields)` By default, TileGrids will not show fields marked `detail:true` in the DataSource.
`void`	`setShowHiddenFields(Boolean showHiddenFields)` Whether to show fields marked `hidden:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`void`	`setStyleName(String styleName)` Style for the overall TileGrid component.
`void`	`setTileDragAppearance(DragAppearance tileDragAppearance)` Visual appearance to show when the tile is being dragged.
`void`	`setTileProperties(Canvas tileProperties)` Common properties to use when creating every tile.
`void`	`setTileValueAlign(String tileValueAlign)` Horizontal alignment for tile values: "left", "right" or "center".
`void`	`setTileValueStyle(String tileValueStyle)` When using the default `SimpleTile`, CSS style for each value shown within a tile.
`void`	`setTitleField(String titleField)` Sets the best field to use for a user-visible title for an individual record from this component.
`void`	`setUpdateOperation(String updateOperation)` Operation ID this component should use when performing update operations.
`void`	`setUseAllDataSourceFields(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.
`void`	`setUseFlatFields(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.
`void`	`setWrapValues(Boolean wrapValues)` Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.
`void`	`sortByProperty(String property, boolean ascending)` Sort data by property.
`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.

Methods inherited from class com.smartgwt.client.widgets.tile.TileLayout
addTile, addTile, getAutoWrapLines, getExpandMargins, getLayoutMargin, getOrientation, getOverflow, getPaddingAsLayoutMargin, getTileHeight, getTileHMargin, getTileMargin, getTileSize, getTilesPerLine, getTileVMargin, getTileWidth, layoutTiles, removeTile, removeTile, removeTile, setAutoWrapLines, setDefaultProperties, setExpandMargins, setLayoutMargin, setLayoutPolicy, setLogicalStructure, setOrientation, setOverflow, setPaddingAsLayoutMargin, setTileHeight, setTileHMargin, setTileMargin, setTiles, setTileSize, setTilesPerLine, setTileVMargin, setTileWidth

Methods inherited from class com.smartgwt.client.widgets.tile.TileLayout

addTile, addTile, getAutoWrapLines, getExpandMargins, getLayoutMargin, getOrientation, getOverflow, getPaddingAsLayoutMargin, getTileHeight, getTileHMargin, getTileMargin, getTileSize, getTilesPerLine, getTileVMargin, getTileWidth, layoutTiles, removeTile, removeTile, removeTile, setAutoWrapLines, setDefaultProperties, setExpandMargins, setLayoutMargin, setLayoutPolicy, setLogicalStructure, setOrientation, setOverflow, setPaddingAsLayoutMargin, setTileHeight, setTileHMargin, setTileMargin, setTiles, setTileSize, setTilesPerLine, setTileVMargin, setTileWidth

Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, 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, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, deparent, depeer, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAttribute, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getParentElements, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

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

addChild, addChild, addChild, addChild, 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, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, deparent, depeer, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAttribute, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getParentElements, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
`addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents`

Methods inherited from class com.google.gwt.user.client.ui.UIObject
`addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents`

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

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
`getOrCreateJsObj`

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

Constructor Detail

TileGrid

public TileGrid()

TileGrid

public TileGrid(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static TileGrid getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:: setJavaScriptObject in class TileLayout

create

protected JavaScriptObject create()

Overrides:: create in class TileLayout

setAnimateTileChange

public void setAnimateTileChange(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.

Note : This is an advanced setting

Overrides:: setAnimateTileChange in class TileLayout

Parameters:: animateTileChange - animateTileChange Default value is true
See Also:: Appearance overview and related methods

getAnimateTileChange

public 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.

Overrides:: getAnimateTileChange in class TileLayout

Returns:: Boolean
See Also:: Appearance overview and related methods

setCanAcceptDroppedRecords

public void setCanAcceptDroppedRecords(Boolean canAcceptDroppedRecords)

Indicates whether records can be dropped into this TileGrid.

Parameters:: canAcceptDroppedRecords - canAcceptDroppedRecords Default value is false
See Also:: Drag list (move) Example

getCanAcceptDroppedRecords

public Boolean getCanAcceptDroppedRecords()

Indicates whether records can be dropped into this TileGrid.

Returns:: Boolean
See Also:: Drag list (move) Example

setCanDragTilesOut

public void setCanDragTilesOut(Boolean canDragTilesOut)

Indicates whether tiles can be dragged from this tileGrid and dropped elsewhere.

Parameters:: canDragTilesOut - canDragTilesOut Default value is false

getCanDragTilesOut

public Boolean getCanDragTilesOut()

Indicates whether tiles can be dragged from this tileGrid and dropped elsewhere.

Returns:: Boolean

setCanReorderTiles

public void setCanReorderTiles(Boolean canReorderTiles)

Indicates whether tiles can be reordered by dragging within this tileGrid.

Parameters:: canReorderTiles - canReorderTiles Default value is false

getCanReorderTiles

public Boolean getCanReorderTiles()

Indicates whether tiles can be reordered by dragging within this tileGrid.

Returns:: Boolean

setDataFetchMode

public void setDataFetchMode(FetchMode dataFetchMode)

How to fetch and manage records retrieve from the server. See FetchMode.

This setting only applies to the ResultSet automatically created by calling TileGrid.fetchData. If a pre-existing ResultSet is passed to setData() instead, it's existing setting for fetchMode applies.

Specified by:: setDataFetchMode in interface DataBoundComponent

Parameters:: dataFetchMode - dataFetchMode Default value is "paged"
See Also:: Databinding overview and related methods

getDataFetchMode

public FetchMode getDataFetchMode()

How to fetch and manage records retrieve from the server. See FetchMode.

Specified by:: getDataFetchMode in interface DataBoundComponent

Returns:: FetchMode
See Also:: Databinding overview and related methods

setDetailViewerProperties

public void setDetailViewerProperties(DetailViewer detailViewerProperties)
                               throws IllegalStateException

Properties for the DetailViewer that is automatically created to render the contents of tiles by default.

Parameters:: detailViewerProperties - detailViewerProperties Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getDetailViewerProperties

public DetailViewer getDetailViewerProperties()

Properties for the DetailViewer that is automatically created to render the contents of tiles by default.

Returns:: DetailViewer

setPrintTilesPerLine

public void setPrintTilesPerLine(Integer printTilesPerLine)
                          throws IllegalStateException

How many tiles should be present in a line when printing?

Parameters:: printTilesPerLine - printTilesPerLine Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getPrintTilesPerLine

public Integer getPrintTilesPerLine()

How many tiles should be present in a line when printing?

Returns:: Integer

setSelectionType

public void setSelectionType(SelectionStyle selectionType)

Defines a tileGrid's clickable-selection behavior.

Parameters:: selectionType - selectionType Default value is Selection.MULTIPLE
See Also:: SelectionStyle, Appearance overview and related methods, Editing Example

getSelectionType

public SelectionStyle getSelectionType()

Defines a tileGrid's clickable-selection behavior.

Returns:: SelectionStyle
See Also:: SelectionStyle, Appearance overview and related methods, Editing Example

setShowAllRecords

public void setShowAllRecords(Boolean showAllRecords)
                       throws IllegalStateException

Whether tiles are created and drawn for all records, or only for those currently visible.

Parameters:: showAllRecords - showAllRecords Default value is false
Throws:: IllegalStateException - this property cannot be changed after the component has been created
See Also:: Basics overview and related methods

getShowAllRecords

public Boolean getShowAllRecords()

Whether tiles are created and drawn for all records, or only for those currently visible.

Returns:: Boolean
See Also:: Basics overview and related methods

setShowDetailFields

public void setShowDetailFields(Boolean showDetailFields)
                         throws IllegalStateException

By default, TileGrids will not show fields marked detail:true in the DataSource. See also fields.

Specified by:: setShowDetailFields in interface DataBoundComponent

Parameters:: showDetailFields - showDetailFields Default value is false
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getShowDetailFields

public Boolean getShowDetailFields()

By default, TileGrids will not show fields marked detail:true in the DataSource. See also fields.

Specified by:: getShowDetailFields in interface DataBoundComponent

Returns:: Boolean

setStyleName

public void setStyleName(String styleName)
                  throws IllegalStateException

Style for the overall TileGrid component.

Overrides:: setStyleName in class Canvas

Parameters:: styleName - . See CSSStyleName. Default value is "tileGrid"
Throws:: IllegalStateException - this property cannot be changed after the component has been created
See Also:: Appearance overview and related methods

getStyleName

public String getStyleName()

Style for the overall TileGrid component.

Overrides:: getStyleName in class Canvas

Returns:: . See CSSStyleName
See Also:: Appearance overview and related methods

setTileDragAppearance

public void setTileDragAppearance(DragAppearance tileDragAppearance)

Visual appearance to show when the tile is being dragged.

Note : This is an advanced setting

Parameters:: tileDragAppearance - tileDragAppearance Default value is EventHandler.TRACKER
See Also:: Canvas.setDragAppearance(com.smartgwt.client.types.DragAppearance), Dragdrop overview and related methods

getTileDragAppearance

public DragAppearance getTileDragAppearance()

Visual appearance to show when the tile is being dragged.

Returns:: DragAppearance
See Also:: Canvas.getDragAppearance(), Dragdrop overview and related methods

setTileProperties

public void setTileProperties(Canvas tileProperties)
                       throws IllegalStateException

Common properties to use when creating every tile.

Parameters:: tileProperties - tileProperties Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getTileProperties

public Canvas getTileProperties()

Common properties to use when creating every tile.

Returns:: Canvas

setTileValueAlign

public void setTileValueAlign(String tileValueAlign)
                       throws IllegalStateException

Horizontal alignment for tile values: "left", "right" or "center".

Parameters:: tileValueAlign - . See String. Default value is "center"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getTileValueAlign

public String getTileValueAlign()

Horizontal alignment for tile values: "left", "right" or "center".

Returns:: . See String

setTileValueStyle

public void setTileValueStyle(String tileValueStyle)
                       throws IllegalStateException

When using the default SimpleTile, CSS style for each value shown within a tile.

Parameters:: tileValueStyle - . See CSSClassName. Default value is "tileValue"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getTileValueStyle

public String getTileValueStyle()

When using the default SimpleTile, CSS style for each value shown within a tile.

Returns:: . See CSSClassName

setWrapValues

public void setWrapValues(Boolean wrapValues)
                   throws IllegalStateException

Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.

Parameters:: wrapValues - wrapValues Default value is false
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getWrapValues

public Boolean getWrapValues()

Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.

Returns:: Boolean

addTile

public void addTile()

This is not allowed for tileGrid. Instead, use TileGrid.addData.

addDataArrivedHandler

public HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)

Add a dataArrived 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.

Specified by:: addDataArrivedHandler in interface HasDataArrivedHandlers

Parameters:: handler - the dataArrived handler
Returns:: HandlerRegistration used to remove this handler

getCurrentTile

public SimpleTile getCurrentTile()

Returns the tile currently under the mouse.

Returns:: the tile currently under the mouse

getDragTrackerTitle

public 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).

Note: Only called if dragTrackerMode is set to "title".

Parameters:: record - First selected record being dragged; rowNum - row index of first record being dragged
Returns:: Title for the row. Default implementation looks at the value of the title-field cell for the row.

getFieldState

public String getFieldState()

Returns a snapshot of the current presentation of this grid's fields as a ListGridFieldState object.

This object can be passed to TileGrid.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.

Returns:: current state of this grid's fields.
See Also:: setFieldState(java.lang.String)

getSelectedRecord

public TileRecord getSelectedRecord()

Return the first selected record in this component

Returns:: first selected record, or null if nothing selected
See Also:: Selection overview and related methods, Databound remove Example

getTileIndex

public int getTileIndex(Canvas tile)

Returns the index of the specified tile.

Parameters:: tile - Tile you want to get the index for
Returns:: index of the tile in this tileGrid. Will return -1 if the specifiedtile is not displayed within this grid.

getTileRecord

public TileRecord getTileRecord(Canvas tile)

Given a tile within this this tile-grid, this method will return the associated record from the TileGrid's data.

Parameters:: tile - Tile you want to get the record for
Returns:: Record associated with the specified tile

addRecordClickHandler

public HandlerRegistration addRecordClickHandler(RecordClickHandler handler)

Add a recordClick 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.grid.events.RecordClickEvent). Otherwise, return true so that the click event be registered with the tile.

Specified by:: addRecordClickHandler in interface HasRecordClickHandlers

Parameters:: handler - the recordClick handler
Returns:: HandlerRegistration used to remove this handler

addRecordContextClickHandler

public HandlerRegistration addRecordContextClickHandler(RecordContextClickHandler handler)

Add a recordContextClick 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.

Specified by:: addRecordContextClickHandler in interface HasRecordContextClickHandlers

Parameters:: handler - the recordContextClick handler
Returns:: HandlerRegistration used to remove this handler

addRecordDoubleClickHandler

public HandlerRegistration addRecordDoubleClickHandler(RecordDoubleClickHandler handler)

Add a recordDoubleClick 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.grid.events.RecordDoubleClickEvent). Otherwise, return true so that the doubleclick event be registered with the tile.

Specified by:: addRecordDoubleClickHandler in interface HasRecordDoubleClickHandlers

Parameters:: handler - the recordDoubleClick handler
Returns:: HandlerRegistration used to remove this handler

removeTile

public void removeTile()

This is not allowed for tileGrid. Instead, use TileGrid.removeData.

addSelectionChangedHandler

public HandlerRegistration addSelectionChangedHandler(SelectionChangedHandler handler)

Add a selectionChanged 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).

Specified by:: addSelectionChangedHandler in interface HasSelectionChangedHandlers

Parameters:: handler - the selectionChanged handler
Returns:: HandlerRegistration used to remove this handler

setFieldState

public void setFieldState(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 TileGrid.getFieldState.

Parameters:: fieldState - state to apply to the grid's fields.

setDefaultProperties

public static void setDefaultProperties(TileGrid tileGridProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Note: This method is intended for setting default attributes only and will effect 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.

Parameters:: tileGridProperties - properties that should be used as new defaults when instances of this class are created

onInit

protected void onInit()

Overrides:: onInit in class Canvas

onInit_TileGrid

protected void onInit_TileGrid()

getTileHTML

protected String getTileHTML(Record record)

This method provides the HTML to be displayed within each tile. See tile.

This is an override point.

Parameters:: record - the tile for which HTML should be retrieved
Returns:: HTML contents for the tile, as a String

getTile

public Canvas getTile(Record record)

Returns the tile for the passed record or record index.

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.

Parameters:: tile - (TileRecord) record
Returns:: (Canvas) tile for this record

getTile

public Canvas getTile(int recordNum)

Returns the tile for the passed record or record index.

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

Overrides:: getTile in class TileLayout

Parameters:: tile - (int) index of record in this.data
Returns:: (Canvas) tile for this record

setFields

public void setFields(DetailViewerField... fields)
               throws IllegalStateException

Array of field definitions to control the default rendering of tiles.

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 com.smartgwt.client..SimpleTile class for tiles.

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("animalName");  
 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);

Parameters:: fields - fields Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

setData

public void setData(TileRecord[] data)

A List of TileRecord objects, specifying the data to be used to create the tiles.

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.

Parameters:: data - data Default value is null

setData

public void setData(Record[] data)

An array of Record objects, specifying the data to be used to populate the DataBoundComponent. Note that not all DataBoundComponents observe the changes to the data to redraw themselves. Refer to the version of setData that accepts component specific records.

Parameters:: data - array of Record objects.
See Also:: setData(TileRecord[])

setData

public void setData(RecordList data)

An List of Record objects, specifying the data to be used to populate the DataBoundComponent. Note that not all DataBoundComponents observe the changes to the data to redraw themselves. Refer to the version of setData that accepts component specific records.

Parameters:: data - List of Records

getData

public Record[] getData()

A List of TileRecord objects, specifying the data to be used to create the tiles.

Returns:: the records in the TileGrid

getDataAsRecordList

public RecordList getDataAsRecordList()

Return the tileGrid data as a RecordList. If the component is bound to a DataSource, the actual type of the RecordList instance will be a ResultSet.

Returns:: the data

addData

public void addData(Record record)

Perform a DataSource "add" operation to add new records to this component's DataSource.

Parameters:: record - new record

addData

public void addData(Record record,
                    DSCallback callback)

Perform a DataSource "add" operation to add new records to this component's DataSource.

Parameters:: record - new record; callback - method to call on operation completion

addData

public void addData(Record record,
                    DSCallback callback,
                    DSRequest requestProperties)

Perform a DataSource "add" operation to add new records to this component's DataSource.

Parameters:: record - new record; callback - method to call on operation completion; requestProperties - additional properties to set on the DSRequest that will be issued

removeData

public void removeData(Record record)

Perform a DataSource "remove" operation to remove records from this component's DataSource.

Parameters:: record - primary key values of record to delete, (or complete record)

removeData

public void removeData(Record record,
                       DSCallback callback)

Perform a DataSource "remove" operation to remove records from this component's DataSource.

Parameters:: record - primary key values of record to delete, (or complete record); callback - method to call on operation completion

removeData

public void removeData(Record record,
                       DSCallback callback,
                       DSRequest requestProperties)

Perform a DataSource "remove" operation to remove records from this component's DataSource.

Parameters:: record - primary key values of record to delete, (or complete record); callback - method to call on operation completion; requestProperties - additional properties to set on the DSRequest that will be issued

sortByProperty

public void sortByProperty(String property,
                           boolean ascending)

Sort data by property.

Parameters:: property - property; ascending - direction

removeSelectedData

public void removeSelectedData()

Remove the currently selected records from this component. If this is a databound grid, the records will be removed directly from the DataSource.

If no records are selected, no action is taken. The grid will automatically be updated if the record deletion succeeds.

getSelection

public Record[] getSelection()

Returns all selected records, as an Array.

Returns:: list of records, empty list if nothing selected

setDataSource

public void setDataSource(DataSource dataSource,
                          DetailViewerField... fields)

Bind to a DataSource.

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().

Parameters:: dataSource -; fields -

setDataPageSize

public void setDataPageSize(int dataPageSize)

Description copied from interface: DataBoundComponent

When using data paging, how many records to fetch at a time. The value of this attribute is passed on to the auto-constructed ResultSet object for this component. In effect, this gives you control over the resultSize attribute for this component.

Note that regardless of the dataPageSize setting, a component will always fetch all of data that it needs to draw. Settings such as showAllRecords, drawAllMaxCells and drawAheadRatio can cause more rows than the configured dataPageSize to be fetched.

Specified by:: setDataPageSize in interface DataBoundComponent

Parameters:: dataPageSize - dataPageSize Default value is 75

getDataPageSize

public int getDataPageSize()

Description copied from interface: DataBoundComponent

Specified by:: getDataPageSize in interface DataBoundComponent

Returns:: int

setUseAllDataSourceFields

public void setUseAllDataSourceFields(Boolean useAllDataSourceFields)

Description copied from interface: DataBoundComponent

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.

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.

Specified by:: setUseAllDataSourceFields in interface DataBoundComponent

Parameters:: useAllDataSourceFields - useAllDataSourceFields Default value is false

getUseAllDataSourceFields

public Boolean getUseAllDataSourceFields()

Description copied from interface: DataBoundComponent

Specified by:: getUseAllDataSourceFields in interface DataBoundComponent

Returns:: Boolean

setShowHiddenFields

public void setShowHiddenFields(Boolean showHiddenFields)

Description copied from interface: DataBoundComponent

Whether to show fields marked hidden: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.

Specified by:: setShowHiddenFields in interface DataBoundComponent

Parameters:: showHiddenFields - showHiddenFields Default value is false

getShowHiddenFields

public Boolean getShowHiddenFields()

Description copied from interface: DataBoundComponent

Whether to show fields marked hidden: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.

Specified by:: getShowHiddenFields in interface DataBoundComponent

Returns:: Boolean

setShowComplexFields

public void setShowComplexFields(Boolean showComplexFields)

Description copied from interface: DataBoundComponent

Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.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

Specified by:: setShowComplexFields in interface DataBoundComponent

Parameters:: showComplexFields - showComplexFields Default value is true

getShowComplexFields

public Boolean getShowComplexFields()

Description copied from interface: DataBoundComponent

Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.fields.

Specified by:: getShowComplexFields in interface DataBoundComponent

Returns:: Boolean

setFetchOperation

public void setFetchOperation(String fetchOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing fetch operations.

Specified by:: setFetchOperation in interface DataBoundComponent

Parameters:: fetchOperation - fetchOperation Default value is null

getFetchOperation

public String getFetchOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing fetch operations.

Specified by:: getFetchOperation in interface DataBoundComponent

Returns:: String

setUpdateOperation

public void setUpdateOperation(String updateOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing update operations.

Specified by:: setUpdateOperation in interface DataBoundComponent

Parameters:: updateOperation - updateOperation Default value is null

getUpdateOperation

public String getUpdateOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing update operations.

Specified by:: getUpdateOperation in interface DataBoundComponent

Returns:: String

setAddOperation

public void setAddOperation(String addOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing add operations.

Specified by:: setAddOperation in interface DataBoundComponent

Parameters:: addOperation - addOperation Default value is null

getAddOperation

public String getAddOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing add operations.

Specified by:: getAddOperation in interface DataBoundComponent

Returns:: String

setRemoveOperation

public void setRemoveOperation(String removeOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing remove operations.

Specified by:: setRemoveOperation in interface DataBoundComponent

Parameters:: removeOperation - removeOperation Default value is null

getRemoveOperation

public String getRemoveOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing remove operations.

Specified by:: getRemoveOperation in interface DataBoundComponent

Returns:: String

setExportFields

public void setExportFields(String[] exportFields)

Description copied from interface: DataBoundComponent

The list of field-names to export. If provided, the field-list in the exported output is limited and sorted as per the list.

If exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.

Specified by:: setExportFields in interface DataBoundComponent

Parameters:: exportFields - exportFields Default value is null

getExportFields

public String[] getExportFields()

Description copied from interface: DataBoundComponent

The list of field-names to export. If provided, the field-list in the exported output is limited and sorted as per the list.

If exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.

Specified by:: getExportFields in interface DataBoundComponent

Returns:: the list of field-names to export.

setExportAll

public void setExportAll(Boolean exportAll)

Description copied from interface: DataBoundComponent

Setting exportAll to true prevents the component from passing its list of fields to the export call. The result is the export of all visible fields from fields.

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.

Specified by:: setExportAll in interface DataBoundComponent

Parameters:: exportAll - exportAll Default value is false

getExportAll

public Boolean getExportAll()

Description copied from interface: DataBoundComponent

Setting exportAll to true prevents the component from passing its list of fields to the export call. The result is the export of all visible fields from fields.

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.

Specified by:: getExportAll in interface DataBoundComponent

Returns:: Boolean

setPreventDuplicates

public void setPreventDuplicates(Boolean preventDuplicates)
                          throws IllegalStateException

Description copied from interface: DataBoundComponent

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). 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.

Specified by:: setPreventDuplicates in interface DataBoundComponent

Parameters:: preventDuplicates - preventDuplicates Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getPreventDuplicates

public Boolean getPreventDuplicates()

Description copied from interface: DataBoundComponent

Specified by:: getPreventDuplicates in interface DataBoundComponent

Returns:: Boolean

setDuplicateDragMessage

public void setDuplicateDragMessage(String duplicateDragMessage)
                             throws IllegalStateException

Description copied from interface: DataBoundComponent

Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.

Specified by:: setDuplicateDragMessage in interface DataBoundComponent

Parameters:: duplicateDragMessage - duplicateDragMessage Default value is "Duplicates not allowed"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getDuplicateDragMessage

public String getDuplicateDragMessage()

Description copied from interface: DataBoundComponent

Specified by:: getDuplicateDragMessage in interface DataBoundComponent

Returns:: String

setAddDropValues

public void setAddDropValues(Boolean addDropValues)

Description copied from interface: DataBoundComponent

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. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.

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

Specified by:: setAddDropValues in interface DataBoundComponent

Parameters:: addDropValues - addDropValues Default value is true

getAddDropValues

public Boolean getAddDropValues()

Description copied from interface: 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

Specified by:: getAddDropValues in interface DataBoundComponent

Returns:: Boolean

setDropValues

public void setDropValues(Map dropValues)

Description copied from interface: DataBoundComponent

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.

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

Specified by:: setDropValues in interface DataBoundComponent

Parameters:: dropValues - dropValues Default value is null

getDropValues

public Map getDropValues()

Description copied from interface: DataBoundComponent

Note : This is an advanced setting

Specified by:: getDropValues in interface DataBoundComponent

Returns:

Returns the "drop values" to apply to a record dropped on this component prior to update. Only applicable to databound components - see dropValues for more details. If multiple records are being dropped, this method is called for each of them in turn.

This method returns the following:

Nothing, if addDropValues is false
dropValues, if that property is set. If the component's criteria object is applicable (as explained in the next item), it is merged into dropValues, with properties in dropValues taking precedence.
The component's criteria object, if the most recent textMatchStyle for the component was "exact" and it is simple criteria (ie, not an AdvancedCriteria object)
Otherwise nothing

You can override this method if you need more complex setting of drop values than can be provided by simply supplying a dropValues object.

setUseFlatFields

public void setUseFlatFields(Boolean useFlatFields)
                      throws IllegalStateException

Description copied from interface: DataBoundComponent

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.

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.

Specified by:: setUseFlatFields in interface DataBoundComponent

Parameters:: useFlatFields - useFlatFields Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getUseFlatFields

public Boolean getUseFlatFields()

Description copied from interface: DataBoundComponent

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.

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
 }

You can also set useFlatFields to automatically enable "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a particular operationType.

Specified by:: getUseFlatFields in interface DataBoundComponent

Returns:: Boolean

setHiliteProperty

public void setHiliteProperty(String hiliteProperty)

Description copied from interface: DataBoundComponent

Marker that can be set on a record to flag that record as hilited. Should be set to a value that matches id for a hilite defined on this component.

Specified by:: setHiliteProperty in interface DataBoundComponent

Parameters:: hiliteProperty - hiliteProperty Default value is "_hilite"

getHiliteProperty

public String getHiliteProperty()

Description copied from interface: DataBoundComponent

Marker that can be set on a record to flag that record as hilited. Should be set to a value that matches id for a hilite defined on this component.

Specified by:: getHiliteProperty in interface DataBoundComponent

Returns:: String

editHilites

public void editHilites()

Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.

Specified by:: editHilites in interface DataBoundComponent

getHiliteState

public String getHiliteState()

Get the current hilites encoded as a String, for saving.

Specified by:: getHiliteState in interface DataBoundComponent

Returns:: the hilite state

setHiliteState

public void setHiliteState(String hiliteState)

Set the current hilites based on a hiliteState String previously returned from getHilitesState.

Specified by:: setHiliteState in interface DataBoundComponent

Parameters:: hiliteState - hilites state encoded as a String

setHilites

public void setHilites(Hilite[] hilites)

Accepts an array of hilite objects and applies them to this DataBoundComponent. See also getHilites for a method of retrieving the hilite array for storage, including hilites manually added by the user.

Specified by:: setHilites in interface DataBoundComponent

Parameters:: hilites - array of hilite objects

getHilites

public Hilite[] getHilites()

Return the set of hilite-objects currently applied to this DataBoundComponent. These can be saved for storage and then restored to a component later via setHilites().

Specified by:: getHilites in interface DataBoundComponent

Returns:: array of hilite objects

setDragDataAction

public void setDragDataAction(DragDataAction dragDataAction)

Description copied from class: TileLayout

Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.

Specified by:: setDragDataAction in interface DataBoundComponent
Overrides:: setDragDataAction in class TileLayout

Parameters:: dragDataAction - dragDataAction Default value is Canvas.MOVE
See Also:: Drag move Example, Drag copy Example

getDragDataAction

public DragDataAction getDragDataAction()

Description copied from class: TileLayout

Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.

Specified by:: getDragDataAction in interface DataBoundComponent
Overrides:: getDragDataAction in class TileLayout

Returns:: DragDataAction
See Also:: Drag move Example, Drag copy Example

setDragTrackerStyle

public void setDragTrackerStyle(String dragTrackerStyle)

Description copied from interface: DataBoundComponent

CSS Style to apply to the drag tracker when dragging occurs on this component.

Specified by:: setDragTrackerStyle in interface DataBoundComponent

Parameters:: dragTrackerStyle - dragTrackerStyle Default value is "gridDragTracker"

getDragTrackerStyle

public String getDragTrackerStyle()

Description copied from interface: DataBoundComponent

CSS Style to apply to the drag tracker when dragging occurs on this component.

Specified by:: getDragTrackerStyle in interface DataBoundComponent

Returns:: String

setCanAddFormulaFields

public void setCanAddFormulaFields(Boolean canAddFormulaFields)

Description copied from interface: DataBoundComponent

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.

User-added formula fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:: setCanAddFormulaFields in interface DataBoundComponent

Parameters:: canAddFormulaFields - canAddFormulaFields Default value is false

addSummaryField

public void addSummaryField()

Description copied from interface: DataBoundComponent

Convenience method to display a com.smartgwt.client..SummaryBuilder to create a new Summary Field. This is equivalent to calling DataBoundComponentGen#editSummaryField with no parameter.

Specified by:: addSummaryField in interface DataBoundComponent

addFormulaField

public void addFormulaField()

Description copied from interface: DataBoundComponent

Convenience method to display a com.smartgwt.client..FormulaBuilder to create a new Formula Field. This is equivalent to calling DataBoundComponentGen#editFormulaField with no parameter.

Specified by:: addFormulaField in interface DataBoundComponent

getCanAddFormulaFields

public Boolean getCanAddFormulaFields()

Description copied from interface: DataBoundComponent

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.

User-added formula fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:: getCanAddFormulaFields in interface DataBoundComponent

Returns:: Boolean

setAddFormulaFieldText

public void setAddFormulaFieldText(String addFormulaFieldText)

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to add a formula field

Specified by:: setAddFormulaFieldText in interface DataBoundComponent

Parameters:: addFormulaFieldText - addFormulaFieldText Default value is "Add formula column..."

getAddFormulaFieldText

public String getAddFormulaFieldText()

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to add a formula field

Specified by:: getAddFormulaFieldText in interface DataBoundComponent

Returns:: String

setEditFormulaFieldText

public void setEditFormulaFieldText(String editFormulaFieldText)

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to edit a formula field

Specified by:: setEditFormulaFieldText in interface DataBoundComponent

Parameters:: editFormulaFieldText - editFormulaFieldText Default value is "Edit formula..."

getEditFormulaFieldText

public String getEditFormulaFieldText()

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to edit a formula field

Specified by:: getEditFormulaFieldText in interface DataBoundComponent

Returns:: String

setCanAddSummaryFields

public void setCanAddSummaryFields(Boolean canAddSummaryFields)

Description copied from interface: DataBoundComponent

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.

User-added summary fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:: setCanAddSummaryFields in interface DataBoundComponent

Parameters:: canAddSummaryFields - canAddSummaryFields Default value is false

getCanAddSummaryFields

public Boolean getCanAddSummaryFields()

Description copied from interface: DataBoundComponent

User-added summary fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:: getCanAddSummaryFields in interface DataBoundComponent

Returns:: Boolean

setAddSummaryFieldText

public void setAddSummaryFieldText(String addSummaryFieldText)

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to add a formula field

Specified by:: setAddSummaryFieldText in interface DataBoundComponent

Parameters:: addSummaryFieldText - addSummaryFieldText Default value is "Add summary column..."

getAddSummaryFieldText

public String getAddSummaryFieldText()

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to add a formula field

Specified by:: getAddSummaryFieldText in interface DataBoundComponent

Returns:: String

setEditSummaryFieldText

public void setEditSummaryFieldText(String editSummaryFieldText)

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to edit the formatter for a field

Specified by:: setEditSummaryFieldText in interface DataBoundComponent

Parameters:: editSummaryFieldText - editSummaryFieldText Default value is "Edit summary format..."

getEditSummaryFieldText

public String getEditSummaryFieldText()

Description copied from interface: DataBoundComponent

Text for a menu item allowing users to edit the formatter for a field

Specified by:: getEditSummaryFieldText in interface DataBoundComponent

Returns:: String

selectRecord

public void selectRecord(Record record)

Description copied from interface: DataBoundComponent

Select/deselect a Record passed in explicitly, or by index.

Specified by:: selectRecord in interface DataBoundComponent

Parameters:: record - record (or row number) to select

selectRecord

public void selectRecord(int record)

Description copied from interface: DataBoundComponent

Select/deselect a Record passed in explicitly, or by index.

Specified by:: selectRecord in interface DataBoundComponent

Parameters:: record - record (or row number) to select

selectRecord

public void selectRecord(int record,
                         boolean newState)

Description copied from interface: DataBoundComponent

Select/deselect a Record passed in explicitly, or by index.

Specified by:: selectRecord in interface DataBoundComponent

Parameters:: record - record (or row number) to select; newState - new selection state (if null, defaults to true)

selectRecord

public void selectRecord(Record record,
                         boolean newState)

Description copied from interface: DataBoundComponent

Select/deselect a Record passed in explicitly, or by index.

Specified by:: selectRecord in interface DataBoundComponent

Parameters:: record - record (or row number) to select; newState - new selection state (if null, defaults to true)

selectRecords

public void selectRecords(int[] records)

Description copied from interface: DataBoundComponent

Select/deselect a list of Records passed in explicitly, or by index.

Specified by:: selectRecords in interface DataBoundComponent

Parameters:: records - records (or row numbers) to select

selectRecords

public void selectRecords(int[] records,
                          boolean newState)

Description copied from interface: DataBoundComponent

Select/deselect a list of Records passed in explicitly, or by index.

Specified by:: selectRecords in interface DataBoundComponent

Parameters:: records - records (or row numbers) to select; newState - new selection state

selectRecords

public void selectRecords(Record[] records)

Description copied from interface: DataBoundComponent

Select/deselect a list of Records passed in explicitly, or by index.

Specified by:: selectRecords in interface DataBoundComponent

Parameters:: records - records (or row numbers) to select

selectRecords

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

Description copied from interface: DataBoundComponent

Select/deselect a list of Records passed in explicitly, or by index.

Specified by:: selectRecords in interface DataBoundComponent

Parameters:: records - records (or row numbers) to select; newState - new selection state (if null, defaults to true)

deselectRecord

public void deselectRecord(Record record)

Description copied from interface: DataBoundComponent

Deselect a Record passed in explicitly, or by index.

Synonym for selectRecord(record, false)

Specified by:: deselectRecord in interface DataBoundComponent

Parameters:: record - record (or row number) to deselect

deselectRecord

public void deselectRecord(int record)

Description copied from interface: DataBoundComponent

Deselect a Record passed in explicitly, or by index.

Synonym for selectRecord(record, false)

Specified by:: deselectRecord in interface DataBoundComponent

Parameters:: record - record (or row number) to deselect

deselectRecords

public void deselectRecords(int[] records)

Description copied from interface: DataBoundComponent

Deselect a list of Records passed in explicitly, or by index.

Synonym for selectRecords(records, false)

Specified by:: deselectRecords in interface DataBoundComponent

Parameters:: records - records (or row numbers) to deselect

deselectRecords

public void deselectRecords(Record[] records)

Description copied from interface: DataBoundComponent

Deselect a list of Records passed in explicitly, or by index.

Synonym for selectRecords(records, false)

Specified by:: deselectRecords in interface DataBoundComponent

Parameters:: records - records (or row numbers) to deselect

selectAllRecords

public void selectAllRecords()

Description copied from interface: DataBoundComponent

Select all records

Specified by:: selectAllRecords in interface DataBoundComponent

deselectAllRecords

public void deselectAllRecords()

Description copied from interface: DataBoundComponent

Deselect all records

Specified by:: deselectAllRecords in interface DataBoundComponent

anySelected

public Boolean anySelected()

Description copied from interface: DataBoundComponent

Whether at least one item is selected

Specified by:: anySelected in interface DataBoundComponent

Returns:: true == at least one item is selected false == nothing at all is selected

enableHilite

public void enableHilite(String hiliteID)

Description copied from interface: DataBoundComponent

Enable / disable a hilites

Specified by:: enableHilite in interface DataBoundComponent

Parameters:: hiliteID - ID of hilite to enable

enableHilite

public void enableHilite(String hiliteID,
                         boolean enable)

Description copied from interface: DataBoundComponent

Enable / disable a hilites

Specified by:: enableHilite in interface DataBoundComponent

Parameters:: hiliteID - ID of hilite to enable; enable - new enabled state to apply - if null, defaults to true

disableHilite

public void disableHilite(String hiliteID)

Description copied from interface: DataBoundComponent

Disable a hilite

Specified by:: disableHilite in interface DataBoundComponent

Parameters:: hiliteID - ID of hilite to disable

enableHiliting

public void enableHiliting()

Description copied from interface: DataBoundComponent

Enable all hilites.

Specified by:: enableHiliting in interface DataBoundComponent

enableHiliting

public void enableHiliting(boolean enable)

Description copied from interface: DataBoundComponent

Enable all hilites.

Specified by:: enableHiliting in interface DataBoundComponent

Parameters:: enable - new enabled state to apply - if null, defaults to true

disableHiliting

public void disableHiliting()

Description copied from interface: DataBoundComponent

Disable all hilites.

Specified by:: disableHiliting in interface DataBoundComponent

getDragData

public Record[] getDragData()

Description copied from interface: DataBoundComponent

During a drag-and-drop interaction, this method returns the set of records being dragged out of the component. In the default implementation, this is the list of currently selected records.

This method is consulted by ListGrid.willAcceptDrop().

Specified by:: getDragData in interface DataBoundComponent

Returns:: Array of Records that are currently selected.

transferSelectedData

public void transferSelectedData(DataBoundComponent source)

Description copied from interface: DataBoundComponent

Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by calling DataBoundComponent.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.

Specified by:: transferSelectedData in interface DataBoundComponent

Parameters:: source - source component from which the records will be tranferred

transferSelectedData

public void transferSelectedData(DataBoundComponent source,
                                 int index)

Description copied from interface: DataBoundComponent

To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.

Specified by:: transferSelectedData in interface DataBoundComponent

Parameters:: source - source component from which the records will be tranferred; index - target index (drop position) of the rows within this grid.

getRecordIndex

public int getRecordIndex(Record record)

Description copied from interface: DataBoundComponent

Get the index of the provided record.

Override in subclasses to provide more specific behaviour, for instance, when data holds a large number of records

Specified by:: getRecordIndex in interface DataBoundComponent

Parameters:: record - the record whose index is to be retrieved
Returns:: indexindex of the record, or -1 if not found

getTitleFieldValue

public String getTitleFieldValue(Record record)

Description copied from interface: DataBoundComponent

Get the value of the titleField for the passed record

Override in subclasses

Specified by:: getTitleFieldValue in interface DataBoundComponent

Parameters:: record - the record whose index is to be retrieved
Returns:: valuethe value of the titleField for the passed record

setTitleField

public void setTitleField(String titleField)

Description copied from interface: DataBoundComponent

Sets the best field to use for a user-visible title for an individual record from this component.

Specified by:: setTitleField in interface DataBoundComponent

getTitleField

public String getTitleField()

Description copied from interface: DataBoundComponent

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". If we dont find any field-names that match these titles, the first field in the component will be used instead.

Specified by:: getTitleField in interface DataBoundComponent

Returns:: fieldName the title field for this component.

setDataSource

public void setDataSource(DataSource dataSource)

Description copied from interface: DataBoundComponent

Bind to a DataSource. Binding to a DataSource means that the component will use the DataSource to provide default data for its fields.

When binding a previously-bound componenet 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, you may be able to refer to setDataSource(dataSource, fields) as an alternative method if the widget has an implementation of it.

Specified by:: setDataSource in interface DataBoundComponent

Parameters:: dataSource - DataSource to bind to. Default value is null

getDataSource

public DataSource getDataSource()

Description copied from interface: DataBoundComponent

The DataSource that this component should bind to for default fields and for performing DataSource requests.

Specified by:: getDataSource in interface DataBoundComponent

Returns:: DataSource

setAutoFetchData

public void setAutoFetchData(Boolean autoFetchData)
                      throws IllegalStateException

Description copied from interface: DataBoundComponent

If true, when this component is first drawn, automatically call DataBoundComponent.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.

Specified by:: setAutoFetchData in interface DataBoundComponent

Parameters:: autoFetchData - autoFetchData
Throws:: IllegalStateException

getAutoFetchData

public Boolean getAutoFetchData()

Description copied from interface: DataBoundComponent

Specified by:: getAutoFetchData in interface DataBoundComponent

Returns:: autoFetchData autoFetchData

setAutoFetchTextMatchStyle

public void setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
                                throws IllegalStateException

Description copied from interface: DataBoundComponent

If autoFetchData is true, this attribute allows the developer to specify a textMatchStyle for the initial DataBoundComponent.fetchData() call.

Specified by:: setAutoFetchTextMatchStyle in interface DataBoundComponent

Throws:: IllegalStateException

getAutoFetchTextMatchStyle

public TextMatchStyle getAutoFetchTextMatchStyle()

Description copied from interface: DataBoundComponent

If autoFetchData is true, this attribute allows the developer to specify a textMatchStyle for the initial DataBoundComponent.fetchData() call.

Specified by:: getAutoFetchTextMatchStyle in interface DataBoundComponent

Returns:: autoFetchTextMatchStyle autoFetchTextMatchStyle

setAutoFetchAsFilter

public void setAutoFetchAsFilter(Boolean autoFetchAsFilter)
                          throws IllegalStateException

Description copied from interface: DataBoundComponent

If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()

Specified by:: setAutoFetchAsFilter in interface DataBoundComponent

Parameters:: autoFetchAsFilter - autoFetchAsFilter
Throws:: IllegalStateException

getAutoFetchAsFilter

public Boolean getAutoFetchAsFilter()

Description copied from interface: DataBoundComponent

Specified by:: getAutoFetchAsFilter in interface DataBoundComponent

Returns:: auto fetch as filter

setInitialCriteria

public void setInitialCriteria(Criteria initialCriteria)
                        throws IllegalStateException

Description copied from interface: DataBoundComponent

Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.

Specified by:: setInitialCriteria in interface DataBoundComponent

Parameters:: initialCriteria - the initial criteria
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getInitialCriteria

public Criteria getInitialCriteria()

Description copied from interface: DataBoundComponent

Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.

Specified by:: getInitialCriteria in interface DataBoundComponent

Returns:: the criteria

fetchData

public void fetchData()

Description copied from interface: DataBoundComponent

Retrieves data from the DataSource that matches the specified criteria.

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.

Specified by:: fetchData in interface DataBoundComponent

fetchData

public void fetchData(Criteria criteria)

Description copied from interface: DataBoundComponent

Retrieves data from the DataSource that matches the specified 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.

In addition to the callback parameter for this method, developers can use resultSet.addDataArrivedHandler to be notified every time data is loaded.

Specified by:: fetchData in interface DataBoundComponent

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback)

Description copied from interface: DataBoundComponent

Retrieves data from the DataSource that matches the specified 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.

In addition to the callback parameter for this method, developers can use resultSet.addDataArrivedHandler to be notified every time data is loaded.

Specified by:: fetchData in interface DataBoundComponent

Parameters:: criteria - 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

fetchData

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

Description copied from interface: DataBoundComponent

Retrieves data from the DataSource that matches the specified 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.

In addition to the callback parameter for this method, developers can use resultSet.addDataArrivedHandler to be notified every time data is loaded.

Specified by:: fetchData in interface DataBoundComponent

Parameters:: criteria - 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; requestProperties - additional properties to set on the DSRequest that will be issued

filterData

public void filterData()

Description copied from interface: DataBoundComponent

Retrieves data that matches the provided criteria and displays the matching data in this component.

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.

Specified by:: filterData in interface DataBoundComponent

filterData

public void filterData(Criteria criteria)

Description copied from interface: DataBoundComponent

Retrieves data that matches the provided criteria and displays the matching data in this component.

Specified by:: filterData in interface DataBoundComponent

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()

filterData

public void filterData(Criteria criteria,
                       DSCallback callback)

Description copied from interface: DataBoundComponent

Retrieves data that matches the provided criteria and displays the matching data in this component.

Specified by:: filterData in interface DataBoundComponent

Parameters:: criteria - 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 details

filterData

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

Description copied from interface: DataBoundComponent

Retrieves data that matches the provided criteria and displays the matching data in this component.

Specified by:: filterData in interface DataBoundComponent

Parameters:: criteria - 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 details; requestProperties - for databound components only - optional additional properties to set on the DSRequest that will be issued

invalidateCache

public void invalidateCache()

Description copied from interface: DataBoundComponent

Invalidate the current data cache for this databound component via a call to this.data.invalidateCache(). If necessary, this will cause a new fetch to be performed with the current set of criteria for this component.

Has no effect if this component is not showing a set of filtered data.

Specified by:: invalidateCache in interface DataBoundComponent

getResultSet

public ResultSet getResultSet()

Description copied from interface: DataBoundComponent

Return the underlying data of this DataBoundComponent as a ResultSet.

Note that this method should only be called after initial data has been fetched by this DataBoundComponent.

Specified by:: getResultSet in interface DataBoundComponent

Returns:: ResultSet, or null if the underlying data is not a ResultSet
See Also:: DataBoundComponent.fetchData()

getRecordList

public RecordList getRecordList()

Description copied from interface: DataBoundComponent

Return the underlying data of this DataBoundComponent as a RecordList.

Depending on the component configuration, the actual JavaScript instance of the returned RecordList may be one of several types:

If the component is not bound to a DataSource, the instance is generally an Array of Record.
If the component is bound to a DataSource, the instance is a ResultSet.
If the component is a grouped ListGrid, the instance is a Tree. To access the ungrouped record list regardless of grouping status, use
```
isGrouped() ? getOriginalRecordList() : getRecordList()
```
If the component is a TreeGrid, the instance is a ResultTree.

The underlying type determines the structure of the returned data. An Array or ResultSet represents a list of records, but a Tree or ResultTree represents a list of open rows in the tree, including groups or other nodes which contain no records.

Specified by:: getRecordList in interface DataBoundComponent

Returns:: the RecordList

exportData

public void exportData()

Description copied from interface: DataBoundComponent

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.

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.

Specified by:: exportData in interface DataBoundComponent

See Also:: DataBoundComponentMethods overview and related methods

exportData

public void exportData(DSRequest requestProperties)

Description copied from interface: DataBoundComponent

A variety of DSRequest settings, such as exportAs and exportFilename, affect the exporting process: see exportResults for further detail.

For more information on exporting data, see DataSource.exportData.

Specified by:: exportData in interface DataBoundComponent

Parameters:: requestProperties - additional properties to set on the DSRequest that will be issued
See Also:: DataBoundComponentMethods overview and related methods

exportClientData

public void exportClientData()

Description copied from interface: DataBoundComponent

Exports this component's data with client-side formatters applied, so is suitable for direct display to users. This feature requires the SmartClient server, but does not rely on any server-side DataSources.

To export unformatted data from this component's dataSource, see exportData which does not include client-side formatters, but relies on both the SmartClient server and server-side DataSources.

Specified by:: exportClientData in interface DataBoundComponent

See Also:: DataSource.exportClientData(java.lang.Object[], com.smartgwt.client.data.DSRequest)

exportClientData

public void exportClientData(DSRequest requestProperties)

Description copied from interface: DataBoundComponent

To export unformatted data from this component's dataSource, see exportData which does not include client-side formatters, but relies on both the SmartClient server and server-side DataSources.

Specified by:: exportClientData in interface DataBoundComponent

Parameters:: requestProperties - Request properties for the export
See Also:: DataSource.exportClientData(java.lang.Object[], com.smartgwt.client.data.DSRequest)

addFetchDataHandler

public HandlerRegistration addFetchDataHandler(FetchDataHandler handler)

Add a fetchData handler.

Notification function fired on fetchData() or filterData()

Specified by:: addFetchDataHandler in interface HasFetchDataHandlers

Parameters:: handler - the filterData handler
Returns:: HandlerRegistration used to remove this handler

addDropCompleteHandler

public HandlerRegistration addDropCompleteHandler(DropCompleteHandler handler)

Add a 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).

Specified by:: addDropCompleteHandler in interface HasDropCompleteHandlers

Parameters:: handler - the DropCompleteHandler
Returns:: HandlerRegistration used to remove this handler

addDragCompleteHandler

public HandlerRegistration addDragCompleteHandler(DragCompleteHandler handler)

Add a 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).

Specified by:: addDragCompleteHandler in interface HasDragCompleteHandlers

Parameters:: handler - the DropCompleteHandler
Returns:: HandlerRegistration used to remove this handler

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.tile.TileGridLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()

Specified by:: getLogicalStructure in interface LogicalStructure
Overrides:: getLogicalStructure in class TileLayout

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.smartgwt.client.widgets.tile Class TileGrid

TileGrid

TileGrid

getOrCreateRef

setJavaScriptObject

create

setAnimateTileChange

getAnimateTileChange

setCanAcceptDroppedRecords

getCanAcceptDroppedRecords

setCanDragTilesOut

getCanDragTilesOut

setCanReorderTiles

getCanReorderTiles

setDataFetchMode

getDataFetchMode

setDetailViewerProperties

getDetailViewerProperties

setPrintTilesPerLine

getPrintTilesPerLine

setSelectionType

getSelectionType

setShowAllRecords

getShowAllRecords

setShowDetailFields

getShowDetailFields

setStyleName

getStyleName

setTileDragAppearance

getTileDragAppearance

setTileProperties

getTileProperties

setTileValueAlign

getTileValueAlign

setTileValueStyle

getTileValueStyle

setWrapValues

getWrapValues

addTile

addDataArrivedHandler

getCurrentTile

getDragTrackerTitle

getFieldState

getSelectedRecord

getTileIndex

getTileRecord

addRecordClickHandler

addRecordContextClickHandler

addRecordDoubleClickHandler

removeTile

addSelectionChangedHandler

setFieldState

setDefaultProperties

onInit

onInit_TileGrid

getTileHTML

getTile

getTile

setFields

setData

setData

setData

getData

getDataAsRecordList

addData

addData

addData

removeData

removeData

removeData

sortByProperty

removeSelectedData

getSelection

setDataSource

setDataPageSize

getDataPageSize

setUseAllDataSourceFields

getUseAllDataSourceFields

setShowHiddenFields

getShowHiddenFields

com.smartgwt.client.widgets.tile
Class TileGrid