ListGrid

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.grid
Class ListGrid

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.grid.ListGrid

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, HasFormulaUpdatedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasBodyKeyPressHandlers, HasCellClickHandlers, HasCellContextClickHandlers, HasCellDoubleClickHandlers, HasCellHoverHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellSavedHandlers, HasCellSelectionChangedHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasFilterEditorSubmitHandlers, HasGroupByHandlers, HasHeaderClickHandlers, HasHeaderDoubleClickHandlers, HasHilitesChangedHandlers, HasRecordClickHandlers, HasRecordCollapseHandlers, HasRecordDoubleClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRemoveRecordClickHandlers, HasRowContextClickHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasRowHoverHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRowOutHandlers, HasRowOverHandlers, HasSelectionChangedHandlers, HasSelectionUpdatedHandlers, HasSortChangedHandlers, HasSorterClickHandlers, HasSorterContextClickHandlers, HasViewStateChangedHandlers

Direct Known Subclasses:: CubeGrid, DateGrid, Menu, TableView, TreeGrid

public class ListGrid
extends Canvas
implements DataBoundComponent, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasFieldStateChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorExitHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasEditorEnterHandlers, HasCellSavedHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellContextClickHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellClickHandlers, HasCellDoubleClickHandlers, HasRowOutHandlers, HasRowOverHandlers, HasRowContextClickHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRecordClickHandlers, HasRecordDoubleClickHandlers, HasRemoveRecordClickHandlers, HasCellHoverHandlers, HasRowHoverHandlers, HasSorterClickHandlers, HasSorterContextClickHandlers, HasSelectionChangedHandlers, HasSelectionUpdatedHandlers, HasHeaderDoubleClickHandlers, HasFilterEditorSubmitHandlers, HasGroupByHandlers, HasViewStateChangedHandlers, HasHilitesChangedHandlers, HasCellSelectionChangedHandlers, HasRecordDropHandlers, HasHeaderClickHandlers, HasBodyKeyPressHandlers, HasSortChangedHandlers, HasRecordExpandHandlers, HasRecordCollapseHandlers, HasFormulaUpdatedHandlers
extends Canvas
implements DataBoundComponent, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasFieldStateChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorExitHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasEditorEnterHandlers, HasCellSavedHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellContextClickHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellClickHandlers, HasCellDoubleClickHandlers, HasRowOutHandlers, HasRowOverHandlers, HasRowContextClickHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRecordClickHandlers, HasRecordDoubleClickHandlers, HasRemoveRecordClickHandlers, HasCellHoverHandlers, HasRowHoverHandlers, HasSorterClickHandlers, HasSorterContextClickHandlers, HasSelectionChangedHandlers, HasSelectionUpdatedHandlers, HasHeaderDoubleClickHandlers, HasFilterEditorSubmitHandlers, HasGroupByHandlers, HasViewStateChangedHandlers, HasHilitesChangedHandlers, HasCellSelectionChangedHandlers, HasRecordDropHandlers, HasHeaderClickHandlers, HasBodyKeyPressHandlers, HasSortChangedHandlers, HasRecordExpandHandlers, HasRecordCollapseHandlers, HasFormulaUpdatedHandlers

A ListGrid is a DataBoundComponent that displays a list of objects in a grid, where each row represents one object and each cell in the row represents one property.

See Also:: Editing overview and related methods

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
`ListGrid()`
`ListGrid(DataSource dataSource)`
`ListGrid(JavaScriptObject jsObj)`

Method Summary
`HandlerRegistration`	`addBodyKeyPressHandler(BodyKeyPressHandler handler)` Add a bodyKeyPress handler.
`HandlerRegistration`	`addCellClickHandler(CellClickHandler handler)` Add a cellClick handler.
`HandlerRegistration`	`addCellContextClickHandler(CellContextClickHandler handler)` Add a cellContextClick handler.
`HandlerRegistration`	`addCellDoubleClickHandler(CellDoubleClickHandler handler)` Add a cellDoubleClick handler.
`HandlerRegistration`	`addCellHoverHandler(CellHoverHandler handler)` Add a cellHover handler.
`HandlerRegistration`	`addCellMouseDownHandler(CellMouseDownHandler handler)` Add a cellMouseDown handler.
`HandlerRegistration`	`addCellMouseUpHandler(CellMouseUpHandler handler)` Add a cellMouseUp handler.
`HandlerRegistration`	`addCellOutHandler(CellOutHandler handler)` Add a cellOut handler.
`HandlerRegistration`	`addCellOverHandler(CellOverHandler handler)` Add a cellOver handler.
`HandlerRegistration`	`addCellSavedHandler(CellSavedHandler handler)` Add a cellSaved handler.
`HandlerRegistration`	`addCellSelectionChangedHandler(CellSelectionChangedHandler handler)` Add a cellSelectionChanged handler.
`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`	`addDrawAreaChangedHandler(DrawAreaChangedHandler handler)` Add a drawAreaChanged handler.
`HandlerRegistration`	`addDropCompleteHandler(DropCompleteHandler handler)` Add a `com.smartgwt.client.widgets.DropCompleteHandler`.
`HandlerRegistration`	`addEditCompleteHandler(EditCompleteHandler handler)` Add a editComplete handler.
`HandlerRegistration`	`addEditFailedHandler(EditFailedHandler handler)` Add a editFailed handler.
`HandlerRegistration`	`addEditorEnterHandler(EditorEnterHandler handler)` Add a editorEnter handler.
`HandlerRegistration`	`addEditorExitHandler(EditorExitHandler handler)` Add a editorExit handler.
`void`	`addEmbeddedComponent(Canvas component, ListGridRecord record)` Attaches the component to the provided record.
`void`	`addEmbeddedComponent(Canvas component, ListGridRecord record, Integer rowNum, Integer colNum, EmbeddedPosition position)` Attaches the component to the provided record.
`HandlerRegistration`	`addFetchDataHandler(FetchDataHandler handler)` Add a fetchData handler.
`HandlerRegistration`	`addFieldStateChangedHandler(FieldStateChangedHandler handler)` Add a fieldStateChanged handler.
`HandlerRegistration`	`addFilterEditorSubmitHandler(FilterEditorSubmitHandler handler)` Add a filterEditorSubmit handler.
`void`	`addFormulaField()` Convenience method to display a `com.smartgwt.client..FormulaBuilder` to create a new Formula Field.
`HandlerRegistration`	`addFormulaUpdatedHandler(FormulaUpdatedHandler handler)` Add a formulaUpdated handler.
`HandlerRegistration`	`addGroupByHandler(GroupByHandler handler)` Add a groupBy handler.
`HandlerRegistration`	`addHeaderClickHandler(HeaderClickHandler handler)` Add a headerClick handler.
`HandlerRegistration`	`addHeaderDoubleClickHandler(HeaderDoubleClickHandler handler)` Add a headerDoubleClick handler.
`HandlerRegistration`	`addHilitesChangedHandler(HilitesChangedHandler handler)` Add a hilitesChanged handler.
`HandlerRegistration`	`addRecordClickHandler(RecordClickHandler handler)` Add a recordClick handler.
`HandlerRegistration`	`addRecordCollapseHandler(RecordCollapseHandler handler)` Add a recordCollapse handler.
`HandlerRegistration`	`addRecordDoubleClickHandler(RecordDoubleClickHandler handler)` Add a recordDoubleClick handler.
`HandlerRegistration`	`addRecordDropHandler(RecordDropHandler handler)` Add a recordDrop handler.
`HandlerRegistration`	`addRecordExpandHandler(RecordExpandHandler handler)` Add a recordExpand handler.
`HandlerRegistration`	`addRemoveRecordClickHandler(RemoveRecordClickHandler handler)` Add a removeRecordClick handler.
`HandlerRegistration`	`addRowContextClickHandler(RowContextClickHandler handler)` Add a rowContextClick handler.
`HandlerRegistration`	`addRowEditorEnterHandler(RowEditorEnterHandler handler)` Add a rowEditorEnter handler.
`HandlerRegistration`	`addRowEditorExitHandler(RowEditorExitHandler handler)` Add a rowEditorExit handler.
`HandlerRegistration`	`addRowHoverHandler(RowHoverHandler handler)` Add a rowHover handler.
`HandlerRegistration`	`addRowMouseDownHandler(RowMouseDownHandler handler)` Add a rowMouseDown handler.
`HandlerRegistration`	`addRowMouseUpHandler(RowMouseUpHandler handler)` Add a rowMouseUp handler.
`HandlerRegistration`	`addRowOutHandler(RowOutHandler handler)` Add a rowOut handler.
`HandlerRegistration`	`addRowOverHandler(RowOverHandler handler)` Add a rowOver handler.
`HandlerRegistration`	`addSelectionChangedHandler(SelectionChangedHandler handler)` Add a selectionChanged handler.
`HandlerRegistration`	`addSelectionUpdatedHandler(SelectionUpdatedHandler handler)` Add a selectionUpdated handler.
`void`	`addSort(SortSpecifier sortSpecifier)` Adds another SortSpecifierto this grid's sort configuration and resorts.
`HandlerRegistration`	`addSortChangedHandler(SortChangedHandler handler)` Add a sortChanged handler.
`HandlerRegistration`	`addSorterClickHandler(SorterClickHandler handler)` Add a sorterClick handler.
`HandlerRegistration`	`addSorterContextClickHandler(SorterContextClickHandler handler)` Add a sorterContextClick handler.
`void`	`addSummaryField()` Convenience method to display a `com.smartgwt.client..SummaryBuilder` to create a new Summary Field.
`HandlerRegistration`	`addViewStateChangedHandler(ViewStateChangedHandler handler)` Add a viewStateChanged handler.
`Boolean`	`anySelected()` Whether at least one item is selected
`void`	`applyCellData(RecordList cellData)` Applies a set of Records containing coordinate-based data as returned by `ListGrid.getSelectedCellData` and applies the data at the current selection.
`void`	`applyRecordData(RecordList recordData)` Applies a list of Records as changes to the current selection.
`int`	`autoFitField(String fieldName)` Programmatically cause a field to auto-fit horizontally to it's contents or title.
`void`	`autoFitFields(ListGridField... fields)` Perform a one-time horizontal auto-fit of the fields passed.
`void`	`cancelEditing()` Cancel the current edit without saving.
`protected boolean`	`canEditCell(int rowNum, int colNum)` Can this cell be edited?
`boolean`	`canExpandRecord(ListGridRecord record, int rowNum)` Expands a given record by creating a subcomponent and inserting it in to the record's grid-row.
`Boolean`	`cellHasChanges(int rowNum, int colNum)` If this listGrid can be edited, this method will return true if the cell passed in has been edited, but the edits have not yet been saved to the ListGrid's data object.
`Boolean`	`cellHasErrors(int rowNum, int colIndex)` Given a rowNum and a colNum or fieldName, determine whether we currently have stored validation errors for the record/field in question.
`Boolean`	`cellHasErrors(int rowNum, String fieldName)` Given a rowNum and a colNum or fieldName, determine whether we currently have stored validation errors for the record/field in question.
`FacetChart`	`chartData(String labelField)` Chart the data in this listGrid as a multi-series chart.
`FacetChart`	`chartData(String labelField, String[] dataFields, Record[] dataRows, FacetChart chartProperties, boolean labelFieldFirst)` Chart the data in this listGrid as a multi-series chart.
`void`	`clearCriteria()` Clear the current criteria used to filter data.
`void`	`clearCriteria(DSCallback callback, DSRequest requestProperties)` Clear the current criteria used to filter data.
`void`	`clearEditValue(int rowNum, String fieldName)` Clear a field value being tracked as an unsaved user edit.
`void`	`clearFieldError(int rowNum, int colIndex)` Clears any validation errors for some cell.
`void`	`clearFieldError(int rowNum, String fieldName)` Clears any validation errors for some cell.
`void`	`clearRowErrors(int rowNum)` Clear any stored validation errors for some row
`void`	`clearSort()` This method clears any existing sort on this grid by calling `ListGrid.setSort` with a null parameter.
`void`	`closeRecord(ListGridRecord record)` Deprecated. use `setCanExpandRecords(Boolean)` with `setExpansionMode(com.smartgwt.client.types.ExpansionMode)`, or override `getExpansionComponent(ListGridRecord)`
`void`	`collapseRecord(ListGridRecord record)` Collapses a given `record` which has been previously expanded using `ListGrid.expandRecord`.
`static ListGridField[]`	`convertToListGridFieldArray(JavaScriptObject nativeArray)`
`protected JavaScriptObject`	`create()`
`protected Canvas`	`createRecordComponent(ListGridRecord record, Integer colNum)` When `showRecordComponents` is true, this method is called for a row/cell the first time it is brought into the drawArea, or when there are not yet any components in the pool.
`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`	`discardAllEdits()` Cancel outstanding edits, discarding edit values, and hiding editors for the records.
`void`	`discardAllEdits(int[] rows, boolean dontHideEditor)` Cancel outstanding edits, discarding edit values, and hiding editors for the record[s] passed in if appropriate.
`void`	`discardEdits(int rowNum, int colNum)` Cancel outstanding edits for the specified rows, discarding edit values, and hiding editors if appropriate.
`void`	`discardEdits(int rowNum, int colNum, Boolean dontHideEditor)` Cancel outstanding edits for the specified rows, discarding edit values, and hiding editors if appropriate.
`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`	`endEditing()` Complete the current edit by storing the value and hiding the inline editor.
`void`	`expandRecord(ListGridRecord record)` Expands a given `record` by creating a subcomponent and inserting it in to the record's grid-row.
`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`	`fetchRelatedData(Record record, DataSource dataSource)` Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this grid that are related to the passed-in record.
`void`	`fetchRelatedData(Record record, DataSource dataSource, DSCallback callback, DSRequest requestProperties)` Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this grid that are related to the passed-in record.
`boolean`	`fieldIsVisible(String fieldName)` Check whether a field is currently visible
`void`	`filterByEditor()` If the filter editor (`showFilterEditor`) is visible for this grid, this method will perform a filter based on the current values in the editor.
`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.
`void`	`focusInFilterEditor()` If the filter editor (`showFilterEditor`) is visible for this grid, this method will explicitly put focus into the specified field in the filter editor.
`void`	`focusInFilterEditor(String fieldName)` If the filter editor (`showFilterEditor`) is visible for this grid, this method will explicitly put focus into the specified field in the filter editor.
`void`	`freezeField(int colNum)` Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.
`void`	`freezeField(String fieldName)` Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.
`void`	`freezeFields(int[] colNums)` Freeze the indicated fields, so that they remains in place and visible when horizontal scrolling occurs.
`void`	`freezeFields(String[] fieldNames)` Freeze the indicated fields, so that they remains in place and visible when horizontal scrolling occurs.
`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
`int[]`	`getAllEditRows()` Returns an array of every rowNum for which we have pending (unsubmitted) edits.
`ListGridField[]`	`getAllFields()` Get the complete array of fields for this ListGrid, including fields that are not currently visible or were specified implicitly via `dataSource`.
`Boolean`	`getAllowFilterExpressions()` For use with `showFilterEditor`:true, allows simple search expressions to be entered into filter fields, as though `allowExpressions` were true.
`Boolean`	`getAllowRowSpanning()` Should cells in this grid be allowed to span multiple rows? If set to `true`, the `ListGrid.getRowSpan` method will be called for every cell when rendering out the listGrid to determine how many rows the cell should span.
`String`	`getAlternateBodyStyleName()` Optional css style to apply to the body if `alternateRecordStyles` is true for this grid.
`int`	`getAlternateRecordFrequency()` The number of consecutive rows to draw in the same style before alternating, when alternateRowStyles is true.
`Boolean`	`getAlternateRecordStyles()` Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
`Boolean`	`getAlwaysShowEditors()` When this attribute is set, editors will be rendered into every row of the grid rather than showing up in a single record at a time.
`AnimationAcceleration`	`getAnimateFolderEffect()` When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
`Integer`	`getAnimateFolderMaxRows()` If `animateFolders` is true for this grid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
`Boolean`	`getAnimateFolders()` If true, when folders are opened / closed children will be animated into view.
`int`	`getAnimateFolderSpeed()` When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second.
`int`	`getAnimateFolderTime()` When animating folder opening / closing, if `animateFolderSpeed` is not set, this property designates the duration of the animation in ms.
`Boolean`	`getAnimateRemoveRecord()` When `canRemoveRecords` is enabled, should records be animated out of view when they are removed by the user?
`int`	`getAnimateRemoveSpeed()` When `animating record removal`, this property designates the speed of the animation in pixels per second.
`int`	`getAnimateRemoveTime()` When animating record removal `(see animateRemoveRecord)`, if `animateRemoveSpeed` is not set, this property designates the duration of the animation in ms.
`Boolean`	`getAnimateRollOver()` If `showRollOverCanvas` is `true` setting this property to true ensures that when the rollOver canvas is displayed it animates into view via an `Canvas.animateShow`.
`Boolean`	`getAnimateRollUnder()` If `showRollOverCanvas` is `true` setting this property to true ensures that when the rollUnder canvas is displayed it animates into view via an `Canvas.animateShow`.
`Boolean`	`getAnimateSelection()` If `showSelectionCanvas` is `true` setting this property to true ensures that when the selection canvas is displayed it animates into view via an `Canvas.animateShow`.
`Boolean`	`getAnimateSelectionUnder()` If `showSelectionCanvas` is `true` setting this property to true ensures that when the selectionUnder canvas is displayed it animates into view via an `Canvas.animateShow`.
`String`	`getArrowKeyAction()` Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the up or down arrow key.
`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()` .
`Boolean`	`getAutoFetchDisplayMap()` If true, for fields where `optionDataSource` is specified, a valueMap will be automatically created by making a `DataSource.fetchData` call against the specified dataSource and extracting a valueMap from the returned records based on the displayField and valueField.
`TextMatchStyle`	`getAutoFetchTextMatchStyle()` If `autoFetchData` is `true`, this attribute allows the developer to specify a textMatchStyle for the initial `DataBoundComponent.fetchData()` call.
`String`	`getAutoFitAllText()` If we're showing a `headerContextMenu` for this grid, and `canAutoFitFields` is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via the `ListGrid.autoFitField` method.
`String[]`	`getAutoFitClipFields()` If `autoFitFieldWidths` is enabled and the calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear.
`Autofit`	`getAutoFitData()` Should this ListGrid automatically expand to accommodate the size of records and fields?
`String`	`getAutoFitExpandField()` The field to expand if `autoFitFieldWidths` and `autoFitFieldsFillViewport` are enabled and auto-fitting will not fill all available horizontal space.
`Integer`	`getAutoFitExtraRecords()` If `autoFitData` is set to `"vertical"` or `"both"` this property specifies the number of additional records for which the grid will expand.
`Boolean`	`getAutoFitFieldsFillViewport()` If `autoFitFieldWidths` is enabled, and extra space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.
`String`	`getAutoFitFieldText()` If we're showing a `headerContextMenu` for this grid, and `canAutoFitFields` is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or content via a call to `ListGrid.autoFitField`.
`Boolean`	`getAutoFitFieldWidths()` Enables autofitting of fields to values or titles.
`AutoFitIconFieldType`	`getAutoFitIconFields()` Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields with `type:"icon"`, fields displaying only `value icons`, and boolean fields (which are rendered as a checkmark type icon by default.
`int`	`getAutoFitMaxColumns()` If `autoFitData` is set to `"horizontal"` or `"both"` this property provides the maximum number of columns for which the ListGrid will expand.
`Integer`	`getAutoFitMaxHeight()` If `autoFitData` is set to `"vertical"` or `"both"` this property provides an upper limit on how far the ListGrid will expand vertically to accommodate its content.
`int`	`getAutoFitMaxRecords()` If `autoFitData` is set to `"vertical"` or `"both"` this property provides the maximum number of records for which the ListGrid will expand.
`Integer`	`getAutoFitMaxWidth()` If `autoFitData` is set to `"horizontal"` or `"both"` this property provides an upper limit on how far the ListGrid will expand horizontally to accommodate its content.
`AutoFitWidthApproach`	`getAutoFitWidthApproach()` When a user requests column autofitting via the `header contextmenu` or via a `mouse gesture`, what autofit approach is used.
`Boolean`	`getAutoSaveEdits()` If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell if `saveByCell` is true).
`Boolean`	`getAutoSizeHeaderSpans()` If this listGrid has specified `headerSpans`, setting this attribute to true will cause spans to expand to accomodate long titles if necessary.
`Canvas`	`getBackgroundComponent()` Has no effect unless `showBackgroundComponent` is `true`.
`String`	`getBaseStyle()` `base cell style` for this listGrid.
`protected String`	`getBaseStyle(ListGridRecord record, int rowNum, int colNum)` Return the base stylename for this cell.
`String`	`getBodyBackgroundColor()` Background color applied to the ListGrid body (that is, the area of the grid where data values are rendered). Note that this will typically not be visible to the user unless there are few enough rows that there is visible space in the body below the last row.
`Overflow`	`getBodyOverflow()` Overflow setting for the "body", that is, the area of the grid where data values are rendered.
`Integer`	`getBodyScrollLeft()` Get the current scrollLeft for the body of this ListGrid
`Integer`	`getBodyScrollTop()` Get the current scrollTop for the body of this ListGrid
`String`	`getBodyStyleName()` CSS style used for the body of this grid.
`String`	`getBooleanFalseImage()` Image to display for a false value in a boolean field.
`int`	`getBooleanImageHeight()` Height for the `booleanTrueImage`, `booleanFalseImage` and `booleanPartialImage`.
`int`	`getBooleanImageWidth()` Width for the `booleanTrueImage`, `booleanFalseImage` and `booleanPartialImage`.
`String`	`getBooleanPartialImage()` Image to display for a partially true value in a boolean field (typically selection).
`String`	`getBooleanTrueImage()` Image to display for a true value in a boolean field.
`Boolean`	`getCanAcceptDroppedRecords()` Indicates whether records can be dropped into this listGrid.
`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`	`getCanAutoFitFields()` Whether the user able to autofit specific columns to their data and/or title via a context menu item or `headerAutoFitEvent`.
`String`	`getCancelEditingConfirmationMessage()` If this is an editable listGrid, and `this.confirmCancelEditing` is true this property is used as the message to display in the confirmation dismissal prompt.
`Boolean`	`getCanCollapseGroup()` Can a group be collapsed/expanded? When true a collapse/expand icon is shown (`groupIcon`) and clicking the icon or double-clicking the group title will collapse or expand the group.
`Boolean`	`getCanDragRecordsOut()` Indicates whether records can be dragged from this listGrid and dropped elsewhere.
`Boolean`	`getCanDragSelect()` If this property is true, users can drag the mouse to select several rows or cells.
`Boolean`	`getCanDragSelectText()` If this property is true, users can drag the mouse to select text within grid rows.
`Boolean`	`getCanEdit()` Can the user edit cells in this listGrid? Can be set for the listGrid, and overridden for individual fields. If 'canEdit' is false at the listGrid level, fields can never be edited - in this case the canEdit property on individual fields will be ignored. If 'canEdit' is set to true at the listGrid level, setting the 'canEdit' property to false at the field level will prevent the field from being edited inline. If 'canEdit' is not set at the listGrid level, setting 'canEdit' to true at the field level enables the field to be edited inline.
`String`	`getCanEditFieldAttribute()` If this component is bound to a dataSource, this attribute may be specified to customize what fields from the dataSource may be edited by default.
`Boolean`	`getCanExpandMultipleRecords()` When `canExpandRecords` is true, this property indicates whether multiple records can be expanded simultaneously.
`String`	`getCanExpandRecordProperty()` Property name on a record that will be checked to determine whether a record can be expanded.
`Boolean`	`getCanExpandRecords()` When set to true, shows an additional field at the beginning of the field-list (respecting RTL) to allow users to expand and collapse individual records.
`Boolean`	`getCanFreezeFields()` Whether an interface should be shown to allow user is allowed to dynamically "freeze" or "unfreeze" columns with respect to horizontally scrolling.
`Boolean`	`getCanGroupBy()` If false, grouping via context menu will be disabled.
`Boolean`	`getCanHover()` If true, cellHover and rowHover events will fire when the user leaves the mouse over a row / cell.
`Boolean`	`getCanMultiSort()` When true, indicates that this ListGrid supports sorting on multiple fields.
`Boolean`	`getCanPickFields()` Indicates whether the field picker item and submenu should be present in the header context menu.
`Boolean`	`getCanPickOmittedFields()` If this grid has a specified `dataSource`, and `useAllDataSourceFields` is false, setting this property to true will cause all dataSource fields not included in the specified set of fields to show up in the `field picker menu item`.
`Boolean`	`getCanRemoveRecords()` If set, provide UI for the user to remove records from the grid as an additional field showing the `removeIcon`, which, when clicked, will call `ListGrid.removeRecordClick` which removes the row from the data set (or if `deferRemoval` is true changes the `ListGrid.markRecordRemoved` status for the record).
`Boolean`	`getCanReorderFields()` Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.
`Boolean`	`getCanReorderRecords()` Indicates whether records can be reordered by dragging within this listGrid.
`Boolean`	`getCanResizeFields()` Indicates whether fields in this listGrid can be resized by dragging header fields.
`Boolean`	`getCanSelectAll()` Controls whether a checkbox for selecting all records appears in the header with `selectionAppearance` set to "checkbox"
`Boolean`	`getCanSelectCells()` Enables cell-level selection behavior as well as `cell-level rollover`.
`Boolean`	`getCanSort()` Enables or disables interactive sorting behavior for this listGrid.
`Boolean`	`getCanTabToHeader()` Should the header be included in the tab-order for the page? If not explicitly specified, the header will be included in the tab order for the page if setScreenReaderMode is called.
`protected String`	`getCellCSSText(ListGridRecord record, int rowNum, int colNum)` Return CSS text for styling this cell, which will be applied in addition to the CSS class for the cell, as overrides.
`String[]`	`getCellErrors(int rowNum, String fieldName)` Returns the current set of errors for this cell.
`int`	`getCellHeight()` The default height of each row in pixels.
`protected Canvas`	`getCellHoverComponent(Record record, Integer rowNum, Integer colNum)` Gets the embedded-component to show as a given record's hoverComponent.
`int`	`getCellPadding()` The amount of empty space, in pixels, surrounding each value in its cell.
`int`	`getCellRowSpan(int rowNum, int colNum)` When using `row spanning`, returns the number of cells spanned by the cell at the given coordinates.
`CellSelection`	`getCellSelection()` When `canSelectCells` is active, returns the `CellSelection` object that tracks and manages the current selection.
`int`	`getCellStartRow(int rowNum, int colNum)` When using `row spanning`, returns the row number where a row-spanning cell starts.
`protected String`	`getCellStyle(ListGridRecord record, int rowNum, int colNum)` Return the CSS class for a cell.
`String`	`getChartConstructor()` Name of the Smart GWT Class to be used when creating charts.
`ChartType`	`getChartType()` Default type of chart to plot.
`String`	`getCheckboxFieldFalseImage()` If `selectionAppearance` is set to `"checkbox"` this property determines the image to display in the checkbox field for an unselected row.
`int`	`getCheckboxFieldHSpace()` How much horizontal space should the `checkbox field` leave around the checkbox icon when `selectionAppearance` is set to `"checkbox"`?
`Integer`	`getCheckboxFieldImageHeight()` If `selectionAppearance` is set to `"checkbox"` this property may be set to govern the height of the checkbox image displayed to indicate whether a row is selected.
`Integer`	`getCheckboxFieldImageWidth()` If `selectionAppearance` is set to `"checkbox"` this property may be set to govern the width of the checkbox image displayed to indicate whether a row is selected.
`String`	`getCheckboxFieldPartialImage()` If `selectionAppearance` is set to `"checkbox"` this property determines the image to display in the checkbox field for a partially selected row.
`String`	`getCheckboxFieldTrueImage()` If `selectionAppearance` is set to `"checkbox"` this property determines the image to display in the checkbox field for a selected row.
`ExpansionMode`	`getChildExpansionMode()` For `expansionModes` that show another grid or tree, what the child's expansionMode should be.
`String`	`getClearAllSortingText()` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to clear any existing sort on all fields.
`String`	`getClearFilterText()` If we're showing a `headerContextMenu` for this grid, and a `filter-editor` is visible, this attribute will be shown as the menu item title to clear any existing filter.
`String`	`getClearSortFieldText()` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to clear an existing sort on this field.
`String`	`getConfigureSortText()` If we're showing a `headerContextMenu` for this grid, and multi-sorting is enabled, this attribute is used as the title for a menu item that opens a MultiSortDialog to configure the sort-specification for this grid.
`Boolean`	`getConfirmCancelEditing()` If this is an editable listGrid, when the user attempts to cancel an edit, should we display a confirmation prompt before discarding the edited values for the record?
`Boolean`	`getConfirmDiscardEdits()` For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded.
`String`	`getConfirmDiscardEditsMessage()` If `this.confirmDiscardEdits` is true, this property can be used to customize the error message string displayed to the user in a dialog with options to cancel the action, or save or discard pending edits in response to sort/filter actions that would otherwise drop unsaved edit values.
`Criteria`	`getCriteria()` Retrieves a copy of the current criteria for this component (may be null)
`Canvas`	`getCurrentExpansionComponent(Integer record)` Returns the expansion component derived from `ListGrid.getExpansionComponent` currently visible in some record, or null if the specified record is not showing an expansion component.
`Canvas`	`getCurrentExpansionComponent(ListGridRecord record)` Returns the expansion component derived from `ListGrid.getExpansionComponent` currently visible in some record, or null if the specified record is not showing an expansion component.
`RecordList`	`getDataAsRecordList()` Return the grid 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`.
`DateDisplayFormat`	`getDateFormatter()` How should Date type values be displayed in this ListGrid by default?
`DateDisplayFormat`	`getDatetimeFormatter()` Display format to use for fields specified as type 'datetime'.
`ListGridField[]`	`getDefaultFields()` An array of listGrid field configuration objects.
`int`	`getDefaultFieldWidth(ListGridField field)` Method to calculate and return the default width of a field.
`String`	`getDefaultFormattedValue(Record record, int rowNum, int colNum)` Get the value for some cell with default formatters applied.
`Boolean`	`getDeferRemoval()` When enabled, the field shown by `canRemoveRecords` causes records to be marked for future removal via `ListGrid.markRecordRemoved` instead of immediately being removed.
`String`	`getDetailDS()` If `canExpandRecords` is true and `listGrid.expansionMode` is `"related"`, this property specifies the dataSource for the related records grid to be shown embedded in expanded records.
`String`	`getDetailField()` The field whose contents to show in the expanded portion of a record when `canExpandRecords` is `true` and `listGrid.expansionMode` is `detailField`.
`String`	`getDiscardEditsSaveButtonTitle()` If `confirmDiscardEdits` is true this is the title for the save button appearing in the lost edits confirmation dialog.
`Object`	`getDisplayValue(String fieldName, boolean value)` Given a field with a specified `com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap` or `com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField`, this method will return the display value for any underlying data value.
`Object`	`getDisplayValue(String fieldName, Date value)` Given a field with a specified `com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap` or `com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField`, this method will return the display value for any underlying data value.
`Object`	`getDisplayValue(String fieldName, float value)` Given a field with a specified `com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap` or `com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField`, this method will return the display value for any underlying data value.
`Object`	`getDisplayValue(String fieldName, int value)` Given a field with a specified `com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap` or `com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField`, this method will return the display value for any underlying data value.
`Object`	`getDisplayValue(String fieldName, String value)` Given a field with a specified `com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap` or `com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField`, this method will return the display value for any underlying data value.
`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.
`DragTrackerMode`	`getDragTrackerMode()` When records are being dragged from within a ListGrid, what sort of drag-tracker should be displayed? Note that if multiple records are being dragged the displayed tracker will be based on the first selected record.
`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).
`float`	`getDrawAheadRatio()` How far should we render rows ahead of the currently visible area? This is expressed as a ratio from viewport size to rendered area size.
`int`	`getDrawAllMaxCells()` If drawing all rows would cause less than `drawAllMaxCells` cells to be rendered, the full dataset will instead be drawn even if `showAllRecords` is false and the viewport size and `drawAheadRatio` setting would normally have caused incremental rendering to be used.
`Integer[]`	`getDrawArea()` Returns the extents of the rows and columns current visible in this grid's viewport.
`int`	`getDrawnRowHeight(int rowNum)` Get the drawn height of a row.
`Integer[]`	`getDrawnRows()` Get the rows that are currently drawn (exist in the DOM), as an array of [firstRowNum, lastRowNum].
`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.
`Boolean`	`getEditByCell()` Determines whether when the user edits a cell in this listGrid the entire row becomes editable, or just the cell that received the edit event.
`int`	`getEditCol()` Returns the index of the column being edited or -1 if there is no edit col.
`Object`	`getEditedCell(int rowNum, int colNum)` Returns the current value of a cell.
`Object`	`getEditedCell(int rowNum, String fieldName)` Returns the current value of a cell.
`Object`	`getEditedCell(Record record, int colNum)` Returns the current value of a cell.
`Object`	`getEditedCell(Record record, String fieldName)` Returns the current value of a cell.
`Record`	`getEditedRecord(int rowNum)` Returns the combination of unsaved edits (if any) and original values (if any) for a given row being edited.
`ListGridEditEvent`	`getEditEvent()` Event that will trigger inline editing, see `ListGridEditEvent` for options.
`String`	`getEditFailedBaseStyle()` A base name for the CSS class applied to cells when editing has failed. If this listGrid is editable, this style will be applied to any edited cells for which validation failed. As with the default 'baseStyle' property, this style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell. If null, cells for which editing has failed will be rendered using the normal base style classNames, but with custom CSSText applied as derived from `this.editFailedCSSText`
`String`	`getEditFailedCSSText()` Custom CSS text to be applied to cells when editing has failed. If this listGrid is editable, this css text will be applied to any edited cells for which validation failed, on top of the base style for the cell. For further customization of styling for cells that failed editing validation, use `this.editFailedBaseStyle` instead.
`FormItem`	`getEditFormItem(Integer field)` Method to retrieve a live edit form item for an `editable` ListGrid.
`FormItem`	`getEditFormItem(String field)` Method to retrieve a live edit form item for an `editable` ListGrid.
`String`	`getEditFormulaFieldText()` Text for a menu item allowing users to edit a formula field
`Boolean`	`getEditOnF2Keypress()` Should we start editing when the widget has focus and the user presses the "f2" key (if this ListGrid supports editing)?
`Boolean`	`getEditOnFocus()` Should we start editing when this widget receives focus (if this ListGrid supports editing)?
`String`	`getEditPendingBaseStyle()` A base name for the CSS class applied to cells containing pending (unsaved) edits As with the default 'baseStyle' property, this style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.
`String`	`getEditPendingCSSText()` Custom CSS text to be applied to cells with pending edits that have not yet been submitted. For further customization of styling for cells with pending edits use `this.editPendingBaseStyle` instead.
`int`	`getEditRow()` Returns the index of the row being edited or -1 if there is no current edit row.
`String`	`getEditSummaryFieldText()` Text for a menu item allowing users to edit the formatter for a field
`Object`	`getEditValue(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Boolean`	`getEditValueAsBoolean(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Date`	`getEditValueAsDate(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Float`	`getEditValueAsFloat(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Integer`	`getEditValueAsInt(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Record`	`getEditValueAsRecord(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Record[]`	`getEditValueAsRecordArray(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`String`	`getEditValueAsString(int rowNum, String fieldName)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Map`	`getEditValues(int rowNum)` Returns the current set of unsaved edits for a given row being edited.
`Map`	`getEditValues(Record record)` Returns the current set of unsaved edits for a given row being edited.
`String`	`getEmptyCellValue()` The value to display for cells whose value is null or the empty string after applying formatCellValue and valueMap (if any).
`String`	`getEmptyMessage()` The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.
`String`	`getEmptyMessageStyle()` The CSS style name applied to the `emptyMessage` if displayed.
`Boolean`	`getEnforceVClipping()` For performance reasons, even when `fixedRecordHeights` is set, vertical clipping is not enforced by default for some kinds of content (such as images) on all browsers.
`EnterKeyEditAction`	`getEnterKeyEditAction()` What to do when a user hits enter while editing a cell: "nextCell": start editing the next editable cell in this record (or the first editable cell in the next record if focus is in the last editable cell in the row) "nextRow": start editing the same field in the next row (skipping any rows where that would be a non-editable cell.
`Boolean`	`getEnumCriteriaAsInitialValues()` In a ListGrid that has a DataSource and has filter criteria that include values for fields declared as `type "enum"` in the DataSource, by default a newly edited row will use those filter criteria as initial values.
`EscapeKeyEditAction`	`getEscapeKeyEditAction()` What to do when a user hits escape while editing a cell: "cancel": close the editor and discard the current set of edit values "done": just close the editor (the edit is complete, but the edited values are retained).
`int`	`getEventColumn()` Returns the column number of the most recent mouse event.
`int`	`getEventColumn(Integer x)` Returns the column number of the most recent mouse event.
`int`	`getEventRow()` Returns the row number of the most recent mouse event.
`int`	`getEventRow(Integer y)` Returns the row number of the most recent mouse event.
`Boolean`	`getExpansionCanEdit()` For `expansionModes` that show another grid or tree, is that component editable?
`protected Canvas`	`getExpansionComponent(ListGridRecord record)` Gets the embedded-component to show as a given record's expansionComponent.
`Boolean`	`getExpansionEditorCollapseOnSave()` When `ExpansionMode` is editor, should the row be collapsed following a save initiated by the expansion-component's `save button`.
`String`	`getExpansionEditorSaveButtonTitle()` The title for the `expansionEditorSaveButton`.
`String`	`getExpansionEditorSaveDialogPrompt()` When `canExpandRecords` is true and `expansionMode` is editor, the prompt to display in a dialog when an expanded row is collapsed while it's nested editor has changed values.
`Boolean`	`getExpansionEditorShowSaveDialog()` When `canExpandRecords` is true and `expansionMode` is editor, whether a dialog should be displayed when an expanded row is collapsed while it's nested editor has changed values.
`String`	`getExpansionFieldFalseImage()` If `canExpandRecords` is set to `true`, this property determines the image to display in the expansion field for collapsed rows.
`Integer`	`getExpansionFieldImageHeight()` If `canExpandRecords` is set to `true`, this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded.
`Integer`	`getExpansionFieldImageWidth()` If `canExpandRecords` is set to `true`, this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded.
`String`	`getExpansionFieldTrueImage()` If `canExpandRecords` is set to `true`, this property determines the image to display in the expansion field for expanded rows.
`ExpansionMode`	`getExpansionMode()` The `ExpansionMode` for records in this grid.
`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.
`Boolean`	`getExportRawValues()` Dictates whether the data in this grid should be exported raw by `exportClientData()`.
`int`	`getFetchDelay()` If we're showing the filterEditor (`showFilterEditor` is true), and we're re-filtering on every keypress (`filterOnKeypress` is true), this property is the delay in milliseconds between the user changing the filter and the filter request being kicked off.
`String`	`getFetchOperation()` Operation ID this component should use when performing fetch operations.
`ListGridField`	`getField(int colNum)` Given a column number or field name, return the field definition.
`ListGridField`	`getField(String fieldName)` Given a column number or field name, return the field definition.
`String`	`getFieldName(int colNum)` Given a column number or field id, return the field name of a field.
`String`	`getFieldName(String fieldName)` Given a column number or field id, return the field name of a field.
`int`	`getFieldNum(String fieldName)` Given a field or field id, return it's index in the fields array
`ListGridField[]`	`getFields()` The ListGrid fields
`String`	`getFieldState()` Returns a snapshot of the current presentation of this listGrid's fields as a ListGridFieldState object.
`String`	`getFieldVisibilitySubmenuTitle()` If we're showing a `headerContextMenu` for this grid, and `this.canPickFields` is true, this attribute will be shown as the title for the menu item which contains a submenu with items allowing the user to show and hide fields in the grid.
`int`	`getFieldWidth(Number fieldNum)` Returns a numeric value for the width of some field within this listGrid.
`int`	`getFieldWidth(String fieldName)` Returns a numeric value for the width of some field within this listGrid.
`String`	`getFilterButtonPrompt()` The prompt to show when the mouse hovers over the Filter button in the FilterEditor.
`Boolean`	`getFilterByCell()` If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be filtered every time the user puts focus in a different field in the filter editor.
`Criteria`	`getFilterEditorCriteria()` If `showFilterEditor` is true, this method will return the criteria currently displayed in the `filterEditor`.
`Criteria`	`getFilterEditorCriteria(Boolean omitHiddenFields)` If `showFilterEditor` is true, this method will return the criteria currently displayed in the `filterEditor`.
`int`	`getFilterEditorHeight()` Height for the filterEditor, if shown.
`ListGrid`	`getFilterEditorProperties()` Properties to apply to the automatically generated `filterEditor` if `showFilterEditor` is true.
`Boolean`	`getFilterLocalData()` If this grid has its `data property` set to a static array of records, should `ListGrid.filterData` filter this array? If this property is set to true, the local data array will be filtered according to the specified criteria, and the results displayed.
`Boolean`	`getFilterOnKeypress()` If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be filtered every time the user modifies the value in a field of the filter-editor.
`Boolean`	`getFixedFieldWidths()` Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?
`Boolean`	`getFixedRecordHeights()` Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?
`Integer`	`getFocusRow()` Get the row that currently has keyboard focus.
`String`	`getFormulaBuilderSpanTitleSeparator()` If this grid has specified `headerSpans`, and `showHeaderSpanTitlesInFormulaBuilder` is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid in the FormulaBuilder and SummaryBuilder.
`int`	`getFormulaFieldValue(ListGridField field, Record record)` Get the computed value of a `canAddFormulaFields`.
`String`	`getFreezeFieldText()` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to freeze a currently unfrozen field.
`String`	`getFreezeOnLeftText()` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to freeze fields on the left of the scrollable body.
`String`	`getFreezeOnRightText()` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to freeze fields on the right of the scrollable body.
`String`	`getFrozenBaseStyle()` If this listGrid contains any frozen fields, this property can be used to apply a custom baseStyle to all cells in those frozen fields.
`String`	`getFrozenHeaderBaseStyle()` If this listGrid contains any frozen fields, this property can be used to apply a custom headerBaseStyle to the frozen set of fields.
`String`	`getFrozenHeaderTitleStyle()` If this listGrid contains any frozen fields, this property can be used to apply a custom headerTitleStyle to the frozen set of fields.
`Boolean`	`getGenerateClickOnEnter()` If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a click event.
`Boolean`	`getGenerateClickOnSpace()` If true, when the user navigates to a cell using arrow keys and hits space, the cell will respond to a click event.
`Boolean`	`getGenerateDoubleClickOnEnter()` If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a double click event.
`Boolean`	`getGenerateDoubleClickOnSpace()` If true, when the user navigates to a cell using arrow keys and hits Space, the cell will respond to a double click event.
`ListGridComponent[]`	`getGridComponents()` Array of components that make up this grid.
`GridRenderer`	`getGridRenderer()` Return the underlying GridRenderer.
`protected Object`	`getGridSummary(ListGridField field)` When `showGridSummary` is `true` this method is called for each field which will show a grid summary value (as described in `showGridSummary` to get the summary value to display below the relevant column.
`void`	`getGridSummaryData()` This method returns the data to be displayed in the `summaryRow` when `showGridSummary` is true.
`String`	`getGridSummaryRecordProperty()` If `showGridSummary` is true, this attribute will be set to true on the record object representing the grid summary row.
`String[]`	`getGroupByFields()` Get the current grouping of this listGrid as an array of fieldNames.
`String[]`	`getGroupByFieldSummaries()` If this grid is `grouped`, and `showGroupSummary` is true, this attribute may be set to an array of groupBy field names for which group summaries should appear.
`int`	`getGroupByMaxRecords()` Maximum number of records to which a groupBy can be applied.
`String`	`getGroupByText()` If we're showing a `headerContextMenu` for this grid and `this.canGroupBy` is true, this string will be shown as the title for the menu item to toggle the group by setting for a field.
`String`	`getGroupIcon()` The URL of the base icon for the group icons in this treegrid.
`int`	`getGroupIconSize()` Default width and height of group icons for this ListGrid.
`int`	`getGroupIndentSize()` Default number of pixels by which to indent subgroups relative to parent group.
`int`	`getGroupLeadingIndent()` Default number of pixels by which to indent all groups.
`String`	`getGroupNodeStyle()` The CSS style that group rows will have
`String`	`getGroupState()` Returns a snapshot of the current grouping state of this ListGrid. This object can be passed to `ListGrid.setGroupState` to reset this grid's grouping to the current state (assuming the same data / fields are present in the grid).
`String`	`getGroupSummaryRecordProperty()` If `showGroupSummary` is true, this attribute will be set to true on each record object representing a group-level summary row.
`String`	`getGroupSummaryStyle()` `customStyle` for the group-level summary row displayed when `showGroupSummary` is true.
`ListGridField`	`getGroupTitleColumnProperties()` Custom properties for the automatically generated `groupTitleColumn`.
`String`	`getGroupTitleField()` When a list grid is `grouped`, each group shows under an auto generated header node.
`Tree`	`getGroupTree()` If the ListGrid is grouped, return the underlying tree structure.
`AutoFitEvent`	`getHeaderAutoFitEvent()` Event on a ListGrid header that triggers auto fitting to data and/or title.
`String`	`getHeaderBackgroundColor()` BackgroundColor for the header toolbar.
`String`	`getHeaderBarStyle()` Set the CSS style used for the header as a whole.
`String`	`getHeaderBaseStyle()` `baseStyle` to apply to the buttons in the header, and the sorter, for this ListGrid.
`protected MenuItem[]`	`getHeaderContextMenuItems(Integer fieldNum)` If ListGrid.showHeaderContextMenu is true this method returns the menu items to be displayed in the default header context menu.
`int`	`getHeaderHeight()` The height of this listGrid's header, in pixels.
`int`	`getHeaderMenuButtonHeight()` If `showHeaderMenuButton` is true, this property governs the height of the auto-generated `headerMenuButton`
`String`	`getHeaderMenuButtonIcon()` If `showHeaderMenuButton` is true, this property governs the icon shown on the auto-generated `headerMenuButton`
`int`	`getHeaderMenuButtonIconHeight()` If `showHeaderMenuButton` is true, this property governs the height of the icon shown on the auto-generated `headerMenuButton`
`int`	`getHeaderMenuButtonIconWidth()` If `showHeaderMenuButton` is true, this property governs the width of the icon shown on the auto-generated `headerMenuButton`
`int`	`getHeaderMenuButtonWidth()` If `showHeaderMenuButton` is true, this property governs the width of the auto-generated `headerMenuButton`
`protected MenuItem[]`	`getHeaderSpanContextMenuItems(HeaderSpan headerSpan)` Return the menus items that should be shown in a menu triggered from a headerSpan.
`Integer`	`getHeaderSpanHeight()` Default height for a `headerSpan` with no height specified.
`String`	`getHeaderTitleStyle()` `titleStyle` to apply to the buttons in the header, and the sorter, for this ListGrid.
`String`	`getHiliteEditorSpanTitleSeparator()` If this grid has specified `headerSpans`, and `showHeaderSpanTitlesInHiliteEditor` is true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser grid.
`Integer`	`getHiliteIconHeight()` Height for hilite icons for this listGrid.
`int`	`getHiliteIconLeftPadding()` How much padding should there be on the left of `hilite icons` by default? Can be overridden at the field level
`HiliteIconPosition`	`getHiliteIconPosition()` When `hiliteIcons` are present, where the hilite icon will be placed relative to the field value.
`int`	`getHiliteIconRightPadding()` How much padding should there be on the right of `hilite icons` by default? Can be overridden at the field level
`String[]`	`getHiliteIcons()` Specifies a list of icons that can be used in `hilites`.
`int`	`getHiliteIconSize()` Default width and height of `hilite icons` for this component.
`Integer`	`getHiliteIconWidth()` Width for hilite icons for this component.
`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.
`HoverMode`	`getHoverMode()` When `showHoverComponents` is true, the builtin mode to use when automatically creating a hover component for rows in this grid.
`String`	`getHoverStyle()` Style to apply to hovers shown over this grid.
`int`	`getImageSize()` Default size of thumbnails shown for fieldTypes image and imageFile.
`String`	`getIncludeInSummaryProperty()` Property name on a record that will be checked to determine whether a record should be included when calculating totals for the `grid summary`.
`Criteria`	`getInitialCriteria()` Criteria to use when `DataBoundComponent.setAutoFetchData(Boolean)` is used.
`SortSpecifier[]`	`getInitialSort()` An array of ${isc.DocUtils.linkForRef('object:SortSpecifier')} objects used to set up the initial sort configuration for this grid.
`Boolean`	`getInstantScrollTrackRedraw()` If true, if the user clicks on the scroll buttons at the end of the track or clicks once on the scroll track, there will be an instant redraw of the grid content so that the user doesn't see any blank space.
`String`	`getInvalidSummaryValue()` Value to display to the user if showing summary values (through `showGridSummary`, `showGroupSummary` or `listGridFieldType:"summary"`), and the summary function returns `"null"` (implying it was unable to calculate a valid summary value).
`Boolean`	`getIsGrouped()` True if this listgrid is grouped, false otherwise Note : This method should be called only after the widget has been rendered.
`String`	`getIsSeparatorProperty()` If `record[this.isSeparatorProperty]` is set for some record, the record will be displayed as a simple separator row.
`Boolean`	`getLeaveScrollbarGap()` Whether to leave a gap for the vertical scrollbar, even when it's not present.
`String`	`getLinkTextProperty()` Property name on a record that will hold the link text for that record.
`RowEndEditAction`	`getListEndEditAction()` If the user is editing the last record in this listGrid, and attempts to navigate beyond the last row either by tabbing off the last editable field, or using the down arrow key, this property determines what action to take: "next": start editing a new record at the end of the list.
`String`	`getLoadingDataMessage()` The string to display in the body of a listGrid while data is being loaded.
`String`	`getLoadingDataMessageStyle()` The CSS style name applied to the loadingDataMessage string if displayed.
`String`	`getLoadingMessage()` If you have a databound listGrid and you scroll out of the currently loaded dataset, by default you will see blank rows until the server returns the data for those rows.
`String`	`getLocateColumnsBy()` When AutoTest.getElement is used to parse locator strings generated by AutoTest.getLocator for a cell in this grid, how should the column be identified? Note that getLocator() will actually store all available information about the column in the generated string -- this attribute effects how a stored string will be parsed only.
`String`	`getLocateRowsBy()` When AutoTest.getElement is used to parse locator strings generated by AutoTest.getLocator for a cell in this grid, how should the row be identified? Note that getLocator() will actually store all available information about the row in the generated string -- this attribute effects how a stored string will be parsed only.
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`getLogicalStructure()`
`int`	`getLongTextEditorThreshold()` When the length of the field specified by `length` exceeds this value, the ListGrid shows an edit field of type `longTextEditorType` rather than the standard text field when the field enters inline edit mode.
`String`	`getLongTextEditorType()` When the length of the field specified by `length` exceeds `this.longTextEditorThreshold` show an edit field of this type rather than the standard text field when the field enters inline edit mode.
`Integer`	`getMaxExpandedRecords()` When `canExpandRecords` and `canExpandMultipleRecords` are both true, this property dictates the number of records which can be expanded simultaneously.
`String`	`getMaxExpandedRecordsPrompt()` This is a dynamic string - text within `\${...}` will be evaluated as JS code when the message is displayed.
`int`	`getMinFieldWidth()` Minimum size, in pixels, for ListGrid headers.
`Boolean`	`getModalEditing()` If this property is true, any mouse click outside of the open cell editors will end editing mode, hiding the cell editors and saving any changes to those cell values.
`Boolean`	`getNeverValidate()` If true, validation will not occur as a result of cell editing for this grid.
`String`	`getNormalBaseStyle()` "Normal" baseStyle for this listGrid.
`int`	`getNormalCellHeight()` If `baseStyle` is unset, base style will be derived from `normalBaseStyle` if this grid has fixed row heights and the specified `cellHeight` matches this value.
`String`	`getNullGroupTitle()` Default alias to use for groups with no value
`String`	`getOfflineMessageStyle()` The CSS style name applied to the `offlineMessage` if displayed.
`static ListGrid`	`getOrCreateRef(JavaScriptObject jsObj)`
`RecordList`	`getOriginalRecordList()` Return the underlying, ungrouped data of this DataBoundComponent as a `RecordList`.
`ResultSet`	`getOriginalResultSet()` Return the underlying, ungrouped data of this ListGrid as a `ResultSet`.
`String`	`getOriginBaseStyle()` Name of a CSS Style to use as the `baseStyle` for a cell that is currently a selection origin for shifted incremental cell selection.
`Boolean`	`getPoolComponentsPerColumn()` Should recycled `record components`, be pooled per column or per record.
`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)`.
`Boolean`	`getPrintAutoFit()` Whether cell contents should wrap during printing.
`String`	`getPrintBaseStyle()` Style for non-header cells in printed output.
`String`	`getPrintHeaderStyle()` Style for header cells in printed output.
`int`	`getPrintMaxRows()` Advanced property - when generating printHTML for a large ListGrid, rows are printed in batches in order to avoid triggering a native "script is running slowly" browser dialog.
`Boolean`	`getPrintWrapCells()` Whether cell contents should wrap during printing.
`float`	`getQuickDrawAheadRatio()` Alternative to `drawAheadRatio`, to be used when the user is rapidly changing the grids viewport (for example drag scrolling through the grid).
`ListGridRecord`	`getRecord(int recordNum)` Return the pointer to a particular record by record number.
`String`	`getRecordBaseStyleProperty()` This attribute allows custom base styles to be displayed on a per-record basis.
`String`	`getRecordCanSelectProperty()` If set to false on a record, selection of that record is disallowed.
`Canvas`	`getRecordComponent(int rowNum)` Retrieve the `recordComponent` currently being shown at the given coordinates.
`Canvas`	`getRecordComponent(int rowNum, Integer colNum)` Retrieve the `recordComponent` currently being shown at the given coordinates.
`Integer`	`getRecordComponentHeight()` If `showRecordComponents` is true, this attribute may be used to specify a standard height for record components.
`RecordComponentPoolingMode`	`getRecordComponentPoolingMode()` The method of `component-pooling` to employ for `recordComponents`.
`EmbeddedPosition`	`getRecordComponentPosition()` if `showRecordComponents` is true, how should the component appear within the cell.
`String`	`getRecordDetailDSProperty()` The name of the ListGridRecord property that specifies the DataSource to use when `listGrid.expansionMode` is "related".
`String`	`getRecordEditProperty()` Property name on a record that should be checked to determine whether the record may be edited.
`String`	`getRecordEnabledProperty()` Property name on a record that will be checked to determine whether a record is enabled.
`int`	`getRecordIndex(ListGridRecord record)` Get the index of the provided record.
`int`	`getRecordIndex(Record record)` Get the index of the provided record.
`RecordList`	`getRecordList()` Return the underlying data of this DataBoundComponent as a `RecordList`.
`ListGridRecord[]`	`getRecords()` Returns the current set of records displayed in this grid as an array of ListGridRecord objects.
`String`	`getRecordSummaryBaseStyle()` If showing any record summary fields (IE: fields of `type:"summary"`), this attribute specifies a custom base style to apply to cells in the summary field
`DataSource`	`getRelatedDataSource(ListGridRecord record)` Returns the `DataSource` containing data related to the passed record.
`String`	`getRemovedCSSText()` Custom CSS text to be applied to records that have been `marked for removal`.
`JavaScriptObject`	`getRemoveFieldDefaults()` Returns a JavaScriptObject containing default `ListGridField` attributes of remove fields.
`ListGridField`	`getRemoveFieldProperties()` Configuration properties for the "remove field" displayed when `canRemoveRecords` is enabled.
`String`	`getRemoveFieldTitle()` The title to use for the `remove field`.
`String`	`getRemoveIcon()` When `canRemoveRecords` is enabled, default icon to show in the auto-generated field that allows removing records.
`int`	`getRemoveIconSize()` Default width and height of `remove icons` for this ListGrid.
`String`	`getRemoveOperation()` Operation ID this component should use when performing remove operations.
`Boolean`	`getResizeFieldsInRealTime()` True == we redraw the list viewer in real time as fields are being resized.
`ResultSet`	`getResultSet()` Return the underlying data of this DataBoundComponent as a `ResultSet`.
`Boolean`	`getReverseRTLAlign()` If a page is rendered in `RTL mode`, should cell alignments specified `cellAlign` be reversed (so an `align:"right"` field will have content aligned on the left and vice versa)?
`protected Canvas`	`getRollOverCanvas(Integer rowNum, Integer colNum)` If `showRollOverCanvas` is true, this method will be called to create the canvas to display over the current row when a user moves their mouse over the row. Note that for efficiency this should not typically create a new canvas instance, every time it is called.
`protected Canvas`	`getRollUnderCanvas(Integer rowNum, Integer colNum)` If `showRollUnderCanvas` is true, this method will be called to create the canvas to display under the current row when a user moves their mouse under the row. Note that for efficiency this should not typically create a new canvas instance, every time it is called.
`RowEndEditAction`	`getRowEndEditAction()` If the user is editing a record in this listGrid, and attempts to navigate to a field beyond the end of the row, via tab (or shift-tab off the first editable field), this property determines what action to take: "next": start editing the next (or previous) record in the list "same": put focus back into the first editable field of the same record.
`Map`	`getRowErrors(int rowNum)` Returns any currently stored validation errors for this row
`int`	`getRowHeight(ListGridRecord record, int rowNum)` Return the height this row should be.
`int`	`getRowNumberStart()` The number to start the row-count from - default value is 1.
`String`	`getRowNumberStyle()` The CSS Style name for the `rowNumberField`.
`int`	`getRowSpan(ListGridRecord record, int rowNum, int colNum)` Return how many rows this cell should span.
`RowSpanSelectionMode`	`getRowSpanSelectionMode()` Chooses the selection mode when `useRowSpanStyling` is enabled.
`Boolean`	`getSaveByCell()` Whether edits should be saved whenever the user moves between cells in the current edit row.
`Boolean`	`getSaveLocally()` For grids with a specified `dataSource`, this property can be set to `true` to prevent the grid from attempting to save / retrieve data from the server.
`DSRequest`	`getSaveRequestProperties()` For editable grids with a specified `dataSource`, where `saveLocally` is false, this attribute may be used to specify standard DSRequest properties to apply to all save operations performed by this grid (whether triggered by user interaction, or explicit saveEdits or saveAllEdits call).
`int`	`getScrollRedrawDelay()` While drag scrolling in an incrementally rendered grid, time in milliseconds to wait before redrawing, after the last mouse movement by the user.
`RecordList`	`getSelectedCellData()` Returns the selected cells as a series of Records where each field value is stored under it's offset from the top-left of the selection.
`ListGridRecord`	`getSelectedRecord()` Return the first selected record in this component. This method is appropriate if `selectionType` is `"single"`, or if you only care about the first selected record in a multiple-record selection.
`ListGridRecord[]`	`getSelectedRecords()` The selection associated with the listGrid.
`ListGridRecord[]`	`getSelectedRecords(boolean excludePartialSelections)` The selection associated with the listGrid.
`String`	`getSelectedState()` Returns a snapshot of the current selection within this listGrid as a ListGridSelectedState object. This object can be passed to `ListGrid.setSelectedState` to reset this grid's selection the current state (assuming the same data is present in the grid).
`Boolean`	`getSelectHeaderOnSort()` If true, show the field-header for the sorted field (or the first field in a `multi-sort` grid) in the selected state.
`ListGridRecord[]`	`getSelection()` Deprecated. use `getSelectedRecords()` instead
`ListGridRecord[]`	`getSelection(boolean excludePartialSelections)` Deprecated. use `getSelectedRecords(boolean)` instead
`SelectionAppearance`	`getSelectionAppearance()` How selection of rows should be presented to the user.
`String`	`getSelectionProperty()` If specified, the selection object for this list will use this property to mark records as selected.
`SelectionStyle`	`getSelectionType()` Defines a listGrid's clickable-selection behavior.
`Boolean`	`getSelectOnEdit()` When the user starts editing a row, should the row also be selected?
`Boolean`	`getShowAllColumns()` Whether all columns should be drawn all at once, or only columns visible in the viewport.
`Boolean`	`getShowAllRecords()` Whether all rows should be drawn all at once, or only rows visible in the viewport.
`Boolean`	`getShowBackgroundComponent()` If `true` this grid will create and show per-row backgroundComponents as detailed `here`.
`Boolean`	`getShowCellContextMenus()` Whether to show a context menu with standard items for all context clicks on rows in the body.
`Boolean`	`getShowComplexFields()` Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no `component.fields`.
`Boolean`	`getShowDetailFields()` Whether to include fields marked `detail:true` from this component's `DataSource`.
`Boolean`	`getShowEmptyMessage()` Indicates whether the text of the emptyMessage property should be displayed if no data is available.
`Boolean`	`getShowExpansionEditorSaveButton()` When `ExpansionMode` is editor, should a Save button be shown below the the expanded editor?
`Boolean`	`getShowFilterEditor()` Should this listGrid display a filter row.
`Boolean`	`getShowGridSummary()` Should this ListGrid show a summary row beneath the last record of the grid.
`Boolean`	`getShowGroupSummary()` If this listGrid supports `grouping`, setting this property will cause the grid to render an extra row at the end of each group when grouped, containing summary information for the fields.
`Boolean`	`getShowGroupSummaryInHeader()` If this grid is `grouped`, and `showGroupSummary` is true, setting this property causes field summary values for each group to be displayed directly in the group header node, rather than showing up at the bottom of each expanded group.
`Boolean`	`getShowGroupTitleColumn()` If this grid is `grouped` and `showGroupSummaryInHeader` is true, instead of group header nodes showing up with a single cell value spanning the full set of columns, summaries for each field will show up in the appropriate columns of the header node.
`Boolean`	`getShowHeader()` Should we show the header for this ListGrid?
`Boolean`	`getShowHeaderContextMenu()` Whether to show a context menu on the header with standard items for showing and hiding fields.
`Boolean`	`getShowHeaderMenuButton()` If set to true and `showHeaderContextMenu` is true, the `headerMenuButton` will be displayed when the user rolls over the header buttons in this grid.
`Boolean`	`getShowHeaderSpanTitlesInFormulaBuilder()` If this grid has specified `headerSpans`, should field titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or SummaryBuilder.
`Boolean`	`getShowHeaderSpanTitlesInHiliteEditor()` If this grid has specified `headerSpans`, should field titles be prefixed with the titles of the headerSpans in which they are contained when using the `hilite editor`.
`Boolean`	`getShowHeaderSpanTitlesInSortEditor()` If this grid has specified `headerSpans`, should field titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor.
`Boolean`	`getShowHiddenFields()` Whether to show fields marked `hidden:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`Boolean`	`getShowHover()` If true, and canHover is also true, when the user hovers over a cell, hover text will pop up next to the mouse.
`Boolean`	`getShowHoverComponents()` When set to true and canHover is also true, shows a widget hovering at the mouse point.
`Boolean`	`getShowRecordComponents()` If set to true, this listGrid should create and show an embedded component in every row of the grid.
`Boolean`	`getShowRecordComponentsByCell()` If true, shows `'recordComponents'` in cells, rather than just in records.
`Boolean`	`getShowRollOver()` Should we show different styling for the cell the mouse is over? If true, the cell style will have the suffix "Over" appended.
`Boolean`	`getShowRollOverCanvas()` If `showRollOver` is true, this property provides an option to show roll over styling with the `rollOverCanvas` and `rollUnderCanvas` rather than using css styling.
`Boolean`	`getShowRowNumbers()` When set to true, shows an additional field at the beginning of the field-list (respecting RTL) that displays the current rowNum for each record.
`Boolean`	`getShowSelectedStyle()` Should the "Selected" style be applied to selected records?
`Boolean`	`getShowSelectionCanvas()` If `selectionType` is set to `"single"`, setting this property to true means selection will be displayed to the user with the `selectionCanvas` and `selectionUnderCanvas` rather than using css styling.
`SortArrow`	`getShowSortArrow()` Indicates whether a sorting arrow should appear for the listGrid, and its location.
`Boolean`	`getShowSortNumerals()` When multiple fields are sorted, set this to false to hide the sort-numeral displayed by default after the sort-arrows in the header-buttons of sorted fields.
`Boolean`	`getShowTreeColumnPicker()` When `headerSpans` are in use, whether to show a hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under headerSpans similarly to how a `TreeGrid` displays a Tree.
`Boolean`	`getShrinkForFreeze()` If this list grid is showing any `frozen` fields, and a horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible below the frozen columns? Note that if set to `true` any backgroundColor or border applied to the ListGrid will show up below the bottom row of the frozen column(s).
`String`	`getSingleCellValueProperty()` If `record[this.singleCellValueProperty]` is set for some record, the record will be displayed as a single cell spanning every column in the grid, with contents set to the value of `record[this.singleCellValueProperty]`.
`String`	`getSkinImgDir()` Where do 'skin' images (those provided with the class) live?
`SortSpecifier[]`	`getSort()` Return the grids current sort specification.
`ImgProperties`	`getSortAscendingImage()` Image to show when sorting ascending.
`ImgProperties`	`getSortDescendingImage()` Image to show when sorting descending.
`SortDirection`	`getSortDirection()` Sorting direction of this ListGrid.
`String`	`getSortEditorSpanTitleSeparator()` If this grid has specified `headerSpans`, and `showHeaderSpanTitlesInSortEditor` is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid on the multi-sort editor
`String`	`getSortField()` The field by which this grid should be initially sorted.
`String`	`getSortFieldAscendingText()` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to sort a field in ascending order.
`int`	`getSortFieldCount()` Returns the number of fields involved in this grid's current sort configuration.
`String`	`getSortFieldDescendingText()` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to sort a field in descending order.
`String`	`getSortNumeralHTML(String fieldName, int sortIndex)` When multiple fields are sorted, this method returns the HTML for the sort-numeral that appears after the sort-arrows in the header-buttons of sorted fields.
`String`	`getSortNumeralStyle()` When multiple fields are sorted, the Style to apply to the numeral that appears after the sort-arrows in the header-buttons of sorted fields.
`SortSpecifier`	`getSortSpecifier(String fieldName)` Returns the ${isc.DocUtils.linkForRef('object:SortSpecifier')} for the passed fieldName, or null if the field is not sorted.
`String`	`getSortState()` Returns a snapshot of the current sort state within this listGrid as a ListGridSortState object. This object can be passed to `ListGrid.setSortState` to reset this grid's sort to the current state (assuming the same fields are present in the grid).
`Boolean`	`getStopOnErrors()` If this is an editable listGrid, this property determines how failure to save due to validation errors should be displayed to the user.
`String`	`getStyleName()` Default CSS class
`int`	`getSummaryFieldValue(ListGridField field, Record record)` Get the computed value of a `canAddSummaryFields`.
`Criteria`	`getSummaryRowCriteria()` If `showGridSummary` is true, and a `summaryRowDataSource` is specified this property may be used to specify fetch criteria to apply when retrieving summary data to show in the summary row.
`DataSource`	`getSummaryRowDataSource()` If `showGridSummary` is true, by default summary values are calculated on the client based on the current data-set for the grid (see `ListGrid.getGridSummary` and `ListGrid.getGridSummaryFunction`).
`DSRequest`	`getSummaryRowFetchRequestProperties()` If `setShowGridSummary(Boolean)` is true, and a ${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to customize the fetch request used when retrieving summary data to show in the summary row.
`int`	`getSummaryRowHeight()` Default height for the `summary row autoChild`.
`String`	`getSummaryRowStyle()` `baseStyle` for the `summaryRow`
`String`	`getTallBaseStyle()` "Tall" baseStyle for this listGrid.
`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`	`getToggleFreezeText(ListGridField field)` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to toggle whether a field is frozen or unfrozen.
`int`	`getTotalRows()` Return the total number of rows in the grid.
`ImgProperties`	`getTrackerImage()` Default image to use for the dragTracker when things are dragged within or out of this list.
`String`	`getUnfreezeFieldText()` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to unfreeze a currently frozen field.
`String`	`getUngroupText()` If we're showing a `headerContextMenu` for this grid, and `this.isGrouped` is true, this attribute will be shown as the title for the menu item to ungroup the grid.
`String`	`getUnremoveIcon()` When `canRemoveRecords` is enabled, this icon will be shown in the auto generated field fro removing records if the record has been marked as removed via `ListGrid.markRecordRemoved`.
`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`	`getUseCellRollOvers()` Are rollovers cell-level or row-level?
`Boolean`	`getUseCopyPasteShortcuts()` Enables copy/paste shortcuts, provided `canSelectCells` is true
`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`	`getUseRemoteValidators()` If `saveLocally` is specified, but this grid is bound to a DataSource which includes remote field validators, by default edits will be saved synchronously and these validators will not be executed. Set this property to `true` to ensure these remote validators are called when saving edits in saveLocally mode.
`Boolean`	`getUseRowSpanStyling()` Enables various styling behaviors that potentially make sense when `ListGrid.getRowSpan` has been overriden to introduce spanning cells, and spanning is largest on the left and smaller as cells go to the right.
`Boolean`	`getValidateByCell()` Whether client-side validation checks should be performed when the user moves between cells in the current edit row.
`Boolean`	`getValidateOnChange()` If true, validation will be performed on each edited cell when each editor's "change" handler is fired.
`String`	`getValueIcon(ListGridField field, Object value, ListGridRecord record)` Returns the appropriate valueIcon for a cell based on the field and the data value for the cell.
`Integer`	`getValueIconHeight()` Height for value icons for this listGrid.
`int`	`getValueIconLeftPadding()` How much padding should there be on the left of valueIcons by default Can be overridden at the field level
`int`	`getValueIconRightPadding()` How much padding should there be on the right of valueIcons by default
`int`	`getValueIconSize()` Default width and height of value icons for this ListGrid.
`Integer`	`getValueIconWidth()` Width for value icons for this listGrid.
`String`	`getViewState()` Returns a snapshot of the current view state of this ListGrid. This includes the field state, sort state and selected state of the grid, returned as a ListGridViewState object. This object can be passed to `ListGrid.setViewState` to reset this grid's vew state to the current state (assuming the same data / fields are present in the grid).
`Boolean`	`getVirtualScrolling()` When incremental rendering is switched on and there are variable record heights, the virtual scrolling mechanism manages the differences in scroll height calculations due to the unknown sizes of unrendered rows to make the scrollbar and viewport appear correctly.
`Integer[]`	`getVisibleRows()` Get the rows that are currently visible in the viewport, as an array of [firstRowNum, lastRowNum].
`Boolean`	`getWaitForSave()` If this is an editable listGrid, this property determines whether the user will be able to dismiss the edit form, or navigate to another cell while the save is in process (before the asynchronous server response returns).
`Boolean`	`getWarnOnRemoval()` If `canRemoveRecords` is true, when the user clicks the remove icon for some record, should we show a warning message (defined as `warnOnRemovalMessage`) and allow the user to cancel removal?
`String`	`getWarnOnRemovalMessage()` Warning message to show the user on a click on the 'remove' icon if `canRemoveRecords` is true and `warnOnRemoval` is true.
`Boolean`	`getWarnOnUnmappedValueFieldChange()` If a field has `displayField` specified and has no `optionDataSource`, this field will display the value from the `displayField` of each record by default (for more on this behavior see `optionDataSource`).
`Boolean`	`getWrapCells()` Should content within cells be allowed to wrap?
`void`	`groupBy(String... fields)` Display the current set of records grouped by their values for the given field or fields.
`Boolean`	`hasChanges()` Whether the grid as a whole has any unsaved edits, in any row.
`Boolean`	`hasErrors()` Does this grid currently have errors associated with editValues for any row in the grid.
`void`	`hideField(String fieldName)` Force a field to be hidden.
`void`	`hideField(String fieldName, boolean suppressRelayout)` Force a field to be hidden.
`void`	`hideFields(ListGridField... fields)` Force an array of fields to be hidden.
`void`	`hideFields(ListGridField[] fields, boolean suppressRelayout)` Force an array of fields to be hidden.
`void`	`hideFields(String... fields)` Force an array of fields to be hidden.
`void`	`hideFields(String[] fields, boolean suppressRelayout)` Force an array of fields to be hidden.
`void`	`invalidateCache()` Invalidate the current data cache for this databound component via a call to `this.data.invalidateCache()`.
`void`	`invalidateRecordComponents()` Invalidates the currently visible set of `recordComponents` and gets fresh ones for the visible rows in the grid according to the `recordComponentPoolingMode`
`Boolean`	`isCheckboxField(ListGridField field)` Identifies whether the passed-in field is the specially generated `checkboxField` used when `SelectionAppearance` is "checkbox".
`Boolean`	`isExpanded(ListGridRecord record)` Whether a given `record` is expanded or collapsed.
`Boolean`	`isExpansionField(ListGridField field)` Identifies whether the passed-in field is the specially generated `expansionField` used when `canExpandRecords` is true.
`boolean`	`isGrouped()` Return true if the ListGrid is grouped on a field.
`Boolean`	`isPartiallySelected(ListGridRecord record)` Returns true if the record is partially selected.
`Boolean`	`isRowNumberField(ListGridField field)` Identifies whether the passed-in field is the specially generated `rowNumberField` used when `showRowNumbers` is true.
`Boolean`	`isSelected(ListGridRecord record)` Returns true if the record is selected.
`Boolean`	`isSortField(String fieldName)` Returns true if the passed fieldName is in the current sort-specification.
`void`	`markForRedraw()` Marks the widget as "dirty" so that it will be added to a queue for redraw.
`void`	`markForRedraw(String reason)` Marks the widget as "dirty" so that it will be added to a queue for redraw.
`void`	`markRecordRemoved(int rowNum)` Marks a record deleted such that a later call to `ListGrid.saveEdits` or `ListGrid.saveAllEdits` will cause a "remove" `DSRequest` to be submitted.
`void`	`markSelectionRemoved()` Marks the currently selected records as removed, as though `ListGrid.markRecordRemoved` had been called.
`protected void`	`onInit_ListGrid()`
`protected void`	`onInit()`
`void`	`openRecordDetailGrid(ListGridRecord record, DataSource detailDataSource)` Deprecated. use `setCanExpandRecords(Boolean)` with `setExpansionMode(com.smartgwt.client.types.ExpansionMode)`, or override `getExpansionComponent(ListGridRecord)`
`void`	`openRecordEditor(ListGridRecord record)` Deprecated. use `setCanExpandRecords(Boolean)` with `setExpansionMode(com.smartgwt.client.types.ExpansionMode)`, or override `getExpansionComponent(ListGridRecord)`
`static void`	`preloadImages()` Preload primary ListGrid skin images.
`void`	`recalculateGridSummary()` Refresh the `grid summary`, by either re-calculating from already-loaded data or doing a new fetch from the `summaryRowDataSource`.
`void`	`recalculateSummaries()` Recalculates values for fields with `summary-functions` defined and for values displayed in the `grid summary` and `group summary rows`.
`void`	`recalculateSummaries(Record[] records)` Recalculates values for fields with `summary-functions` defined and for values displayed in the `grid summary` and `group summary rows`.
`Boolean`	`recordMarkedAsRemoved(int rowNum)` Returns true if the specified record is marked as removed via a call to `ListGrid.markRecordRemoved`
`void`	`refreshCell(int rowNum, int colNum)` Refresh an individual cell without redrawing the grid.
`void`	`refreshCell(int rowNum, int colNum, boolean refreshingRow, boolean allowEditCellRefresh)` Refresh an individual cell without redrawing the grid.
`void`	`refreshCellStyle(int rowNum, int colNum)` Refresh the styling of an individual cell without redrawing the grid.
`void`	`refreshFields()` Re-evaluates `ListGridField.showIf` for each field, dynamically showing and hiding the appropriate set of fields
`void`	`refreshRecordComponent(int rowNum)` Discards any currently visible set of `recordComponent` and gets a fresh one for the specified record (or cell) according to the `recordComponentPoolingMode`
`void`	`refreshRecordComponent(int rowNum, Integer colNum)` Discards any currently visible set of `recordComponent` and gets a fresh one for the specified record (or cell) according to the `recordComponentPoolingMode`
`void`	`refreshRow(int rowNum)` Refresh an entire row of cells without redrawing the grid.
`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`	`removeEmbeddedComponent(Canvas component)` Removes an embedded component from a grid.
`void`	`removeEmbeddedComponent(ListGridRecord record)` Removes an embedded component previously associated with the provided record.
`void`	`removeEmbeddedComponent(ListGridRecord record, Integer colNum)` Removes an embedded component previously associated with the provided record and colNum.
`void`	`removeSelectedData()` Remove the currently selected records from this component.
`void`	`removeSelectedData(DSCallback callback, DSRequest requestProperties)` Remove the currently selected records from this component.
`void`	`reorderField(int fieldNum, int moveToPosition)` Reorder a particular field
`void`	`reorderFields(int start, int end, int moveDelta)` Reorder a set of adjacent fields, from start to end exclusive at the end, by distance moveDelta. NOTE: start and end coordinates are in terms of the currently visible fields, not the full set of fields.
`void`	`resizeField(int fieldNum, int newWidth)` Resize a particular field to a new width.
`void`	`resort()` If a list has become unsorted due to data modification or a call to `ListGrid.unsort`, this method will resort the list by the previous `sort-specifier` array, if there is one, or by the previous sort-field and -direction.
`void`	`rowClick(ListGridRecord record, int recordNum, int fieldNum)` Programatically simulate clicking of a row.
`void`	`rowDoubleClick(ListGridRecord record, int recordNum, int fieldNum)` Programatically simulate clicking of a row.
`Boolean`	`rowHasChanges(int rowNum)` If this listGrid can be edited, this method will return true if the row passed in has been edited, but the edits have not yet been saved to the ListGrid's data object.
`Boolean`	`rowHasErrors(int rowNum)` Does the specified row have unresolved errors?
`boolean`	`saveAllEdits()` Save a number of outstanding edits for this ListGrid.
`boolean`	`saveAllEdits(Function callback)` Save a number of outstanding edits for this ListGrid.
`boolean`	`saveAllEdits(Function callback, int[] rows)` Save a number of outstanding edits for this ListGrid.
`void`	`scrollBodyTo(Integer left, Integer top)` Scroll the body of the grid to the specified coordinates.
`void`	`scrollToCell(int rowNum, int colNum)` Will scroll the listGrid body such that the specified cell is visible close to the centre of the viewport.
`void`	`scrollToColumn(int colNum)` Scroll the grid to specified column such that the row appears near the center of the viewport.
`void`	`scrollToRow(int rowNum)` Scroll the grid to specified row such that the row appears near the center of the viewport, loading data if necessary.
`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`	`selectSingleRecord(int rowNum)` Select a single `Record` passed in explicitly, or by index, and deselect everything else.
`void`	`selectSingleRecord(Record record)` Select a single `Record` passed in explicitly, or by index, and deselect everything else.
`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`	`setAllowFilterExpressions(Boolean allowFilterExpressions)` For use with `showFilterEditor`:true, allows simple search expressions to be entered into filter fields, as though `allowExpressions` were true.
`void`	`setAllowRowSpanning(Boolean allowRowSpanning)` Should cells in this grid be allowed to span multiple rows? If set to `true`, the `ListGrid.getRowSpan` method will be called for every cell when rendering out the listGrid to determine how many rows the cell should span.
`void`	`setAlternateBodyStyleName(String alternateBodyStyleName)` Optional css style to apply to the body if `alternateRecordStyles` is true for this grid.
`void`	`setAlternateRecordFrequency(int alternateRecordFrequency)` The number of consecutive rows to draw in the same style before alternating, when alternateRowStyles is true.
`void`	`setAlternateRecordStyles(Boolean alternateRecordStyles)` Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
`void`	`setAlwaysShowEditors(Boolean alwaysShowEditors)` When this attribute is set, editors will be rendered into every row of the grid rather than showing up in a single record at a time.
`void`	`setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)` When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
`void`	`setAnimateFolderMaxRows(Integer animateFolderMaxRows)` If `animateFolders` is true for this grid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
`void`	`setAnimateFolders(Boolean animateFolders)` If true, when folders are opened / closed children will be animated into view.
`void`	`setAnimateFolderSpeed(int animateFolderSpeed)` When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second.
`void`	`setAnimateFolderTime(int animateFolderTime)` When animating folder opening / closing, if `animateFolderSpeed` is not set, this property designates the duration of the animation in ms.
`void`	`setAnimateRemoveRecord(Boolean animateRemoveRecord)` When `canRemoveRecords` is enabled, should records be animated out of view when they are removed by the user?
`void`	`setAnimateRemoveSpeed(int animateRemoveSpeed)` When `animating record removal`, this property designates the speed of the animation in pixels per second.
`void`	`setAnimateRemoveTime(int animateRemoveTime)` When animating record removal `(see animateRemoveRecord)`, if `animateRemoveSpeed` is not set, this property designates the duration of the animation in ms.
`void`	`setAnimateRollOver(Boolean animateRollOver)` If `showRollOverCanvas` is `true` setting this property to true ensures that when the rollOver canvas is displayed it animates into view via an `Canvas.animateShow`.
`void`	`setAnimateRollUnder(Boolean animateRollUnder)` If `showRollOverCanvas` is `true` setting this property to true ensures that when the rollUnder canvas is displayed it animates into view via an `Canvas.animateShow`.
`void`	`setAnimateSelection(Boolean animateSelection)` If `showSelectionCanvas` is `true` setting this property to true ensures that when the selection canvas is displayed it animates into view via an `Canvas.animateShow`.
`void`	`setAnimateSelectionUnder(Boolean animateSelectionUnder)` If `showSelectionCanvas` is `true` setting this property to true ensures that when the selectionUnder canvas is displayed it animates into view via an `Canvas.animateShow`.
`void`	`setArrowKeyAction(String arrowKeyAction)` Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the up or down arrow key.
`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`	`setAutoFetchDisplayMap(Boolean autoFetchDisplayMap)` If true, for fields where `optionDataSource` is specified, a valueMap will be automatically created by making a `DataSource.fetchData` call against the specified dataSource and extracting a valueMap from the returned records based on the displayField and valueField.
`void`	`setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)` If `autoFetchData` is `true`, this attribute allows the developer to specify a textMatchStyle for the initial `DataBoundComponent.fetchData()` call.
`void`	`setAutoFitAllText(String autoFitAllText)` If we're showing a `headerContextMenu` for this grid, and `canAutoFitFields` is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via the `ListGrid.autoFitField` method.
`void`	`setAutoFitClipFields(String... autoFitClipFields)` If `autoFitFieldWidths` is enabled and the calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear.
`void`	`setAutoFitData(Autofit autoFitData)` Should this ListGrid automatically expand to accommodate the size of records and fields?
`void`	`setAutoFitExpandField(String autoFitExpandField)` The field to expand if `autoFitFieldWidths` and `autoFitFieldsFillViewport` are enabled and auto-fitting will not fill all available horizontal space.
`void`	`setAutoFitExtraRecords(Integer autoFitExtraRecords)` If `autoFitData` is set to `"vertical"` or `"both"` this property specifies the number of additional records for which the grid will expand.
`void`	`setAutoFitFieldsFillViewport(Boolean autoFitFieldsFillViewport)` If `autoFitFieldWidths` is enabled, and extra space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.
`void`	`setAutoFitFieldText(String autoFitFieldText)` If we're showing a `headerContextMenu` for this grid, and `canAutoFitFields` is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or content via a call to `ListGrid.autoFitField`.
`void`	`setAutoFitFieldWidths(Boolean autoFitFieldWidths)` Enables autofitting of fields to values or titles.
`void`	`setAutoFitIconFields(AutoFitIconFieldType autoFitIconFields)` Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields with `type:"icon"`, fields displaying only `value icons`, and boolean fields (which are rendered as a checkmark type icon by default.
`void`	`setAutoFitMaxColumns(int autoFitMaxColumns)` If `autoFitData` is set to `"horizontal"` or `"both"` this property provides the maximum number of columns for which the ListGrid will expand.
`void`	`setAutoFitMaxHeight(Integer autoFitMaxHeight)` If `autoFitData` is set to `"vertical"` or `"both"` this property provides an upper limit on how far the ListGrid will expand vertically to accommodate its content.
`void`	`setAutoFitMaxRecords(int autoFitMaxRecords)` If `autoFitData` is set to `"vertical"` or `"both"` this property provides the maximum number of records for which the ListGrid will expand.
`void`	`setAutoFitMaxWidth(Integer autoFitMaxWidth)` If `autoFitData` is set to `"horizontal"` or `"both"` this property provides an upper limit on how far the ListGrid will expand horizontally to accommodate its content.
`void`	`setAutoFitWidth(String fieldName, boolean autoFit)` Setter for autoFitWidth.
`void`	`setAutoFitWidthApproach(AutoFitWidthApproach autoFitWidthApproach)` When a user requests column autofitting via the `header contextmenu` or via a `mouse gesture`, what autofit approach is used.
`void`	`setAutoSaveEdits(Boolean autoSaveEdits)` If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell if `saveByCell` is true).
`void`	`setAutoSizeHeaderSpans(Boolean autoSizeHeaderSpans)` If this listGrid has specified `headerSpans`, setting this attribute to true will cause spans to expand to accomodate long titles if necessary.
`void`	`setBackgroundComponent(Canvas backgroundComponent)` Has no effect unless `showBackgroundComponent` is `true`.
`void`	`setBaseStyle(String baseStyle)` `base cell style` for this listGrid.
`void`	`setBodyBackgroundColor(String bodyBackgroundColor)` Background color applied to the ListGrid body (that is, the area of the grid where data values are rendered). Note that this will typically not be visible to the user unless there are few enough rows that there is visible space in the body below the last row.
`void`	`setBodyOverflow(Overflow bodyOverflow)` Overflow setting for the "body", that is, the area of the grid where data values are rendered.
`void`	`setBodyStyleName(String bodyStyleName)` CSS style used for the body of this grid.
`void`	`setBooleanFalseImage(String booleanFalseImage)` Image to display for a false value in a boolean field.
`void`	`setBooleanImageHeight(int booleanImageHeight)` Height for the `booleanTrueImage`, `booleanFalseImage` and `booleanPartialImage`.
`void`	`setBooleanImageWidth(int booleanImageWidth)` Width for the `booleanTrueImage`, `booleanFalseImage` and `booleanPartialImage`.
`void`	`setBooleanPartialImage(String booleanPartialImage)` Image to display for a partially true value in a boolean field (typically selection).
`void`	`setBooleanTrueImage(String booleanTrueImage)` Image to display for a true value in a boolean field.
`void`	`setCanAcceptDroppedRecords(Boolean canAcceptDroppedRecords)` Indicates whether records can be dropped into this listGrid.
`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`	`setCanAutoFitFields(Boolean canAutoFitFields)` Whether the user able to autofit specific columns to their data and/or title via a context menu item or `headerAutoFitEvent`.
`void`	`setCancelEditingConfirmationMessage(String cancelEditingConfirmationMessage)` If this is an editable listGrid, and `this.confirmCancelEditing` is true this property is used as the message to display in the confirmation dismissal prompt.
`void`	`setCanCollapseGroup(Boolean canCollapseGroup)` Can a group be collapsed/expanded? When true a collapse/expand icon is shown (`groupIcon`) and clicking the icon or double-clicking the group title will collapse or expand the group.
`void`	`setCanDragRecordsOut(Boolean canDragRecordsOut)` Indicates whether records can be dragged from this listGrid and dropped elsewhere.
`void`	`setCanDragSelect(Boolean canDragSelect)` If this property is true, users can drag the mouse to select several rows or cells.
`void`	`setCanDragSelectText(Boolean canDragSelectText)` If this property is true, users can drag the mouse to select text within grid rows.
`void`	`setCanEdit(Boolean canEdit)` Can the user edit cells in this listGrid? Can be set for the listGrid, and overridden for individual fields. If 'canEdit' is false at the listGrid level, fields can never be edited - in this case the canEdit property on individual fields will be ignored. If 'canEdit' is set to true at the listGrid level, setting the 'canEdit' property to false at the field level will prevent the field from being edited inline. If 'canEdit' is not set at the listGrid level, setting 'canEdit' to true at the field level enables the field to be edited inline.
`void`	`setCanEditFieldAttribute(String canEditFieldAttribute)` If this component is bound to a dataSource, this attribute may be specified to customize what fields from the dataSource may be edited by default.
`void`	`setCanExpandMultipleRecords(Boolean canExpandMultipleRecords)` When `canExpandRecords` is true, this property indicates whether multiple records can be expanded simultaneously.
`void`	`setCanExpandRecordProperty(String canExpandRecordProperty)` Property name on a record that will be checked to determine whether a record can be expanded.
`void`	`setCanExpandRecords(Boolean canExpandRecords)` When set to true, shows an additional field at the beginning of the field-list (respecting RTL) to allow users to expand and collapse individual records.
`void`	`setCanFreezeFields(Boolean canFreezeFields)` Whether an interface should be shown to allow user is allowed to dynamically "freeze" or "unfreeze" columns with respect to horizontally scrolling.
`void`	`setCanGroupBy(Boolean canGroupBy)` If false, grouping via context menu will be disabled.
`void`	`setCanHover(Boolean canHover)` If true, cellHover and rowHover events will fire when the user leaves the mouse over a row / cell.
`void`	`setCanMultiSort(Boolean canMultiSort)` When true, indicates that this ListGrid supports sorting on multiple fields.
`void`	`setCanPickFields(Boolean canPickFields)` Indicates whether the field picker item and submenu should be present in the header context menu.
`void`	`setCanPickOmittedFields(Boolean canPickOmittedFields)` If this grid has a specified `dataSource`, and `useAllDataSourceFields` is false, setting this property to true will cause all dataSource fields not included in the specified set of fields to show up in the `field picker menu item`.
`void`	`setCanRemoveRecords(Boolean canRemoveRecords)` If set, provide UI for the user to remove records from the grid as an additional field showing the `removeIcon`, which, when clicked, will call `ListGrid.removeRecordClick` which removes the row from the data set (or if `deferRemoval` is true changes the `ListGrid.markRecordRemoved` status for the record).
`void`	`setCanReorderFields(Boolean canReorderFields)` Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.
`void`	`setCanReorderRecords(Boolean canReorderRecords)` Indicates whether records can be reordered by dragging within this listGrid.
`void`	`setCanResizeFields(Boolean canResizeFields)` Indicates whether fields in this listGrid can be resized by dragging header fields.
`void`	`setCanSelectAll(Boolean canSelectAll)` Controls whether a checkbox for selecting all records appears in the header with `selectionAppearance` set to "checkbox"
`void`	`setCanSelectCells(Boolean canSelectCells)` Enables cell-level selection behavior as well as `cell-level rollover`.
`void`	`setCanSort(Boolean canSort)` Enables or disables interactive sorting behavior for this listGrid.
`void`	`setCanTabToHeader(Boolean canTabToHeader)` Should the header be included in the tab-order for the page? If not explicitly specified, the header will be included in the tab order for the page if setScreenReaderMode is called.
`void`	`setCellFormatter(CellFormatter formatter)` Formatter to apply to values displayed within cells.
`void`	`setCellHeight(int cellHeight)` The default height of each row in pixels.
`void`	`setCellPadding(int cellPadding)` The amount of empty space, in pixels, surrounding each value in its cell.
`void`	`setChartConstructor(String chartConstructor)` Name of the Smart GWT Class to be used when creating charts.
`void`	`setChartType(ChartType chartType)` Default type of chart to plot.
`void`	`setCheckboxFieldFalseImage(String checkboxFieldFalseImage)` If `selectionAppearance` is set to `"checkbox"` this property determines the image to display in the checkbox field for an unselected row.
`void`	`setCheckboxFieldHSpace(int checkboxFieldHSpace)` How much horizontal space should the `checkbox field` leave around the checkbox icon when `selectionAppearance` is set to `"checkbox"`?
`void`	`setCheckboxFieldImageHeight(Integer checkboxFieldImageHeight)` If `selectionAppearance` is set to `"checkbox"` this property may be set to govern the height of the checkbox image displayed to indicate whether a row is selected.
`void`	`setCheckboxFieldImageWidth(Integer checkboxFieldImageWidth)` If `selectionAppearance` is set to `"checkbox"` this property may be set to govern the width of the checkbox image displayed to indicate whether a row is selected.
`void`	`setCheckboxFieldPartialImage(String checkboxFieldPartialImage)` If `selectionAppearance` is set to `"checkbox"` this property determines the image to display in the checkbox field for a partially selected row.
`void`	`setCheckboxFieldProperties(ListGridField checkboxField)` Standard properties to apply to the automatically generated checkbox field, shown when `#setSelectionAppearance(),selectionAppearance` is set to "checkbox".
`void`	`setCheckboxFieldTrueImage(String checkboxFieldTrueImage)` If `selectionAppearance` is set to `"checkbox"` this property determines the image to display in the checkbox field for a selected row.
`void`	`setChildExpansionMode(ExpansionMode childExpansionMode)` For `expansionModes` that show another grid or tree, what the child's expansionMode should be.
`void`	`setClearAllSortingText(String clearAllSortingText)` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to clear any existing sort on all fields.
`void`	`setClearFilterText(String clearFilterText)` If we're showing a `headerContextMenu` for this grid, and a `filter-editor` is visible, this attribute will be shown as the menu item title to clear any existing filter.
`void`	`setClearSortFieldText(String clearSortFieldText)` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to clear an existing sort on this field.
`void`	`setConfigureSortText(String configureSortText)` If we're showing a `headerContextMenu` for this grid, and multi-sorting is enabled, this attribute is used as the title for a menu item that opens a MultiSortDialog to configure the sort-specification for this grid.
`void`	`setConfirmCancelEditing(Boolean confirmCancelEditing)` If this is an editable listGrid, when the user attempts to cancel an edit, should we display a confirmation prompt before discarding the edited values for the record?
`void`	`setConfirmDiscardEdits(Boolean confirmDiscardEdits)` For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded.
`void`	`setConfirmDiscardEditsMessage(String confirmDiscardEditsMessage)` If `this.confirmDiscardEdits` is true, this property can be used to customize the error message string displayed to the user in a dialog with options to cancel the action, or save or discard pending edits in response to sort/filter actions that would otherwise drop unsaved edit values.
`void`	`setCriteria(Criteria criteria)` Sets this component's filter criteria.
`void`	`setData(ListGridRecord[] records)` A List of ListGridRecord objects, specifying the data to be used to populate the ListGrid.
`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`	`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`	`setDataProperties(ResultSet resultSetProperties)` For databound ListGrids, this attribute can be used to customize the `ResultSet` object created for this grid when data is fetched
`void`	`setDataSource(DataSource dataSource)` Bind to a DataSource.
`void`	`setDataSource(DataSource dataSource, ListGridField... fields)` Bind to a DataSource.
`void`	`setDateFormatter(DateDisplayFormat dateFormatter)` How should Date type values be displayed in this ListGrid by default?
`void`	`setDateInputFormat(String dateInputFormat)` If this is an editable listGrid, this property will specify the `inputFormat` applied to editors for fields of type "date" 3 character string containing the "M", "D" and "Y" characters to indicate the format of strings being parsed into Date instances via Date.parseInput().
`void`	`setDatetimeFormatter(DateDisplayFormat datetimeFormatter)` Display format to use for fields specified as type 'datetime'.
`void`	`setDefaultFields(ListGridField[] defaultFields)` An array of listGrid field configuration objects.
`static void`	`setDefaultProperties(ListGrid listGridProperties)` Class level method to set the default properties of this class.
`void`	`setDeferRemoval(Boolean deferRemoval)` When enabled, the field shown by `canRemoveRecords` causes records to be marked for future removal via `ListGrid.markRecordRemoved` instead of immediately being removed.
`void`	`setDetailDS(DataSource detailDS)` If `canExpandRecords` is true and `listGrid.expansionMode` is `"related"`, this property specifies the dataSource for the related records grid to be shown embedded in expanded records.
`void`	`setDetailDS(String detailDS)` If `canExpandRecords` is true and `listGrid.expansionMode` is `"related"`, this property specifies the dataSource for the related records grid to be shown embedded in expanded records.
`void`	`setDetailField(String detailField)` The field whose contents to show in the expanded portion of a record when `canExpandRecords` is `true` and `listGrid.expansionMode` is `detailField`.
`void`	`setDiscardEditsSaveButtonTitle(String discardEditsSaveButtonTitle)` If `confirmDiscardEdits` is true this is the title for the save button appearing in the lost edits confirmation dialog.
`void`	`setDontAutoDestroyComponent(Canvas component, boolean dontAutoDestroy)` If `showRecordComponents` is true, by default any created record components are destroyed once they are no longer in use (for example in the ListGrid as a whole is destroyed).
`void`	`setDragDataAction(DragDataAction dragDataAction)` Indicates what to do with data dragged into another DataBoundComponent.
`void`	`setDragTrackerMode(DragTrackerMode dragTrackerMode)` When records are being dragged from within a ListGrid, what sort of drag-tracker should be displayed? Note that if multiple records are being dragged the displayed tracker will be based on the first selected record.
`void`	`setDragTrackerStyle(String dragTrackerStyle)` CSS Style to apply to the drag tracker when dragging occurs on this component.
`void`	`setDrawAheadRatio(float drawAheadRatio)` How far should we render rows ahead of the currently visible area? This is expressed as a ratio from viewport size to rendered area size.
`void`	`setDrawAllMaxCells(int drawAllMaxCells)` If drawing all rows would cause less than `drawAllMaxCells` cells to be rendered, the full dataset will instead be drawn even if `showAllRecords` is false and the viewport size and `drawAheadRatio` setting would normally have caused incremental rendering to be used.
`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`	`setEditByCell(Boolean editByCell)` Determines whether when the user edits a cell in this listGrid the entire row becomes editable, or just the cell that received the edit event.
`void`	`setEditEvent(ListGridEditEvent editEvent)` Event that will trigger inline editing, see `ListGridEditEvent` for options.
`void`	`setEditFailedBaseStyle(String editFailedBaseStyle)` A base name for the CSS class applied to cells when editing has failed. If this listGrid is editable, this style will be applied to any edited cells for which validation failed. As with the default 'baseStyle' property, this style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell. If null, cells for which editing has failed will be rendered using the normal base style classNames, but with custom CSSText applied as derived from `this.editFailedCSSText`
`void`	`setEditFailedCSSText(String editFailedCSSText)` Custom CSS text to be applied to cells when editing has failed. If this listGrid is editable, this css text will be applied to any edited cells for which validation failed, on top of the base style for the cell. For further customization of styling for cells that failed editing validation, use `this.editFailedBaseStyle` instead.
`void`	`setEditFormulaFieldText(String editFormulaFieldText)` Text for a menu item allowing users to edit a formula field
`void`	`setEditOnF2Keypress(Boolean editOnF2Keypress)` Should we start editing when the widget has focus and the user presses the "f2" key (if this ListGrid supports editing)?
`void`	`setEditOnFocus(Boolean editOnFocus)` Should we start editing when this widget receives focus (if this ListGrid supports editing)?
`void`	`setEditorCustomizer(ListGridEditorCustomizer customizer)` This method allows developers to dynamically customize the form item displayed in an editable grid, based on the cell being edited.
`void`	`setEditorValueMap(String fieldName, LinkedHashMap valueMap)` Set a valueMap to display for this field while editing. This method sets the +link{ListGridField.editorValueMap, field.editorValueMap} property and may be called at runtime while editing the grid.
`void`	`setEditorValueMap(String fieldName, String... valueMap)` Set a valueMap to display for this field while editing. This method sets the +link{ListGridField.editorValueMap, field.editorValueMap} property and may be called at runtime while editing the grid.
`void`	`setEditPendingCSSText(String editPendingCSSText)` Custom CSS text to be applied to cells with pending edits that have not yet been submitted. For further customization of styling for cells with pending edits use `this.editPendingBaseStyle` instead.
`void`	`setEditSummaryFieldText(String editSummaryFieldText)` Text for a menu item allowing users to edit the formatter for a field
`void`	`setEditValue(int rowNum, int colNum, boolean value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, Date value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, double value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, float value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, int value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, JavaScriptObject value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, Object value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, Record value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, Record[] value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, int colNum, String value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, boolean value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, Date value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, double value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, float value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, int value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, JavaScriptObject value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, Record value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, Record[] value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValue(int rowNum, String fieldName, String value)` Modifies a field value being tracked as an unsaved user edit.
`void`	`setEditValues(int rowNum, Map values)` This method sets up a set of editValues for some row / cell.
`void`	`setEmptyCellValue(String emptyCellValue)` The value to display for cells whose value is null or the empty string after applying formatCellValue and valueMap (if any).
`void`	`setEmptyMessage(String emptyMessage)` The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.
`void`	`setEmptyMessageStyle(String emptyMessageStyle)` The CSS style name applied to the `emptyMessage` if displayed.
`void`	`setEnforceVClipping(Boolean enforceVClipping)` For performance reasons, even when `fixedRecordHeights` is set, vertical clipping is not enforced by default for some kinds of content (such as images) on all browsers.
`void`	`setEnterKeyEditAction(EnterKeyEditAction enterKeyEditAction)` What to do when a user hits enter while editing a cell: "nextCell": start editing the next editable cell in this record (or the first editable cell in the next record if focus is in the last editable cell in the row) "nextRow": start editing the same field in the next row (skipping any rows where that would be a non-editable cell.
`void`	`setEnumCriteriaAsInitialValues(Boolean enumCriteriaAsInitialValues)` In a ListGrid that has a DataSource and has filter criteria that include values for fields declared as `type "enum"` in the DataSource, by default a newly edited row will use those filter criteria as initial values.
`void`	`setEscapeKeyEditAction(EscapeKeyEditAction escapeKeyEditAction)` What to do when a user hits escape while editing a cell: "cancel": close the editor and discard the current set of edit values "done": just close the editor (the edit is complete, but the edited values are retained).
`void`	`setExpansionCanEdit(Boolean expansionCanEdit)` For `expansionModes` that show another grid or tree, is that component editable?
`void`	`setExpansionEditorSaveDialogPrompt(String expansionEditorSaveDialogPrompt)` When `canExpandRecords` is true and `expansionMode` is editor, the prompt to display in a dialog when an expanded row is collapsed while it's nested editor has changed values.
`void`	`setExpansionEditorShowSaveDialog(Boolean expansionEditorShowSaveDialog)` When `canExpandRecords` is true and `expansionMode` is editor, whether a dialog should be displayed when an expanded row is collapsed while it's nested editor has changed values.
`void`	`setExpansionFieldFalseImage(String expansionFieldFalseImage)` If `canExpandRecords` is set to `true`, this property determines the image to display in the expansion field for collapsed rows.
`void`	`setExpansionFieldImageHeight(Integer expansionFieldImageHeight)` If `canExpandRecords` is set to `true`, this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded.
`void`	`setExpansionFieldImageWidth(Integer expansionFieldImageWidth)` If `canExpandRecords` is set to `true`, this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded.
`void`	`setExpansionFieldTrueImage(String expansionFieldTrueImage)` If `canExpandRecords` is set to `true`, this property determines the image to display in the expansion field for expanded rows.
`void`	`setExpansionMode(ExpansionMode expansionMode)` The `ExpansionMode` for records in this grid.
`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`	`setExportRawValues(Boolean exportRawValues)` Dictates whether the data in this grid should be exported raw by `exportClientData()`.
`void`	`setFastCellUpdates(Boolean fastCellUpdates)` Note: This property only has an effect in Internet Explorer
`void`	`setFetchDelay(int fetchDelay)` If we're showing the filterEditor (`showFilterEditor` is true), and we're re-filtering on every keypress (`filterOnKeypress` is true), this property is the delay in milliseconds between the user changing the filter and the filter request being kicked off.
`void`	`setFetchOperation(String fetchOperation)` Operation ID this component should use when performing fetch operations.
`void`	`setFieldCellIcon(String fieldName, String cellIcon)` Change the `cellIcon` for a field after the grid is created
`void`	`setFieldError(int rowNum, String fieldName, String errorMessage)` Set a validation error for some cell.
`void`	`setFieldError(int rowNum, String fieldName, String[] errorMessages)` Set a validation error for some cell.
`void`	`setFieldIcon(String fieldName, String icon)` Change the `icon` for a field after the grid is created
`void`	`setFields(ListGridField... fields)` An array of field objects, specifying the order, layout, formatting, and sorting behavior of each field in the listGrid object.
`void`	`setFieldState(String fieldState)` Sets some presentation properties (visibility, width, userFormula and userSummary) of the listGrid fields based on the ListGridFieldState object passed in. Used to restore previous state retrieved from the grid by a call to `ListGrid.getFieldState`.
`void`	`setFieldTitle(int fieldNum, String title)` Change the title of a field after the grid is created.
`void`	`setFieldTitle(String fieldName, String title)` Change the title of a field after the grid is created.
`void`	`setFieldVisibilitySubmenuTitle(String fieldVisibilitySubmenuTitle)` If we're showing a `headerContextMenu` for this grid, and `this.canPickFields` is true, this attribute will be shown as the title for the menu item which contains a submenu with items allowing the user to show and hide fields in the grid.
`void`	`setFilterButtonPrompt(String filterButtonPrompt)` The prompt to show when the mouse hovers over the Filter button in the FilterEditor.
`void`	`setFilterButtonProperties(Button filterButtonProperties)` If `showFilterEditor` is true, this attribute may be used to customize the filter button shown to the right of the filterEditor row.
`void`	`setFilterByCell(Boolean filterByCell)` If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be filtered every time the user puts focus in a different field in the filter editor.
`void`	`setFilterEditorCriteria(Criteria criteria)` If `showFilterEditor` is true, this method will update the criteria shown in the `filterEditor` without performing a filter.
`void`	`setFilterEditorHeight(int filterEditorHeight)` Height for the filterEditor, if shown.
`void`	`setFilterEditorProperties(ListGrid filterEditorProperties)` Properties to apply to the automatically generated `filterEditor` if `showFilterEditor` is true.
`void`	`setFilterLocalData(Boolean filterLocalData)` If this grid has its `data property` set to a static array of records, should `ListGrid.filterData` filter this array? If this property is set to true, the local data array will be filtered according to the specified criteria, and the results displayed.
`void`	`setFilterOnKeypress(Boolean filterOnKeypress)` If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be filtered every time the user modifies the value in a field of the filter-editor.
`void`	`setFixedFieldWidths(Boolean fixedFieldWidths)` Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?
`void`	`setFixedRecordHeights(Boolean fixedRecordHeights)` Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?
`void`	`setFormulaBuilderSpanTitleSeparator(String formulaBuilderSpanTitleSeparator)` If this grid has specified `headerSpans`, and `showHeaderSpanTitlesInFormulaBuilder` is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid in the FormulaBuilder and SummaryBuilder.
`void`	`setFreezeFieldText(String freezeFieldText)` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to freeze a currently unfrozen field.
`void`	`setFreezeOnLeftText(String freezeOnLeftText)` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to freeze fields on the left of the scrollable body.
`void`	`setFreezeOnRightText(String freezeOnRightText)` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to freeze fields on the right of the scrollable body.
`void`	`setFrozenBaseStyle(String frozenBaseStyle)` If this listGrid contains any frozen fields, this property can be used to apply a custom baseStyle to all cells in those frozen fields.
`void`	`setFrozenHeaderBaseStyle(String frozenHeaderBaseStyle)` If this listGrid contains any frozen fields, this property can be used to apply a custom headerBaseStyle to the frozen set of fields.
`void`	`setFrozenHeaderTitleStyle(String frozenHeaderTitleStyle)` If this listGrid contains any frozen fields, this property can be used to apply a custom headerTitleStyle to the frozen set of fields.
`void`	`setGenerateClickOnEnter(Boolean generateClickOnEnter)` If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a click event.
`void`	`setGenerateClickOnSpace(Boolean generateClickOnSpace)` If true, when the user navigates to a cell using arrow keys and hits space, the cell will respond to a click event.
`void`	`setGenerateDoubleClickOnEnter(Boolean generateDoubleClickOnEnter)` If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a double click event.
`void`	`setGenerateDoubleClickOnSpace(Boolean generateDoubleClickOnSpace)` If true, when the user navigates to a cell using arrow keys and hits Space, the cell will respond to a double click event.
`void`	`setGridComponents(ListGridComponent... gridComponents)` Array of components that make up this grid.
`void`	`setGridComponents(Object... gridComponents)` Array of components that make up this grid.
`void`	`setGridSummaryRecordProperty(String gridSummaryRecordProperty)` If `showGridSummary` is true, this attribute will be set to true on the record object representing the grid summary row.
`void`	`setGroupByField(String... field)` List of fields to group grid records.
`void`	`setGroupByField(String field)` Field to group grid records by.
`void`	`setGroupByFieldSummaries(String... groupByFieldSummaries)` If this grid is `grouped`, and `showGroupSummary` is true, this attribute may be set to an array of groupBy field names for which group summaries should appear.
`void`	`setGroupByMaxRecords(int groupByMaxRecords)` Maximum number of records to which a groupBy can be applied.
`void`	`setGroupByText(String groupByText)` If we're showing a `headerContextMenu` for this grid and `this.canGroupBy` is true, this string will be shown as the title for the menu item to toggle the group by setting for a field.
`void`	`setGroupIcon(String groupIcon)` The URL of the base icon for the group icons in this treegrid.
`void`	`setGroupIconSize(int groupIconSize)` Default width and height of group icons for this ListGrid.
`void`	`setGroupIndentSize(int groupIndentSize)` Default number of pixels by which to indent subgroups relative to parent group.
`void`	`setGroupLeadingIndent(int groupLeadingIndent)` Default number of pixels by which to indent all groups.
`void`	`setGroupNodeStyle(String groupNodeStyle)` The CSS style that group rows will have
`void`	`setGroupStartOpen(GroupStartOpen group)` Describes the default state of ListGrid groups when groupBy is called.
`void`	`setGroupStartOpen(Object... groupValues)`
`void`	`setGroupState(String selectedState)` Reset this grid's grouping to match the ListGridGroupState object passed in. Used to restore previous state retrieved from the grid by a call to `ListGrid.getGroupState`.
`void`	`setGroupSummaryRecordProperty(String groupSummaryRecordProperty)` If `showGroupSummary` is true, this attribute will be set to true on each record object representing a group-level summary row.
`void`	`setGroupSummaryStyle(String groupSummaryStyle)` `customStyle` for the group-level summary row displayed when `showGroupSummary` is true.
`void`	`setGroupTitleColumnProperties(ListGridField groupTitleColumnProperties)` Custom properties for the automatically generated `groupTitleColumn`.
`void`	`setGroupTitleField(String groupTitleField)` When a list grid is `grouped`, each group shows under an auto generated header node.
`void`	`setHeaderAutoFitEvent(AutoFitEvent headerAutoFitEvent)` Event on a ListGrid header that triggers auto fitting to data and/or title.
`void`	`setHeaderBackgroundColor(String headerBackgroundColor)` BackgroundColor for the header toolbar.
`void`	`setHeaderBarStyle(String headerBarStyle)` Set the CSS style used for the header as a whole.
`void`	`setHeaderBaseStyle(String headerBaseStyle)` `baseStyle` to apply to the buttons in the header, and the sorter, for this ListGrid.
`void`	`setHeaderHeight(int headerHeight)` The height of this listGrid's header, in pixels.
`void`	`setHeaderMenuButtonHeight(int headerMenuButtonHeight)` If `showHeaderMenuButton` is true, this property governs the height of the auto-generated `headerMenuButton`
`void`	`setHeaderMenuButtonIcon(String headerMenuButtonIcon)` If `showHeaderMenuButton` is true, this property governs the icon shown on the auto-generated `headerMenuButton`
`void`	`setHeaderMenuButtonIconHeight(int headerMenuButtonIconHeight)` If `showHeaderMenuButton` is true, this property governs the height of the icon shown on the auto-generated `headerMenuButton`
`void`	`setHeaderMenuButtonIconWidth(int headerMenuButtonIconWidth)` If `showHeaderMenuButton` is true, this property governs the width of the icon shown on the auto-generated `headerMenuButton`
`void`	`setHeaderMenuButtonWidth(int headerMenuButtonWidth)` If `showHeaderMenuButton` is true, this property governs the width of the auto-generated `headerMenuButton`
`void`	`setHeaderSpanHeaderTitle(String name, String newTitle)` Update the headerTitle of a `headerSpan` dynamically.
`void`	`setHeaderSpanHeight(Integer headerSpanHeight)` Default height for a `headerSpan` with no height specified.
`void`	`setHeaderSpans(HeaderSpan... headerSpans)` Header spans are a second level of headers that appear above the normal ListGrid headers, spanning one or more listGrid fields in a manner similar to a column-spanning cell in an HTML table.
`void`	`setHeaderSpanTitle(String name, String newTitle)` Update the title of a `headerSpan` dynamically.
`void`	`setHeaderTitleStyle(String headerTitleStyle)` `titleStyle` to apply to the buttons in the header, and the sorter, for this ListGrid.
`void`	`setHiliteEditorSpanTitleSeparator(String hiliteEditorSpanTitleSeparator)` If this grid has specified `headerSpans`, and `showHeaderSpanTitlesInHiliteEditor` is true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser grid.
`void`	`setHiliteIconHeight(Integer hiliteIconHeight)` Height for hilite icons for this listGrid.
`void`	`setHiliteIconLeftPadding(int hiliteIconLeftPadding)` How much padding should there be on the left of `hilite icons` by default? Can be overridden at the field level
`void`	`setHiliteIconPosition(HiliteIconPosition hiliteIconPosition)` When `hiliteIcons` are present, where the hilite icon will be placed relative to the field value.
`void`	`setHiliteIconRightPadding(int hiliteIconRightPadding)` How much padding should there be on the right of `hilite icons` by default? Can be overridden at the field level
`void`	`setHiliteIcons(String... hiliteIcons)` Specifies a list of icons that can be used in `hilites`.
`void`	`setHiliteIconSize(int hiliteIconSize)` Default width and height of `hilite icons` for this component.
`void`	`setHiliteIconWidth(Integer hiliteIconWidth)` Width for hilite icons for this component.
`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`	`setHoverCustomizer(HoverCustomizer hoverCustomizer)` HTML to be shown in hovers over cells in the column described by this field.
`void`	`setHoverMode(HoverMode hoverMode)` When `showHoverComponents` is true, the builtin mode to use when automatically creating a hover component for rows in this grid.
`void`	`setHoverStyle(String hoverStyle)` Style to apply to hovers shown over this grid.
`void`	`setImageSize(int imageSize)` Default size of thumbnails shown for fieldTypes image and imageFile.
`void`	`setIncludeInSummaryProperty(String includeInSummaryProperty)` Property name on a record that will be checked to determine whether a record should be included when calculating totals for the `grid summary`.
`void`	`setInitialCriteria(Criteria initialCriteria)` Criteria to use when `DataBoundComponent.setAutoFetchData(Boolean)` is used.
`void`	`setInitialSort(SortSpecifier[] initialSort)` An array of SortSpecifier objects used to set up the initial sort configuration for this grid.
`void`	`setInstantScrollTrackRedraw(Boolean instantScrollTrackRedraw)` If true, if the user clicks on the scroll buttons at the end of the track or clicks once on the scroll track, there will be an instant redraw of the grid content so that the user doesn't see any blank space.
`void`	`setInvalidSummaryValue(String invalidSummaryValue)` Value to display to the user if showing summary values (through `showGridSummary`, `showGroupSummary` or `listGridFieldType:"summary"`), and the summary function returns `"null"` (implying it was unable to calculate a valid summary value).
`void`	`setIsSeparatorProperty(String isSeparatorProperty)` If `record[this.isSeparatorProperty]` is set for some record, the record will be displayed as a simple separator row.
`void`	`setJavaScriptObject(JavaScriptObject jsObj)`
`void`	`setLeaveHeaderMenuButtonSpace(Boolean leaveHeaderMenuButtonSpace)` If `showHeaderMenuButton` is true, when auto-fitting fields to the title width via `autoFitFieldWidths` or `autoFitWidth`, should the button be sized such that there is enough space for the heeader menu button to show without covering the field title?
`void`	`setLeaveScrollbarGap(Boolean leaveScrollbarGap)` Whether to leave a gap for the vertical scrollbar, even when it's not present.
`void`	`setLinkTextProperty(String linkTextProperty)` Property name on a record that will hold the link text for that record.
`void`	`setListEndEditAction(RowEndEditAction listEndEditAction)` If the user is editing the last record in this listGrid, and attempts to navigate beyond the last row either by tabbing off the last editable field, or using the down arrow key, this property determines what action to take: "next": start editing a new record at the end of the list.
`void`	`setLoadingDataMessage(String loadingDataMessage)` The string to display in the body of a listGrid while data is being loaded.
`void`	`setLoadingDataMessageStyle(String loadingDataMessageStyle)` The CSS style name applied to the loadingDataMessage string if displayed.
`void`	`setLoadingMessage(String loadingMessage)` If you have a databound listGrid and you scroll out of the currently loaded dataset, by default you will see blank rows until the server returns the data for those rows.
`void`	`setLocateColumnsBy(String locateColumnsBy)` When AutoTest.getElement is used to parse locator strings generated by AutoTest.getLocator for a cell in this grid, how should the column be identified? Note that getLocator() will actually store all available information about the column in the generated string -- this attribute effects how a stored string will be parsed only.
`void`	`setLocateRowsBy(String locateRowsBy)` When AutoTest.getElement is used to parse locator strings generated by AutoTest.getLocator for a cell in this grid, how should the row be identified? Note that getLocator() will actually store all available information about the row in the generated string -- this attribute effects how a stored string will be parsed only.
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`setLogicalStructure(com.smartgwt.logicalstructure.widgets.grid.ListGridLogicalStructure s)`
`void`	`setLongTextEditorThreshold(int longTextEditorThreshold)` When the length of the field specified by `length` exceeds this value, the ListGrid shows an edit field of type `longTextEditorType` rather than the standard text field when the field enters inline edit mode.
`void`	`setLongTextEditorType(String longTextEditorType)` When the length of the field specified by `length` exceeds `this.longTextEditorThreshold` show an edit field of this type rather than the standard text field when the field enters inline edit mode.
`void`	`setMaxExpandedRecords(Integer maxExpandedRecords)` When `canExpandRecords` and `canExpandMultipleRecords` are both true, this property dictates the number of records which can be expanded simultaneously.
`void`	`setMaxExpandedRecordsPrompt(String maxExpandedRecordsPrompt)` This is a dynamic string - text within `\${...}` will be evaluated as JS code when the message is displayed.
`void`	`setMinFieldWidth(int minFieldWidth)` Minimum size, in pixels, for ListGrid headers.
`void`	`setModalEditing(Boolean modalEditing)` If this property is true, any mouse click outside of the open cell editors will end editing mode, hiding the cell editors and saving any changes to those cell values.
`void`	`setNeverValidate(Boolean neverValidate)` If true, validation will not occur as a result of cell editing for this grid.
`void`	`setNormalBaseStyle(String normalBaseStyle)` "Normal" baseStyle for this listGrid.
`void`	`setNormalCellHeight(int normalCellHeight)` If `baseStyle` is unset, base style will be derived from `normalBaseStyle` if this grid has fixed row heights and the specified `cellHeight` matches this value.
`void`	`setNullGroupTitle(String nullGroupTitle)` Default alias to use for groups with no value
`void`	`setOfflineMessageStyle(String offlineMessageStyle)` The CSS style name applied to the `offlineMessage` if displayed.
`void`	`setOriginBaseStyle(String originBaseStyle)` Name of a CSS Style to use as the `baseStyle` for a cell that is currently a selection origin for shifted incremental cell selection.
`void`	`setPoolComponentsPerColumn(Boolean poolComponentsPerColumn)` Should recycled `record components`, be pooled per column or per record.
`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`	`setPrintAutoFit(Boolean printAutoFit)` Whether cell contents should wrap during printing.
`void`	`setPrintBaseStyle(String printBaseStyle)` Style for non-header cells in printed output.
`void`	`setPrintHeaderStyle(String printHeaderStyle)` Style for header cells in printed output.
`void`	`setPrintMaxRows(int printMaxRows)` Advanced property - when generating printHTML for a large ListGrid, rows are printed in batches in order to avoid triggering a native "script is running slowly" browser dialog.
`void`	`setPrintWrapCells(Boolean printWrapCells)` Whether cell contents should wrap during printing.
`void`	`setQuickDrawAheadRatio(float quickDrawAheadRatio)` Alternative to `drawAheadRatio`, to be used when the user is rapidly changing the grids viewport (for example drag scrolling through the grid).
`void`	`setRecordBaseStyleProperty(String recordBaseStyleProperty)` This attribute allows custom base styles to be displayed on a per-record basis.
`void`	`setRecordCanSelectProperty(String recordCanSelectProperty)` If set to false on a record, selection of that record is disallowed.
`void`	`setRecordComponentHeight(Integer recordComponentHeight)` If `showRecordComponents` is true, this attribute may be used to specify a standard height for record components.
`void`	`setRecordComponentPoolingMode(RecordComponentPoolingMode recordComponentPoolingMode)` The method of `component-pooling` to employ for `recordComponents`.
`void`	`setRecordComponentPosition(EmbeddedPosition recordComponentPosition)` if `showRecordComponents` is true, how should the component appear within the cell.
`void`	`setRecordDetailDSProperty(String recordDetailDSProperty)` The name of the ListGridRecord property that specifies the DataSource to use when `listGrid.expansionMode` is "related".
`void`	`setRecordEditProperty(String recordEditProperty)` Property name on a record that should be checked to determine whether the record may be edited.
`void`	`setRecordEnabledProperty(String recordEnabledProperty)` Property name on a record that will be checked to determine whether a record is enabled.
`void`	`setRecords(ListGridRecord[] records)` Synonym for `setData(ListGridRecord[])`
`void`	`setRecordSummaryBaseStyle(String recordSummaryBaseStyle)` If showing any record summary fields (IE: fields of `type:"summary"`), this attribute specifies a custom base style to apply to cells in the summary field
`void`	`setRemovedCSSText(String removedCSSText)` Custom CSS text to be applied to records that have been `marked for removal`.
`void`	`setRemoveFieldProperties(ListGridField removeFieldProperties)` Configuration properties for the "remove field" displayed when `canRemoveRecords` is enabled.
`void`	`setRemoveFieldTitle(String removeFieldTitle)` The title to use for the `remove field`.
`void`	`setRemoveIcon(String removeIcon)` When `canRemoveRecords` is enabled, default icon to show in the auto-generated field that allows removing records.
`void`	`setRemoveIconSize(int removeIconSize)` Default width and height of `remove icons` for this ListGrid.
`void`	`setRemoveOperation(String removeOperation)` Operation ID this component should use when performing remove operations.
`void`	`setResizeFieldsInRealTime(Boolean resizeFieldsInRealTime)` True == we redraw the list viewer in real time as fields are being resized.
`void`	`setReverseRTLAlign(Boolean reverseRTLAlign)` If a page is rendered in `RTL mode`, should cell alignments specified `cellAlign` be reversed (so an `align:"right"` field will have content aligned on the left and vice versa)?
`void`	`setRollUnderCanvasProperties(Canvas rollUnderCanvasProperties)` The RollUnder Canvas properties when `showRollover` is true and `showRollOverCanvas` is true.
`void`	`setRowEndEditAction(RowEndEditAction rowEndEditAction)` If the user is editing a record in this listGrid, and attempts to navigate to a field beyond the end of the row, via tab (or shift-tab off the first editable field), this property determines what action to take: "next": start editing the next (or previous) record in the list "same": put focus back into the first editable field of the same record.
`void`	`setRowErrors(int rowNum, Map errors)` Set the validation errors for some row (replacing any pre-existant validation errors)
`void`	`setRowNumberFieldProperties(ListGridField rowNumberFieldProperties)` Set the properties generated field that displays the current row number when `showRowNumbers` is true.
`void`	`setRowNumberStart(int rowNumberStart)` The number to start the row-count from - default value is 1.
`void`	`setRowNumberStyle(String rowNumberStyle)` The CSS Style name for the `rowNumberField`.
`void`	`setRowSpanSelectionMode(RowSpanSelectionMode rowSpanSelectionMode)` Chooses the selection mode when `useRowSpanStyling` is enabled.
`void`	`setSaveByCell(Boolean saveByCell)` Whether edits should be saved whenever the user moves between cells in the current edit row.
`void`	`setSaveLocally(Boolean saveLocally)` For grids with a specified `dataSource`, this property can be set to `true` to prevent the grid from attempting to save / retrieve data from the server.
`void`	`setSaveRequestProperties(DSRequest saveRequestProperties)` For editable grids with a specified `dataSource`, where `saveLocally` is false, this attribute may be used to specify standard DSRequest properties to apply to all save operations performed by this grid (whether triggered by user interaction, or explicit saveEdits or saveAllEdits call).
`void`	`setScrollRedrawDelay(int scrollRedrawDelay)` While drag scrolling in an incrementally rendered grid, time in milliseconds to wait before redrawing, after the last mouse movement by the user.
`void`	`setSelectedState(String selectedState)` Reset this grid's selection to match the ListGridSelectedState object passed in. Used to restore previous state retrieved from the grid by a call to `ListGrid.getSelectedState`.
`void`	`setSelectHeaderOnSort(Boolean selectHeaderOnSort)` If true, show the field-header for the sorted field (or the first field in a `multi-sort` grid) in the selected state.
`void`	`setSelectionAppearance(SelectionAppearance selectionAppearance)` How selection of rows should be presented to the user.
`void`	`setSelectionCanvasProperties(Canvas selectionCanvasProperties)` Canvas with properties to apply to the auto-generated Selection Canvas properties when `showSelectionCanvas` is true.
`void`	`setSelectionProperty(String selectionProperty)` If specified, the selection object for this list will use this property to mark records as selected.
`void`	`setSelectionType(SelectionStyle selectionType)` Defines a listGrid's clickable-selection behavior.
`void`	`setSelectionUnderCanvasProperties(Canvas selectionUnderCanvasProperties)` Canvas with properties to apply to the auto-generated Selection Under Canvas properties when `showSelectionCanvas` is true.
`void`	`setSelectOnEdit(Boolean selectOnEdit)` When the user starts editing a row, should the row also be selected?
`void`	`setShowAllColumns(Boolean showAllColumns)` Whether all columns should be drawn all at once, or only columns visible in the viewport.
`void`	`setShowAllRecords(Boolean showAllRecords)` Whether all rows should be drawn all at once, or only rows visible in the viewport.
`void`	`setShowBackgroundComponent(Boolean showBackgroundComponent)` If `true` this grid will create and show per-row backgroundComponents as detailed `here`.
`void`	`setShowCellContextMenus(Boolean showCellContextMenus)` Whether to show a context menu with standard items for all context clicks on rows in the body.
`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)` Whether to include fields marked `detail:true` from this component's `DataSource`.
`void`	`setShowEmptyMessage(Boolean showEmptyMessage)` Indicates whether the text of the emptyMessage property should be displayed if no data is available.
`void`	`setShowFilterEditor(Boolean showFilterEditor)` Should this listGrid display a filter row.
`void`	`setShowGridSummary(Boolean showGridSummary)` Should this ListGrid show a summary row beneath the last record of the grid.
`void`	`setShowGroupSummary(Boolean showGroupSummary)` If this listGrid supports `grouping`, setting this property will cause the grid to render an extra row at the end of each group when grouped, containing summary information for the fields.
`void`	`setShowGroupSummaryInHeader(Boolean showGroupSummaryInHeader)` If this grid is `grouped`, and `showGroupSummary` is true, setting this property causes field summary values for each group to be displayed directly in the group header node, rather than showing up at the bottom of each expanded group.
`void`	`setShowGroupTitleColumn(Boolean showGroupTitleColumn)` If this grid is `grouped` and `showGroupSummaryInHeader` is true, instead of group header nodes showing up with a single cell value spanning the full set of columns, summaries for each field will show up in the appropriate columns of the header node.
`void`	`setShowHeader(Boolean showHeader)` Should we show the header for this ListGrid? If this method is called after the component has been drawn/initialized: Show or hide the ListGrid header.
`void`	`setShowHeaderContextMenu(Boolean showHeaderContextMenu)` Whether to show a context menu on the header with standard items for showing and hiding fields.
`void`	`setShowHeaderMenuButton(Boolean showHeaderMenuButton)` If set to true and `showHeaderContextMenu` is true, the `headerMenuButton` will be displayed when the user rolls over the header buttons in this grid.
`void`	`setShowHeaderSpanTitlesInFormulaBuilder(Boolean showHeaderSpanTitlesInFormulaBuilder)` If this grid has specified `headerSpans`, should field titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or SummaryBuilder.
`void`	`setShowHeaderSpanTitlesInHiliteEditor(Boolean showHeaderSpanTitlesInHiliteEditor)` If this grid has specified `headerSpans`, should field titles be prefixed with the titles of the headerSpans in which they are contained when using the `hilite editor`.
`void`	`setShowHeaderSpanTitlesInSortEditor(Boolean showHeaderSpanTitlesInSortEditor)` If this grid has specified `headerSpans`, should field titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor.
`void`	`setShowHiddenFields(Boolean showHiddenFields)` Whether to show fields marked `hidden:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`void`	`setShowHover(Boolean showHover)` If true, and canHover is also true, when the user hovers over a cell, hover text will pop up next to the mouse.
`void`	`setShowHoverComponents(Boolean showHoverComponents)` When set to true and canHover is also true, shows a widget hovering at the mouse point.
`void`	`setShowRecordComponents(Boolean showRecordComponents)` If set to true, this listGrid should create and show an embedded component in every row of the grid.
`void`	`setShowRecordComponentsByCell(Boolean showRecordComponentsByCell)` If true, shows `'recordComponents'` in cells, rather than just in records.
`void`	`setShowRollOver(Boolean showRollOver)` Should we show different styling for the cell the mouse is over? If true, the cell style will have the suffix "Over" appended.
`void`	`setShowRollOverCanvas(Boolean showRollOverCanvas)` If `showRollOver` is true, this property provides an option to show roll over styling with the `rollOverCanvas` and `rollUnderCanvas` rather than using css styling.
`void`	`setShowRowNumbers(Boolean showRowNumbers)` When set to true, shows an additional field at the beginning of the field-list (respecting RTL) that displays the current rowNum for each record.
`void`	`setShowSelectedStyle(Boolean showSelectedStyle)` Should the "Selected" style be applied to selected records?
`void`	`setShowSelectionCanvas(Boolean showSelectionCanvas)` If `selectionType` is set to `"single"`, setting this property to true means selection will be displayed to the user with the `selectionCanvas` and `selectionUnderCanvas` rather than using css styling.
`void`	`setShowSortArrow(SortArrow showSortArrow)` Indicates whether a sorting arrow should appear for the listGrid, and its location.
`void`	`setShowSortNumerals(Boolean showSortNumerals)` When multiple fields are sorted, set this to false to hide the sort-numeral displayed by default after the sort-arrows in the header-buttons of sorted fields.
`void`	`setShowTreeColumnPicker(Boolean showTreeColumnPicker)` When `headerSpans` are in use, whether to show a hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under headerSpans similarly to how a `TreeGrid` displays a Tree.
`void`	`setShrinkForFreeze(Boolean shrinkForFreeze)` If this list grid is showing any `frozen` fields, and a horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible below the frozen columns? Note that if set to `true` any backgroundColor or border applied to the ListGrid will show up below the bottom row of the frozen column(s).
`void`	`setSingleCellValueProperty(String singleCellValueProperty)` If `record[this.singleCellValueProperty]` is set for some record, the record will be displayed as a single cell spanning every column in the grid, with contents set to the value of `record[this.singleCellValueProperty]`.
`void`	`setSkinImgDir(String skinImgDir)` Where do 'skin' images (those provided with the class) live?
`void`	`setSort(SortSpecifier[] sortSpecifiers)` This method sorts the grid on one or more fields, or configures it to be so sorted upon the underlying JS object's creation.
`void`	`setSortAscendingImage(ImgProperties sortAscendingImage)` Image to show when sorting ascending.
`void`	`setSortDescendingImage(ImgProperties sortDescendingImage)` Image to show when sorting descending.
`void`	`setSortDirection(SortDirection sortDirection)` Sorting direction of this ListGrid.
`void`	`setSortEditorSpanTitleSeparator(String sortEditorSpanTitleSeparator)` If this grid has specified `headerSpans`, and `showHeaderSpanTitlesInSortEditor` is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid on the multi-sort editor
`void`	`setSortField(int fieldIndex)` Specifies the field by which this grid should be initially sorted.
`void`	`setSortField(String fieldName)` Specifies the field by which this grid should be initially sorted.
`void`	`setSortFieldAscendingText(String sortFieldAscendingText)` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to sort a field in ascending order.
`void`	`setSortFieldDescendingText(String sortFieldDescendingText)` If we're showing a `headerContextMenu` for this grid, this attribute will be shown as the menu item title to sort a field in descending order.
`void`	`setSortNumeralStyle(String sortNumeralStyle)` When multiple fields are sorted, the Style to apply to the numeral that appears after the sort-arrows in the header-buttons of sorted fields.
`void`	`setSortState(String sortState)` Reset this grid's sort state (sort field and direction or list of `SortSpecifier`s) to match the ListGridSortState object passed in. Used to restore previous state retrieved from the grid by a call to `ListGrid.getSortState`.
`void`	`setStopOnErrors(Boolean stopOnErrors)` If this is an editable listGrid, this property determines how failure to save due to validation errors should be displayed to the user.
`void`	`setStyleName(String styleName)` Default CSS class
`void`	`setSummaryRowCriteria(Criteria summaryRowCriteria)` If `showGridSummary` is true, and a `summaryRowDataSource` is specified this property may be used to specify fetch criteria to apply when retrieving summary data to show in the summary row.
`void`	`setSummaryRowDataSource(DataSource summaryRowDataSource)` If `showGridSummary` is true, by default summary values are calculated on the client based on the current data-set for the grid (see `ListGrid.getGridSummary` and `ListGrid.getGridSummaryFunction`).
`void`	`setSummaryRowFetchRequestProperties(DSRequest summaryRowFetchRequestProperties)` If `setShowGridSummary(Boolean)` is true, and a ${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to customize the fetch request used when retrieving summary data to show in the summary row.
`void`	`setSummaryRowHeight(int summaryRowHeight)` Default height for the `summary row autoChild`.
`void`	`setSummaryRowStyle(String summaryRowStyle)` `baseStyle` for the `summaryRow`
`void`	`setTallBaseStyle(String tallBaseStyle)` "Tall" baseStyle for this listGrid.
`void`	`setTitleField(String titleField)` Sets the best field to use for a user-visible title for an individual record from this component.
`void`	`setTrackerImage(ImgProperties trackerImage)` Default image to use for the dragTracker when things are dragged within or out of this list.
`void`	`setUnfreezeFieldText(String unfreezeFieldText)` If we're showing a `headerContextMenu` for this grid and `this.canFreezeFields` is true, this string will be shown as the title for the menu item to unfreeze a currently frozen field.
`void`	`setUngroupText(String ungroupText)` If we're showing a `headerContextMenu` for this grid, and `this.isGrouped` is true, this attribute will be shown as the title for the menu item to ungroup the grid.
`void`	`setUnremoveIcon(String unremoveIcon)` When `canRemoveRecords` is enabled, this icon will be shown in the auto generated field fro removing records if the record has been marked as removed via `ListGrid.markRecordRemoved`.
`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`	`setUseCellRollOvers(Boolean useCellRollOvers)` Are rollovers cell-level or row-level?
`void`	`setUseCopyPasteShortcuts(Boolean useCopyPasteShortcuts)` Enables copy/paste shortcuts, provided `canSelectCells` is true
`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`	`setUseRemoteValidators(Boolean useRemoteValidators)` If `saveLocally` is specified, but this grid is bound to a DataSource which includes remote field validators, by default edits will be saved synchronously and these validators will not be executed. Set this property to `true` to ensure these remote validators are called when saving edits in saveLocally mode.
`void`	`setUseRowSpanStyling(Boolean useRowSpanStyling)` Enables various styling behaviors that potentially make sense when `ListGrid.getRowSpan` has been overriden to introduce spanning cells, and spanning is largest on the left and smaller as cells go to the right.
`void`	`setValidateByCell(Boolean validateByCell)` Whether client-side validation checks should be performed when the user moves between cells in the current edit row.
`void`	`setValidateOnChange(Boolean validateOnChange)` If true, validation will be performed on each edited cell when each editor's "change" handler is fired.
`void`	`setValueIconHeight(Integer valueIconHeight)` Height for value icons for this listGrid.
`void`	`setValueIconLeftPadding(int valueIconLeftPadding)` How much padding should there be on the left of valueIcons by default Can be overridden at the field level
`void`	`setValueIconRightPadding(int valueIconRightPadding)` How much padding should there be on the right of valueIcons by default
`void`	`setValueIconSize(int valueIconSize)` Default width and height of value icons for this ListGrid.
`void`	`setValueIconWidth(Integer valueIconWidth)` Width for value icons for this listGrid.
`void`	`setValueMap(String fieldName, LinkedHashMap valueMap)` Set the value map for a field. See also the `setEditorValueMap(java.lang.String, java.util.LinkedHashMap)` and `com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap` methods which allow further customization of the valueMap displayed while the field is in edit mode.
`void`	`setValueMap(String fieldName, String... valueMap)` Set the value map for a field. See also the `setEditorValueMap(java.lang.String, java.util.LinkedHashMap)` and `com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap` methods which allow further customization of the valueMap displayed while the field is in edit mode.
`void`	`setViewState(String viewState)` Reset this grid's view state to match the ListGridViewState object passed in. Used to restore previous state retrieved from the grid by a call to `ListGrid.getViewState`.
`void`	`setVirtualScrolling(Boolean virtualScrolling)` When incremental rendering is switched on and there are variable record heights, the virtual scrolling mechanism manages the differences in scroll height calculations due to the unknown sizes of unrendered rows to make the scrollbar and viewport appear correctly.
`void`	`setWaitForSave(Boolean waitForSave)` If this is an editable listGrid, this property determines whether the user will be able to dismiss the edit form, or navigate to another cell while the save is in process (before the asynchronous server response returns).
`void`	`setWarnOnRemoval(Boolean warnOnRemoval)` If `canRemoveRecords` is true, when the user clicks the remove icon for some record, should we show a warning message (defined as `warnOnRemovalMessage`) and allow the user to cancel removal?
`void`	`setWarnOnRemovalMessage(String warnOnRemovalMessage)` Warning message to show the user on a click on the 'remove' icon if `canRemoveRecords` is true and `warnOnRemoval` is true.
`void`	`setWarnOnUnmappedValueFieldChange(Boolean warnOnUnmappedValueFieldChange)` If a field has `displayField` specified and has no `optionDataSource`, this field will display the value from the `displayField` of each record by default (for more on this behavior see `optionDataSource`).
`void`	`setWrapCells(Boolean wrapCells)` Should content within cells be allowed to wrap?
`void`	`showField(String fieldName)` Force a field to be shown.
`void`	`showField(String fieldName, boolean suppressRelayout)` Force a field to be shown.
`void`	`showFields(ListGridField... fields)` Force an array of fields to be shown.
`void`	`showFields(ListGridField[] fields, boolean suppressRelayout)` Force an array of fields to be shown.
`void`	`showFields(String... fields)` Force an array of fields to be shown.
`void`	`showFields(String[] fields, boolean suppressRelayout)` Force an array of fields to be shown.
`protected boolean`	`showRecordComponent(ListGridRecord record, Integer colNum)` When `showRecordComponents` is true, return false from this method to prevent showRecordComponent behavior for the passed record.
`Boolean`	`sort()` Sort the the data by the first sortable column.
`Boolean`	`sort(int sortCol, SortDirection sortDirection)` Sorts a listGrid explicitly by the column given by sortFieldNum, if provided, in ascending or descending order if specified by sortDirection.
`Boolean`	`sort(String sortField, SortDirection sortDirection)` Sorts a listGrid explicitly by the column given by sortFieldNum, if provided, in ascending or descending order if specified by sortDirection.
`Boolean`	`startEditing()` Start inline editing at the provided coordinates.
`Boolean`	`startEditing(Integer rowNum, Integer colNum, Boolean suppressFocus)` Start inline editing at the provided coordinates.
`void`	`startEditingNew()` Start editing a new row, after the last pre-existing record in the current set of data.
`void`	`startEditingNew(Map defaultValues)` Start editing a new row, after the last pre-existing record in the current set of data.
`void`	`startEditingNew(Record defaultRecordValue)` Start editing a new row, after the last pre-existing record in the current set of data.
`void`	`stopHover()` Notification that the user is no longer hovering over some cell.
`void`	`toggleSort(String fieldName)` Toggles the sort-direction of the field with the passed name and resorts the grid.
`void`	`transferSelectedData(DataBoundComponent source)` Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
`void`	`transferSelectedData(DataBoundComponent source, int index)` Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
`void`	`unfreezeField(int colNum)` Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.
`void`	`unfreezeField(String fieldName)` Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.
`void`	`unfreezeFields(int[] colNums)` Unfreeze the indicated fields, so that it will now scroll along with other fields when horizontal scrolling occurs.
`void`	`unfreezeFields(String[] fieldNames)` Unfreeze the indicated fields, so that it will now scroll along with other fields when horizontal scrolling occurs.
`void`	`ungroup()` Removes the grouping from the listgrid, restoring its original data
`void`	`unmarkRecordRemoved(int rowNum)` Reverses a previous call to `ListGrid.markRecordRemoved`.
`void`	`unsort()` Turn sorting off, typically because data has changed and is no longer sorted.
`void`	`updateData(Record record)` Perform a DataSource "update" operation to update existing records in this component's DataSource.
`void`	`updateData(Record record, DSCallback callback)` Perform a DataSource "update" operation to update existing records in this component's DataSource.
`void`	`updateData(Record record, DSCallback callback, DSRequest requestProperties)` Perform a DataSource "update" operation to update existing records in this component's DataSource.
`Canvas`	`updateRecordComponent(ListGridRecord record, Integer colNum, Canvas component, boolean recordChanged)` When `showRecordComponents` is true, this method is called for a row/cell that has already been rendered.
`Boolean`	`validateCell(int rowNum, int colIndex)` Validate the current edit value for the cell in question.
`Boolean`	`validateCell(int rowNum, String fieldName)` Validate the current edit value for the cell in question.
`Boolean`	`validateRow(int rowNum)` Validate the current set of edit values for the row in question.
`Boolean`	`willAcceptDrop()` This method overrides `Canvas.willAcceptDrop()` and works as follows: If `Canvas.willAcceptDrop()` (the superclass definition) returns false, this method always returns false.
`Boolean`	`willFetchData(Criteria newCriteria)` Compares the specified criteria with the current criteria applied to this component's data object and determines whether the new criteria could be satisfied from the currently cached set of data, or if a new filter/fetch operation will be required.
`Boolean`	`willFetchData(Criteria newCriteria, TextMatchStyle textMatchStyle)` Compares the specified criteria with the current criteria applied to this component's data object and determines whether the new criteria could be satisfied from the currently cached set of data, or if a new filter/fetch operation will be required.

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, 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, 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, getOverflow, 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, getShowResizeBar, getShowShadow, 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, 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, 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, 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, setOverflow, 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, setShowResizeBar, setShowShadow, 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

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, 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, 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, getOverflow, 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, getShowResizeBar, getShowShadow, 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, 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, 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, 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, setOverflow, 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, setShowResizeBar, setShowShadow, 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

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

ListGrid

public ListGrid()

ListGrid

public ListGrid(JavaScriptObject jsObj)

ListGrid

public ListGrid(DataSource dataSource)

Method Detail

getOrCreateRef

public static ListGrid getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:: setJavaScriptObject in class Canvas

create

protected JavaScriptObject create()

Overrides:: create in class Canvas

setAllowFilterExpressions

public void setAllowFilterExpressions(Boolean allowFilterExpressions)
                               throws IllegalStateException

For use with showFilterEditor:true, allows simple search expressions to be entered into filter fields, as though allowExpressions were true.

Can also be enabled or disabled on a field-by-field basis via filterEditorProperties.

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

getAllowFilterExpressions

public Boolean getAllowFilterExpressions()

For use with showFilterEditor:true, allows simple search expressions to be entered into filter fields, as though allowExpressions were true.

Can also be enabled or disabled on a field-by-field basis via filterEditorProperties.

Returns:: Boolean

setAllowRowSpanning

public void setAllowRowSpanning(Boolean allowRowSpanning)
                         throws IllegalStateException

Should cells in this grid be allowed to span multiple rows? If set to true, the ListGrid.getRowSpan method will be called for every cell when rendering out the listGrid to determine how many rows the cell should span.

See ListGrid.getRowSpan for more details

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

getAllowRowSpanning

public Boolean getAllowRowSpanning()

See ListGrid.getRowSpan for more details

Returns:: Boolean

setAlternateBodyStyleName

public void setAlternateBodyStyleName(String alternateBodyStyleName)

Optional css style to apply to the body if alternateRecordStyles is true for this grid. If unset bodyStyleName will be used to style the body regardless of the alternateRecordStyles setting.

If this method is called after the component has been drawn/initialized: Update the alternateBodyStyleName for this listGrid.

Note : This is an advanced setting

Parameters:: alternateBodyStyleName - new body style name when showing alternateRecordStyles. See CSSStyleName. Default value is null

getAlternateBodyStyleName

public String getAlternateBodyStyleName()

Optional css style to apply to the body if alternateRecordStyles is true for this grid. If unset bodyStyleName will be used to style the body regardless of the alternateRecordStyles setting.

Returns:: . See CSSStyleName

setAlternateRecordFrequency

public void setAlternateRecordFrequency(int alternateRecordFrequency)

The number of consecutive rows to draw in the same style before alternating, when alternateRowStyles is true.

Parameters:: alternateRecordFrequency - alternateRecordFrequency Default value is 1

getAlternateRecordFrequency

public int getAlternateRecordFrequency()

The number of consecutive rows to draw in the same style before alternating, when alternateRowStyles is true.

Returns:: int

setAlternateRecordStyles

public void setAlternateRecordStyles(Boolean alternateRecordStyles)

Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading. If enabled, the cell style for alternate rows will have "Dark" appended to it.

If this method is called after the component has been drawn/initialized: Setter for alternateRecordStyles

Parameters:: alternateRecordStyles - New value for this.alternateRecordStyles. Default value is false
See Also:: Grid cells Example

getAlternateRecordStyles

public Boolean getAlternateRecordStyles()

Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading. If enabled, the cell style for alternate rows will have "Dark" appended to it.

Returns:: Boolean
See Also:: Grid cells Example

setAlwaysShowEditors

public void setAlwaysShowEditors(Boolean alwaysShowEditors)
                          throws IllegalStateException

When this attribute is set, editors will be rendered into every row of the grid rather than showing up in a single record at a time. This attribute is only valid when editByCell is false

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

getAlwaysShowEditors

public Boolean getAlwaysShowEditors()

When this attribute is set, editors will be rendered into every row of the grid rather than showing up in a single record at a time. This attribute is only valid when editByCell is false

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

setAnimateFolderEffect

public void setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)

When animating folder opening / closing, this property can be set to apply an animated acceleration effect. This allows the animation speed to be "weighted", for example expanding or collapsing at a faster rate toward the beginning of the animation than at the end.

For a ListGrid, this property applies when grouping is enabled.

Parameters:: animateFolderEffect - animateFolderEffect Default value is null

getAnimateFolderEffect

public AnimationAcceleration getAnimateFolderEffect()

For a ListGrid, this property applies when grouping is enabled.

Returns:: AnimationAcceleration

setAnimateFolderMaxRows

public void setAnimateFolderMaxRows(Integer animateFolderMaxRows)

If animateFolders is true for this grid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.

For a ListGrid, this property applies when grouping is enabled.

Parameters:: animateFolderMaxRows - animateFolderMaxRows Default value is null

getAnimateFolderMaxRows

public Integer getAnimateFolderMaxRows()

If animateFolders is true for this grid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.

For a ListGrid, this property applies when grouping is enabled.

Returns:: Integer

setAnimateFolders

public void setAnimateFolders(Boolean animateFolders)

If true, when folders are opened / closed children will be animated into view.

For a ListGrid, this property applies when grouping is enabled.

Parameters:: animateFolders - animateFolders Default value is true

getAnimateFolders

public Boolean getAnimateFolders()

If true, when folders are opened / closed children will be animated into view.

For a ListGrid, this property applies when grouping is enabled.

Returns:: Boolean

setAnimateFolderSpeed

public void setAnimateFolderSpeed(int animateFolderSpeed)

When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second. Takes precedence over the animateFolderTime property, which allows the developer to specify a duration for the animation rather than a speed.

For a ListGrid, this property applies when grouping is enabled.

Parameters:: animateFolderSpeed - animateFolderSpeed Default value is 3000
See Also:: setAnimateFolderTime(int)

getAnimateFolderSpeed

public int getAnimateFolderSpeed()

For a ListGrid, this property applies when grouping is enabled.

Returns:: int
See Also:: getAnimateFolderTime()

setAnimateFolderTime

public void setAnimateFolderTime(int animateFolderTime)

When animating folder opening / closing, if animateFolderSpeed is not set, this property designates the duration of the animation in ms.

For a ListGrid, this property applies when grouping is enabled.

Parameters:: animateFolderTime - animateFolderTime Default value is 100
See Also:: setAnimateFolderSpeed(int)

getAnimateFolderTime

public int getAnimateFolderTime()

When animating folder opening / closing, if animateFolderSpeed is not set, this property designates the duration of the animation in ms.

For a ListGrid, this property applies when grouping is enabled.

Returns:: int
See Also:: getAnimateFolderSpeed()

setAnimateRemoveRecord

public void setAnimateRemoveRecord(Boolean animateRemoveRecord)

When canRemoveRecords is enabled, should records be animated out of view when they are removed by the user?

Parameters:: animateRemoveRecord - animateRemoveRecord Default value is true

getAnimateRemoveRecord

public Boolean getAnimateRemoveRecord()

When canRemoveRecords is enabled, should records be animated out of view when they are removed by the user?

Returns:: Boolean

setAnimateRemoveSpeed

public void setAnimateRemoveSpeed(int animateRemoveSpeed)

When animating record removal, this property designates the speed of the animation in pixels per second. Takes precedence over the animateRemoveTime property, which allows the developer to specify a duration for the animation rather than a speed.

Parameters:: animateRemoveSpeed - animateRemoveSpeed Default value is 200
See Also:: setAnimateRemoveRecord(java.lang.Boolean)

getAnimateRemoveSpeed

public int getAnimateRemoveSpeed()

Returns:: int
See Also:: getAnimateRemoveRecord()

setAnimateRemoveTime

public void setAnimateRemoveTime(int animateRemoveTime)

When animating record removal

(see
 animateRemoveRecord)

, if animateRemoveSpeed is not set, this property designates the duration of the animation in ms.

Parameters:: animateRemoveTime - animateRemoveTime Default value is 100
See Also:: setAnimateRemoveRecord(java.lang.Boolean)

getAnimateRemoveTime

public int getAnimateRemoveTime()

When animating record removal

(see
 animateRemoveRecord)

, if animateRemoveSpeed is not set, this property designates the duration of the animation in ms.

Returns:: int
See Also:: getAnimateRemoveRecord()

setAnimateRollOver

public void setAnimateRollOver(Boolean animateRollOver)

If showRollOverCanvas is true setting this property to true ensures that when the rollOver canvas is displayed it animates into view via an Canvas.animateShow. Note that the animation effect may be customized via the standard animateShowEffect, animateShowTime and animateShowAcceleration.

Note : This is an advanced setting

Parameters:: animateRollOver - animateRollOver Default value is false

getAnimateRollOver

public Boolean getAnimateRollOver()

Returns:: Boolean

setAnimateRollUnder

public void setAnimateRollUnder(Boolean animateRollUnder)

If showRollOverCanvas is true setting this property to true ensures that when the rollUnder canvas is displayed it animates into view via an Canvas.animateShow. Note that the animation effect may be customized via the standard animateShowEffect, animateShowTime and animateShowAcceleration.

Note : This is an advanced setting

Parameters:: animateRollUnder - animateRollUnder Default value is false

getAnimateRollUnder

public Boolean getAnimateRollUnder()

Returns:: Boolean

setAnimateSelection

public void setAnimateSelection(Boolean animateSelection)

If showSelectionCanvas is true setting this property to true ensures that when the selection canvas is displayed it animates into view via an Canvas.animateShow. Note that the animation effect may be customized via the standard animateShowEffect, animateShowTime and animateShowAcceleration.

Note : This is an advanced setting

Parameters:: animateSelection - animateSelection Default value is false

getAnimateSelection

public Boolean getAnimateSelection()

Returns:: Boolean

setAnimateSelectionUnder

public void setAnimateSelectionUnder(Boolean animateSelectionUnder)

If showSelectionCanvas is true setting this property to true ensures that when the selectionUnder canvas is displayed it animates into view via an Canvas.animateShow. Note that the animation effect may be customized via the standard animateShowEffect, animateShowTime and animateShowAcceleration.

Note : This is an advanced setting

Parameters:: animateSelectionUnder - animateSelectionUnder Default value is false

getAnimateSelectionUnder

public Boolean getAnimateSelectionUnder()

Returns:: Boolean

setArrowKeyAction

public void setArrowKeyAction(String arrowKeyAction)

Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the up or down arrow key. Possible values are:

"select" : select the next row in the list (calls recordClick handler)
"focus" : move focus to the next row in the list without changing the selection
"activate" : select and activate the next row in the list (calls recordDoubleClick handler)
"none" : no action
null : if selectionAppearance is "checkbox", behaves as if set to "focus"; otherwise, behaves as if set to "select"

Note : This is an advanced setting

Parameters:: arrowKeyAction - . See String. Default value is null

getArrowKeyAction

public String getArrowKeyAction()

Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the up or down arrow key. Possible values are:

"select" : select the next row in the list (calls recordClick handler)
"focus" : move focus to the next row in the list without changing the selection
"activate" : select and activate the next row in the list (calls recordDoubleClick handler)
"none" : no action
null : if selectionAppearance is "checkbox", behaves as if set to "focus"; otherwise, behaves as if set to "select"

Returns:: . See String

setAutoFetchDisplayMap

public void setAutoFetchDisplayMap(Boolean autoFetchDisplayMap)

If true, for fields where optionDataSource is specified, a valueMap will be automatically created by making a DataSource.fetchData call against the specified dataSource and extracting a valueMap from the returned records based on the displayField and valueField.

If set to false, valueMaps will not be automatically fetched. In this case, setting field.optionDataSource is effectively a shortcut for setting optionDataSource on the editor via editorProperties.

Can also be disabled on a per-field basis with autoFetchDisplayMap.

Parameters:: autoFetchDisplayMap - autoFetchDisplayMap Default value is true
See Also:: ListGridField.setAutoFetchDisplayMap(java.lang.Boolean), ListGridField.setOptionDataSource(com.smartgwt.client.data.DataSource)

getAutoFetchDisplayMap

public Boolean getAutoFetchDisplayMap()

If set to false, valueMaps will not be automatically fetched. In this case, setting field.optionDataSource is effectively a shortcut for setting optionDataSource on the editor via editorProperties.

Can also be disabled on a per-field basis with autoFetchDisplayMap.

Returns:: Boolean
See Also:: ListGridField.getAutoFetchDisplayMap(), com.smartgwt.client.widgets.grid.ListGridField#getOptionDataSource

setAutoFitAllText

public void setAutoFitAllText(String autoFitAllText)

If we're showing a headerContextMenu for this grid, and canAutoFitFields is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via the ListGrid.autoFitField method.

Parameters:: autoFitAllText - . See String. Default value is "Auto Fit All Columns"

getAutoFitAllText

public String getAutoFitAllText()

Returns:: . See String

setAutoFitClipFields

public void setAutoFitClipFields(String... autoFitClipFields)
                          throws IllegalStateException

If autoFitFieldWidths is enabled and the calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear.

Note: If any frozen columns are included in this list they will not be clipped.

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

getAutoFitClipFields

public String[] getAutoFitClipFields()

Note: If any frozen columns are included in this list they will not be clipped.

Returns:: . See String

setAutoFitData

public void setAutoFitData(Autofit autoFitData)

Should this ListGrid automatically expand to accommodate the size of records and fields?

Valid settings are

"vertical": expand vertically to accommodate records.
"horizontal": expand horizontally to accommodate fields.
"both": expand horizontally and vertically to accommodate content.

How far the ListGrid will expand may be limited via the following properties: autoFitMaxHeight, autoFitMaxRecords, autoFitMaxWidth, autoFitMaxColumns.

Note that this property causes the grid as a whole to expand to fit records or fields. To have the fields or records themselves expand to fit cell contents, see autoFitFieldWidths and fixedRecordHeights.

If this method is called after the component has been drawn/initialized: Setter for autoFitData.

Parameters:: autoFitData - One of "vertical", "horizontal" or "both". To disable auto fit behavior, pass in null.. Default value is null

getAutoFitData

public Autofit getAutoFitData()

Should this ListGrid automatically expand to accommodate the size of records and fields?

Valid settings are

"vertical": expand vertically to accommodate records.
"horizontal": expand horizontally to accommodate fields.
"both": expand horizontally and vertically to accommodate content.

How far the ListGrid will expand may be limited via the following properties: autoFitMaxHeight, autoFitMaxRecords, autoFitMaxWidth, autoFitMaxColumns.

Returns:: Autofit

setAutoFitExpandField

public void setAutoFitExpandField(String autoFitExpandField)
                           throws IllegalStateException

The field to expand if autoFitFieldWidths and autoFitFieldsFillViewport are enabled and auto-fitting will not fill all available horizontal space.

If unset, will default to the text field with the longest length if length is set, otherwise, the first text field with no width specified.

Note that expanding frozen columns is not supported.

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

getAutoFitExpandField

public String getAutoFitExpandField()

The field to expand if autoFitFieldWidths and autoFitFieldsFillViewport are enabled and auto-fitting will not fill all available horizontal space.

If unset, will default to the text field with the longest length if length is set, otherwise, the first text field with no width specified.

Note that expanding frozen columns is not supported.

Returns:: . See String

setAutoFitExtraRecords

public void setAutoFitExtraRecords(Integer autoFitExtraRecords)

If autoFitData is set to "vertical" or "both" this property specifies the number of additional records for which the grid will expand. If more records are present, scrolling will be introduced to reach them as normal.

If this method is called after the component has been drawn/initialized: Setter for autoFitExtraRecords.

Parameters:: autoFitExtraRecords - Number of extra rows beyond the data-size we'll expand to accommodate if auto fit is enabled vertically.. Default value is null

getAutoFitExtraRecords

public Integer getAutoFitExtraRecords()

Returns:: Integer

setAutoFitFieldsFillViewport

public void setAutoFitFieldsFillViewport(Boolean autoFitFieldsFillViewport)
                                  throws IllegalStateException

If autoFitFieldWidths is enabled, and extra space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.

When enabled, the field to expand may be specified via autoFitExpandField.

Note this logic will not expand a frozen column.

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

getAutoFitFieldsFillViewport

public Boolean getAutoFitFieldsFillViewport()

If autoFitFieldWidths is enabled, and extra space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.

When enabled, the field to expand may be specified via autoFitExpandField.

Note this logic will not expand a frozen column.

Returns:: Boolean

setAutoFitFieldText

public void setAutoFitFieldText(String autoFitFieldText)

If we're showing a headerContextMenu for this grid, and canAutoFitFields is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or content via a call to ListGrid.autoFitField.

Parameters:: autoFitFieldText - . See String. Default value is "Auto Fit"

getAutoFitFieldText

public String getAutoFitFieldText()

If we're showing a headerContextMenu for this grid, and canAutoFitFields is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or content via a call to ListGrid.autoFitField.

Returns:: . See String

setAutoFitFieldWidths

public void setAutoFitFieldWidths(Boolean autoFitFieldWidths)
                           throws IllegalStateException

Enables autofitting of fields to values or titles. This property may be overridden on a per-field basis via autoFitWidth.

The autoFitWidthApproach controls whether fitting is to values, titles or both. This property may also be overridden on a per field basis.

If width is also set on the field, it will be taken as a minimum width. minFieldWith will also be respected. Developers may also use the autoFitFieldsFillViewport setting to ensure that all available space is used even if the field content isn't wide enough to fill the listGrid viewport.

Autofitting will be performed:

whenever the dataset is completely changed or rows are added or removed
whenever a field which is autofitting is changed
on a manual call to ListGrid.autoFitField or ListGrid.autoFitFields

Autofitting behavior continues until the user resizes the field manually, at which point it stops. The user can also perform a one-time auto-fit of fields via the header context menu if canAutoFitFields is enabled.

When autofitting to column values, ListGrid.getDefaultFieldWidth will be called to determine the space required for a field's values. This method uses values from the rendered set of rows to calculate the required column width. The values used not match the complete set of data for the grid when rendering rows incrementally. See showAllRecords and drawAheadRatio) to control incremental rendering of rows.

Note that for icon type fields, the autoFitIconFields property setting may turn on auto-fit-width behavior for specific fields by default, even if autoFitFieldWidths is false for the grid as a whole.

Using this feature has a performance penalty roughly comparable to always rendering one additional field per field where autofitting is enabled. Specifically, enabling it for all fields would be comparable to both doubling the number of fields and disabling horizontal incremental rendering. In a grid where only half the fields are normally visible and hence only half are normally rendered, this would be roughly 4 times slower overall.

This performance penalty is a result of ListGrid.getDefaultFieldWidth having to render out the data set offscreen and measure the rendered content - it does not apply for cases where this method can return a simple fixed values (as with icon fields).

Which fields are currently autofitting is saved as part of the view state of the ListGrid.

If this method is called after the component has been drawn/initialized: Setter for autoFitFieldWidths. Modifies the default auto-fit-width behavior for fields in this grid. Note that this may be overridden at the field level via autoFitWidth.

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

getAutoFitFieldWidths

public Boolean getAutoFitFieldWidths()

Enables autofitting of fields to values or titles. This property may be overridden on a per-field basis via autoFitWidth.

The autoFitWidthApproach controls whether fitting is to values, titles or both. This property may also be overridden on a per field basis.

Autofitting will be performed:

whenever the dataset is completely changed or rows are added or removed
whenever a field which is autofitting is changed
on a manual call to ListGrid.autoFitField or ListGrid.autoFitFields

Which fields are currently autofitting is saved as part of the view state of the ListGrid.

Returns:: Boolean

setAutoFitIconFields

public void setAutoFitIconFields(AutoFitIconFieldType autoFitIconFields)

Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields with type:"icon", fields displaying only value icons, and boolean fields (which are rendered as a checkmark type icon by default.

This attribute controls this behavior - governing whether icon fields should be sized to fit their content (icon), title, or whether to disable this behavior. Setting this value to "title" or "iconWidth" will cause autoFitWidth to be enabled by default for all icon fields with the autoFitWidthApproach set to "value" or "both" as appropriate. Note that the width required for the icons is calculated by ListGrid.getDefaultFieldWidth which performs a simple calculation based on the specified icon width for these types of fields.

This setting governs default behavior for icon fields - for specific fields within a grid, this default behavior can be overridden by setting an explicit width or explicitly enabling autoFitWidth and setting autoFitWidthApproach on the field in question.

Parameters:: autoFitIconFields - autoFitIconFields Default value is "title"
See Also:: setAutoFitFieldWidths(java.lang.Boolean)

getAutoFitIconFields

public AutoFitIconFieldType getAutoFitIconFields()

Returns:: AutoFitIconFieldType
See Also:: getAutoFitFieldWidths()

setAutoFitMaxColumns

public void setAutoFitMaxColumns(int autoFitMaxColumns)

If autoFitData is set to "horizontal" or "both" this property provides the maximum number of columns for which the ListGrid will expand. If more columns are present, scrolling will be introduced to reach them as normal. If unset the ListGrid will expand to accommodate as many columns as are defined for the grid.

If this method is called after the component has been drawn/initialized: Setter for autoFitMaxColumns.

Parameters:: autoFitMaxColumns - Maximum number of fields we'll expand to accommodate if auto fit is enabled horizontally.. Default value is 50

getAutoFitMaxColumns

public int getAutoFitMaxColumns()

Returns:: int

setAutoFitMaxHeight

public void setAutoFitMaxHeight(Integer autoFitMaxHeight)

If autoFitData is set to "vertical" or "both" this property provides an upper limit on how far the ListGrid will expand vertically to accommodate its content. If content exceeds this height, scrollbars will be introduced as usual. In addition to this property, autoFitMaxRecords allows you to limit vertical expansion based on the number of rows to be rendered.

If this method is called after the component has been drawn/initialized: Setter for autoFitMaxHeight.

Parameters:: autoFitMaxHeight - Maximum height in px we'll expand to accommodate if auto fit is enabled vertically.. Default value is null

getAutoFitMaxHeight

public Integer getAutoFitMaxHeight()

Returns:: Integer

setAutoFitMaxRecords

public void setAutoFitMaxRecords(int autoFitMaxRecords)

If autoFitData is set to "vertical" or "both" this property provides the maximum number of records for which the ListGrid will expand. If more records are present, scrolling will be introduced to reach them as normal. If unset, by default the ListGrid will expand to accommodate as many records as are present.

If this method is called after the component has been drawn/initialized: Setter for autoFitMaxRecords.

Parameters:: autoFitMaxRecords - Maximum number of rows we'll expand to accommodate if auto fit is enabled vertically.. Default value is 50

getAutoFitMaxRecords

public int getAutoFitMaxRecords()

Returns:: int

setAutoFitMaxWidth

public void setAutoFitMaxWidth(Integer autoFitMaxWidth)

If autoFitData is set to "horizontal" or "both" this property provides an upper limit on how far the ListGrid will expand horizontally to accommodate its content. If content exceeds this width, scrollbars will be introduced as usual. In addition to this property, autoFitMaxColumns allows you to limit horizontal expansion based on the number of columns to be rendered.

If this method is called after the component has been drawn/initialized: Setter for autoFitMaxWidth.

Parameters:: autoFitMaxWidth - Width in px we'll expand to accommodate if auto fit is enabled horizontally.. Default value is null

getAutoFitMaxWidth

public Integer getAutoFitMaxWidth()

Returns:: Integer

setAutoFitWidthApproach

public void setAutoFitWidthApproach(AutoFitWidthApproach autoFitWidthApproach)

When a user requests column autofitting via the header contextmenu or via a mouse gesture, what autofit approach is used.

If this method is called after the component has been drawn/initialized: Setter for the autoFitWidthApproach.

Parameters:: autoFitWidthApproach - new AutoFitWidth approach. Default value is "value"

getAutoFitWidthApproach

public AutoFitWidthApproach getAutoFitWidthApproach()

When a user requests column autofitting via the header contextmenu or via a mouse gesture, what autofit approach is used.

Returns:: AutoFitWidthApproach

setAutoSaveEdits

public void setAutoSaveEdits(Boolean autoSaveEdits)

If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell if saveByCell is true).

The default of true indicates that edits will be automatically saved as the user navigates through the grid and/or ${isc.DocUtils.linkForRef('type:EnterKeyEditAction','hits 'Enter'')} to end editing. See the Grid Editing overview for details.

Setting autoSaveEdits false creates a "mass update" / "mass delete" interaction where edits will be retained for all edited cells (across rows if appropriate) until ListGrid.saveEdits is called to save a particular row, or ListGrid.saveAllEdits is called to save all changes in a batch.

Note : This is an advanced setting

Parameters:: autoSaveEdits - autoSaveEdits Default value is true
See Also:: Editing overview and related methods

getAutoSaveEdits

public Boolean getAutoSaveEdits()

If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell if saveByCell is true).

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

setAutoSizeHeaderSpans

public void setAutoSizeHeaderSpans(Boolean autoSizeHeaderSpans)
                            throws IllegalStateException

If this listGrid has specified headerSpans, setting this attribute to true will cause spans to expand to accomodate long titles if necessary.

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

getAutoSizeHeaderSpans

public Boolean getAutoSizeHeaderSpans()

If this listGrid has specified headerSpans, setting this attribute to true will cause spans to expand to accomodate long titles if necessary.

Returns:: Boolean

setBackgroundComponent

public void setBackgroundComponent(Canvas backgroundComponent)
                            throws IllegalStateException

Has no effect unless showBackgroundComponent is true.

Canvas created and embedded in the body behind a given record. When backgroundComponent is set, this autoChild canvas will be constructed (if listGridRecord.backgroundComponent is not already a Canvas) and it's properties combined with those of listGridRecord.backgroundComponent and then displayed behind a specific record in the page's z-order, meaning it will only be visible if the cell styling is transparent.

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

getBackgroundComponent

public Canvas getBackgroundComponent()

Has no effect unless showBackgroundComponent is true.

Returns:: Canvas

setBaseStyle

public void setBaseStyle(String baseStyle)
                  throws IllegalStateException

base cell style for this listGrid. If this property is unset, base style may be derived from normalBaseStyle or tallBaseStyle as described in ListGrid.getBaseStyle.

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

getBaseStyle

public String getBaseStyle()

base cell style for this listGrid. If this property is unset, base style may be derived from normalBaseStyle or tallBaseStyle as described in ListGrid.getBaseStyle.

Returns:

Return the base stylename for this cell. Has the following implementation by default:

If this.editFailedBaseStyle is defined, and the cell is displaying a validation error return this value.
If this.editFailedPendingStyle is defined, and the cell is displaying an edit value that has not yet been saved (see autoSaveEdits) return this value.
Otherwise return record[listGrid.recordBaseStyleProperty], if defined, otherwise field.baseStyle.

If no custom style is found for the cell as described above, the default baseStyle will be returned. If baseStyle is specified this will be used. Otherwise for grids showing fixed height rows which match normalCellHeight normalBaseStyle will be used. For grids with variable, or modified cell heights, tallBaseStyle will be used.

Note also that enabling fastCellUpdates will cause the tallBaseStyle to be used rather than normalBaseStyle.. See CSSStyleName

setBodyBackgroundColor

public void setBodyBackgroundColor(String bodyBackgroundColor)

Background color applied to the ListGrid body (that is, the area of the grid where data values are rendered).
Note that this will typically not be visible to the user unless there are few enough rows that there is visible space in the body below the last row. To style data cells, override baseStyle instead.

Parameters:: bodyBackgroundColor - . See String. Default value is "white"
See Also:: Appearance overview and related methods

getBodyBackgroundColor

public String getBodyBackgroundColor()

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

setBodyOverflow

public void setBodyOverflow(Overflow bodyOverflow)

Overflow setting for the "body", that is, the area of the grid where data values are rendered.

By setting both the grid itself and the body to overflow:visible, it is possible to "auto-fit" to the rendered height or width of the rows. Note that in this case grid.width and grid.height act as minimums.

If this method is called after the component has been drawn/initialized: Update the bodyOverflow for this listGrid.

Note : This is an advanced setting

Parameters:: bodyOverflow - new overflow setting for the body. Default value is Canvas.AUTO
See Also:: Sizing overview and related methods, Rows Example

getBodyOverflow

public Overflow getBodyOverflow()

Overflow setting for the "body", that is, the area of the grid where data values are rendered.

Returns:: Overflow
See Also:: Sizing overview and related methods, Rows Example

setBodyStyleName

public void setBodyStyleName(String bodyStyleName)

CSS style used for the body of this grid. If applying a background-color to the body via a CSS style applied using this property, be sure to set bodyBackgroundColor to null.

If this method is called after the component has been drawn/initialized: Update the bodyStyleName for this listGrid.

Parameters:: bodyStyleName - new body style name. See CSSStyleName. Default value is null
See Also:: Appearance overview and related methods

getBodyStyleName

public String getBodyStyleName()

CSS style used for the body of this grid. If applying a background-color to the body via a CSS style applied using this property, be sure to set bodyBackgroundColor to null.

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

setBooleanFalseImage

public void setBooleanFalseImage(String booleanFalseImage)

Image to display for a false value in a boolean field. Default null value means no image will be displayed

To turn this off explicitly set suppressValueIcon to true

If this, booleanTrueImage and booleanPartialImage are undefined, this will be set to uncheckedImage.

Note : This is an advanced setting

Parameters:: booleanFalseImage - . See SCImgURL. Default value is null
See Also:: setBooleanTrueImage(java.lang.String), setBooleanPartialImage(java.lang.String), ImageColumns overview and related methods

getBooleanFalseImage

public String getBooleanFalseImage()

Image to display for a false value in a boolean field. Default null value means no image will be displayed

To turn this off explicitly set suppressValueIcon to true

If this, booleanTrueImage and booleanPartialImage are undefined, this will be set to uncheckedImage.

Returns:: . See SCImgURL
See Also:: getBooleanTrueImage(), getBooleanPartialImage(), ImageColumns overview and related methods

setBooleanImageHeight

public void setBooleanImageHeight(int booleanImageHeight)

Height for the booleanTrueImage, booleanFalseImage and booleanPartialImage. Note: If booleanTrueImage is unset, the checkedImage will be used to indicate a true value in a boolean field. In this case this property is ignored in favor of valueIconHeight.

Note : This is an advanced setting

Parameters:: booleanImageHeight - booleanImageHeight Default value is 16
See Also:: ImageColumns overview and related methods

getBooleanImageHeight

public int getBooleanImageHeight()

Returns:: int
See Also:: ImageColumns overview and related methods

setBooleanImageWidth

public void setBooleanImageWidth(int booleanImageWidth)

Width for the booleanTrueImage, booleanFalseImage and booleanPartialImage. Note: If booleanTrueImage is unset, the checkedImage will be used to indicate a true value in a boolean field. In this case this property is ignored in favor of valueIconWidth.

Note : This is an advanced setting

Parameters:: booleanImageWidth - booleanImageWidth Default value is 16
See Also:: ImageColumns overview and related methods

getBooleanImageWidth

public int getBooleanImageWidth()

Returns:: int
See Also:: ImageColumns overview and related methods

setBooleanPartialImage

public void setBooleanPartialImage(String booleanPartialImage)

Image to display for a partially true value in a boolean field (typically selection).

To turn this off explicitly set suppressValueIcon to true.

If this, booleanTrueImage and booleanFalseImage are undefined, this will be set to partialSelectedImage.

Note : This is an advanced setting

Parameters:: booleanPartialImage - . See SCImgURL. Default value is null
See Also:: setBooleanTrueImage(java.lang.String), setBooleanFalseImage(java.lang.String), ImageColumns overview and related methods

getBooleanPartialImage

public String getBooleanPartialImage()

Image to display for a partially true value in a boolean field (typically selection).

To turn this off explicitly set suppressValueIcon to true.

If this, booleanTrueImage and booleanFalseImage are undefined, this will be set to partialSelectedImage.

Returns:: . See SCImgURL
See Also:: getBooleanTrueImage(), getBooleanFalseImage(), ImageColumns overview and related methods

setBooleanTrueImage

public void setBooleanTrueImage(String booleanTrueImage)

Image to display for a true value in a boolean field.

To turn this off explicitly set suppressValueIcon to true.

If this, booleanFalseImage and booleanPartialImage are undefined, this will be set to checkedImage.

Note : This is an advanced setting

Parameters:: booleanTrueImage - . See SCImgURL. Default value is null
See Also:: setBooleanFalseImage(java.lang.String), setBooleanPartialImage(java.lang.String), ImageColumns overview and related methods

getBooleanTrueImage

public String getBooleanTrueImage()

Image to display for a true value in a boolean field.

To turn this off explicitly set suppressValueIcon to true.

If this, booleanFalseImage and booleanPartialImage are undefined, this will be set to checkedImage.

Returns:: . See SCImgURL
See Also:: getBooleanFalseImage(), getBooleanPartialImage(), ImageColumns overview and related methods

setCanAcceptDroppedRecords

public void setCanAcceptDroppedRecords(Boolean canAcceptDroppedRecords)

Indicates whether records can be dropped into this listGrid.

Parameters:: canAcceptDroppedRecords - canAcceptDroppedRecords Default value is false
See Also:: ListGridRecord.setCanDrag(java.lang.Boolean), ListGridRecord.setCanAcceptDrop(java.lang.Boolean), Drag list (move) Example

getCanAcceptDroppedRecords

public Boolean getCanAcceptDroppedRecords()

Indicates whether records can be dropped into this listGrid.

Returns:: Boolean
See Also:: ListGridRecord.getCanDrag(), ListGridRecord.getCanAcceptDrop(), Drag list (move) Example

setCanAutoFitFields

public void setCanAutoFitFields(Boolean canAutoFitFields)

Whether the user able to autofit specific columns to their data and/or title via a context menu item or headerAutoFitEvent.

Autofitting can also be programmatically enabled by setting autoFitWidth.

Parameters:: canAutoFitFields - canAutoFitFields Default value is true

getCanAutoFitFields

public Boolean getCanAutoFitFields()

Whether the user able to autofit specific columns to their data and/or title via a context menu item or headerAutoFitEvent.

Autofitting can also be programmatically enabled by setting autoFitWidth.

Returns:: Boolean

setCancelEditingConfirmationMessage

public void setCancelEditingConfirmationMessage(String cancelEditingConfirmationMessage)

If this is an editable listGrid, and this.confirmCancelEditing is true this property is used as the message to display in the confirmation dismissal prompt.

Parameters:: cancelEditingConfirmationMessage - . See String. Default value is Cancelling this edit will discard unsaved changes for this record. Continue?
See Also:: Editing overview and related methods

getCancelEditingConfirmationMessage

public String getCancelEditingConfirmationMessage()

If this is an editable listGrid, and this.confirmCancelEditing is true this property is used as the message to display in the confirmation dismissal prompt.

Returns:: . See String
See Also:: Editing overview and related methods

setCanCollapseGroup

public void setCanCollapseGroup(Boolean canCollapseGroup)
                         throws IllegalStateException

Can a group be collapsed/expanded? When true a collapse/expand icon is shown (groupIcon) and clicking the icon or double-clicking the group title will collapse or expand the group. When false the group icon is not shown and double-clicking on the title does not change group state. Additionally groupStartOpen is initialized to "all".

Parameters:: canCollapseGroup - canCollapseGroup Default value is true
Throws:: IllegalStateException - this property cannot be changed after the component has been created
See Also:: groupBy(java.lang.String...)

getCanCollapseGroup

public Boolean getCanCollapseGroup()

Returns:: Boolean
See Also:: groupBy(java.lang.String...)

setCanDragRecordsOut

public void setCanDragRecordsOut(Boolean canDragRecordsOut)

Indicates whether records can be dragged from this listGrid and dropped elsewhere.

Parameters:: canDragRecordsOut - canDragRecordsOut Default value is false
See Also:: ListGridRecord.setCanDrag(java.lang.Boolean), ListGridRecord.setCanAcceptDrop(java.lang.Boolean), Drag list (move) Example

getCanDragRecordsOut

public Boolean getCanDragRecordsOut()

Indicates whether records can be dragged from this listGrid and dropped elsewhere.

Returns:: Boolean
See Also:: ListGridRecord.getCanDrag(), ListGridRecord.getCanAcceptDrop(), Drag list (move) Example

setCanDragSelect

public void setCanDragSelect(Boolean canDragSelect)

If this property is true, users can drag the mouse to select several rows or cells. This is mutually exclusive with rearranging rows or cells by dragging.

Parameters:: canDragSelect - canDragSelect Default value is false
See Also:: Selection overview and related methods, Drag list (select) Example

getCanDragSelect

public Boolean getCanDragSelect()

If this property is true, users can drag the mouse to select several rows or cells. This is mutually exclusive with rearranging rows or cells by dragging.

Returns:: Boolean
See Also:: Selection overview and related methods, Drag list (select) Example

setCanDragSelectText

public void setCanDragSelectText(Boolean canDragSelectText)

If this property is true, users can drag the mouse to select text within grid rows. This is mutually exclusive with rearranging rows or cells by dragging, and with drag selection of rows.

Parameters:: canDragSelectText - canDragSelectText Default value is false
See Also:: Selection overview and related methods

getCanDragSelectText

public Boolean getCanDragSelectText()

If this property is true, users can drag the mouse to select text within grid rows. This is mutually exclusive with rearranging rows or cells by dragging, and with drag selection of rows.

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

setCanEdit

public void setCanEdit(Boolean canEdit)

Can the user edit cells in this listGrid? Can be set for the listGrid, and overridden for individual fields.
If 'canEdit' is false at the listGrid level, fields can never be edited - in this case the canEdit property on individual fields will be ignored.
If 'canEdit' is set to true at the listGrid level, setting the 'canEdit' property to false at the field level will prevent the field from being edited inline.
If 'canEdit' is not set at the listGri

com.smartgwt.client.widgets.grid Class ListGrid

ListGrid

ListGrid

ListGrid

getOrCreateRef

setJavaScriptObject

create

setAllowFilterExpressions

getAllowFilterExpressions

setAllowRowSpanning

getAllowRowSpanning

setAlternateBodyStyleName

getAlternateBodyStyleName

setAlternateRecordFrequency

getAlternateRecordFrequency

setAlternateRecordStyles

getAlternateRecordStyles

setAlwaysShowEditors

getAlwaysShowEditors

setAnimateFolderEffect

getAnimateFolderEffect

setAnimateFolderMaxRows

getAnimateFolderMaxRows

setAnimateFolders

getAnimateFolders

setAnimateFolderSpeed

getAnimateFolderSpeed

setAnimateFolderTime

getAnimateFolderTime

setAnimateRemoveRecord

getAnimateRemoveRecord

setAnimateRemoveSpeed

getAnimateRemoveSpeed

setAnimateRemoveTime

getAnimateRemoveTime

setAnimateRollOver

getAnimateRollOver

setAnimateRollUnder

getAnimateRollUnder

setAnimateSelection

getAnimateSelection

setAnimateSelectionUnder

getAnimateSelectionUnder

setArrowKeyAction

getArrowKeyAction

setAutoFetchDisplayMap

getAutoFetchDisplayMap

setAutoFitAllText

getAutoFitAllText

setAutoFitClipFields

getAutoFitClipFields

setAutoFitData

getAutoFitData

setAutoFitExpandField

getAutoFitExpandField

setAutoFitExtraRecords

getAutoFitExtraRecords

setAutoFitFieldsFillViewport

getAutoFitFieldsFillViewport

setAutoFitFieldText

getAutoFitFieldText

setAutoFitFieldWidths

getAutoFitFieldWidths

setAutoFitIconFields

getAutoFitIconFields

setAutoFitMaxColumns

getAutoFitMaxColumns

setAutoFitMaxHeight

getAutoFitMaxHeight

setAutoFitMaxRecords

getAutoFitMaxRecords

setAutoFitMaxWidth

getAutoFitMaxWidth

setAutoFitWidthApproach

getAutoFitWidthApproach

setAutoSaveEdits

getAutoSaveEdits

setAutoSizeHeaderSpans

getAutoSizeHeaderSpans

setBackgroundComponent

com.smartgwt.client.widgets.grid
Class ListGrid