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:: HasHandlers, EventListener, DataBoundComponent, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasCellClickHandlers, HasCellContextClickHandlers, HasCellDoubleClickHandlers, HasCellHoverHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellSavedHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasHeaderClickHandlers, HasRecordClickHandlers, HasRecordCollapseHandlers, HasRecordDoubleClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRowContextClickHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasRowHoverHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRowOutHandlers, HasRowOverHandlers, HasSelectionChangedHandlers

Direct Known Subclasses:: Menu, TreeGrid

public class ListGrid
extends Canvas
implements DataBoundComponent, HasHeaderClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRecordCollapseHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasFieldStateChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorExitHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasEditorEnterHandlers, HasCellSavedHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellContextClickHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellClickHandlers, HasCellDoubleClickHandlers, HasRowOutHandlers, HasRowOverHandlers, HasRowContextClickHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRecordClickHandlers, HasRecordDoubleClickHandlers, HasCellHoverHandlers, HasRowHoverHandlers, HasSelectionChangedHandlers
extends Canvas
implements DataBoundComponent, HasHeaderClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRecordCollapseHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasFieldStateChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorExitHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasEditorEnterHandlers, HasCellSavedHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellContextClickHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellClickHandlers, HasCellDoubleClickHandlers, HasRowOutHandlers, HasRowOverHandlers, HasRowContextClickHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRecordClickHandlers, HasRecordDoubleClickHandlers, HasCellHoverHandlers, HasRowHoverHandlers, HasSelectionChangedHandlers

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.

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, scClassName`

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

Constructor Summary
`ListGrid()`
`ListGrid(JavaScriptObject jsObj)`

Method Summary
`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.
`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`	`addDrawAreaChangedHandler(DrawAreaChangedHandler handler)` Add a drawAreaChanged handler.
`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, int rowNum, int colNum, EmbeddedPosition position)` Attaches the component to the provided record.
`HandlerRegistration`	`addFieldStateChangedHandler(FieldStateChangedHandler handler)` Add a fieldStateChanged handler.
`void`	`addFormulaField()` Convenience method to display a `com.smartgwt.client..FormulaBuilder` to create a new Formula Field.
`HandlerRegistration`	`addHeaderClickHandler(HeaderClickHandler handler)` Add a onHeaderClick 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 onRecordDrop handler.
`HandlerRegistration`	`addRecordExpandHandler(RecordExpandHandler handler)` Add a recordExpand 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.
`void`	`addSort(SortSpecifier sortSpecifier)` Adds another SortSpecifierto this grid's sort configuration and resorts.
`void`	`addSummaryField()` Convenience method to display a `com.smartgwt.client..SummaryBuilder` to create a new Summary Field.
`Boolean`	`anySelected()` Whether at least one item is selected
`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.
`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`.
`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. Note that if this method is called on a new edit row (created via `ListGrid.startEditingNew` for example), which has not yet been saved, this method will remove the row entirely.
`void`	`discardEdits(int rowNum, int colNum, boolean dontHideEditor)` Cancel outstanding edits for the specified rows, discarding edit values, and hiding editors if appropriate. Note that if this method is called on a new edit row (created via `ListGrid.startEditingNew` for example), which has not yet been saved, this method will remove the row entirely.
`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`	`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()` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component.
`void`	`fetchData(Criteria criteria)` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component.
`void`	`fetchData(Criteria criteria, DSCallback callback)` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component.
`void`	`fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component.
`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.
`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`.
`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.
`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`	`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()` When this grid is initially filtered via `autoFetchData`, or filtered by the user via the `filterEditor`, this attribute can be used to set the `textMatchStyle` on the dsRequest passed to `fetchData()`.
`Autofit`	`getAutoFitData()` Should this ListGrid automatically expand to accomodate its content?
`Integer`	`getAutoFitExtraRecords()` If `autoFitData` is set to `"vertical"` or `"both"` this property specifies the number of additional records for which the grid will expand.
`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.
`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).
`Canvas`	`getBackgroundComponent()` Canvas created and embedded in the body behind a given record.
`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.
`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`.
`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`	`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.
`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 multi-level sorting.
`Boolean`	`getCanPickFields()` Indicates whether the field picker item and submenu should be present in the header context menu
`Boolean`	`getCanRemoveRecords()` If set, provide UI for the user to remove records from the grid.
`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`	`getCanSort()` Enables or disables interactive sorting behavior for this listGrid.
`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.
`int`	`getCellPadding()` The amount of empty space, in pixels, surrounding each value in its cell.
`String`	`getCheckboxFieldFalseImage()` If `selectionAppearance` is set to `"checkbox"` this property determines the image to display in the checkbox field for an unselected row.
`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 will be shown as the menu item title to show 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)
`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 `DSRequest`.
`DateDisplayFormat`	`getDateFormatter()` Display format to use for fields specified as type 'date'.
`DateDisplayFormat`	`getDatetimeFormatter()` Display format to use for fields specified as type 'datetime'.
`ListGridField[]`	`getDefaultFields()` An array of listGrid field configuration objects.
`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.
`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. Tweaking drawAheadRatio allows you to make tradeoffs between continuous scrolling speed vs initial render time and render time when scrolling by large amounts. NOTE: Only applies when showAllRows is false.
`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 SmartGWT 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.
`String`	`getEditFormulaFieldText()` Text for a menu item allowing users to edit a formula field
`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, int colNum)` Returns the current temporary locally stored edit value for some field within a record being edited.
`Object`	`getEditValue(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(int 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(int 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.
`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 it's list of fields to the export call.
`String[]`	`getExportFields()` The list of field-names to export.
`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 `String` 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.
`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`.
`int`	`getFilterEditorHeight()` Height for the filterEditor, if shown.
`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?
`int`	`getFocusRow()` Get the row that currently has keyboard focus.
`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.
`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.
`String`	`getGridSummaryRecordProperty()` If `showGridSummary` is true, this attribute will be set to true on the record object representing the grid summary row.
`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`	`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.
`String`	`getGroupTitleField()` If set, causes the titles of auto-generated group nodes to appear as though they were values of the designated field instead of as separate rows that span all columns.
`Tree`	`getGroupTree()` If the ListGrid is grouped, return the underlying tree structure.
`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`
`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`	`getHiliteProperty()` Marker that can be set on a record to flag that record as hilited.
`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.
`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 link{isc.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 link{isc.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.
`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
`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`.
`Boolean`	`getPoolComponentsPerColumn()` When `recordComponentPoolingMode` is "recycle" and you have components of different types in different columns, set this property to true to ensure that components intended for one column are not recycled for use in another column that should have a different component.
`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.
`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`	`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.
`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`.
`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`	`getRowNumberStart()` The number to start the row-count from - default value is 1.
`String`	`getRowNumberStyle()` The CSS Style name for the `rowNumberField`.
`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 avoid the grid from attempting to save / retrieve data from the server.
`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.
`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.
`String`	`getSelectedState()` Returns a snapshot of the current selection within this listGrid as a `String` 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).
`ListGridRecord[]`	`getSelection()` The selection associated with the listGrid.
`ListGridRecord[]`	`getSelection(boolean excludePartialSelections)` The selection associated with the listGrid.
`SelectionAppearance`	`getSelectionAppearance()` How selection of rows should be presented to the user.
`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. Drawing all rows causes longer initial rendering time, but allows smoother vertical scrolling.
`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 show fields marked `detail:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`Boolean`	`getShowEmptyMessage()` Indicates whether the text of the emptyMessage property should be displayed if no data is available.
`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`	`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`	`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`	`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`	`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`	`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)` 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 `String` 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()` 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 compounds. 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`	`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`	`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`	`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.
`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 `String` 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`	`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`	`invalidateCache()` Invalidate the current data cache for this databound component via a call to `this.data.invalidateCache()`.
`Boolean`	`isCheckboxField(ListGridField field)` Identifies whether the passed-in field is the specially generated `checkboxField` used when `SelectionAppearance` is "checkbox".
`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.
`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`	`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`	`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`	`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?
`void`	`saveAllEdits()` Save a number of outstanding edits for this ListGrid.
`void`	`saveAllEdits(Function callback)` Save a number of outstanding edits for this ListGrid.
`void`	`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 scified coordinates.
`void`	`scrollToRow(int rowNum)` Scroll to the specified row number.
`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`	`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`	`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`	`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)` When this grid is initially filtered via `autoFetchData`, or filtered by the user via the `filterEditor`, this attribute can be used to set the `textMatchStyle` on the dsRequest passed to `fetchData()`.
`void`	`setAutoFitData(Autofit autoFitData)` Should this ListGrid automatically expand to accomodate its content?
`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`	`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`	`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`	`setBackgroundComponent(Canvas backgroundComponent)` Canvas created and embedded in the body behind a given record.
`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`	`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`	`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`	`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 multi-level sorting.
`void`	`setCanPickFields(Boolean canPickFields)` Indicates whether the field picker item and submenu should be present in the header context menu
`void`	`setCanRemoveRecords(Boolean canRemoveRecords)` If set, provide UI for the user to remove records from the grid.
`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`	`setCanSort(Boolean canSort)` Enables or disables interactive sorting behavior for this listGrid.
`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`	`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`	`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`	`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 will be shown as the menu item title to show 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 fetchMode)` 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)` The DataSource that this component should bind to for default fields and for performing `DSRequest`.
`void`	`setDateFormatter(DateDisplayFormat dateFormatter)` Display format to use for fields specified as type 'date'.
`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`	`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`	`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. Tweaking drawAheadRatio allows you to make tradeoffs between continuous scrolling speed vs initial render time and render time when scrolling by large amounts. NOTE: Only applies when showAllRows is false.
`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 SmartGWT 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`	`setEditOnFocus(Boolean editOnFocus)` Should we start editing when this widget receives focus (if this ListGrid supports editing)?
`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, 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, 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`	`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 it's list of fields to the export call.
`void`	`setExportFields(String[] exportFields)` The list of field-names to export.
`void`	`setFastCellUpdates(Boolean fastCellUpdates)` Advanced property to improve performance for dynamic styling of gridRenderer cells at the expense of slightly slower drawing.
`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`	`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`	`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 `String` 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`	`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`	`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`	`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`	`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`	`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... groupValues)`
`void`	`setGroupStartOpen(GroupStartOpen group)` Describes the default state of ListGrid groups when groupBy is called.
`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`	`setGroupTitleField(String groupTitleField)` If set, causes the titles of auto-generated group nodes to appear as though they were values of the designated field instead of as separate rows that span all columns.
`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`	`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`	`setHiliteProperty(String hiliteProperty)` Marker that can be set on a record to flag that record as hilited.
`void`	`setHoverCustomizer(HoverCustomizer hoverCustomizer)` HTML to be shown in hovers over cells in the column described by this field.
`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`	`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`	`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 link{isc.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 link{isc.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.
`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`	`setPoolComponentsPerColumn(Boolean poolComponentsPerColumn)` When `recordComponentPoolingMode` is "recycle" and you have components of different types in different columns, set this property to true to ensure that components intended for one column are not recycled for use in another column that should have a different component.
`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`	`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`	`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`	`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`	`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`	`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 avoid the grid from attempting to save / retrieve data from the server.
`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 `String` object passed in. Used to restore previous state retrieved from the grid by a call to `ListGrid.getSelectedState`.
`void`	`setSelectionAppearance(SelectionAppearance selectionAppearance)` How selection of rows should be presented to the user.
`void`	`setSelectionType(SelectionStyle selectionType)` Defines a listGrid's clickable-selection behavior.
`void`	`setSelectionUnderCanvasProperties(Canvas selectionUnderCanvasProperties)` The 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. Drawing all rows causes longer initial rendering time, but allows smoother vertical scrolling.
`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 show fields marked `detail:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`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`	`setShowHeader(Boolean showHeader)` Should we show the header for this ListGrid? 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`	`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`	`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)`
`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`	`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.
`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`	`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 `String` 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)` 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)`
`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`	`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`	`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`	`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 `com.smartgwt.client.widgets.grid.ListGrid#setEditorValueMap` 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 `com.smartgwt.client.widgets.grid.ListGrid#setEditorValueMap` 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 `String` 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`	`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.
`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(int rowNum, int 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`	`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`	`ungroup()` Removes the grouping from the listgrid, restoring its original data
`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, 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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, 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, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, 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, 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, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, 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, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint

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

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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, 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, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, 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, 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, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, 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, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint

Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, 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, 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, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, 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, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
`addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, 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, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, 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)

Method Detail

getOrCreateRef

public static ListGrid getOrCreateRef(JavaScriptObject jsObj)

create

protected JavaScriptObject create()

Overrides:: create in class Canvas

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. Update the alternateBodyStyleName for this listGrid.

Note : This is an advanced setting

Parameters:: alternateBodyStyleName - new body style name when showing alternateRecordStyles. 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:: String

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

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

getAnimateRemoveSpeed

public int getAnimateRemoveSpeed()

Returns:: int

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

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

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

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

Note : This is an advanced setting

Parameters:: arrowKeyAction - arrowKeyAction Default value is "select"

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

Returns:: 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

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

setAutoFetchTextMatchStyle

public void setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
                                throws IllegalStateException

When this grid is initially filtered via autoFetchData, or filtered by the user via the filterEditor, this attribute can be used to set the textMatchStyle on the dsRequest passed to fetchData().

Parameters:: autoFetchTextMatchStyle - autoFetchTextMatchStyle Default value is "substring"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getAutoFetchTextMatchStyle

public TextMatchStyle getAutoFetchTextMatchStyle()

Returns:: TextMatchStyle

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

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

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

setBackgroundComponent

public void setBackgroundComponent(Canvas backgroundComponent)
                            throws IllegalStateException

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

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 - baseStyle 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 normalCellUpdates.

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 - bodyBackgroundColor Default value is "white"
See Also:: Appearance overview and related methods

getBodyBackgroundColor

public String getBodyBackgroundColor()

Returns:: 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. 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)
                      throws IllegalStateException

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. Update the bodyStyleName for this listGrid.

Parameters:: bodyStyleName - new body style name. Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created
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:: String
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 - booleanFalseImage Default value is null
See Also:: 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:: String
See Also:: 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 - booleanPartialImage Default value is null
See Also:: 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:: String
See Also:: 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 - booleanTrueImage Default value is null
See Also:: 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:: String
See Also:: 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:: Drag list (move) Example

getCanAcceptDroppedRecords

public Boolean getCanAcceptDroppedRecords()

Indicates whether records can be dropped into this listGrid.

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

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 - cancelEditingConfirmationMessage Default value is Cancelling this edit will clear unsaved edit values 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:: String
See Also:: Editing overview and related methods

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:: Drag list (move) Example

getCanDragRecordsOut

public Boolean getCanDragRecordsOut()

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

Returns:: Boolean
See Also:: 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 listGrid level, setting 'canEdit' to true at the field level enables the field to be edited inline.

Parameters:: canEdit - canEdit Default value is null
See Also:: Editing overview and related methods, Edit by row Example

getCanEdit

public Boolean getCanEdit()

Returns:: Boolean
See Also:: Editing overview and related methods, Edit by row Example

setCanExpandMultipleRecords

public void setCanExpandMultipleRecords(Boolean canExpandMultipleRecords)

When canExpandRecords is true, this property indicates whether multiple records can be expanded simultaneously. If set to false, expanding a record will automatically collapse any record which is already expanded. The default value is true.

Note : This is an advanced setting

Parameters:: canExpandMultipleRecords - canExpandMultipleRecords Default value is true

getCanExpandMultipleRecords

public Boolean getCanExpandMultipleRecords()

Returns:: Boolean

setCanExpandRecordProperty

public void setCanExpandRecordProperty(String canExpandRecordProperty)
                                throws IllegalStateException

Property name on a record that will be checked to determine whether a record can be expanded.

Parameters:: canExpandRecordProperty - canExpandRecordProperty Default value is "canExpand"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getCanExpandRecordProperty

public String getCanExpandRecordProperty()

Property name on a record that will be checked to determine whether a record can be expanded.

Returns:: String

setCanExpandRecords

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

If expanded records will be variable height, you should switch on virtualScrolling.

Note : This is an advanced setting

Parameters:: canExpandRecords - canExpandRecords Default value is false

getCanExpandRecords

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

If expanded records will be variable height, you should switch on virtualScrolling.

Returns:: Boolean

setCanFreezeFields

public 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. If unset, this property defaults to true unless:

this.fixedRecordHeights is false
this.bodyOverflow is "visible"
this.autoFitData is set to "horizontal" or "both"
Any field has overflow set to "visible"

Note that the canFreezeFields setting enables or disables the user interface for freezing and unfreezing fields only. Fields can be programmatically frozen via setting field.frozen to true when the grid is created, or dynamically frozen and unfrozen via ListGrid.freezeField and ListGrid.unfreezeField. Setter method for canFreezeFields

Parameters:: canFreezeFields - New value for listGrid.canFreezeFields. Default value is null
See Also:: FrozenFields overview and related methods

getCanFreezeFields

public Boolean getCanFreezeFields()

Whether an interface should be shown to allow user is allowed to dynamically "freeze" or "unfreeze" columns with respect to horizontally scrolling. If unset, this property defaults to true unless:

this.fixedRecordHeights is false
this.bodyOverflow is "visible"
this.autoFitData is set to "horizontal" or "both"
Any field has overflow set to "visible"

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

setCanGroupBy

public void setCanGroupBy(Boolean canGroupBy)

If false, grouping via context menu will be disabled.

Parameters:: canGroupBy - canGroupBy Default value is true

getCanGroupBy

public Boolean getCanGroupBy()

If false, grouping via context menu will be disabled.

Returns:: Boolean

setCanHover

public void setCanHover(Boolean canHover)

If true, cellHover and rowHover events will fire when the user leaves the mouse over a row / cell.

Overrides:: setCanHover in class Canvas

Parameters:: canHover - canHover Default value is null
See Also:: Value hover tips Example

getCanHover

public Boolean getCanHover()

If true, cellHover and rowHover events will fire when the user leaves the mouse over a row / cell.

Overrides:: getCanHover in class Canvas

Returns:: Boolean
See Also:: Value hover tips Example

setCanMultiSort

public void setCanMultiSort(Boolean canMultiSort)

When true, indicates that this ListGrid supports multi-level sorting.

Parameters:: canMultiSort - canMultiSort Default value is true

getCanMultiSort

public Boolean getCanMultiSort()

When true, indicates that this ListGrid supports multi-level sorting.

Returns:: Boolean

setCanPickFields

public void setCanPickFields(Boolean canPickFields)

Indicates whether the field picker item and submenu should be present in the header context menu

Parameters:: canPickFields - canPickFields Default value is true

getCanPickFields

public Boolean getCanPickFields()

Indicates whether the field picker item and submenu should be present in the header context menu

Returns:: Boolean

setCanRemoveRecords

public void setCanRemoveRecords(Boolean canRemoveRecords)
                         throws IllegalStateException

If set, provide UI for the user to remove records from the grid. This is achieved by rendering an additional field in the listGrid which, when clicked, will remove the record associated with the clicked row via a call to ListGrid.removeData.

If animateRemoveRecord is true, the removed record will appear to shrink out of view when it is removed.

By default the field will display the removeIcon next to each record, and will be rendered as the leftmost column. Two mechanisms exist to further modify this field:

To change the position of the remove-field, include an explicitly specified field with the attribute isRemoveField:true set. This will then be used as the remove field instead of adding a field to the beginning of the set of columns.
Additional direct configuration of the remove field may be achieved by modifying removeFieldProperties.

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

getCanRemoveRecords

public Boolean getCanRemoveRecords()

If animateRemoveRecord is true, the removed record will appear to shrink out of view when it is removed.

By default the field will display the removeIcon next to each record, and will be rendered as the leftmost column. Two mechanisms exist to further modify this field:

To change the position of the remove-field, include an explicitly specified field with the attribute isRemoveField:true set. This will then be used as the remove field instead of adding a field to the beginning of the set of columns.
Additional direct configuration of the remove field may be achieved by modifying removeFieldProperties.

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

setCanReorderFields

public void setCanReorderFields(Boolean canReorderFields)

Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.

Parameters:: canReorderFields - canReorderFields Default value is true
See Also:: Column order Example

getCanReorderFields

public Boolean getCanReorderFields()

Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.

Returns:: Boolean
See Also:: Column order Example

setCanReorderRecords

public void setCanReorderRecords(Boolean canReorderRecords)

Indicates whether records can be reordered by dragging within this listGrid.

Parameters:: canReorderRecords - canReorderRecords Default value is false
See Also:: Drag list (move) Example, Drag reorder Example

getCanReorderRecords

public Boolean getCanReorderRecords()

Indicates whether records can be reordered by dragging within this listGrid.

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

setCanResizeFields

public void setCanResizeFields(Boolean canResizeFields)

Indicates whether fields in this listGrid can be resized by dragging header fields. Setter method for updating canResizeFields at runtime.

Parameters:: canResizeFields - new value for this.canResizeFields. Default value is true
See Also:: Column size Example

getCanResizeFields

public Boolean getCanResizeFields()

Indicates whether fields in this listGrid can be resized by dragging header fields.

Returns:: Boolean
See Also:: Column size Example

setCanSelectAll

public void setCanSelectAll(Boolean canSelectAll)

Controls whether a checkbox for selecting all records appears in the header with selectionAppearance set to "checkbox"

Parameters:: canSelectAll - canSelectAll Default value is null
See Also:: Selection overview and related methods

getCanSelectAll

public Boolean getCanSelectAll()

Controls whether a checkbox for selecting all records appears in the header with selectionAppearance set to "checkbox"

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

setCanSort

public void setCanSort(Boolean canSort)

Enables or disables interactive sorting behavior for this listGrid. Does not affect sorting by direct calls to the sort method.

Parameters:: canSort - canSort Default value is true

getCanSort

public Boolean getCanSort()

Enables or disables interactive sorting behavior for this listGrid. Does not affect sorting by direct calls to the sort method.

Returns:: Boolean

setCellHeight

public void setCellHeight(int cellHeight)

The default height of each row in pixels.

Parameters:: cellHeight - cellHeight Default value is 20
See Also:: Multiline values Example

getCellHeight

public int getCellHeight()

The default height of each row in pixels.

Returns:: int
See Also:: Multiline values Example

setCellPadding

public void setCellPadding(int cellPadding)

The amount of empty space, in pixels, surrounding each value in its cell.

Parameters:: cellPadding - cellPadding Default value is 2

getCellPadding

public int getCellPadding()

The amount of empty space, in pixels, surrounding each value in its cell.

Returns:: int

setCheckboxFieldFalseImage

public 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. If unset, the booleanFalseImage will be used.

Note : This is an advanced setting

Parameters:: checkboxFieldFalseImage - checkboxFieldFalseImage Default value is null

getCheckboxFieldFalseImage

public String getCheckboxFieldFalseImage()

If selectionAppearance is set to "checkbox" this property determines the image to display in the checkbox field for an unselected row. If unset, the booleanFalseImage will be used.

Returns:: String

setCheckboxFieldImageHeight

public void setCheckboxFieldImageHeight(Integer checkboxFieldImageHeight)
                                 throws IllegalStateException

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. If unset, the checkboxField image will be sized to match the booleanImageHeight for this grid.

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

getCheckboxFieldImageHeight

public Integer getCheckboxFieldImageHeight()

Returns:: Integer

setCheckboxFieldImageWidth

public void setCheckboxFieldImageWidth(Integer checkboxFieldImageWidth)
                                throws IllegalStateException

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. If unset, the checkboxField image will be sized to match the booleanImageWidth for this grid.

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

getCheckboxFieldImageWidth

public Integer getCheckboxFieldImageWidth()

Returns:: Integer

setCheckboxFieldPartialImage

public 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. If unset, the booleanPartialImage will be used.

Note : This is an advanced setting

Parameters:: checkboxFieldPartialImage - checkboxFieldPartialImage Default value is null

getCheckboxFieldPartialImage

public String getCheckboxFieldPartialImage()

If selectionAppearance is set to "checkbox" this property determines the image to display in the checkbox field for a partially selected row. If unset, the booleanPartialImage will be used.

Returns:: String

setCheckboxFieldTrueImage

public 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. If unset, the booleanTrueImage will be used.

Note : This is an advanced setting

Parameters:: checkboxFieldTrueImage - checkboxFieldTrueImage Default value is null

getCheckboxFieldTrueImage

public String getCheckboxFieldTrueImage()

If selectionAppearance is set to "checkbox" this property determines the image to display in the checkbox field for a selected row. If unset, the booleanTrueImage will be used.

Returns:: String

setChildExpansionMode

public void setChildExpansionMode(ExpansionMode childExpansionMode)

For expansionModes that show another grid or tree, what the child's expansionMode should be.

Default value null means no further expansion.

Note : This is an advanced setting

Parameters:: childExpansionMode - childExpansionMode Default value is null

getChildExpansionMode

public ExpansionMode getChildExpansionMode()

For expansionModes that show another grid or tree, what the child's expansionMode should be.

Default value null means no further expansion.

Returns:: ExpansionMode

setClearAllSortingText

public 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. This menu-item is displayed only in the context menu for the sorter button.

Parameters:: clearAllSortingText - clearAllSortingText Default value is "Clear All Sorting"

getClearAllSortingText

public String getClearAllSortingText()

Returns:: String

setClearFilterText

public 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. This menu-item is displayed only in the context menu for the sorter button.

Parameters:: clearFilterText - clearFilterText Default value is "Clear Filter"

getClearFilterText

public String getClearFilterText()

Returns:: String

setClearSortFieldText

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

Parameters:: clearSortFieldText - clearSortFieldText Default value is "Clear Sort"

getClearSortFieldText

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

Returns:: String

setConfigureSortText

public void setConfigureSortText(String configureSortText)

If we're showing a headerContextMenu for this grid, and multi-sorting is enabled, this attribute will be shown as the menu item title to show a MultiSortDialog to configure the sort-specification for this grid. This menu-item is displayed only in the context menu for the sorter button.

Parameters:: configureSortText - configureSortText Default value is "Configure Sort"

getConfigureSortText

public String getConfigureSortText()

Returns:: String

setConfirmCancelEditing

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

Parameters:: confirmCancelEditing - confirmCancelEditing Default value is false
See Also:: Editing overview and related methods

getConfirmCancelEditing

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

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

setConfirmDiscardEdits

public void setConfirmDiscardEdits(Boolean confirmDiscardEdits)

For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded. This flag determines whether we should display a confirmation dialog with options to save or discard the edits, or cancel the action in this case.

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

getConfirmDiscardEdits

public Boolean getConfirmDiscardEdits()

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

setConfirmDiscardEditsMessage

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

Parameters:: confirmDiscardEditsMessage - confirmDiscardEditsMessage Default value is "This action will discard all unsaved edited values for this list."
See Also:: Editing overview and related methods

getConfirmDiscardEditsMessage

public String getConfirmDiscardEditsMessage()

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

setDateFormatter

public void setDateFormatter(DateDisplayFormat dateFormatter)

Display format to use for fields specified as type 'date'. Default is to use the system-wide default short date format, configured via Date.setShortDisplayFormat. Specify any valid DateDisplayFormat, or function to change the display format for dates used by this grid. If specified as a function, this function will be executed in the scope of the Date and should return the formatted string.
May also be specified at the field level via displayFormat.
If this field is editable the dateFormatter will also be passed to the editor created to edit this field as displayFormat. In this case you may also need to set dateInputFormat.

Parameters:: dateFormatter - dateFormatter Default value is null
See Also:: Appearance overview and related methods

getDateFormatter

public DateDisplayFormat getDateFormatter()

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

setDatetimeFormatter

public void setDatetimeFormatter(DateDisplayFormat datetimeFormatter)

Display format to use for fields specified as type 'datetime'. Default is to use the system-wide default date time format, configured via Date.setShortDatetimeDisplayFormat. Specify any valid DateDisplayFormat, or function to change the display format for datetimes used by this grid. If specified as a function, this function will be executed in the scope of the Date and should return the formatted string.
May also be specified at the field level via displayFormat.
If this field is editable the dateFormatter will also be passed to the editor created to edit this field as displayFormat. In this case you may also need to set dateInputFormat.

Parameters:: datetimeFormatter - datetimeFormatter Default value is null
See Also:: Appearance overview and related methods

getDatetimeFormatter

public DateDisplayFormat getDatetimeFormatter()

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

setDetailField

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

Note : This is an advanced setting

Parameters:: detailField - detailField Default value is null

getDetailField

public String getDetailField()

The field whose contents to show in the expanded portion of a record when canExpandRecords is true and listGrid.expansionMode is detailField.

Returns:: String

setDiscardEditsSaveButtonTitle

public void setDiscardEditsSaveButtonTitle(String discardEditsSaveButtonTitle)

If confirmDiscardEdits is true this is the title for the save button appearing in the lost edits confirmation dialog. Override this for localization if necessary.

Parameters:: discardEditsSaveButtonTitle - discardEditsSaveButtonTitle Default value is "Save"
See Also:: Editing overview and related methods

getDiscardEditsSaveButtonTitle

public String getDiscardEditsSaveButtonTitle()

If confirmDiscardEdits is true this is the title for the save button appearing in the lost edits confirmation dialog. Override this for localization if necessary.

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

setDragTrackerMode

public void setDragTrackerMode(DragTrackerMode dragTrackerMode)
                        throws IllegalStateException

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.

Note : This is an advanced setting

Parameters:: dragTrackerMode - dragTrackerMode Default value is "icon"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getDragTrackerMode

public DragTrackerMode getDragTrackerMode()

Returns:: DragTrackerMode

setDrawAheadRatio

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

Tweaking drawAheadRatio allows you to make tradeoffs between continuous scrolling speed vs initial render time and render time when scrolling by large amounts.

NOTE: Only applies when showAllRows is false.

Parameters:: drawAheadRatio - drawAheadRatio Default value is 1.3
See Also:: Databound fetch Example

getDrawAheadRatio

public float getDrawAheadRatio()

Returns:: float
See Also:: Databound fetch Example

setDrawAllMaxCells

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

The drawAllMaxCells setting prevents incremental rendering from being used in situations where it's really unnecessary, such as a 40 row, 5 column dataset (only 200 cells) which happens to be in a grid with a viewport showing only 20 or so rows. Incremental rendering causes a brief "flash" during scrolling as the visible portion of the dataset is redrawn, and a better scrolling experience can be obtained in this situation by drawing the entire dataset up front, which in this example would have negligible effect on initial draw time.

drawAllMaxCells:0 disables this features. You may want to disable this feature if performance is an issue and:

you are very frequently redraw a grid
you do a lot of computation when rendering each cell (eg formulas)
you are showing many grids on one screen and the user won't scroll most of them

Note : This is an advanced setting

Parameters:: drawAllMaxCells - drawAllMaxCells Default value is 250

getDrawAllMaxCells

public int getDrawAllMaxCells()

drawAllMaxCells:0 disables this features. You may want to disable this feature if performance is an issue and:

you are very frequently redraw a grid
you do a lot of computation when rendering each cell (eg formulas)
you are showing many grids on one screen and the user won't scroll most of them

Returns:: int

setEditByCell

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

No effect if this.canEdit is false or null.

Parameters:: editByCell - editByCell Default value is null
See Also:: Editing overview and related methods, Edit by cell Example

getEditByCell

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

No effect if this.canEdit is false or null.

Returns:: Boolean
See Also:: Editing overview and related methods, Edit by cell Example

setEditEvent

public void setEditEvent(ListGridEditEvent editEvent)

Event that will trigger inline editing, see ListGridEditEvent for options.

Note this setting has no effect unless canEdit has been set to enable editing.

Parameters:: editEvent - editEvent Default value is "doubleClick"
See Also:: Editing overview and related methods, Edit by row Example

getEditEvent

public ListGridEditEvent getEditEvent()

Event that will trigger inline editing, see ListGridEditEvent for options.

Note this setting has no effect unless canEdit has been set to enable editing.

Returns:: ListGridEditEvent
See Also:: Editing overview and related methods, Edit by row Example

setEditFailedBaseStyle

public 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

Note : This is an advanced setting

Parameters:: editFailedBaseStyle - editFailedBaseStyle Default value is null
See Also:: Appearance overview and related methods

getEditFailedBaseStyle

public String getEditFailedBaseStyle()

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

setEditFailedCSSText

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

Note : This is an advanced setting

Parameters:: editFailedCSSText - editFailedCSSText Default value is "color:red;border:1px solid red;"
See Also:: Appearance overview and related methods

getEditFailedCSSText

public String getEditFailedCSSText()

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

setEditOnFocus

public void setEditOnFocus(Boolean editOnFocus)

Should we start editing when this widget receives focus (if this ListGrid supports editing)?

Note that this property being set to true will cause editing to occur on a single click, even if editEvent is "doubleClick", because single clicking the grid will place keyboard focus there automatically.

Note : This is an advanced setting

Parameters:: editOnFocus - editOnFocus Default value is null
See Also:: Editing overview and related methods

getEditOnFocus

public Boolean getEditOnFocus()

Should we start editing when this widget receives focus (if this ListGrid supports editing)?

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

getEditPendingBaseStyle

public String getEditPendingBaseStyle()
                               throws IllegalStateException

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. If this property is null, cells with pending edits will pick up custom css text to be applied on top of the normal base style from this.editPendingCSSText Note : This method should be called only after the widget has been rendered.

Returns:: String
Throws:: IllegalStateException - if widget has not yet been rendered.
See Also:: Appearance overview and related methods

setEditPendingCSSText

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

Note : This is an advanced setting

Parameters:: editPendingCSSText - editPendingCSSText Default value is "border:color:#0066CC;"
See Also:: Appearance overview and related methods

getEditPendingCSSText

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

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

setEmptyCellValue

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

This is the grid-wide attribute. You may also set the emptyCellValue on a per-field basis.

Parameters:: emptyCellValue - emptyCellValue Default value is " "
See Also:: Empty values Example

getEmptyCellValue

public String getEmptyCellValue()

The value to display for cells whose value is null or the empty string after applying formatCellValue and valueMap (if any).

This is the grid-wide attribute. You may also set the emptyCellValue on a per-field basis.

Returns:: String
See Also:: Empty values Example

setEmptyMessage

public void setEmptyMessage(String emptyMessage)

The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.

Parameters:: emptyMessage - emptyMessage Default value is "No items to show."
See Also:: Empty grid Example

getEmptyMessage

public String getEmptyMessage()

The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.

Returns:: String
See Also:: Empty grid Example

setEmptyMessageStyle

public void setEmptyMessageStyle(String emptyMessageStyle)

The CSS style name applied to the emptyMessage if displayed.

Parameters:: emptyMessageStyle - emptyMessageStyle Default value is "emptyMessage"

getEmptyMessageStyle

public String getEmptyMessageStyle()

The CSS style name applied to the emptyMessage if displayed.

Returns:: String

setEnforceVClipping

public 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. Set enforceVClipping:true to enforce clipping for all types of content on all browsers.

This additional setting is likely to be phased out as browsers improve.

Parameters:: enforceVClipping - enforceVClipping Default value is false

getEnforceVClipping

public Boolean getEnforceVClipping()

This additional setting is likely to be phased out as browsers improve.

Returns:: Boolean

setEnterKeyEditAction

public 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.
"nextRowStart": start editing the first editable cell in the next row.
"done": hide the editor (editing is complete)

Note that if this.autoSaveEdits is true, this may cause a save of the current edit values

Parameters:: enterKeyEditAction - enterKeyEditAction Default value is "done"
See Also:: Editing overview and related methods

getEnterKeyEditAction

public 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.
"nextRowStart": start editing the first editable cell in the next row.
"done": hide the editor (editing is complete)

Note that if this.autoSaveEdits is true, this may cause a save of the current edit values

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

setEnumCriteriaAsInitialValues

public void setEnumCriteriaAsInitialValues(Boolean enumCriteriaAsInitialValues)
                                    throws IllegalStateException

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.

For example, if a ListGrid is showing all Accounts that have status:"Active" and a new row is created, the new row will default to status:"Active" unless this flag is set to false.

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

getEnumCriteriaAsInitialValues

public Boolean getEnumCriteriaAsInitialValues()

For example, if a ListGrid is showing all Accounts that have status:"Active" and a new row is created, the new row will default to status:"Active" unless this flag is set to false.

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

setEscapeKeyEditAction

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

Note that if autoSaveEdits is true, this may cause a save of the current edit values

Parameters:: escapeKeyEditAction - escapeKeyEditAction Default value is "cancel"
See Also:: Editing overview and related methods

getEscapeKeyEditAction

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

Note that if autoSaveEdits is true, this may cause a save of the current edit values

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

setExpansionCanEdit

public void setExpansionCanEdit(Boolean expansionCanEdit)

For expansionModes that show another grid or tree, is that component editable?

The default value for this property is false.

Note : This is an advanced setting

Parameters:: expansionCanEdit - expansionCanEdit Default value is false

getExpansionCanEdit

public Boolean getExpansionCanEdit()

For expansionModes that show another grid or tree, is that component editable?

The default value for this property is false.

Returns:: Boolean

setExpansionFieldFalseImage

public void setExpansionFieldFalseImage(String expansionFieldFalseImage)

If canExpandRecords is set to true, this property determines the image to display in the expansion field for collapsed rows. If unset, the booleanFalseImage will be used.

Note : This is an advanced setting

Parameters:: expansionFieldFalseImage - expansionFieldFalseImage Default value is null

getExpansionFieldFalseImage

public String getExpansionFieldFalseImage()

If canExpandRecords is set to true, this property determines the image to display in the expansion field for collapsed rows. If unset, the booleanFalseImage will be used.

Returns:: String

setExpansionFieldImageHeight

public void setExpansionFieldImageHeight(Integer expansionFieldImageHeight)
                                  throws IllegalStateException

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. If unset, the expansionField image will be sized to match the booleanImageHeight for this grid.

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

getExpansionFieldImageHeight

public Integer getExpansionFieldImageHeight()

Returns:: Integer

setExpansionFieldImageWidth

public void setExpansionFieldImageWidth(Integer expansionFieldImageWidth)
                                 throws IllegalStateException

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. If unset, the expansionField image will be sized to match the booleanImageWidth for this grid.

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

getExpansionFieldImageWidth

public Integer getExpansionFieldImageWidth()

Returns:: Integer

setExpansionFieldTrueImage

public void setExpansionFieldTrueImage(String expansionFieldTrueImage)

If canExpandRecords is set to true, this property determines the image to display in the expansion field for expanded rows. If unset, the booleanTrueImage will be used.

Note : This is an advanced setting

Parameters:: expansionFieldTrueImage - expansionFieldTrueImage Default value is null

getExpansionFieldTrueImage

public String getExpansionFieldTrueImage()

If canExpandRecords is set to true, this property determines the image to display in the expansion field for expanded rows. If unset, the booleanTrueImage will be used.

Returns:: String

setExpansionMode

public void setExpansionMode(ExpansionMode expansionMode)

The ExpansionMode for records in this grid. Default null value means no expansion.

Note : This is an advanced setting

Parameters:: expansionMode - expansionMode Default value is null

getExpansionMode

public ExpansionMode getExpansionMode()

The ExpansionMode for records in this grid. Default null value means no expansion.

Returns:: ExpansionMode

setFastCellUpdates

public void setFastCellUpdates(Boolean fastCellUpdates)
                        throws IllegalStateException

Advanced property to improve performance for dynamic styling of gridRenderer cells at the expense of slightly slower drawing.

fastCellUpdates speeds up the dynamic styling system used by rollovers, selections, and custom styling that calls GridRenderer.refreshCellStyle, at the cost of slightly slower draw() and redraw() times.

This property is enabled by default in Internet Explorer and only has an effect in that browser.

Notes:

If any cell styles specify a a background image URL, the URL will be resolved relative to the page location rather than the location of the CSS stylesheet. This means cell styles with a background URL should either supply a fully qualified path, or the background image media should be made available at a second location for IE.
fastCellUpdates will not work if the styles involved are in an external stylesheet loaded from a remote host. Either the stylesheet containing cell styles needs to be loaded from the same host as the main page, or the cell styles need to be inlined in the html of the bootstrap page.

Also note that this property can effect the baseStyle used for for listGrid bodies. See ListGrid.getBaseStyle. Setter for fastCellUpdates. Has no effect in browsers other than Internet Explorer.

Parameters:: fastCellUpdates - whether to enable fastCellUpdates.. Default value is varies
Throws:: IllegalStateException - this property cannot be changed after the component has been created

setFetchDelay

public 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. If multiple changes are made to the filter within this fetch delay, only the most recent will actually cause a re-filter

Note : This is an advanced setting

Parameters:: fetchDelay - fetchDelay Default value is 300

getFetchDelay

public int getFetchDelay()

Returns:: int

setFieldVisibilitySubmenuTitle

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

Parameters:: fieldVisibilitySubmenuTitle - fieldVisibilitySubmenuTitle Default value is "Columns"

getFieldVisibilitySubmenuTitle

public String getFieldVisibilitySubmenuTitle()

Returns:: String

setFilterByCell

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

Note : This is an advanced setting

Parameters:: filterByCell - filterByCell Default value is null

getFilterByCell

public Boolean getFilterByCell()

Returns:: Boolean

setFilterEditorHeight

public void setFilterEditorHeight(int filterEditorHeight)

Height for the filterEditor, if shown.

Parameters:: filterEditorHeight - filterEditorHeight Default value is 22

getFilterEditorHeight

public int getFilterEditorHeight()

Height for the filterEditor, if shown.

Returns:: int

setFilterOnKeypress

public 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. Can also be set at the field level.

Note : This is an advanced setting

Parameters:: filterOnKeypress - filterOnKeypress Default value is null

getFilterOnKeypress

public Boolean getFilterOnKeypress()

Returns:: Boolean

setFixedFieldWidths

public void setFixedFieldWidths(Boolean fixedFieldWidths)

Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?

If we allow columns to expand, the column width is treated as a minimum.

NOTE: the header does not automatically respond to expanded field widths

Note : This is an advanced setting

Parameters:: fixedFieldWidths - fixedFieldWidths Default value is true

getFixedFieldWidths

public Boolean getFixedFieldWidths()

Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?

If we allow columns to expand, the column width is treated as a minimum.

NOTE: the header does not automatically respond to expanded field widths

Returns:: Boolean

setFixedRecordHeights

public void setFixedRecordHeights(Boolean fixedRecordHeights)

Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?

If we allow rows to expand, the row height as derived from getRowHeight() or the default cellHeight is treated as a minimum.

NOTE: by default, for performance reasons, clipping is not enforced for some kinds of content (such as images) on all browsers. Set enforceVClipping:true to enforce clipping for all types of content on all browsers.

Note : This is an advanced setting

Parameters:: fixedRecordHeights - fixedRecordHeights Default value is true
See Also:: Cell Values Example

getFixedRecordHeights

public Boolean getFixedRecordHeights()

Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?

If we allow rows to expand, the row height as derived from getRowHeight() or the default cellHeight is treated as a minimum.

Returns:: Boolean
See Also:: Cell Values Example

setFreezeFieldText

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

This is a dynamic string - text within \${...} will be evaluated as JS code when the message is displayed, with title available as a variable containing the field title.

Default value returns "Freeze " + the field's summary title.

Note : This is an advanced setting

Parameters:: freezeFieldText - freezeFieldText Default value is "Freeze \${title}"

getFreezeFieldText

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

This is a dynamic string - text within \${...} will be evaluated as JS code when the message is displayed, with title available as a variable containing the field title.

Default value returns "Freeze " + the field's summary title.

Returns:: String

setFreezeOnLeftText

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

Parameters:: freezeOnLeftText - freezeOnLeftText Default value is "Freeze on left"

getFreezeOnLeftText

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

Returns:: String

setFreezeOnRightText

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

Parameters:: freezeOnRightText - freezeOnRightText Default value is "Freeze on right"

getFreezeOnRightText

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

Returns:: String

setFrozenBaseStyle

public 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. If unset, the standard base style will be used for both frozen and unfrozen cells.

Parameters:: frozenBaseStyle - frozenBaseStyle Default value is null
See Also:: Appearance overview and related methods

getFrozenBaseStyle

public String getFrozenBaseStyle()

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

setFrozenHeaderBaseStyle

public void setFrozenHeaderBaseStyle(String frozenHeaderBaseStyle)
                              throws IllegalStateException

If this listGrid contains any frozen fields, this property can be used to apply a custom headerBaseStyle to the frozen set of fields. If unset, the standard headerBaseStyle will be used for both frozen and unfrozen cells.

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

getFrozenHeaderBaseStyle

public String getFrozenHeaderBaseStyle()

Returns:: String
See Also:: GridHeader overview and related methods

setFrozenHeaderTitleStyle

public void setFrozenHeaderTitleStyle(String frozenHeaderTitleStyle)
                               throws IllegalStateException

If this listGrid contains any frozen fields, this property can be used to apply a custom headerTitleStyle to the frozen set of fields. If unset, the standard headerTitleStyle will be used for both frozen and unfrozen cells.

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

getFrozenHeaderTitleStyle

public String getFrozenHeaderTitleStyle()

Returns:: String
See Also:: GridHeader overview and related methods

setGenerateClickOnEnter

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

Note : This is an advanced setting

Parameters:: generateClickOnEnter - generateClickOnEnter Default value is false

getGenerateClickOnEnter

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

Returns:: Boolean

setGenerateClickOnSpace

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

Note : This is an advanced setting

Parameters:: generateClickOnSpace - generateClickOnSpace Default value is true

getGenerateClickOnSpace

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

Returns:: Boolean

setGenerateDoubleClickOnEnter

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

Note : This is an advanced setting

Parameters:: generateDoubleClickOnEnter - generateDoubleClickOnEnter Default value is true

getGenerateDoubleClickOnEnter

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

Returns:: Boolean

setGenerateDoubleClickOnSpace

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

Note : This is an advanced setting

Parameters:: generateDoubleClickOnSpace - generateDoubleClickOnSpace Default value is false

getGenerateDoubleClickOnSpace

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

Returns:: Boolean

setGridSummaryRecordProperty

public void setGridSummaryRecordProperty(String gridSummaryRecordProperty)

If showGridSummary is true, this attribute will be set to true on the record object representing the grid summary row.

Parameters:: gridSummaryRecordProperty - gridSummaryRecordProperty Default value is "isGridSummary"

getGridSummaryRecordProperty

public String getGridSummaryRecordProperty()

If showGridSummary is true, this attribute will be set to true on the record object representing the grid summary row.

Returns:: String

setGroupByMaxRecords

public void setGroupByMaxRecords(int groupByMaxRecords)

Maximum number of records to which a groupBy can be applied. If there are more records, grouping will not be available via the default header context menu, and calls to ListGrid.groupBy will be ignored.

Parameters:: groupByMaxRecords - groupByMaxRecords Default value is 1000

getGroupByMaxRecords

public int getGroupByMaxRecords()

Returns:: int

setGroupByText

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

This is a dynamic string - text within \${...} will be evaluated as JS code when the message is displayed, with title available as a variable containing the field title.

Default value returns "Group by " + the field's summary title.

Note : This is an advanced setting

Parameters:: groupByText - groupByText Default value is "Group by \${title}"

getGroupByText

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

This is a dynamic string - text within \${...} will be evaluated as JS code when the message is displayed, with title available as a variable containing the field title.

Default value returns "Group by " + the field's summary title.

Returns:: 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.
Default implementation evaluates and returns the dynamic groupByText string.

setGroupIcon

public void setGroupIcon(String groupIcon)

The URL of the base icon for the group icons in this treegrid.

Parameters:: groupIcon - groupIcon Default value is "[SKINIMG]/TreeGrid/opener.gif"

getGroupIcon

public String getGroupIcon()

The URL of the base icon for the group icons in this treegrid.

Returns:: String

setGroupIconSize

public void setGroupIconSize(int groupIconSize)

Default width and height of group icons for this ListGrid.

Parameters:: groupIconSize - groupIconSize Default value is 16

getGroupIconSize

public int getGroupIconSize()

Default width and height of group icons for this ListGrid.

Returns:: int

setGroupIndentSize

public void setGroupIndentSize(int groupIndentSize)

Default number of pixels by which to indent subgroups relative to parent group.

Parameters:: groupIndentSize - groupIndentSize Default value is 20

getGroupIndentSize

public int getGroupIndentSize()

Default number of pixels by which to indent subgroups relative to parent group.

Returns:: int

setGroupLeadingIndent

public void setGroupLeadingIndent(int groupLeadingIndent)

Default number of pixels by which to indent all groups.

Parameters:: groupLeadingIndent - groupLeadingIndent Default value is 10

getGroupLeadingIndent

public int getGroupLeadingIndent()

Default number of pixels by which to indent all groups.

Returns:: int

setGroupNodeStyle

public void setGroupNodeStyle(String groupNodeStyle)

The CSS style that group rows will have

Parameters:: groupNodeStyle - groupNodeStyle Default value is "groupNode"

getGroupNodeStyle

public String getGroupNodeStyle()

The CSS style that group rows will have

Returns:: String

setGroupSummaryRecordProperty

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

Parameters:: groupSummaryRecordProperty - groupSummaryRecordProperty Default value is "isGroupSummary"

getGroupSummaryRecordProperty

public String getGroupSummaryRecordProperty()

If showGroupSummary is true, this attribute will be set to true on each record object representing a group-level summary row.

Returns:: String

setGroupSummaryStyle

public void setGroupSummaryStyle(String groupSummaryStyle)
                          throws IllegalStateException

customStyle for the group-level summary row displayed when showGroupSummary is true.

Parameters:: groupSummaryStyle - groupSummaryStyle Default value is "gridSummaryCell"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getGroupSummaryStyle

public String getGroupSummaryStyle()

customStyle for the group-level summary row displayed when showGroupSummary is true.

Returns:: String

setGroupTitleField

public void setGroupTitleField(String groupTitleField)
                        throws IllegalStateException

If set, causes the titles of auto-generated group nodes to appear as though they were values of the designated field instead of as separate rows that span all columns. The normal values of the designated groupTitleField will appear indented under the group title in a manner similar to how a TreeGrid shows a Tree.

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

getGroupTitleField

public String getGroupTitleField()

Returns:: String

setHeaderBackgroundColor

public void setHeaderBackgroundColor(String headerBackgroundColor)

BackgroundColor for the header toolbar. Typically this is set to match the color of the header buttons.

Parameters:: headerBackgroundColor - headerBackgroundColor Default value is "#CCCCCC"
See Also:: GridHeader overview and related methods

getHeaderBackgroundColor

public String getHeaderBackgroundColor()

BackgroundColor for the header toolbar. Typically this is set to match the color of the header buttons.

Returns:: String
See Also:: GridHeader overview and related methods

setHeaderBarStyle

public void setHeaderBarStyle(String headerBarStyle)
                       throws IllegalStateException

Set the CSS style used for the header as a whole.

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

getHeaderBarStyle

public String getHeaderBarStyle()

Set the CSS style used for the header as a whole.

Returns:: String
See Also:: GridHeader overview and related methods

setHeaderBaseStyle

public void setHeaderBaseStyle(String headerBaseStyle)
                        throws IllegalStateException

baseStyle to apply to the buttons in the header, and the sorter, for this ListGrid. Note that, depending on the Class of the header buttons, you may also need to set headerTitleStyle.

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

getHeaderBaseStyle

public String getHeaderBaseStyle()

baseStyle to apply to the buttons in the header, and the sorter, for this ListGrid. Note that, depending on the Class of the header buttons, you may also need to set headerTitleStyle.

Returns:: String
See Also:: GridHeader overview and related methods

setHeaderHeight

public void setHeaderHeight(int headerHeight)

The height of this listGrid's header, in pixels. Modify the height of a listGrid. To hide the header set height to zero.

Parameters:: headerHeight - new height for the header. Default value is 22
See Also:: Sizing overview and related methods

getHeaderHeight

public int getHeaderHeight()

The height of this listGrid's header, in pixels.

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

setHeaderMenuButtonHeight

public void setHeaderMenuButtonHeight(int headerMenuButtonHeight)
                               throws IllegalStateException

If showHeaderMenuButton is true, this property governs the height of the auto-generated headerMenuButton

Note : This is an advanced setting

Parameters:: headerMenuButtonHeight - headerMenuButtonHeight Default value is "100%"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getHeaderMenuButtonHeight

public int getHeaderMenuButtonHeight()

If showHeaderMenuButton is true, this property governs the height of the auto-generated headerMenuButton

Returns:: int

setHeaderMenuButtonIcon

public void setHeaderMenuButtonIcon(String headerMenuButtonIcon)
                             throws IllegalStateException

If showHeaderMenuButton is true, this property governs the icon shown on the auto-generated headerMenuButton

Note : This is an advanced setting

Parameters:: headerMenuButtonIcon - headerMenuButtonIcon Default value is "[SKIN]/ListGrid/sort_descending.gif"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getHeaderMenuButtonIcon

public String getHeaderMenuButtonIcon()

If showHeaderMenuButton is true, this property governs the icon shown on the auto-generated headerMenuButton

Returns:: String

setHeaderMenuButtonIconHeight

public void setHeaderMenuButtonIconHeight(int headerMenuButtonIconHeight)
                                   throws IllegalStateException

If showHeaderMenuButton is true, this property governs the height of the icon shown on the auto-generated headerMenuButton

Note : This is an advanced setting

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

getHeaderMenuButtonIconHeight

public int getHeaderMenuButtonIconHeight()

If showHeaderMenuButton is true, this property governs the height of the icon shown on the auto-generated headerMenuButton

Returns:: int

setHeaderMenuButtonIconWidth

public void setHeaderMenuButtonIconWidth(int headerMenuButtonIconWidth)
                                  throws IllegalStateException

If showHeaderMenuButton is true, this property governs the width of the icon shown on the auto-generated headerMenuButton

Note : This is an advanced setting

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

getHeaderMenuButtonIconWidth

public int getHeaderMenuButtonIconWidth()

If showHeaderMenuButton is true, this property governs the width of the icon shown on the auto-generated headerMenuButton

Returns:: int

setHeaderMenuButtonWidth

public void setHeaderMenuButtonWidth(int headerMenuButtonWidth)
                              throws IllegalStateException

If showHeaderMenuButton is true, this property governs the width of the auto-generated headerMenuButton

Note : This is an advanced setting

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

getHeaderMenuButtonWidth

public int getHeaderMenuButtonWidth()

If showHeaderMenuButton is true, this property governs the width of the auto-generated headerMenuButton

Returns:: int

setHeaderSpanHeight

public void setHeaderSpanHeight(Integer headerSpanHeight)
                         throws IllegalStateException

Default height for a headerSpan with no height specified.

If headerSpanHeight is not specified (the default), headerSpans will be 1/2 of headerHeight.

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

getHeaderSpanHeight

public Integer getHeaderSpanHeight()

Default height for a headerSpan with no height specified.

If headerSpanHeight is not specified (the default), headerSpans will be 1/2 of headerHeight.

Returns:: Integer

setHeaderTitleStyle

public void setHeaderTitleStyle(String headerTitleStyle)
                         throws IllegalStateException

titleStyle to apply to the buttons in the header, and the sorter, for this ListGrid. Note that this will typically only have an effect if headerButtonConstructor is set to StretchImgButton or a subclass thereof.

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

getHeaderTitleStyle

public String getHeaderTitleStyle()

Returns:: String
See Also:: GridHeader overview and related methods

setHoverStyle

public void setHoverStyle(String hoverStyle)

Style to apply to hovers shown over this grid.

Note : This is an advanced setting

Overrides:: setHoverStyle in class Canvas

Parameters:: hoverStyle - hoverStyle Default value is "gridHover"
See Also:: Hovers / Tooltips Example

getHoverStyle

public String getHoverStyle()

Style to apply to hovers shown over this grid.

Overrides:: getHoverStyle in class Canvas

Returns:: String
See Also:: Hovers / Tooltips Example

setImageSize

public void setImageSize(int imageSize)

Default size of thumbnails shown for fieldTypes image and imageFile. Overrideable on a per-field basis via imageSize or imageWidth/imageHeight

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

getImageSize

public int getImageSize()

Default size of thumbnails shown for fieldTypes image and imageFile. Overrideable on a per-field basis via imageSize or imageWidth/imageHeight

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

setIncludeInSummaryProperty

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

Parameters:: includeInSummaryProperty - includeInSummaryProperty Default value is "includeInSummary"

getIncludeInSummaryProperty

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

Returns:: String

setInvalidSummaryValue

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

Note : This is an advanced setting

Parameters:: invalidSummaryValue - invalidSummaryValue Default value is " "

getInvalidSummaryValue

public String getInvalidSummaryValue()

Returns:: String

getIsGrouped

public Boolean getIsGrouped()
                     throws IllegalStateException

True if this listgrid is grouped, false otherwise Note : This method should be called only after the widget has been rendered.

Returns:: Boolean
Throws:: IllegalStateException - if widget has not yet been rendered.

setIsSeparatorProperty

public void setIsSeparatorProperty(String isSeparatorProperty)

If record[this.isSeparatorProperty] is set for some record, the record will be displayed as a simple separator row.

Parameters:: isSeparatorProperty - isSeparatorProperty Default value is "isSeparator"

getIsSeparatorProperty

public String getIsSeparatorProperty()

If record[this.isSeparatorProperty] is set for some record, the record will be displayed as a simple separator row.

Returns:: String

setLeaveScrollbarGap

public void setLeaveScrollbarGap(Boolean leaveScrollbarGap)

Whether to leave a gap for the vertical scrollbar, even when it's not present.

Note that if leaveScrollbarGap is false and vertical scrolling is introduced, fields will be resized to fit the smaller body area if possible, in order to avoid horizontal scrolling also being required.

Parameters:: leaveScrollbarGap - leaveScrollbarGap Default value is true
See Also:: Appearance overview and related methods, Rows Example

getLeaveScrollbarGap

public Boolean getLeaveScrollbarGap()

Whether to leave a gap for the vertical scrollbar, even when it's not present.

Returns:: Boolean
See Also:: Appearance overview and related methods, Rows Example

setLinkTextProperty

public void setLinkTextProperty(String linkTextProperty)

Property name on a record that will hold the link text for that record.
This property is configurable to avoid possible collision with data values in the record.

Parameters:: linkTextProperty - linkTextProperty Default value is "linkText"

getLinkTextProperty

public String getLinkTextProperty()

Property name on a record that will hold the link text for that record.
This property is configurable to avoid possible collision with data values in the record.

Returns:: String

setListEndEditAction

public 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.
"done": hide the editor
"stop": leave focus in the cell being edited
"none": no action

Parameters:: listEndEditAction - listEndEditAction Default value is null
See Also:: Editing overview and related methods, Enter new rows Example

getListEndEditAction

public RowEndEditAction getListEndEditAction()

"next": start editing a new record at the end of the list.
"done": hide the editor
"stop": leave focus in the cell being edited
"none": no action

Returns:: RowEndEditAction
See Also:: Editing overview and related methods, Enter new rows Example

setLoadingDataMessage

public void setLoadingDataMessage(String loadingDataMessage)

The string to display in the body of a listGrid while data is being loaded.

Parameters:: loadingDataMessage - loadingDataMessage Default value is "Loading data..."

getLoadingDataMessage

public String getLoadingDataMessage()

The string to display in the body of a listGrid while data is being loaded.

Returns:: String

setLoadingDataMessageStyle

public void setLoadingDataMessageStyle(String loadingDataMessageStyle)

The CSS style name applied to the loadingDataMessage string if displayed.

Parameters:: loadingDataMessageStyle - loadingDataMessageStyle Default value is "loadingDataMessage"

getLoadingDataMessageStyle

public String getLoadingDataMessageStyle()

The CSS style name applied to the loadingDataMessage string if displayed.

Returns:: String

setLoadingMessage

public void setLoadingMessage(String loadingMessage)
                       throws IllegalStateException

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. The loadingMessage attribute allows you to specify arbitrary html that will be shown in each such "blank" record while the data for that record is loading.

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

getLoadingMessage

public String getLoadingMessage()

Returns:: String

setLocateColumnsBy

public void setLocateColumnsBy(String locateColumnsBy)

When AutoTest.getElement is used to parse locator strings generated by link{isc.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.

Valid options area:

"fieldName" Attempt to identify by fieldName.
"index" Attempt to identify by colNum (index in the fields array).

If unset, default behavior is to identify by fieldName (if available), otherwise by index.

Parameters:: locateColumnsBy - locateColumnsBy Default value is null

getLocateColumnsBy

public String getLocateColumnsBy()

Valid options area:

"fieldName" Attempt to identify by fieldName.
"index" Attempt to identify by colNum (index in the fields array).

If unset, default behavior is to identify by fieldName (if available), otherwise by index.

Returns:: String

setLocateRowsBy

public void setLocateRowsBy(String locateRowsBy)

When AutoTest.getElement is used to parse locator strings generated by link{isc.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.

Valid options area:

"primaryKey" Only applies to databound grids: If the cell in question has a primary key cell value, use it to identify cells in autoTest locator strings.
"titleField" If the cell in question has a value for the titleField, use it to identify cells in autoTest locator strings
"targetCellValue" Identify rows by storing the cell value for the target row / field in autoTest locator strings
"index"The rowNum will be used to identify the row.

If unset, default behavior is to identify by primary key (if available), otherwise by titleField (if available), otherwise by cell value (if available), and lastly by index.

Parameters:: locateRowsBy - locateRowsBy Default value is null

getLocateRowsBy

public String getLocateRowsBy()

Valid options area:

"primaryKey" Only applies to databound grids: If the cell in question has a primary key cell value, use it to identify cells in autoTest locator strings.
"titleField" If the cell in question has a value for the titleField, use it to identify cells in autoTest locator strings
"targetCellValue" Identify rows by storing the cell value for the target row / field in autoTest locator strings
"index"The rowNum will be used to identify the row.

If unset, default behavior is to identify by primary key (if available), otherwise by titleField (if available), otherwise by cell value (if available), and lastly by index.

Returns:: String

setLongTextEditorThreshold

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

Parameters:: longTextEditorThreshold - longTextEditorThreshold Default value is 255
See Also:: Editing overview and related methods

getLongTextEditorThreshold

public int getLongTextEditorThreshold()

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

setLongTextEditorType

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

Parameters:: longTextEditorType - longTextEditorType Default value is "PopUpTextAreaItem"
See Also:: Editing overview and related methods

getLongTextEditorType

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

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

setMaxExpandedRecords

public void setMaxExpandedRecords(Integer maxExpandedRecords)

When canExpandRecords and canExpandMultipleRecords are both true, this property dictates the number of records which can be expanded simultaneously. If the expanded record count hits the value of this property, further attempts to expand records will result in a popup warning (see maxExpandedRecordsPrompt) and expansion will be cancelled.

The default value is null, meaning there is no limit on the number of expanded records.

Note : This is an advanced setting

Parameters:: maxExpandedRecords - maxExpandedRecords Default value is null

getMaxExpandedRecords

public Integer getMaxExpandedRecords()

The default value is null, meaning there is no limit on the number of expanded records.

Returns:: Integer

setMaxExpandedRecordsPrompt

public void setMaxExpandedRecordsPrompt(String maxExpandedRecordsPrompt)
                                 throws IllegalStateException

This is a dynamic string - text within \${...} will be evaluated as JS code when the message is displayed. Note that the local variable count will be available and set to this.maxExpandedRecords. The string will be executed in the scope of the ListGrid so this may also be used to determine other information about this grid.

Default value returns

This grid is limited to [maxExpandedRecords] simultaneously expanded records. Please collapse some expanded records and retry.

Parameters:: maxExpandedRecordsPrompt - maxExpandedRecordsPrompt Default value is "This grid is limited to \${count} simultaneously expanded records. Please collapse some expanded records and retry."
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getMaxExpandedRecordsPrompt

public String getMaxExpandedRecordsPrompt()

Default value returns

This grid is limited to [maxExpandedRecords] simultaneously expanded records. Please collapse some expanded records and retry.

Returns:: String

setMinFieldWidth

public void setMinFieldWidth(int minFieldWidth)

Minimum size, in pixels, for ListGrid headers.

Parameters:: minFieldWidth - minFieldWidth Default value is 10

getMinFieldWidth

public int getMinFieldWidth()

Minimum size, in pixels, for ListGrid headers.

Returns:: int

setModalEditing

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

Note : This is an advanced setting

Parameters:: modalEditing - modalEditing Default value is null
See Also:: Editing overview and related methods, Modal editing Example

getModalEditing

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

Returns:: Boolean
See Also:: Editing overview and related methods, Modal editing Example

setNeverValidate

public void setNeverValidate(Boolean neverValidate)

If true, validation will not occur as a result of cell editing for this grid.

Note : This is an advanced setting

Parameters:: neverValidate - neverValidate Default value is null
See Also:: GridValidation overview and related methods

getNeverValidate

public Boolean getNeverValidate()

If true, validation will not occur as a result of cell editing for this grid.

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

setNormalBaseStyle

public void setNormalBaseStyle(String normalBaseStyle)
                        throws IllegalStateException

"Normal" baseStyle for this listGrid. Only applies if baseStyle is set to null.

If baseStyle is unset, this property will be used as a base cell style if the grid is showing fixed height rows, and the specified cellHeight matches normalCellHeight (and fastCellUpdates is false). Otherwise tallBaseStyle will be used.

Having separate styles defined for fixed vs. variable height rows allows the developer to specify css which is designed to render at a specific height (typically using background images, which won't scale), without breaking support for styling rows of variable height.

Parameters:: normalBaseStyle - normalBaseStyle Default value is "cell"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getNormalBaseStyle

public String getNormalBaseStyle()

"Normal" baseStyle for this listGrid. Only applies if baseStyle is set to null.

Returns:: String

setNormalCellHeight

public 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. Otherwise tallBaseStyle will be used.

Note : This is an advanced setting

Parameters:: normalCellHeight - normalCellHeight Default value is 20

getNormalCellHeight

public int getNormalCellHeight()

Returns:: int

setNullGroupTitle

public void setNullGroupTitle(String nullGroupTitle)

Default alias to use for groups with no value

Parameters:: nullGroupTitle - nullGroupTitle Default value is '-none-'

getNullGroupTitle

public String getNullGroupTitle()

Default alias to use for groups with no value

Returns:: String

setPoolComponentsPerColumn

public void setPoolComponentsPerColumn(Boolean poolComponentsPerColumn)

When recordComponentPoolingMode is "recycle" and you have components of different types in different columns, set this property to true to ensure that components intended for one column are not recycled for use in another column that should have a different component.

If no components applicable to a particular column are available in the pool, the system calls createRecordComponent.

Parameters:: poolComponentsPerColumn - poolComponentsPerColumn Default value is null

getPoolComponentsPerColumn

public Boolean getPoolComponentsPerColumn()

If no components applicable to a particular column are available in the pool, the system calls createRecordComponent.

Returns:: Boolean

setPrintAutoFit

public void setPrintAutoFit(Boolean printAutoFit)

Whether cell contents should wrap during printing. Equivalent to autoFit, but specific to printed output.

Parameters:: printAutoFit - printAutoFit Default value is true
See Also:: Printing overview and related methods

getPrintAutoFit

public Boolean getPrintAutoFit()

Whether cell contents should wrap during printing. Equivalent to autoFit, but specific to printed output.

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

setPrintBaseStyle

public void setPrintBaseStyle(String printBaseStyle)

Style for non-header cells in printed output. Defaults to baseStyle if null.

Parameters:: printBaseStyle - printBaseStyle Default value is null
See Also:: Printing overview and related methods

getPrintBaseStyle

public String getPrintBaseStyle()

Style for non-header cells in printed output. Defaults to baseStyle if null.

Returns:: String
See Also:: Printing overview and related methods

setPrintHeaderStyle

public void setPrintHeaderStyle(String printHeaderStyle)

Style for header cells in printed output. Defaults to headerBaseStyle if null.

Parameters:: printHeaderStyle - printHeaderStyle Default value is "printHeader"
See Also:: Printing overview and related methods

getPrintHeaderStyle

public String getPrintHeaderStyle()

Style for header cells in printed output. Defaults to headerBaseStyle if null.

Returns:: String
See Also:: Printing overview and related methods

setPrintMaxRows

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

For grids with exceptional numbers of columns or complex formatting logic, this number might need to be adjusted downward.

Note : This is an advanced setting

Parameters:: printMaxRows - printMaxRows Default value is 100
See Also:: Printing overview and related methods

getPrintMaxRows

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

For grids with exceptional numbers of columns or complex formatting logic, this number might need to be adjusted downward.

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

setPrintWrapCells

public void setPrintWrapCells(Boolean printWrapCells)

Whether cell contents should wrap during printing. Equivalent to wrapCells, but specific to printed output.

Parameters:: printWrapCells - printWrapCells Default value is true
See Also:: Printing overview and related methods

getPrintWrapCells

public Boolean getPrintWrapCells()

Whether cell contents should wrap during printing. Equivalent to wrapCells, but specific to printed output.

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

setQuickDrawAheadRatio

public 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). If unspecified drawAheadRatio will be used in all cases

Parameters:: quickDrawAheadRatio - quickDrawAheadRatio Default value is 1.0

getQuickDrawAheadRatio

public float getQuickDrawAheadRatio()

Returns:: float

setRecordBaseStyleProperty

public void setRecordBaseStyleProperty(String recordBaseStyleProperty)

This attribute allows custom base styles to be displayed on a per-record basis. To specify a custom base-style for some record set record[listGrid.recordBaseStyleProperty] to the desired base style name - for example if recordBaseStyleProperty is "_baseStyle", set record._baseStyle to the custom base style name.

Note : This is an advanced setting

Parameters:: recordBaseStyleProperty - recordBaseStyleProperty Default value is "_baseStyle"
See Also:: Appearance overview and related methods

getRecordBaseStyleProperty

public String getRecordBaseStyleProperty()

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

setRecordComponentPoolingMode

public void setRecordComponentPoolingMode(RecordComponentPoolingMode recordComponentPoolingMode)

The method of component-pooling to employ for recordComponents.

The default mode is "viewport", which means that recordComponents are destroyed as soon their record leaves the viewport.

For the most efficient implementation, switch to "recycle" mode, which pools components when records leave the viewport and re-uses them in other records. In this mode, you should implement updateRecordComponent() to apply any changes to make reused components applicable to the new record they appear in, if necessary. If you have components of different types in different columns and still want to take advantage of component recycling, you can set poolComponentsPerColumn to ensure that components intended for one column are not recycled for use in another column that should have a different component.

Note that, if different records have distinctly different components embedded in them, or multiple columns in each record embed different components, you should leave the recordComponentPoolingMode at "viewport" if your dataset is very large or use "data" otherwise.

Note : This is an advanced setting

Parameters:: recordComponentPoolingMode - recordComponentPoolingMode Default value is "recycle"

getRecordComponentPoolingMode

public RecordComponentPoolingMode getRecordComponentPoolingMode()

The method of component-pooling to employ for recordComponents.

The default mode is "viewport", which means that recordComponents are destroyed as soon their record leaves the viewport.

Returns:: RecordComponentPoolingMode

setRecordComponentPosition

public void setRecordComponentPosition(EmbeddedPosition recordComponentPosition)

if showRecordComponents is true, how should the component appear within the cell. Valid options are

"within": the component will be rendered inside the record / cell. snapTo may be set to specify where the component should render within the row or cell. Note that if unset, the component will show up at the top/left edge for components embedded within an entire row, or for per-cell components, cell align and valign will be respected.
"expand": the component will be written into the cell below the normal cell content, causing the cell to expand vertically to accomodate it.
null: If this attribute is unset, we will default to showing recordComponents with position "within" if showRecordComponentsByCell is true, otherwise using "expand" logic.

Parameters:: recordComponentPosition - recordComponentPosition Default value is null

getRecordComponentPosition

public EmbeddedPosition getRecordComponentPosition()

if showRecordComponents is true, how should the component appear within the cell. Valid options are

"within": the component will be rendered inside the record / cell. snapTo may be set to specify where the component should render within the row or cell. Note that if unset, the component will show up at the top/left edge for components embedded within an entire row, or for per-cell components, cell align and valign will be respected.
"expand": the component will be written into the cell below the normal cell content, causing the cell to expand vertically to accomodate it.
null: If this attribute is unset, we will default to showing recordComponents with position "within" if showRecordComponentsByCell is true, otherwise using "expand" logic.

Returns:: EmbeddedPosition

setRecordDetailDSProperty

public void setRecordDetailDSProperty(String recordDetailDSProperty)

The name of the ListGridRecord property that specifies the DataSource to use when listGrid.expansionMode is "related". The default is detailDS.

Note : This is an advanced setting

Parameters:: recordDetailDSProperty - recordDetailDSProperty Default value is "detailDS"

getRecordDetailDSProperty

public String getRecordDetailDSProperty()

The name of the ListGridRecord property that specifies the DataSource to use when listGrid.expansionMode is "related". The default is detailDS.

Returns:: String

setRecordEditProperty

public void setRecordEditProperty(String recordEditProperty)

Property name on a record that should be checked to determine whether the record may be edited.
This property is configurable to avoid possible collision with data values in record. With the default setting of "_canEdit", a record can be set non-editable by ensuring record._canEdit == false.
For controlling editability for the entire grid or for a field, set grid.canEdit or field.canEdit.

Note : This is an advanced setting

Parameters:: recordEditProperty - recordEditProperty Default value is "_canEdit"
See Also:: Editing overview and related methods

getRecordEditProperty

public String getRecordEditProperty()

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

setRecordSummaryBaseStyle

public 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

Note : This is an advanced setting

Parameters:: recordSummaryBaseStyle - recordSummaryBaseStyle Default value is "recordSummaryCell"

getRecordSummaryBaseStyle

public 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

Returns:: String

setRemoveFieldTitle

public void setRemoveFieldTitle(String removeFieldTitle)

The title to use for the remove field. Note that this text will appear in the column-picker but the not in the field-header because the removeField has showTitle set to false by default. This can be changed via removeFieldProperties.

Parameters:: removeFieldTitle - removeFieldTitle Default value is "[Remove record]"

getRemoveFieldTitle

public String getRemoveFieldTitle()

Returns:: String

setRemoveIcon

public void setRemoveIcon(String removeIcon)
                   throws IllegalStateException

When canRemoveRecords is enabled, default icon to show in the auto-generated field that allows removing records.

Parameters:: removeIcon - removeIcon Default value is "[SKIN]/actions/remove.png"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getRemoveIcon

public String getRemoveIcon()

When canRemoveRecords is enabled, default icon to show in the auto-generated field that allows removing records.

Returns:: String

setResizeFieldsInRealTime

public void setResizeFieldsInRealTime(Boolean resizeFieldsInRealTime)

True == we redraw the list viewer in real time as fields are being resized. This can be slow with a large list and/or on some platforms.

Note : This is an advanced setting

Parameters:: resizeFieldsInRealTime - resizeFieldsInRealTime Default value is Browser.isIE && isc.Browser.isWin

getResizeFieldsInRealTime

public Boolean getResizeFieldsInRealTime()

True == we redraw the list viewer in real time as fields are being resized. This can be slow with a large list and/or on some platforms.

Returns:: Boolean

setRowEndEditAction

public 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.
"done": hide the editor
"stop": leave focus in the cell being edited
"none": no action

Parameters:: rowEndEditAction - rowEndEditAction Default value is null
See Also:: Editing overview and related methods

getRowEndEditAction

public RowEndEditAction getRowEndEditAction()

"next": start editing the next (or previous) record in the list
"same": put focus back into the first editable field of the same record.
"done": hide the editor
"stop": leave focus in the cell being edited
"none": no action

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

setRowNumberStart

public void setRowNumberStart(int rowNumberStart)

The number to start the row-count from - default value is 1.

Note : This is an advanced setting

Parameters:: rowNumberStart - rowNumberStart Default value is 1

getRowNumberStart

public int getRowNumberStart()

The number to start the row-count from - default value is 1.

Returns:: int

setRowNumberStyle

public void setRowNumberStyle(String rowNumberStyle)

The CSS Style name for the rowNumberField.

Note : This is an advanced setting

Parameters:: rowNumberStyle - rowNumberStyle Default value is "cellDark"

getRowNumberStyle

public String getRowNumberStyle()

The CSS Style name for the rowNumberField.

Returns:: String

setSaveByCell

public void setSaveByCell(Boolean saveByCell)

Whether edits should be saved whenever the user moves between cells in the current edit row.

If unset, defaults to this.editByCell.

To avoid automatic saving entirely, set autoSaveEdits:false.

Parameters:: saveByCell - saveByCell Default value is null
See Also:: Editing overview and related methods

getSaveByCell

public Boolean getSaveByCell()

Whether edits should be saved whenever the user moves between cells in the current edit row.

If unset, defaults to this.editByCell.

To avoid automatic saving entirely, set autoSaveEdits:false.

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

setSaveLocally

public void setSaveLocally(Boolean saveLocally)
                    throws IllegalStateException

For grids with a specified dataSource, this property can be set to true to avoid the grid from attempting to save / retrieve data from the server. In this case the grid's data should be specified as an array via the data attribute, and the datasource will simply act as a schema to describe the set of fields visible in the grid. Inline edits, or removals via the canRemoveRecords mechanism will update the local data array rather than attempting to perform operations against the dataSource.

Note : This is an advanced setting

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

getSaveLocally

public Boolean getSaveLocally()

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

setScrollRedrawDelay

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

Parameters:: scrollRedrawDelay - scrollRedrawDelay Default value is 75

getScrollRedrawDelay

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

Returns:: int

setSelectionAppearance

public void setSelectionAppearance(SelectionAppearance selectionAppearance)

How selection of rows should be presented to the user.

For selectionAppearance:"checkbox" with multiple selection allowed, you would typically use selectionType:"simple" (the default). Because selectionType and selectionAppearance are unrelated, the combination of selectionAppearance:"checkbox" and selectionType:"multiple" results in a grid where multiple selection can only be achieved via shift-click or ctrl-click.

If using "checkbox" for a ListGrid, see also checkboxField for customization APIs.

If using "checkbox" for a TreeGrid, an extra icon, TreeGrid.getExtraIcon is not supported. Additionally only selectionType:"simple" and "single" are supported. Changes selectionAppearance on the fly.

Parameters:: selectionAppearance - new selection appearance. Default value is "rowStyle"
See Also:: Selection overview and related methods

getSelectionAppearance

public SelectionAppearance getSelectionAppearance()

How selection of rows should be presented to the user.

If using "checkbox" for a ListGrid, see also checkboxField for customization APIs.

If using "checkbox" for a TreeGrid, an extra icon, TreeGrid.getExtraIcon is not supported. Additionally only selectionType:"simple" and "single" are supported.

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

setSelectionType

public void setSelectionType(SelectionStyle selectionType)

Defines a listGrid's clickable-selection behavior.

The default selection appearance is governed by selectionAppearance: if selectionAppearance is "checkbox", this will be "simple", otherwise, this will be "multiple". Changes selectionType on the fly.

Parameters:: selectionType - New selection style.. Default value is null
See Also:: Appearance overview and related methods, Multiple select Example

getSelectionType

public SelectionStyle getSelectionType()

Defines a listGrid's clickable-selection behavior.

The default selection appearance is governed by selectionAppearance: if selectionAppearance is "checkbox", this will be "simple", otherwise, this will be "multiple".

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

setSelectOnEdit

public void setSelectOnEdit(Boolean selectOnEdit)

When the user starts editing a row, should the row also be selected?

Note that when this attribute is set to true, other all other rows in the grid will be deselected when a record is selected due to editing.

Note : This is an advanced setting

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

getSelectOnEdit

public Boolean getSelectOnEdit()

When the user starts editing a row, should the row also be selected?

Note that when this attribute is set to true, other all other rows in the grid will be deselected when a record is selected due to editing.

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

setShowAllColumns

public void setShowAllColumns(Boolean showAllColumns)
                       throws IllegalStateException

Whether all columns should be drawn all at once, or only columns visible in the viewport.

Drawing all columns causes longer initial rendering time, but allows smoother horizontal scrolling. With a very large number of columns, showAllColumns will become too slow.

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

getShowAllColumns

public Boolean getShowAllColumns()

Whether all columns should be drawn all at once, or only columns visible in the viewport.

Drawing all columns causes longer initial rendering time, but allows smoother horizontal scrolling. With a very large number of columns, showAllColumns will become too slow.

Returns:: Boolean

setShowAllRecords

public void setShowAllRecords(Boolean showAllRecords)

Whether all rows should be drawn all at once, or only rows visible in the viewport.

Drawing all rows causes longer initial rendering time, but allows smoother vertical scrolling. With a very large number of rows, showAllRows will become too slow.

Parameters:: showAllRecords - showAllRecords Default value is false
See Also:: Rows Example

getShowAllRecords

public Boolean getShowAllRecords()

Returns:: Boolean
See Also:: Rows Example

setShowEmptyMessage

public void setShowEmptyMessage(Boolean showEmptyMessage)

Indicates whether the text of the emptyMessage property should be displayed if no data is available.

Parameters:: showEmptyMessage - showEmptyMessage Default value is true
See Also:: Empty grid Example

getShowEmptyMessage

public Boolean getShowEmptyMessage()

Indicates whether the text of the emptyMessage property should be displayed if no data is available.

Returns:: Boolean
See Also:: Empty grid Example

setShowFilterEditor

public void setShowFilterEditor(Boolean showFilterEditor)

Should this listGrid display a filter row. If true, this ListGrid will be drawn with a single editable row, (separate from the body) with a filter button.

Values entered into this row are used as filter criteria to filter this List's data on enter-keypress or filter button click. autoFetchTextMatchStyle determines the textMatchStyle for the request passed to ListGrid.fetchData.

Note that if ListGrid.filterData or ListGrid.fetchData is called directly while the filter editor is showing, the filter editor values will be updated to reflect the new set of criteria. If you wish to retain the user entered filter criteria and programmatically modify a subset of field values programmatically this can be achieved by deriving new criteria by copying the existing set of criteria and adding other changes - something like this:


   var newCriteria =
 isc.clone(myListGrid.getCriteria());
   isc.addProperties(newCriteria, {
      field1:"new value1",
     
 field2:"new value2"
   });
   myListGrid.setCriteria(newCriteria);

Also note that if you call filterData() and pass in criteria for dataSource fields that are not present in the ListGrid, these criteria will continue to be applied along with the user visible criteria.

filterEditor and advanced criteria: If a developer calls filterData() on a ListGrid and passes in AdvancedCriteria, expected behavior of the filter editor becomes ambiguous, as AdvancedCriteria supports far more complex filter expressions than the ordinary filterEditor is capable of expressing. The default behavior will combine the AdvancedCriteria with the values in the filter editor as follows:

If the top level criteria has operator of type "and":
Each field in the top level criteria array for which a 'canFilter' true field is shown in the listGrid will show up if the specified operator matches the default filter behavior (based on the autoFetchTextMatchStyle).
If the user enters values in the filter editor, these will be combined with the existing AdvancedCriteria by either replacing or adding field level criteria at the top level.
If the top level criteria is a single field-criteria:
If the field shows up in the listGrid and is canFilter:true, it will be displayed to the user (if the operator matches the default filter behavior for the field).
If the user enters new filter criteria in the filterEditor, they will be combined with this existing criterion via a top level "and" operator, or if the user modifies the field for which the criterion already existed, it will be replaced.
Otherwise, if there are multiple top level criteria combined with an "or" operator, these will not be shown in the filter editor. Any filter parameters the user enters will be added to the existing criteria via an additional top level "and" operator, meaning the user will essentially filter a subset of the existing criteria

Setter for the showFilterEditor property. Allows the filter editor to be shown or hidden at runtime.

Parameters:: showFilterEditor - true if the filter editor should be shown, false if it should be hidden. Default value is null
See Also:: Filter Example

getShowFilterEditor

public Boolean getShowFilterEditor()

Should this listGrid display a filter row. If true, this ListGrid will be drawn with a single editable row, (separate from the body) with a filter button.


   var newCriteria =
 isc.clone(myListGrid.getCriteria());
   isc.addProperties(newCriteria, {
      field1:"new value1",
     
 field2:"new value2"
   });
   myListGrid.setCriteria(newCriteria);

If the top level criteria has operator of type "and":
Each field in the top level criteria array for which a 'canFilter' true field is shown in the listGrid will show up if the specified operator matches the default filter behavior (based on the autoFetchTextMatchStyle).
If the user enters values in the filter editor, these will be combined with the existing AdvancedCriteria by either replacing or adding field level criteria at the top level.
If the top level criteria is a single field-criteria:
If the field shows up in the listGrid and is canFilter:true, it will be displayed to the user (if the operator matches the default filter behavior for the field).
If the user enters new filter criteria in the filterEditor, they will be combined with this existing criterion via a top level "and" operator, or if the user modifies the field for which the criterion already existed, it will be replaced.
Otherwise, if there are multiple top level criteria combined with an "or" operator, these will not be shown in the filter editor. Any filter parameters the user enters will be added to the existing criteria via an additional top level "and" operator, meaning the user will essentially filter a subset of the existing criteria

Returns:: Boolean
See Also:: Filter Example

setShowGridSummary

public void setShowGridSummary(Boolean showGridSummary)

Should this ListGrid show a summary row beneath the last record of the grid. This summary row will contain per-field summary information. See showGridSummary and ListGrid.getGridSummaryFunction for details on how the summary value to be displayed for each column will be calculated.

Note that the summaryRow autoChild will be created to actually display the summary row. Setter for the showGridSummary attribute

Parameters:: showGridSummary - new value for this.showGridSummary. Default value is false

getShowGridSummary

public Boolean getShowGridSummary()

Note that the summaryRow autoChild will be created to actually display the summary row.

Returns:: Boolean

setShowGroupSummary

public 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. Summary information will be calculated by the ListGridField.getGroupSummary method if specified, otherwise via the specified summaryFunction.

Parameters:: showGroupSummary - showGroupSummary Default value is false

getShowGroupSummary

public Boolean getShowGroupSummary()

Returns:: Boolean

setShowHeader

public void setShowHeader(Boolean showHeader)

Should we show the header for this ListGrid? Show or hide the ListGrid header.

Parameters:: showHeader - true to show the header, false to hide it.. Default value is true
See Also:: GridHeader overview and related methods

getShowHeader

public Boolean getShowHeader()

Should we show the header for this ListGrid?

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

setShowHeaderContextMenu

public void setShowHeaderContextMenu(Boolean showHeaderContextMenu)
                              throws IllegalStateException

Whether to show a context menu on the header with standard items for showing and hiding fields.

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

getShowHeaderContextMenu

public Boolean getShowHeaderContextMenu()

Whether to show a context menu on the header with standard items for showing and hiding fields.

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

setShowHeaderMenuButton

public void setShowHeaderMenuButton(Boolean showHeaderMenuButton)
                             throws IllegalStateException

If set to true and showHeaderContextMenu is true, the headerMenuButton will be displayed when the user rolls over the header buttons in this grid.

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

getShowHeaderMenuButton

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

Returns:: Boolean

setShowHover

public 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. The contents of the hover is determined by ListGrid.cellHoverHTML.

Overrides:: setShowHover in class Canvas

Parameters:: showHover - showHover Default value is true

getShowHover

public 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. The contents of the hover is determined by ListGrid.cellHoverHTML.

Overrides:: getShowHover in class Canvas

Returns:: Boolean

setShowRecordComponents

public void setShowRecordComponents(Boolean showRecordComponents)

If set to true, this listGrid should create and show an embedded component in every row of the grid.

Developers using this feature should implement the ListGrid.createRecordComponent and ListGrid.updateRecordComponent methods.

createRecordComponent() will be called by the grid to create the record components to use per record. Your implementation should return a component to embed in the record passed in. Note that this method should create and return a new component each time it is called.

This feature also supports reusing components in different rows in the grid. If recordComponentPoolingMode is set to "recycle", components created by the createRecordComponent method will become available for reuse when they are no longer associated with a record. The system will automatically store these in a pool. When a record with no associated component is rendered, if there are any recordComponents in this pool, the system will call ListGrid.updateRecordComponent, and pass in the component. This allows the developer to apply record-specific attributes to an already created component and render it out into the new record. This greatly improves performance for large grids as it allows a small number of components to be created and reused rather than maintaining potentially one record component for every cell in the grid. Setter for the showRecordComponents attribute

Note : This is an advanced setting

Parameters:: showRecordComponents - new value for this.showRecordComponents. Default value is null

getShowRecordComponents

public Boolean getShowRecordComponents()

If set to true, this listGrid should create and show an embedded component in every row of the grid.

Developers using this feature should implement the ListGrid.createRecordComponent and ListGrid.updateRecordComponent methods.

Returns:: Boolean

setShowRollOver

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

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

getShowRollOver

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

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

setShowRollOverCanvas

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

Note : This is an advanced setting

Parameters:: showRollOverCanvas - showRollOverCanvas Default value is null

getShowRollOverCanvas

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

Returns:: Boolean

setShowRowNumbers

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

Note : This is an advanced setting

Parameters:: showRowNumbers - showRowNumbers Default value is null

getShowRowNumbers

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

Returns:: Boolean

setShowSelectedStyle

public void setShowSelectedStyle(Boolean showSelectedStyle)

Should the "Selected" style be applied to selected records?

Parameters:: showSelectedStyle - showSelectedStyle Default value is true

getShowSelectedStyle

public Boolean getShowSelectedStyle()

Should the "Selected" style be applied to selected records?

Returns:: Boolean

setShowSelectionCanvas

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

Note : This is an advanced setting

Parameters:: showSelectionCanvas - showSelectionCanvas Default value is null

getShowSelectionCanvas

public Boolean getShowSelectionCanvas()

Returns:: Boolean

setShowSortArrow

public void setShowSortArrow(SortArrow showSortArrow)

Indicates whether a sorting arrow should appear for the listGrid, and its location. See SortArrow type for details.
Clicking the sort arrow reverses the direction of sorting for the current sort column (if any), or sorts the listGrid by its first sortable column. The arrow image on the button indicates the current direction of sorting. If undefined, the sort arrow will show up in the sorted field, and the corner sort button will be displayed if a vertical scrollbar is being displayed

Parameters:: showSortArrow - showSortArrow Default value is null
See Also:: Appearance overview and related methods

getShowSortArrow

public SortArrow getShowSortArrow()

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

setShowTreeColumnPicker

public void setShowTreeColumnPicker(Boolean showTreeColumnPicker)
                             throws IllegalStateException

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.

If showTreeColumnPicker is false, no column picker will be shown on the headerSpan itself, and the column picker for a clicked on a normal field header will include only normal fields.

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

getShowTreeColumnPicker

public Boolean getShowTreeColumnPicker()

If showTreeColumnPicker is false, no column picker will be shown on the headerSpan itself, and the column picker for a clicked on a normal field header will include only normal fields.

Returns:: Boolean

setShrinkForFreeze

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

Note : This is an advanced setting

Parameters:: shrinkForFreeze - shrinkForFreeze Default value is false
See Also:: FrozenFields overview and related methods

getShrinkForFreeze

public Boolean getShrinkForFreeze()

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

setSingleCellValueProperty

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

Parameters:: singleCellValueProperty - singleCellValueProperty Default value is "singleCellValue"

getSingleCellValueProperty

public String getSingleCellValueProperty()

Returns:: String

setSkinImgDir

public void setSkinImgDir(String skinImgDir)

Where do 'skin' images (those provided with the class) live?

Note : This is an advanced setting

Overrides:: setSkinImgDir in class Canvas

Parameters:: skinImgDir - skinImgDir Default value is "images/ListGrid/"
See Also:: Images overview and related methods

getSkinImgDir

public String getSkinImgDir()

Where do 'skin' images (those provided with the class) live?

Overrides:: getSkinImgDir in class Canvas

Returns:: String
See Also:: Images overview and related methods

setSortAscendingImage

public void setSortAscendingImage(ImgProperties sortAscendingImage)

Image to show when sorting ascending. See ImgProperties for format.

Note : This is an advanced setting

Parameters:: sortAscendingImage - sortAscendingImage Default value is {...}
See Also:: Appearance overview and related methods

getSortAscendingImage

public ImgProperties getSortAscendingImage()

Image to show when sorting ascending. See ImgProperties for format.

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

setSortDescendingImage

public void setSortDescendingImage(ImgProperties sortDescendingImage)

Image to show when sorting descending. See ImgProperties for format.

Note : This is an advanced setting

Parameters:: sortDescendingImage - sortDescendingImage Default value is {...}
See Also:: Appearance overview and related methods

getSortDescendingImage

public ImgProperties getSortDescendingImage()

Image to show when sorting descending. See ImgProperties for format.

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

setSortFieldAscendingText

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

Parameters:: sortFieldAscendingText - sortFieldAscendingText Default value is "Sort Ascending"

getSortFieldAscendingText

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

Returns:: String

setSortFieldDescendingText

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

Parameters:: sortFieldDescendingText - sortFieldDescendingText Default value is "Sort Descending"

getSortFieldDescendingText

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

Returns:: String

setSortNumeralStyle

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

Note : This is an advanced setting

Parameters:: sortNumeralStyle - sortNumeralStyle Default value is "sortNumeral"

getSortNumeralStyle

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

Returns:: String

setStopOnErrors

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

If this property is true, when validation errors occur the errors will be displayed to the user in an alert, and focus will be returned to the first cell to fail validation.

If false, this the cells that failed validation will be silently styled with the editFailedBaseStyle.
Note: stopOnErrors being set to true implies that 'waitForSave' is also true. We will not dismiss the editor until save has completed if stopOnErrors is true.

Note : This is an advanced setting

Parameters:: stopOnErrors - stopOnErrors Default value is false
See Also:: Editing overview and related methods

getStopOnErrors

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

If this property is true, when validation errors occur the errors will be displayed to the user in an alert, and focus will be returned to the first cell to fail validation.

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

setStyleName

public void setStyleName(String styleName)

Default CSS class

Overrides:: setStyleName in class Canvas

Parameters:: styleName - styleName Default value is "listGrid"
See Also:: Appearance overview and related methods

getStyleName

public String getStyleName()

Default CSS class

Overrides:: getStyleName in class Canvas

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

setSummaryRowCriteria

public 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. If unset, and any filter criteria have been specified for the grid, they will be used.

Note : This is an advanced setting

Parameters:: summaryRowCriteria - summaryRowCriteria Default value is null

getSummaryRowCriteria

public Criteria getSummaryRowCriteria()

Returns:: Criteria

setSummaryRowDataSource

public void setSummaryRowDataSource(DataSource summaryRowDataSource)
                             throws IllegalStateException

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

In some cases however it may make sense to calculate summary values on the server and retrieve them via a dataSource fetch. If set, this property specifies a dataSource to fetch against for the summary row. The dataSource should return a single record with summary data for each field for which summary data should be shown. Note that specifying this property completely bypasses the standard client-side grid summary calculation logic.

The fetch may be further customized via summaryRowCriteria and summaryRowFetchRequestProperties

Note : This is an advanced setting

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

getSummaryRowDataSource

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

The fetch may be further customized via summaryRowCriteria and summaryRowFetchRequestProperties

Returns:: DataSource

setSummaryRowHeight

public void setSummaryRowHeight(int summaryRowHeight)
                         throws IllegalStateException

Height for the summary row autoChild.

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

getSummaryRowHeight

public int getSummaryRowHeight()

Height for the summary row autoChild.

Returns:: int

setSummaryRowStyle

public void setSummaryRowStyle(String summaryRowStyle)

baseStyle for the summaryRow

Note : This is an advanced setting

Parameters:: summaryRowStyle - summaryRowStyle Default value is "gridSummaryCell"

getSummaryRowStyle

public String getSummaryRowStyle()

baseStyle for the summaryRow

Returns:: String

setTallBaseStyle

public void setTallBaseStyle(String tallBaseStyle)
                      throws IllegalStateException

"Tall" baseStyle for this listGrid. Only applies if baseStyle is set to null.

If baseStyle is unset, this property will be used as a base cell style unless the grid is showing fixed height rows with a specified cellHeight that matches normalCellHeight, in which case normalBaseStyle will be used.

Parameters:: tallBaseStyle - tallBaseStyle Default value is "cell"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getTallBaseStyle

public String getTallBaseStyle()

"Tall" baseStyle for this listGrid. Only applies if baseStyle is set to null.

Returns:: String

setTrackerImage

public void setTrackerImage(ImgProperties trackerImage)

Default image to use for the dragTracker when things are dragged within or out of this list. See ImgProperties for format.

Note : This is an advanced setting

Parameters:: trackerImage - trackerImage Default value is {...}

getTrackerImage

public ImgProperties getTrackerImage()

Default image to use for the dragTracker when things are dragged within or out of this list. See ImgProperties for format.

Returns:: ImgProperties

setUnfreezeFieldText

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

This is a dynamic string - text within \${...} will be evaluated as JS code when the message is displayed, with title available as a variable containing the field title.

Default value returns "Unfreeze " + the field's summary title.

Note : This is an advanced setting

Parameters:: unfreezeFieldText - unfreezeFieldText Default value is "Unfreeze \$title}"

getUnfreezeFieldText

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

This is a dynamic string - text within \${...} will be evaluated as JS code when the message is displayed, with title available as a variable containing the field title.

Default value returns "Unfreeze " + the field's summary title.

Returns:: String

setUngroupText

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

Parameters:: ungroupText - ungroupText Default value is "Ungroup"

getUngroupText

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

Returns:: String

setUseCellRollOvers

public void setUseCellRollOvers(Boolean useCellRollOvers)

Are rollovers cell-level or row-level?

Parameters:: useCellRollOvers - useCellRollOvers Default value is false

getUseCellRollOvers

public Boolean getUseCellRollOvers()

Are rollovers cell-level or row-level?

Returns:: Boolean

setValidateByCell

public void setValidateByCell(Boolean validateByCell)

Whether client-side validation checks should be performed when the user moves between cells in the current edit row. If unset, defaults to editByCell.

Note that validation always occurs when a row is to be saved, so setting saveByCell:true forces validation on cell transitions. To completely disable automatic validation, set neverValidate:true.

Parameters:: validateByCell - validateByCell Default value is null
See Also:: GridValidation overview and related methods

getValidateByCell

public Boolean getValidateByCell()

Whether client-side validation checks should be performed when the user moves between cells in the current edit row. If unset, defaults to editByCell.

Note that validation always occurs when a row is to be saved, so setting saveByCell:true forces validation on cell transitions. To completely disable automatic validation, set neverValidate:true.

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

setValidateOnChange

public void setValidateOnChange(Boolean validateOnChange)

If true, validation will be performed on each edited cell when each editor's "change" handler is fired.

Parameters:: validateOnChange - validateOnChange Default value is null
See Also:: GridValidation overview and related methods

getValidateOnChange

public Boolean getValidateOnChange()

If true, validation will be performed on each edited cell when each editor's "change" handler is fired.

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

setValueIconHeight

public void setValueIconHeight(Integer valueIconHeight)

Height for value icons for this listGrid. Overrides valueIconSize. Can be overridden at the field level

Parameters:: valueIconHeight - valueIconHeight Default value is null
See Also:: ImageColumns overview and related methods

getValueIconHeight

public Integer getValueIconHeight()

Height for value icons for this listGrid. Overrides valueIconSize. Can be overridden at the field level

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

setValueIconLeftPadding

public void setValueIconLeftPadding(int valueIconLeftPadding)

How much padding should there be on the left of valueIcons by default Can be overridden at the field level

Parameters:: valueIconLeftPadding - valueIconLeftPadding Default value is 2
See Also:: ImageColumns overview and related methods

getValueIconLeftPadding

public int getValueIconLeftPadding()

How much padding should there be on the left of valueIcons by default Can be overridden at the field level

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

setValueIconRightPadding

public void setValueIconRightPadding(int valueIconRightPadding)

How much padding should there be on the right of valueIcons by default

Parameters:: valueIconRightPadding - valueIconRightPadding Default value is 2
See Also:: ImageColumns overview and related methods

getValueIconRightPadding

public int getValueIconRightPadding()

How much padding should there be on the right of valueIcons by default

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

setValueIconSize

public void setValueIconSize(int valueIconSize)

Default width and height of value icons for this ListGrid. Can be overridden at the listGrid level via explicit valueIconWidth and valueIconHeight, or at the field level via valueIconSize, valueIconWidth and {ListGridField.valueIconHeight}

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

getValueIconSize

public int getValueIconSize()

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

setValueIconWidth

public void setValueIconWidth(Integer valueIconWidth)

Width for value icons for this listGrid. Overrides valueIconSize. Can be overridden at the field level

Parameters:: valueIconWidth - valueIconWidth Default value is null
See Also:: ImageColumns overview and related methods

getValueIconWidth

public Integer getValueIconWidth()

Width for value icons for this listGrid. Overrides valueIconSize. Can be overridden at the field level

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

setVirtualScrolling

public void setVirtualScrolling(Boolean virtualScrolling)
                         throws IllegalStateException

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.

virtualScrolling is switched on automatically when fixedRecordHeights is false and when using the recordComponents subsystem, as recordComponents expand the rows that contain them. This flag should be manually enabled when calling ListGrid.addEmbeddedComponent(...) if embedded components can cause record sizes to expand beyond specified cellHeight.

Note : This is an advanced setting

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

getVirtualScrolling

public Boolean getVirtualScrolling()

Returns:: Boolean

setWaitForSave

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

Note : This is an advanced setting

Parameters:: waitForSave - waitForSave Default value is false
See Also:: Editing overview and related methods

getWaitForSave

public Boolean getWaitForSave()

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

setWrapCells

public void setWrapCells(Boolean wrapCells)

Should content within cells be allowed to wrap?

Note : This is an advanced setting

Parameters:: wrapCells - wrapCells Default value is false
See Also:: Cell Values Example

getWrapCells

public Boolean getWrapCells()

Should content within cells be allowed to wrap?

Returns:: Boolean
See Also:: Cell Values Example

addEmbeddedComponent

public void addEmbeddedComponent(Canvas component,
                                 ListGridRecord record)

Attaches the component to the provided record. If position is specified as "within" snapTo may be set to specify where the component will render within the cell or record. If unset, for components embedded within a record we will default to embedding at the top/left coordinate, and for components embedded within a cell, we will respect the align / valign properties for the cell in question. Any percentage sizing will be interpreted as percentage of row size.

Otherwise it will appear to be embedded within the record, underneath the field values.

Embedded components become children of the grid and will stay attached to a record through scrolling, sorting and other operations that cause records to shift position.

If position is set to "expand", embedded components may offer a resize interface, eg, by setting canDragResize:true, and the grid will react accordingly, growing or shrinking the record to match the embedded component's new extents.

Embedded components can be explicitly removed with ListGrid.removeEmbeddedComponent.

If a record is removed from the dataset or is replaced in the dataset, for example, it is eliminated through filtering (removes record) or is successfully edited in a databound grid (replaces record), the component is cleared but not logically removed from the grid. It is the responsibility of code that sets up the embedded component to remove it if the record is removed from the dataSet.

When embedding components will result in variable height records, you should switch on virtualScrolling.

Parameters:: component - component to embed; record - record to attach the component to

addEmbeddedComponent

public void addEmbeddedComponent(Canvas component,
                                 ListGridRecord record,
                                 int rowNum,
                                 int colNum,
                                 EmbeddedPosition position)

Otherwise it will appear to be embedded within the record, underneath the field values.

Embedded components become children of the grid and will stay attached to a record through scrolling, sorting and other operations that cause records to shift position.

Embedded components can be explicitly removed with ListGrid.removeEmbeddedComponent.

When embedding components will result in variable height records, you should switch on virtualScrolling.

Parameters:: component - component to embed; record - record to attach the component to; rowNum - rowNum of the record to attach the component to; colNum - colNum in which to embed the component; position - positioning with respect to the record or cell (Defaults to "expand").

cancelEditing

public void cancelEditing()

Cancel the current edit without saving.

addCellSavedHandler

public HandlerRegistration addCellSavedHandler(CellSavedHandler handler)

Add a cellSaved handler.

Fires after user edits have been successfully saved to the server, when the new value doesn't match the value before editing.

If you want immediate notification of a changes before changes has been saved to the server, implement field.change() or field.changed() instead.

You can supply this method on the listGrid instance or on the listGridField(s) that you want to receive cellChanged events for. If both a field and the listGrid define a cellChanged method and that field receives an edit save, only the one defined on the field is called.

Specified by:: addCellSavedHandler in interface HasCellSavedHandlers

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

addCellClickHandler

public HandlerRegistration addCellClickHandler(CellClickHandler handler)

Add a cellClick handler.

Called when a cell receives a click event.

Specified by:: addCellClickHandler in interface HasCellClickHandlers

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

addCellContextClickHandler

public HandlerRegistration addCellContextClickHandler(CellContextClickHandler handler)

Add a cellContextClick handler.

Called when a cell receives a contextclick event.

Specified by:: addCellContextClickHandler in interface HasCellContextClickHandlers

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

addCellDoubleClickHandler

public HandlerRegistration addCellDoubleClickHandler(CellDoubleClickHandler handler)

Add a cellDoubleClick handler.

Called when a cell receives a double click event.

Specified by:: addCellDoubleClickHandler in interface HasCellDoubleClickHandlers

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

cellHasChanges

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

Parameters:: rowNum - index of row to check for changes; colNum - index of the col to check for changes
Returns:: returns true if the cell has unsaved edits
See Also:: Editing overview and related methods

addCellHoverHandler

public HandlerRegistration addCellHoverHandler(CellHoverHandler handler)

Add a cellHover handler.

Called when the mouse hovers over a cell if this.canHover is true. Returning false will suppress the hover text from being shown if this.showHover is true.

Specified by:: addCellHoverHandler in interface HasCellHoverHandlers

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

addCellMouseDownHandler

public HandlerRegistration addCellMouseDownHandler(CellMouseDownHandler handler)

Add a cellMouseDown handler.

Called when a cell receives a mousedown event.

Specified by:: addCellMouseDownHandler in interface HasCellMouseDownHandlers

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

addCellMouseUpHandler

public HandlerRegistration addCellMouseUpHandler(CellMouseUpHandler handler)

Add a cellMouseUp handler.

Called when a cell receives a mouseup event.

Specified by:: addCellMouseUpHandler in interface HasCellMouseUpHandlers

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

addCellOutHandler

public HandlerRegistration addCellOutHandler(CellOutHandler handler)

Add a cellOut handler.

Called when the mouse pointer leaves a cell

Specified by:: addCellOutHandler in interface HasCellOutHandlers

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

addCellOverHandler

public HandlerRegistration addCellOverHandler(CellOverHandler handler)

Add a cellOver handler.

Called when the mouse pointer enters a cell

Specified by:: addCellOverHandler in interface HasCellOverHandlers

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

clearRowErrors

public void clearRowErrors(int rowNum)

Clear any stored validation errors for some row

Parameters:: rowNum - index of row to clear validation error for

clearSort

public void clearSort()

This method clears any existing sort on this grid by calling ListGrid.setSort with a null parameter. The internal list of SortSpecifiers is removed and the grid is unsorted.

collapseRecord

public void collapseRecord(ListGridRecord record)

Collapses a given record which has been previously expanded using ListGrid.expandRecord.

Parameters:: record - record to collapse

addDataArrivedHandler

public HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)

Add a dataArrived handler.

Notification method fired when new data arrives from the server to be displayed in this ListGrid, (for example in response to the user scrolling a new set of rows into view). Only applies to databound listGrids where the data attribute is a ResultSet. This ResultSet may have been created manually and applied to the grid via a call to ListGrid.setData or may have been created and automatically assigned if ListGrid.fetchData was used to populate the grid. This method is fired directly in response to dataArrived() firing on the data object.

Specified by:: addDataArrivedHandler in interface HasDataArrivedHandlers

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

discardEdits

public void discardEdits(int rowNum,
                         int colNum)

Cancel outstanding edits for the specified rows, discarding edit values, and hiding editors if appropriate.
Note that if this method is called on a new edit row (created via ListGrid.startEditingNew for example), which has not yet been saved, this method will remove the row entirely.

Parameters:: rowNum - Row to cancel; colNum - Column to cancel. Note that this parameter is ignored in ListGrids but may be required in subclasses of ListGrid where each cell represents one record in the data set (EG CubeGrid)

discardEdits

public void discardEdits(int rowNum,
                         int colNum,
                         boolean dontHideEditor)

Parameters:: rowNum - Row to cancel; colNum - Column to cancel. Note that this parameter is ignored in ListGrids but may be required in subclasses of ListGrid where each cell represents one record in the data set (EG CubeGrid); dontHideEditor - By default this method will hide the editor if it is currently showing for the row in question. Passing in this parameter will leave the editor visible (and just reset the edit values underneath the editor).
See Also:: Editing overview and related methods

addDrawAreaChangedHandler

public HandlerRegistration addDrawAreaChangedHandler(DrawAreaChangedHandler handler)

Add a drawAreaChanged handler.

Notification method that fires when the drawArea changes due to scrolling. Receives the previous drawArea co-ordinates as parameters. Call ListGrid.getDrawArea to get the new drawArea co-ordinates.

Specified by:: addDrawAreaChangedHandler in interface HasDrawAreaChangedHandlers

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

addEditCompleteHandler

public HandlerRegistration addEditCompleteHandler(EditCompleteHandler handler)

Add a editComplete handler.

Callback fired when inline edits have been successfully saved.

No default implementation.

Specified by:: addEditCompleteHandler in interface HasEditCompleteHandlers

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

addEditFailedHandler

public HandlerRegistration addEditFailedHandler(EditFailedHandler handler)

Add a editFailed handler.

Called when an attempt to save inline edits fails, due to a validation error or other server error.

The default implementation of editFailed does nothing for normal validation errors, which are displayed before editFailed() is called. For any other errors, the default implementation will call RPCManager.handleError, which by default will result in a warning dialog.

Specified by:: addEditFailedHandler in interface HasEditFailedHandlers

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

addEditorEnterHandler

public HandlerRegistration addEditorEnterHandler(EditorEnterHandler handler)

Add a editorEnter handler.

Callback fired when the user starts editing a new cell.

This callback is typically used to establish dynamic default values via ListGrid.setEditValue or ListGrid.setEditValues.

Can also be overridden on a per-field basis via field.editorEnter.

Specified by:: addEditorEnterHandler in interface HasEditorEnterHandlers

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

addEditorExitHandler

public HandlerRegistration addEditorExitHandler(EditorExitHandler handler)

Add a editorExit handler.

Callback fired when the user attempts to navigate away from the current edit cell, or complete the current edit.

Return false from this method to cancel the default behavior (Saving / cancelling the current edit / moving to the next edit cell).

This callback is typically used to dynamically update values or value maps for related fields (via ListGrid.setEditValue and ListGrid.setEditorValueMap respectively, or to implement custom navigation (via startEditing(rowNum,colNum).

Can be overridden at the field level as field.editorExit.

Specified by:: addEditorExitHandler in interface HasEditorExitHandlers

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

endEditing

public void endEditing()

Complete the current edit by storing the value and hiding the inline editor. Note that if autoSaveEdits is true, the value will be saved to the server.

expandRecord

public void expandRecord(ListGridRecord record)

Expands a given record by creating a subcomponent and inserting it in to the record's grid-row. A number of built-in expansionModes are supported by the default implementation of getExpansionComponent() and you can override that method to provide your own expansion behavior.

Parameters:: record - record to expand

exportData

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

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

Note that data exported via this method does not include any client-side formatting and relies on both the Smart GWT server and server-side DataSources. To export client-data with formatters applied, see exportClientData, which still requires the Smart GWT server but does not rely on server-side DataSources.

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

exportData

public void exportData(DSRequest requestProperties)

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

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

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

addFieldStateChangedHandler

public HandlerRegistration addFieldStateChangedHandler(FieldStateChangedHandler handler)

Add a fieldStateChanged handler.

Notification method executed when columns are resized or reordered, or fields are shown or hidden. Has no default implementation.

Specified by:: addFieldStateChangedHandler in interface HasFieldStateChangedHandlers

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

filterByEditor

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

focusInFilterEditor

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

focusInFilterEditor

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

Parameters:: fieldName - Name of the field to put focus into. If unspecified focus will go to the first field in the editor

getCriteria

public Criteria getCriteria()

Retrieves a copy of the current criteria for this component (may be null)

Returns:: current filter criteria
See Also:: DataBoundComponentMethods overview and related methods

getDragTrackerTitle

public String getDragTrackerTitle(ListGridRecord record,
                                  int rowNum)

Return "title" HTML to display as a drag tracker when the user drags some record.
Default implementation will display the cell value for the title field (see ListGrid.getTitleField) for the record(s) being dragged (including any icons / custom formatting / styling, etc).

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

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

getDrawnRowHeight

public int getDrawnRowHeight(int rowNum)

Get the drawn height of a row.

Parameters:: rowNum -
Returns:: height
See Also:: Sizing overview and related methods

getEventColumn

public int getEventColumn()

Returns the column number of the most recent mouse event.

Returns:: column number, or -2 if beyond last drawn column

getEventColumn

public int getEventColumn(int x)

Returns the column number of the most recent mouse event.

Parameters:: x - optional x-coordinate to obtain column number for, in lieu of the x coordinate of the last mouse event
Returns:: column number, or -2 if beyond last drawn column

getEventRow

public int getEventRow()

Returns the row number of the most recent mouse event.

Returns:: row number, or -2 if beyond last drawn row

getEventRow

public int getEventRow(int y)

Returns the row number of the most recent mouse event.

Parameters:: y - optional y-coordinate to obtain row number, in lieu of the y coordinate of the last mouse event
Returns:: row number, or -2 if beyond last drawn row

getFieldState

public String getFieldState()

Returns a snapshot of the current presentation of this listGrid's fields as a String object.

This object can later be passed to ListGrid.setFieldState to reset this grid's fields to the current state.

Note that the information stored includes the current width and visibility of each of this grid's fields, as well as any formula or summary fields added by the user.

Returns:: current state of this grid's fields.

getFocusRow

public int getFocusRow()

Get the row that currently has keyboard focus. Arrow key navigation moves relative to this row.

Returns:: rowNum of the current focus row

getRecord

public ListGridRecord getRecord(int recordNum)

Return the pointer to a particular record by record number. Synonym for ListGrid.getCellRecord.

Parameters:: recordNum - row index of record to return.
Returns:: Record object for the row.

getRecordIndex

public int getRecordIndex(ListGridRecord record)

Get the index of the provided record.

This is essentially the same as calling listGrid.data.indexOf(record), except that the currently visible range of records is checked first. This is important for responsiveness in functions that respond to user actions when the user is working near the end of a very large dataset (eg 500k records).

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

getSelectedRecord

public 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. To access all selected records, use ListGrid.getSelection instead.

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

getSelectedState

public String getSelectedState()

Returns a snapshot of the current selection within this listGrid as a String 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).

Returns:: current state of this grid's selection

getSortFieldCount

public int getSortFieldCount()

Returns the number of fields involved in this grid's current sort configuration.

Returns:: the number of fields this grid is currently sorted on.

getSortNumeralHTML

public String getSortNumeralHTML(String fieldName)

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. If you don't want sort-numerals in the header-buttons, you can override this method to return null or an empty string.

Parameters:: fieldName - The name of a sort-field to get the sortNumeral HTML for.
Returns:: The HTML for this field's sortNumeral

getSortState

public String getSortState()

Returns a snapshot of the current sort state within this listGrid as a String 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).

Returns:: current sort state for the grid.

getToggleFreezeText

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

Default implementation evaluates and returns freezeFieldText or unfreezeFieldText depending on whether the field is currently frozen.

Parameters:: field - field to get the menu item title for
Returns:: Title to show in the menu item

getViewState

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

Returns:: current view state for the grid.

hasChanges

public Boolean hasChanges()

Whether the grid as a whole has any unsaved edits, in any row.

Returns:: returns true of any unsaved edits are present
See Also:: Editing overview and related methods

hasErrors

public Boolean hasErrors()

Does this grid currently have errors associated with editValues for any row in the grid.

Returns:: true if there are unresolved errors, false otherwise
See Also:: GridValidation overview and related methods

isCheckboxField

public Boolean isCheckboxField(ListGridField field)

Identifies whether the passed-in field is the specially generated checkboxField used when SelectionAppearance is "checkbox". Use this method in your custom event handlers to avoid inappropriately performing actions when the checkboxField is clicked on.

Parameters:: field - field to test
Returns:: whether the provided field is the checkbox field

isExpansionField

public Boolean isExpansionField(ListGridField field)

Identifies whether the passed-in field is the specially generated expansionField used when canExpandRecords is true. Use this method in your custom event handlers to avoid inappropriately performing actions when the expansionField is clicked on.

Parameters:: field - field to test
Returns:: whether the provided field is the expansion field

isPartiallySelected

public Boolean isPartiallySelected(ListGridRecord record)

Returns true if the record is partially selected.

Parameters:: record - record to check
Returns:: true if record is partially selected; false otherwise
See Also:: Selection overview and related methods

isRowNumberField

public Boolean isRowNumberField(ListGridField field)

Identifies whether the passed-in field is the specially generated rowNumberField used when showRowNumbers is true. Use this method in your custom event handlers to avoid inappropriately performing actions when the rowNumberField is clicked on.

Parameters:: field - field to test
Returns:: whether the provided field is the rowNumberField

isSelected

public Boolean isSelected(ListGridRecord record)

Returns true if the record is selected.

Parameters:: record - record to check
Returns:: true if record is selected; false otherwise
See Also:: Selection overview and related methods

isSortField

public Boolean isSortField(String fieldName)

Returns true if the passed fieldName is in the current sort-specification.

Parameters:: fieldName - The name of a field, visible, hidden or existing only in the dataSource
Returns:: True if the passed field is sorted, false otherwise

markForRedraw

public void markForRedraw()

Marks the widget as "dirty" so that it will be added to a queue for redraw. Redraw of dirty components is handled by a looping timer and will after a very short delay (typically less than 100ms). In most cases it is recommended that developers use markForRedraw() instead of calling Canvas.redraw directly. Since this method queues the redraw, multiple calls to markForRedraw() within a single thread of execution will only lead to a single DOM manipulation which greatly improves application performance.

Overrides:: markForRedraw in class Canvas

markForRedraw

public void markForRedraw(String reason)

Overrides:: markForRedraw in class Canvas

Parameters:: reason - reason for performing the redraw
See Also:: Drawing overview and related methods

addRecordClickHandler

public HandlerRegistration addRecordClickHandler(RecordClickHandler handler)

Add a recordClick handler.

Executed when the listGrid receives a 'click' event on an enabled, non-separator record. The default implementation does nothing -- override to perform some action when any record or field is clicked.
A record event handler can be specified either as a function to execute, or as a string of script to evaluate. If the handler is defined as a string of script, all the parameters below will be available as variables for use in the script.
To do something specific if a particular field is clicked, add a recordClick method or string of script to that field (same parameters) when you're setting up the list.
Notes:

This will not be called if the click is below the last item of the list.
This method is called from the default implementation of ListGrid.rowClick, so if that method is overridden this method may not be fired.

Specified by:: addRecordClickHandler in interface HasRecordClickHandlers

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

addRecordDoubleClickHandler

public HandlerRegistration addRecordDoubleClickHandler(RecordDoubleClickHandler handler)

Add a recordDoubleClick handler.

Executed when the listGrid receives a 'doubleClick' event on an enabled, non-separator record. The default implementation does nothing -- override to perform some action when any record or field is double clicked.
A record event handler can be specified either as a function to execute, or as a string of script to evaluate. If the handler is defined as a string of script, all the parameters below will be available as variables for use in the script.
To do something specific if a particular field is double clicked, add a recordDoubleClick method or string of script to that field (same parameters) when you're setting up the list.
Notes:

This will not be called if the click is below the last item of the list.
This method is called from the default implementation of ListGrid.rowDoubleClick, so if that method is overridden this method may not be fired.

Specified by:: addRecordDoubleClickHandler in interface HasRecordDoubleClickHandlers

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

refreshCell

public void refreshCell(int rowNum,
                        int colNum)

Refresh an individual cell without redrawing the grid.

The cell's value, CSS class, and CSS text will be refreshed, to the current values returned by getCellValue(), getCellStyle() and getCellCSSText() respectively.

Parameters:: rowNum - row number of cell to refresh; colNum - column number of cell to refresh

refreshCellStyle

public void refreshCellStyle(int rowNum,
                             int colNum)

Refresh the styling of an individual cell without redrawing the grid.

The cell's CSS class and CSS text will be refreshed, to the current values returned by getCellStyle() and getCellCSSText() respectively.

The cell's contents (as returned by getCellValue()) will not be refreshed. To refresh both styling and contents, call refreshCell() instead.

Parameters:: rowNum - row number of cell to refresh; colNum - column number of cell to refresh

refreshFields

public void refreshFields()

Re-evaluates ListGridField.showIf for each field, dynamically showing and hiding the appropriate set of fields

refreshRow

public void refreshRow(int rowNum)

Refresh an entire row of cells without redrawing the grid.

The cells' values, CSS classes, and CSS text will be refreshed, to the current values returned by getCellValue(), getCellStyle() and getCellCSSText() respectively.

Parameters:: rowNum - row number of cell to refresh

reorderField

public void reorderField(int fieldNum,
                         int moveToPosition)

Reorder a particular field

Parameters:: fieldNum - Number of the field to reorder; moveToPosition - New position for that field

reorderFields

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

Parameters:: start - Start of the range of fields to move, inclusive; end - End of the range of fields to move, non-inclusive; moveDelta - Distance to move by

resizeField

public void resizeField(int fieldNum,
                        int newWidth)

Resize a particular field to a new width.

Parameters:: fieldNum - Number of the field to resize; newWidth - New width of the field

addRowContextClickHandler

public HandlerRegistration addRowContextClickHandler(RowContextClickHandler handler)

Add a rowContextClick handler.

Called when a row receives a contextclick event.

Specified by:: addRowContextClickHandler in interface HasRowContextClickHandlers

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

addRowEditorEnterHandler

public HandlerRegistration addRowEditorEnterHandler(RowEditorEnterHandler handler)

Add a rowEditorEnter handler.

Callback fired when the user starts editing a new row.

Specified by:: addRowEditorEnterHandler in interface HasRowEditorEnterHandlers

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

addRowEditorExitHandler

public HandlerRegistration addRowEditorExitHandler(RowEditorExitHandler handler)

Add a rowEditorExit handler.

Callback fired when the user attempts to navigate away from the current edit row, or complete the current edit.

Return false from this method to cancel the default behavior (Saving / cancelling the current edit / moving to the next edit cell).

Specified by:: addRowEditorExitHandler in interface HasRowEditorExitHandlers

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

rowHasChanges

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

Parameters:: rowNum - index of row to check for changes
Returns:: true if the row has changes.
See Also:: Editing overview and related methods

rowHasErrors

public Boolean rowHasErrors(int rowNum)

Does the specified row have unresolved errors?

Parameters:: rowNum - rowNum to check for errors
Returns:: true if there are unresolved errors, false otherwise
See Also:: GridValidation overview and related methods

addRowHoverHandler

public HandlerRegistration addRowHoverHandler(RowHoverHandler handler)

Add a rowHover handler.

Called when the mouse hovers over a row if this.canHover is true. Returning false will suppress the hover text from being shown if this.showHover is true.

Specified by:: addRowHoverHandler in interface HasRowHoverHandlers

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

addRowMouseDownHandler

public HandlerRegistration addRowMouseDownHandler(RowMouseDownHandler handler)

Add a rowMouseDown handler.

Called when a row receives a mousedown event.

Specified by:: addRowMouseDownHandler in interface HasRowMouseDownHandlers

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

addRowMouseUpHandler

public HandlerRegistration addRowMouseUpHandler(RowMouseUpHandler handler)

Add a rowMouseUp handler.

Called when a row receives a mouseup event.

Specified by:: addRowMouseUpHandler in interface HasRowMouseUpHandlers

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

addRowOutHandler

public HandlerRegistration addRowOutHandler(RowOutHandler handler)

Add a rowOut handler.

Called when the mouse pointer leaves a row

Specified by:: addRowOutHandler in interface HasRowOutHandlers

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

addRowOverHandler

public HandlerRegistration addRowOverHandler(RowOverHandler handler)

Add a rowOver handler.

Called when the mouse pointer enters a row

Specified by:: addRowOverHandler in interface HasRowOverHandlers

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

addSelectionChangedHandler

public HandlerRegistration addSelectionChangedHandler(SelectionChangedHandler handler)

Add a selectionChanged handler.

Called when (row-based) selection changes within this grid. Note this method fires for each record for which selection is modified - so when a user clicks inside a grid this method will typically fire twice (once for the old record being deselected, and once for the new record being selected).

Specified by:: addSelectionChangedHandler in interface HasSelectionChangedHandlers

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

setFieldState

public void setFieldState(String fieldState)

Sets some presentation properties (visibility, width, userFormula and userSummary) of the listGrid fields based on the String object passed in.
Used to restore previous state retrieved from the grid by a call to ListGrid.getFieldState.

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

setHeaderSpanTitle

public void setHeaderSpanTitle(String name,
                               String newTitle)

Update the title of a headerSpan dynamically.

Parameters:: name - name of the headerSpan, as specified via name.; newTitle - new title for the headerSpan

setSelectedState

public void setSelectedState(String selectedState)

Reset this grid's selection to match the String object passed in.
Used to restore previous state retrieved from the grid by a call to ListGrid.getSelectedState.

Parameters:: selectedState - Object describing the desired selection state of the grid

setSortState

public void setSortState(String sortState)

Reset this grid's sort state (sort field and direction or list of SortSpecifiers) to match the String object passed in.
Used to restore previous state retrieved from the grid by a call to ListGrid.getSortState.

Parameters:: sortState - Object describing the desired sort state for the grid.

setViewState

public void setViewState(String viewState)

Reset this grid's view state to match the String object passed in.
Used to restore previous state retrieved from the grid by a call to ListGrid.getViewState.

Parameters:: viewState - Object describing the desired view state for the grid

startEditing

public Boolean startEditing()

Start inline editing at the provided coordinates.

Invoked when a cell is editable and the editEvent occurs on that cell. Can also be invoked explicitly.

If this method is called while editing is already in progress, the value from the current editCell will either be stored locally as a temporary edit value, or saved via 'saveEdits()' depending on this.saveByCell, and the position of the new edit cell.
Will update the UI to show the editor for the new cell, and put focus in it unless explicitly suppressed by the optional suppressFocus parameter.

Returns:: true if we are editing the cell, false if not editing for some reason
See Also:: Editing overview and related methods

startEditing

public Boolean startEditing(int rowNum,
                            int colNum,
                            boolean suppressFocus)

Start inline editing at the provided coordinates.

Invoked when a cell is editable and the editEvent occurs on that cell. Can also be invoked explicitly.

Parameters:: rowNum - Row number of the cell to edit. Defaults to first editable row; colNum - Column number of the cell to edit. Defaults to first editable column; suppressFocus - If passed this parameter suppresses the default behavior of focusing in the edit form item when the editor is shown.
Returns:: true if we are editing the cell, false if not editing for some reason
See Also:: Editing overview and related methods

stopHover

public void stopHover()

Notification that the user is no longer hovering over some cell. Hides the current hover canvas if one is showing.

toggleSort

public void toggleSort(String fieldName)

Toggles the sort-direction of the field with the passed name and resorts the grid.

Parameters:: fieldName - The name of a field, visible, hidden or existing only in the dataSource

ungroup

public void ungroup()

Removes the grouping from the listgrid, restoring its original data

unsort

public void unsort()

Turn sorting off, typically because data has changed and is no longer sorted.

Calling unsort() disables visual indication of which columns are sorted, and calls unsort() on the underlying dataset.

Note that a grid viewing a paged dataset may not be able to support unsort() because the sort order is what establishes the row numbering that allows data to be fetched in batches.

unsort() is automatically called when records are dropped or the sort-configuration is altered.

validateRow

public Boolean validateRow(int rowNum)

Validate the current set of edit values for the row in question.

Called when the user moves to a new edit row, or when an edited record is to be saved if client side validation is enabled for this grid.

This method may also be called directly to perform row level validation at any time.

Parameters:: rowNum - index of row to be validated.
Returns:: returns true if validation was successful (no errors encountered), false otherwise.
See Also:: GridValidation overview and related methods

willFetchData

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

This is equivalent to calling this.data.willFetchData(...). Always returns true if this component is not showing a set of data from the dataSource.

Parameters:: newCriteria - new criteria to test.
Returns:: true if server fetch would be required to satisfy new criteria.
See Also:: DataBoundComponentMethods overview and related methods

willFetchData

public Boolean willFetchData(Criteria newCriteria,
                             TextMatchStyle textMatchStyle)

This is equivalent to calling this.data.willFetchData(...). Always returns true if this component is not showing a set of data from the dataSource.

Parameters:: newCriteria - new criteria to test.; textMatchStyle - New text match style. If not passed assumes textMatchStyle will not be modified.
Returns:: true if server fetch would be required to satisfy new criteria.
See Also:: DataBoundComponentMethods overview and related methods

setDefaultProperties

public static void setDefaultProperties(ListGrid listGridProperties)

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

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

onInit

protected void onInit()

Overrides:: onInit in class Canvas

onInit_ListGrid

protected void onInit_ListGrid()

getRelatedDataSource

public DataSource getRelatedDataSource(ListGridRecord record)

Returns the DataSource containing data related to the passed record. Used when canExpandRecords is true and ExpansionMode is "related". The default implementation returns the DataSource specified in detailDS. Note : This is an override point

Parameters:: record - The record to get the Related dataSource for.
Returns:: The related DataSource for the "record" param

removeEmbeddedComponent

public void removeEmbeddedComponent(ListGridRecord record)

Removes an embedded component previously associated with the provided record. If destroyOnUnEmbed is true for the component, it will also be destroyed.

Parameters:: record - record that the component was previously attached to

removeEmbeddedComponent

public void removeEmbeddedComponent(Canvas component)

Removes an embedded component from a grid. The record in which the component is embedded is automatically derived from the Component passed in. If destroyOnUnEmbed is true for the component, it will also be destroyed.

Parameters:: component - the embedded component

removeEmbeddedComponent

public void removeEmbeddedComponent(ListGridRecord record,
                                    Integer colNum)

Removes an embedded component previously associated with the provided record and colNum. Only applies to components embedded directly in a specific cell. If destroyOnUnEmbed is true for the component, it will also be destroyed.

Parameters:: record - record that the component was previously attached to; colNum - the colNum in which it appears

getRollUnderCanvas

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. Instead typically a single rollUnder canvas should be created and updated to reflect the current rollOver row if necessary.
Note: This is an override point

Parameters:: rowNum - Index of the current roll-over row; colNum - Index of the current roll-over column. This parameter will be null unless useCellRollOvers is true on the grid
Returns:: the embedded component

createRecordComponent

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.

The colNum parameter is applicable only when listGrid.getShowRecordComponentsByCell returns true.
Note: This is an override point

Parameters:: record - record to create a component for; colNum - Column to show the new component in. This parameter will be null unless showRecordComponentsByCell is true on the grid
Returns:: the embedded component

showRecordComponent

protected boolean showRecordComponent(ListGridRecord record,
                                      Integer colNum)

When showRecordComponents is true, return false from this method to prevent showRecordComponent behavior for the passed record. Second parameter will only be passed if showRecordComponentsByCell is true.
Note: This is an override point

Parameters:: record - record being processed; colNum - column index of the cell in which the record component may be shown. Will be null unless showRecordComponentsByCell is true.
Returns:: return false to cancel showRecordComponent behavior

updateRecordComponent

public 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. The colNum parameter is applicable only when showRecordComponentsByCell is true.
Note: This is an override point

Parameters:: record - record to which the passed component applies; colNum - cell to which the passed component applies. This parameter will be null unless showRecordComponentsByCell has been set for this grid; component - the component to update; recordChanged - was the passed component previously embedded in a different record?
Returns:: return the updated embedded component

getRollOverCanvas

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. Instead typically a single rollOver canvas should be created and updated to reflect the current rollOver row if necessary.
Note: This is an override point

Parameters:: rowNum - Index of the current roll-over row; colNum - Index of the current roll-over column. This parameter will be null unless useCellRollOvers is true for the grid
Returns:: the embedded component

canExpandRecord

public boolean canExpandRecord(ListGridRecord record,
                               int rowNum)

Expands a given record by creating a subcomponent and inserting it in to the record's grid-row. A number of built-in ExpansionMode are supported by the default implementation of getExpansionComponent(com.smartgwt.client.widgets.grid.ListGridRecord) and you can override that method to provide more specific expansionComponents.
Note: This is an override point

Parameters:: record - record to work with; rowNum - rowNum of the record to work with
Returns:: true if the record can be expanded

getExpansionComponent

protected Canvas getExpansionComponent(ListGridRecord record)

Gets the embedded-component to show as a given record's expansionComponent. This component is then housed in a VLayout and embedded into a record's row.

By default, this method returns one of a set of builtin components, according the value of expansionMode. You can override this method to return any component you wish to provide as an expansionComponent.
Note: This is an override point

Parameters:: record - record to get the expansionComponent for
Returns:: the embedded component

getGridSummary

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.

The default implementation is as follows:

If this is a databound grid and not all data is loaded, returns null for every field
Otherwise if com.smartgwt.client.widgets.grid.ListGridField#getGridSummary is defined, calls that method passing in the current data set for the grid
If com.smartgwt.client.widgets.grid.ListGridField#getGridSummary is undefined, makes use of the com.smartgwt.client.widgets.grid.ListGrid#getGridSummaryFunction for the field to calculate the summary based on the current data set

This method may be overridden to completely customize the summary value displayed for columns in this grid. An example use case would be when summary information is available on the client and does note need to be calculated directly from the data. Note: this method will not be called if ${isc.DocUtils.linkForRef('listGrid.gridSummaryDataSource')} is specified.

Parameters:: field - field for which the summary value should be returned
Note: This is an override point
Returns:: summary value to display for the specified field.

getCellCSSText

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.

"CSS text" means semicolon-separated style settings, suitable for inclusion in a CSS stylesheet or in a STYLE attribute of an HTML element.
Note: This is an override point

Parameters:: record - cell record as returned by getCellRecord; rowNum - row number for the cell; colNum - column number of the cell
Returns:: CSS text for this cell

canEditCell

protected boolean canEditCell(int rowNum,
                              int colNum)

Can this cell be edited?

The default implementation of canEditCell() respects the various property settings affecting editability: canEdit disables editing for a field, a record with the recordEditProperty set to false is not editable, and disabled records are not editable.

You can override this method to control editability on a cell-by-cell basis. In order to allow complete control over editing, canEditCell() is called very frequently. If you see delays on row to row navigation, check that your implementation is efficient

If you change the editability of a cell on the fly, for example, during com.smartgwt.client.widgets.grid.ListGrid#editorExit on another cell, call refreshCell() to show or hide the editor

If this ListGrid allows new records to be created, canEditCell() may be called when there is no record available. The values input so far by the user are available via getEditValues(int).

Note: This is an override point

Parameters:: rowNum - row number for the cell; colNum - column number of the cell
Returns:: Whether to allow editing this cell

getHeaderContextMenuItems

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.
This method will be called each time the menu is displayed, allowing for dynamic content depending on the current state of the fields.
The default set of menu items will includes menu items for freezing fields, showing and hiding fields, grouping by fields, or other listGrid features
Note: This is an override point

Parameters:: fieldNum - index of the field the user clicked in the fields array. Note: if the user right-clicked the sorter button this parameter will be null.
Returns:: Array of MenuItem

getBaseStyle

protected String getBaseStyle(ListGridRecord record,
                              int rowNum,
                              int colNum)

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 ListGrid.autoSaveEdits) return this value.
Otherwise return record[listGrid.recordBaseStyleProperty], if defined, otherwise field.baseStyle, or finally this.baseStyle

Note: This is an override point

Parameters:: record - the record; rowNum - the row num; colNum - the colum num
Returns:: the CSS class for this cell

setRowNumberFieldProperties

public void setRowNumberFieldProperties(ListGridField rowNumberFieldProperties)

Set the properties generated field that displays the current row number when showRowNumbers is true. For example you can change the default width of the row number column if you have data that exceeds 4 digits to accommodate the width of, say, 10000.

Parameters:: rowNumberFieldProperties - the row number field properties

setSummaryRowFetchRequestProperties

public 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. An example use case might be specifying a ${isc.DocUtils.linkForRef('DSRequest.OperationId')} to perform a custom fetch operation which retrieved only summary values based on criteria.

Note : This is an advanced setting

Parameters:: summaryRowFetchRequestProperties - summaryRowFetchRequestProperties Default value is null

getSummaryRowFetchRequestProperties

public DSRequest getSummaryRowFetchRequestProperties()

Returns:: DSRequest properties

setDateInputFormat

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

As an example - an input format of "MDY" would parse "01/02/1999" to Jan 2nd 1999

Parameters:: dateInputFormat - the dateInputFormat

setFields

public void setFields(ListGridField... fields)

An array of field objects, specifying the order, layout, formatting, and sorting behavior of each field in the listGrid object. In ListGrids, the fields array specifies columns. Each field in the fields array is a ListGridField object. Any listGrid that will display data should have at least one visible field.

If dataSource is also set, this value acts as a set of overrides as explained in fields. Sets the fields array and/or field widths to newFields and sizes, respectively.

If newFields is specified, it is assumed that the new fields may have nothing in common with the old fields, and the component is substantially rebuilt. Consider the following methods for more efficient, more incremental changes: resizeField, reorderField, showField, hideField, setFieldProperty.

Parameters:: fields - array of fields to draw. Default value is null

setDataProperties

public 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

Parameters:: resultSetProperties - the data properties

setData

public void setData(ListGridRecord[] records)

A List of ListGridRecord objects, specifying the data to be used to populate the ListGrid. In ListGrids, the data array specifies rows. Note that ListGrids automatically observe changes to the data List and redraw accordingly.

This property is settable directly only as part of a ListGrid constructor. If you want to change the ListGrid's data after initial creation, call setData(com.smartgwt.client.widgets.grid.ListGridRecord[]).

This property will typically not be explicitly specified for databound ListGrids, where the data is returned from the server via databound component methods such as fetchData(). In this case the data objects will be set to a ResultSet rather than a simple array. Initialize the data object with the given array. Observes methods of the data object so that when the data changes, the listGrid will redraw automatically.

Parameters:: records - data to show in the list. Default value is null

setData

public void setData(Record[] data)

An array of Record objects, specifying the data to be used to populate the DataBoundComponent.

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

setData

public void setData(RecordList data)

An List of Record objects, specifying the data to be used to populate the DataBoundComponent. Note that ListGrids automatically observe changes to the data List and redraw accordingly.

Parameters:: data - List of Records

getDataAsRecordList

public RecordList getDataAsRecordList()

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

Returns:: the data

setRecords

public void setRecords(ListGridRecord[] records)

Synonym for setData(ListGridRecord[])

Parameters:: records - the records

getRecords

public ListGridRecord[] getRecords()

Returns the current set of records displayed in this grid as an array of ListGridRecord objects. Note that if the ListGrid is grouped, you can call getGroupTree() to get the underlying Tree data representation. You can call isGrouped() to test whether the ListGrid is grouped on a field.

If this is a DataBound grid this method will return an empty array unless the entire set of data for the current criteria has been loaded into the client, in which case all matching rows will be returned. For DataBound grids, you can call getResultSet() to retrieve the current data set as a ResultSet object.

Returns:: an array or records.

isGrouped

public boolean isGrouped()

Return true if the ListGrid is grouped on a field.

Returns:: true if grouped

getGroupTree

public Tree getGroupTree()

If the ListGrid is grouped, return the underlying tree structure.

Returns:: the ListGrid group tree

setAutoFitData

public void setAutoFitData(Autofit autoFitData)

Should this ListGrid automatically expand to accomodate its content?

Valid settings are

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

Note that how far the ListGrid will expand may be limited via the following properties: autoFitMaxHeight, autoFitMaxRecords, autoFitMaxWidth, autoFitMaxColumns. Setter for autoFitData.

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

setRecordEnabledProperty

public void setRecordEnabledProperty(String recordEnabledProperty)
                              throws IllegalStateException

Property name on a record that will be checked to determine whether a record is enabled.

Setting this property on a record will effect the visual style and interactivity of the record. If set to false the record (row in a ListGrid or TreeGrid) will not highlight when the mouse moves over it, nor will it respond to mouse clicks.

Parameters:: recordEnabledProperty - recordEnabledProperty Default value is "_enabled"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getRecordEnabledProperty

public String getRecordEnabledProperty()

Property name on a record that will be checked to determine whether a record is enabled.

Returns:: String

getAutoFitData

public Autofit getAutoFitData()

Should this ListGrid automatically expand to accomodate its content?

Valid settings are

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

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

Returns:: String

setSortField

public void setSortField(String fieldName)

Specifies the field by which this grid should be initially sorted.

Parameters:: fieldName - the field Name

getSortField

public String getSortField()

The field by which this grid should be initially sorted.

Returns:: the sort field

setSortField

public void setSortField(int fieldIndex)

Specifies the field by which this grid should be initially sorted. Note that if sortField is initally specified as a number, it will be converted to a string (field name) after list grid initialization.

Parameters:: fieldIndex - the field index

setHeaderSpans

public void setHeaderSpans(HeaderSpan... headerSpans)
                    throws IllegalStateException

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.

A header span can be created by simply naming the fields the header should span. The example below creates a headerSpan that spans the first two fields of the ListGrid.

    isc.ListGrid.create({        headerHeight:40,        fields : [            {
 name:"field1" },            { name:"field2" },            { name:"field3" }        ],        headerSpans : [
       {                 fields: ["field1", "field2"],                title: "Field 1 and 2"            }        ]
    });

Header spans will automatically react to resizing of the headers they span, and will be hidden automatically when all of the spanned fields are hidden.

Header spans appear in the header area of the ListGrid, sharing space with the existing headers, so it's typical to set headerHeight to approximately double its normal height when using headerSpans.

See HeaderSpan for many properties that allow the control of the appearance of headerSpans. Note that headerSpans are created via the AutoChild pattern, hence you can change the Smart GWT component being used, or any of it's properties.

Neither headerSpans themselves nor the fields within them may be drag reordered, but other unspanned headers may be.

Note that headerSpans primarily provide a visual cue for grouping multiple headers together. If you have an OLAP, data "cube" or multi-dimensional data model, the com.smartgwt.client..CubeGrid component is the right choice. Update the headerSpans configuration on the grid dynamically.

Parameters:: headerSpans - same configuration block as that passed to headerSpans.. Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

setGroupByField

public void setGroupByField(String field)
                     throws IllegalStateException

List of fields to group grid records. If only a single field is used, that field may be specified as a string. After initialization, use groupBy(java.lang.String...) to update the grouping field list, instead of modifying groupByField directly.

Parameters:: field - groupByField Default value is see below
Throws:: IllegalStateException - this property cannot be changed after the component has been created

setGroupStartOpen

public void setGroupStartOpen(GroupStartOpen group)

Describes the default state of ListGrid groups when groupBy is called. Possible values are:

"all": open all groups
"first": open the first group
"none": start with all groups closed
Array of values that should be opened

Parameters:: group - the group

setGroupStartOpen

public void setGroupStartOpen(GroupStartOpen... groupValues)

Parameters:: groupValues - Array of values that should be opened

setSelectionUnderCanvasProperties

public void setSelectionUnderCanvasProperties(Canvas selectionUnderCanvasProperties)
                                       throws IllegalStateException

The Selection Under Canvas properties when showSelectionCanvas is true.

Parameters:: selectionUnderCanvasProperties - the selection under Canvas properties
Throws:: IllegalStateException - this property cannot be changed after the component has been created

setShowSelectionCanvas

public void setShowSelectionCanvas(boolean showSelectionCanvas)

setRollUnderCanvasProperties

public void setRollUnderCanvasProperties(Canvas rollUnderCanvasProperties)
                                  throws IllegalStateException

The RollUnder Canvas properties when showRollover is true and showRollOverCanvas is true. This canvas will be created and displayed behind the current rollOver cell in the page's z-order, meaning it will only be visible if the cell styling is transparent.

Parameters:: rollUnderCanvasProperties - the roll under Canvas properties
Throws:: IllegalStateException - this property cannot be changed after the component has been created

setDefaultFields

public void setDefaultFields(ListGridField[] defaultFields)
                      throws IllegalStateException

An array of listGrid field configuration objects. When a listGrid is initialized, if this property is set and there is no value for the fields attribute, this.fields will be defaulted to a generated array of field objects duplicated from this array.

This property is useful for cases where a standard set of fields will be displayed in multiple listGrids - for example a subclass of ListGrid intended to display a particular type of data:
In this example we would not assign a single fields array directly to the class via addProperties() as every generated instance of this class would then point to the same fields array object. This would cause unexpected behavior such as changes to the field order in one grid effecting other grids on the page.
Instead we could use addProperties() on our new subclass to set defaultFields to a standard array of fields to display. Each generated instance of the subclass would then show up with default fields duplicated from this array.

Note : This is an advanced setting

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

getDefaultFields

public ListGridField[] getDefaultFields()

Returns:: Array of ListGridField Properties

getTotalRows

public int getTotalRows()

Return the total number of rows in the grid.

Note that, when creating new rows via inline editing, this can be more than the total number of rows in the dataset (that is, grid.data.getLength())

Returns:: the total rows

scrollToRow

public void scrollToRow(int rowNum)

Scroll to the specified row number.

Parameters:: rowNum - the row num

scrollBodyTo

public void scrollBodyTo(Integer left,
                         Integer top)

Scroll the body of the grid to the scified coordinates.

Parameters:: left - the left position; top - the top position

showField

public void showField(String fieldName)

Force a field to be shown. NOTE: If a field.showIf expression exists, it will be destroyed.

Parameters:: fieldName - the field name

showField

public void showField(String fieldName,
                      boolean suppressRelayout)

Force a field to be shown. NOTE: If a field.showIf expression exists, it will be destroyed.

Parameters:: fieldName - the field name; suppressRelayout - if true, don't relayout non-explicit sized fields to fit the available space

setFieldTitle

public void setFieldTitle(String fieldName,
                          String title)

Change the title of a field after the grid is created.

Parameters:: fieldName - name of the field, or index.; title - new title

setFieldTitle

public void setFieldTitle(int fieldNum,
                          String title)

Change the title of a field after the grid is created.

Parameters:: fieldNum - name of the field, or index.; title - new title

hideField

public void hideField(String fieldName)

Force a field to be hidden. NOTE: If a field.showIf expression exists, it will be destroyed.

Parameters:: fieldName - the field name

hideField

public void hideField(String fieldName,
                      boolean suppressRelayout)

Force a field to be hidden. NOTE: If a field.showIf expression exists, it will be destroyed.

Parameters:: fieldName - the field name; suppressRelayout - if true, don't relayout non-explicit sized fields to fit the available space

startEditingNew

public void startEditingNew()

Start editing a new row, after the last pre-existing record in the current set of data. This new row will be saved via the "add" DataSource operation. If editing is already underway elsewhere in the grid, startEditingNew() behaves just like startEditing().

startEditingNew

public void startEditingNew(Map defaultValues)

Parameters:: defaultValues - the default field values for the new record

getFieldNum

public int getFieldNum(String fieldName)

Given a field or field id, return it's index in the fields array

Parameters:: fieldName - the field name
Returns:: index of the field within this.fields

getFieldName

public String getFieldName(String fieldName)

Given a column number or field id, return the field name of a field.

Parameters:: fieldName - field name
Returns:: Name of the field.

getFieldName

public String getFieldName(int colNum)

Given a column number or field id, return the field name of a field.

Parameters:: colNum - number or id of the field.
Returns:: Name of the field.

getField

public ListGridField getField(String fieldName)

Given a column number or field name, return the field definition.

When using fields, the field definition may be a mix of information derived from fields and dataSource.

Parameters:: fieldName - the field name.
Returns:: field definition

getField

public ListGridField getField(int colNum)

Given a column number or field name, return the field definition.

When using fields, the field definition may be a mix of information derived from fields and dataSource.

Parameters:: colNum - number or id of the field.
Returns:: field definition

getSelection

public ListGridRecord[] getSelection()

The selection associated with the listGrid.

Returns:: the selection

getSelection

public ListGridRecord[] getSelection(boolean excludePartialSelections)

The selection associated with the listGrid.

Parameters:: excludePartialSelections - when true, partially selected records will not be returned. Otherwise, both fully and partially selected records are returned.
Returns:: the selection

getAllFields

public ListGridField[] getAllFields()

Get the complete array of fields for this ListGrid, including fields that are not currently visible or were specified implicitly via dataSource.

This list of fields is only valid once the ListGrid has been BaseWidget.draw() or once setFields(com.smartgwt.client.widgets.grid.ListGridField...) has been called explicitly. If called earlier, only the list of directly specified fields will be returned (the Array passed to create()).

This Array should be treated as read-only. To modify the set of visible fields, use showField(java.lang.String), hideField(java.lang.String) and related APIs. To update properties of individual fields, use com.smartgwt.client.widgets.grid.ListGrid#setFieldProperties or more specific APIs such as setFieldTitle(java.lang.String, java.lang.String).

Returns:: Array of all fields in the ListGrid

getFields

public ListGridField[] getFields()

The ListGrid fields

Returns:: the fields

getEditRow

public int getEditRow()

Returns the index of the row being edited or -1 if there is no current edit row.

Returns:: Index of the current edit row

getEditCol

public int getEditCol()

Returns the index of the column being edited or -1 if there is no edit col.

Returns:: Index of the current edit column

openRecordDetailGrid

public void openRecordDetailGrid(ListGridRecord record,
                                 DataSource detailDataSource)

Deprecated. use setCanExpandRecords(Boolean) with setExpansionMode(com.smartgwt.client.types.ExpansionMode), or override getExpansionComponent(ListGridRecord)

Open the current record detail grid inline,

Parameters:: record - the record; detailDataSource - the detail deta source

closeRecord

public void closeRecord(ListGridRecord record)

Deprecated. use setCanExpandRecords(Boolean) with setExpansionMode(com.smartgwt.client.types.ExpansionMode), or override getExpansionComponent(ListGridRecord)

Close the inline detail grid assoicated with the record.

Parameters:: record - the record

openRecordEditor

public void openRecordEditor(ListGridRecord record)

Deprecated. use setCanExpandRecords(Boolean) with setExpansionMode(com.smartgwt.client.types.ExpansionMode), or override getExpansionComponent(ListGridRecord)

Open the record editor associated with the record.

Parameters:: record - the record

addData

public void addData(Record record)

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

Parameters:: record - new record

addData

public void addData(Record record,
                    DSCallback callback)

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

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

addData

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

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

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

updateData

public void updateData(Record record)

Perform a DataSource "update" operation to update existing records in this component's DataSource.

Parameters:: record - updated record

updateData

public void updateData(Record record,
                       DSCallback callback)

Perform a DataSource "update" operation to update existing records in this component's DataSource.

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

updateData

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

Perform a DataSource "update" operation to update existing records in this component's DataSource.

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

removeData

public void removeData(Record record)

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

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

removeData

public void removeData(Record record,
                       DSCallback callback)

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

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

removeData

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

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

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

removeSelectedData

public void removeSelectedData()

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

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

removeSelectedData

public void removeSelectedData(DSCallback callback,
                               DSRequest requestProperties)

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

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

Parameters:: callback - callback to fire when the data has been removed; requestProperties - additional properties to set on the DSRequest that will be issued

groupBy

public void groupBy(String... fields)

Display the current set of records grouped by their values for the given field or fields. With no arguments, disables all grouping.

Grouping tranforms the current dataset into a Tree on the fly, then provides a familiar tree interface for exploring the grouped data.

Grouping works automatically with any dataset, providing simple default grouping based on each field's declared type. However, you can use the com.smartgwt.client.widgets.grid.ListGridField#getGroupValue API to control how records are grouped, and the com.smartgwt.client.widgets.grid.ListGridField#getGroupTitle API to control how groups are titled.

Grouping can be performed programmatically via this API, or you can set canGroupBy to enable menus that allow the user to performing grouping. To group a grid automatically, instantiate the grid with a groupByField setting.

While grouped, the automatically created Tree is available as groupTree and the original dataset is availabe as originalData.

clearCriteria

public void clearCriteria()

Clear the current criteria used to filter data.

clearCriteria

public void clearCriteria(DSCallback callback,
                          DSRequest requestProperties)

Clear the current criteria used to filter data.

Parameters:: callback - callback to invoke on completion; requestProperties - additional properties to set on the DSRequest that will be issued

fieldIsVisible

public boolean fieldIsVisible(String fieldName)

Check whether a field is currently visible

Parameters:: fieldName - field to be checked
Returns:: true if the field is currently visible, false otherwise

sort

public Boolean sort()

Sort the the data by the first sortable column.

Updates the sortFieldNum and sortDirection to reflect the new sort order of the grid.

Returns:: sorting worked

sort

public 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. If sortFieldNum is not provided and listGrid.sortFieldNum is undefined, the data will be sorted by the first sortable column according to sortDirection if specified, or sortDirection.

Updates the sortFieldNum and sortDirection to reflect the new sort order of the grid.

Parameters:: sortField - the field name to sort by; sortDirection - the direction to sort in
Returns:: sorting worked

sort

public Boolean sort(int sortCol,
                    SortDirection sortDirection)

Updates the sortFieldNum and sortDirection to reflect the new sort order of the grid.

Parameters:: sortCol - the column number to sort by; sortDirection - the direction to sort in
Returns:: sorting worked

saveAllEdits

public void saveAllEdits()

Save a number of outstanding edits for this ListGrid.

saveAllEdits

public void saveAllEdits(Function callback)

Save a number of outstanding edits for this ListGrid.

Parameters:: callback - this callback will be fired on a successful save. Note that if there are no pending edits to be saved this callback will not fire - you can check for this condition using hasChanges() or #rowHasChanges()

saveAllEdits

public void saveAllEdits(Function callback,
                         int[] rows)

Save a number of outstanding edits for this ListGrid.

Parameters:: callback - this callback will be fired on a successful save of the specified rows. Note that if there are no pending edits to be saved this callback will not fire - you can check for this condition using hasChanges() or #rowHasChanges(); rows - specify which rows to save

discardAllEdits

public void discardAllEdits()

Cancel outstanding edits, discarding edit values, and hiding editors for the records.

discardAllEdits

public void discardAllEdits(int[] rows,
                            boolean dontHideEditor)

Cancel outstanding edits, discarding edit values, and hiding editors for the record[s] passed in if appropriate. If no rows are passed in all outstanding edit values will be dropped.

Parameters:: rows - which row(s) to drop edits for; dontHideEditor - By default this method will hide the editor if it is currently showing for any row in the grid. Passing true for this parameter will leave the editor visible (and just reset the edit values underneath the editor)

freezeField

public void freezeField(String fieldName)

Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.

Parameters:: fieldName - the field name

freezeField

public void freezeField(int colNum)

Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.

Parameters:: colNum - the column num

unfreezeField

public void unfreezeField(String fieldName)

Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.

Parameters:: fieldName - the field name

unfreezeField

public void unfreezeField(int colNum)

Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.

Parameters:: colNum - the column num

refreshCell

public void refreshCell(int rowNum,
                        int colNum,
                        boolean refreshingRow,
                        boolean allowEditCellRefresh)

Refresh an individual cell without redrawing the grid.

The cell's value, CSS class, and CSS text will be refreshed, to the current values returned by getCellValue(), getCellStyle() and getCellCSSText() respectively.

Parameters:: rowNum - row number of cell to refresh; colNum - column number of cell to refresh

getVisibleRows

public Integer[] getVisibleRows()

Get the rows that are currently visible in the viewport, as an array of [firstRowNum, lastRowNum]. If the grid contains no records, will return [-1,-1];

Returns:: the visible rows

getDrawArea

public Integer[] getDrawArea()

Returns the extents of the rows and columns current visible in this grid's viewport.

Returns:: The row/col co-ordinates currently visible in the viewport as an array of Integers: [startRow, endRow, startCol, endCol].

getDrawnRows

public Integer[] getDrawnRows()

Get the rows that are currently drawn (exist in the DOM), as an array of [firstRowNum, lastRowNum].

The drawn rows differ from the getVisibleRows() because of drawAheadRatio. The drawn rows are the apppropriate range to consider if you need to, eg, using refreshCell(int, int) to update all the cells in a column.

If the grid is undrawn or the emptyMessage is currently shown, returns [null,null];

Returns:: the drawn rows

fetchRelatedData

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

Relationships between DataSources are declared via DataSourceField.foreignKey.

For example, given a DataSource "orders" and another DataSource "orderItems", where "orderItems" declared a field "orderId" pointing to the primary key field of the "orders" DataSource", there is a set of records from the "orderItems" DataSource related to any given record from the "order" DataSource. If this component were bound to "orderItems" and a record from the "orders".

Parameters:: record - the DataSource record; dataSource - the schema of the DataSource record

fetchRelatedData

public void fetchRelatedData(Record record,
                             DataSource dataSource,
                             DSCallback callback,
                             DSRequest requestProperties)

Relationships between DataSources are declared via DataSourceField.foreignKey.

Parameters:: record - the DataSource record; dataSource - the schema of the DataSource record; callback - callback to invoke on completion; requestProperties - additional properties to set on the DSRequest that will be issued

getGridRenderer

public GridRenderer getGridRenderer()

Return the underlying GridRenderer. Note that this method should only be called after the ListGrid has been drawn. Calling it prior to it being rendered will return a null value. If you need to attach listeners to the GridRenderer at ListGrid configuration time, then add a BaseWidget.addDrawHandler(com.smartgwt.client.widgets.events.DrawHandler) for the ListGrid and access the GridRenderer from within the callback.

Returns:: the grid renderer

getEditedCell

public Object getEditedCell(int rowNum,
                            String fieldName)

Returns the current value of a cell. If the cell has an outstanding edit value, this will be returned, otherwise the underlying value of the record will be returned.

Parameters:: rowNum - the row number; fieldName - the field name
Returns:: the edited cell value

getEditedCell

public Object getEditedCell(int rowNum,
                            int colNum)

Returns the current value of a cell. If the cell has an outstanding edit value, this will be returned, otherwise the underlying value of the record will be returned.

Parameters:: rowNum - the row number; colNum - the column number
Returns:: the edited cell value

getEditedCell

public Object getEditedCell(Record record,
                            String fieldName)

Returns the current value of a cell. If the cell has an outstanding edit value, this will be returned, otherwise the underlying value of the record will be returned.

Parameters:: record - an Object containing values for all the record's primary keys; fieldName - the field name
Returns:: the edited cell value

getEditedCell

public Object getEditedCell(Record record,
                            int colNum)

Returns the current value of a cell. If the cell has an outstanding edit value, this will be returned, otherwise the underlying value of the record will be returned.

Parameters:: record - an Object containing values for all the record's primary keys; colNum - the column number
Returns:: the edited cell value

getEditedRecord

public Record getEditedRecord(int rowNum)

Returns the combination of unsaved edits (if any) and original values (if any) for a given row being edited.

The returned value is never null, and can be freely modified.

Parameters:: rowNum - the row num
Returns:: A copy of the record with unsaved edits included

getEditValue

public Object getEditValue(int rowNum,
                           int colNum)

Returns the current temporary locally stored edit value for some field within a record being edited.

Parameters:: rowNum - index of the row for which the editValue should be returned; colNum - index of the field for which value should be returned
Returns:: edit value for the field in question

setEditValue

public void setEditValue(int rowNum,
                         int colNum,
                         String value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; colNum - column number of cell; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         int colNum,
                         Date value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; colNum - column number of cell; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         int colNum,
                         double value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; colNum - column number of cell; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         int colNum,
                         boolean value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; colNum - column number of cell; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         int colNum,
                         float value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; colNum - column number of cell; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         int colNum,
                         int value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; colNum - column number of cell; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         String fieldName,
                         String value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; fieldName - the field name; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         String fieldName,
                         Date value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; fieldName - the field name; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         String fieldName,
                         double value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; fieldName - the field name; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         String fieldName,
                         boolean value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; fieldName - the field name; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         String fieldName,
                         float value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; fieldName - the field name; value - new value for the appropriate field

setEditValue

public void setEditValue(int rowNum,
                         String fieldName,
                         int value)

Modifies a field value being tracked as an unsaved user edit.

Parameters:: rowNum - row number; fieldName - the field name; value - new value for the appropriate field

setEditValues

public void setEditValues(int rowNum,
                          Map values)

This method sets up a set of editValues for some row / cell. It differs from setEditValue in that:

it takes values for multiple fields
it clears out any previous edit values for the record

Parameters:: rowNum - the row num for the record being edited; values - new values for the row

getEditValue

public Object getEditValue(int rowNum,
                           String fieldName)

Returns the current temporary locally stored edit value for some field within a record being edited.

Parameters:: rowNum - index of the row for which the editValue should be returned; fieldName - field name for which value should be returned
Returns:: edit value for the field in question

getEditValues

public Map getEditValues(int rowNum)

Returns the current set of unsaved edits for a given row being edited.

Parameters:: rowNum - rowNum of the record being edited
Returns:: current editValues object for the row. This contains the current edit values in {fieldName1:value1, fieldName2:value2} format

getEditValues

public Map getEditValues(Record record)

Returns the current set of unsaved edits for a given row being edited.

Parameters:: record - an Object containing values for all the record's primary keys
Returns:: current editValues object for the row. This contains the current edit values in {fieldName1:value1, fieldName2:value2} format

setRowErrors

public void setRowErrors(int rowNum,
                         Map errors)

Set the validation errors for some row (replacing any pre-existant validation errors)

Parameters:: rowNum - row to add validation error for; errors - validation errors for the row. The key of the map must be the field name, and the value can either be a String error message or an array of Strings for multiple errors

setFieldError

public void setFieldError(int rowNum,
                          String fieldName,
                          String errorMessage)

Set a validation error for some cell.

Parameters:: rowNum - row index of cell to add validation error for; fieldName - field name of cell to add validation error for; errorMessage - validation error message

setFieldError

public void setFieldError(int rowNum,
                          String fieldName,
                          String[] errorMessages)

Set a validation error for some cell.

Parameters:: rowNum - row index of cell to add validation error for; fieldName - field name of cell to add validation error for; errorMessages - validation error messages

selectSingleRecord

public void selectSingleRecord(Record record)

Select a single Record passed in explicitly, or by index, and deselect everything else. When programmatic selection of records is a requirement and selectionType is "single", use this method rather than selectRecord(com.smartgwt.client.data.Record) to enforce mutually-exclusive record-selection.

Parameters:: record - record to select

selectSingleRecord

public void selectSingleRecord(int rowNum)

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

getFormulaFieldValue

public int getFormulaFieldValue(ListGridField field,
                                Record record)

Get the computed value of a canAddFormulaFields.

Parameters:: field - field that has a formula; record - record to use to compute formula value
Returns:: formula result

getSummaryFieldValue

public int getSummaryFieldValue(ListGridField field,
                                Record record)

Get the computed value of a canAddSummaryFields.

Parameters:: field - field that has a summary format; record - record to use to compute formula value
Returns:: formula result

getRowErrors

public Map getRowErrors(int rowNum)

Returns any currently stored validation errors for this row

Parameters:: rowNum - the index of row to check for validation errors
Returns:: map of validation errors. If no validation errors stored for the row, null is returned

getCellErrors

public String[] getCellErrors(int rowNum,
                              String fieldName)

Returns the current set of errors for this cell.

Parameters:: rowNum - the index of row to check for validation errors; fieldName - field to check for validation errors
Returns:: array of error messages (strings) for the specified cell. If no validation errors are present, returns null.

setSortDirection

public void setSortDirection(SortDirection sortDirection)

Sorting direction of this ListGrid. If specified when the ListGrid is initialized, this property will be the default sorting direction for the sortField. May be overridden by specifying sortDirection.

After initialization, this property will be updated on sort() to reflect the current sort direction of the grid.

Parameters:: sortDirection - sortDirection Default value is SortDirection.ASCENDING

getSortDirection

public SortDirection getSortDirection()

After initialization, this property will be updated on sort() to reflect the current sort direction of the grid.

Returns:: sort direction Default value is SortDirection.ASCENDING

setCriteria

public void setCriteria(Criteria criteria)

Sets this component's filter criteria. Default implementation calls this.data.setCriteria()

Parameters:: criteria - new criteria to show

setFilterEditorCriteria

public void setFilterEditorCriteria(Criteria criteria)

If showFilterEditor is true, this method will update the criteria shown in the filterEditor without performing a filter.

Parameters:: criteria - New criteria to show

getFilterEditorCriteria

public Criteria getFilterEditorCriteria()

If showFilterEditor is true, this method will return the criteria currently displayed in the filterEditor. Note that these values may differ from the criteria returned by getCriteria() if the filter editor values have been modified without performing an actual filter.

Returns:: criteria currently displayed in the filterEditor

validateCell

public Boolean validateCell(int rowNum,
                            String fieldName)

Validate the current edit value for the cell in question. Called when the user moves to a new edit cell if validateByCell is true.
This method may also be called directly to perform cell level validation at any time.

Parameters:: rowNum - index of row to be validated.; fieldName - field name of field to be validated
Returns:: returns true if validation was successful (no errors encountered), false otherwise.

validateCell

public Boolean validateCell(int rowNum,
                            int colIndex)

Parameters:: rowNum - index of row to be validated.; colIndex - column index of field to be validated
Returns:: returns true if validation was successful (no errors encountered), false otherwise.

cellHasErrors

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

Parameters:: rowNum - index of row to check for validation errors; fieldName - name of field to check for validation errors
Returns:: true if we have validation errors for the row/col in question

cellHasErrors

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

Parameters:: rowNum - index of row to check for validation errors; colIndex - index of column to check for validation errors
Returns:: true if we have validation errors for the row/col in question

clearFieldError

public void clearFieldError(int rowNum,
                            String fieldName)

Clears any validation errors for some cell.

Parameters:: rowNum - row index of cell to add validation error for; fieldName - field name of cell to add validation error for

clearFieldError

public void clearFieldError(int rowNum,
                            int colIndex)

Clears any validation errors for some cell.

Parameters:: rowNum - row index of cell to add validation error for; colIndex - col index of cell to add validation error for

setValueMap

public void setValueMap(String fieldName,
                        LinkedHashMap valueMap)

Set the value map for a field. See also the com.smartgwt.client.widgets.grid.ListGrid#setEditorValueMap and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap methods which allow further customization of the valueMap displayed while the field is in edit mode.

Parameters:: fieldName - Name of field to update; valueMap - ValueMap for the field

setValueMap

public void setValueMap(String fieldName,
                        String... valueMap)

Parameters:: fieldName - Name of field to update; valueMap - ValueMap for the field

clearEditValue

public void clearEditValue(int rowNum,
                           String fieldName)

Clear a field value being tracked as an unsaved user edit.

The saved record value will be displayed in the the appropriate cell instead. Will also discard any validation errors for the specified field / row.

Parameters:: rowNum - the row number; fieldName - name of field for which the value is to be cleared

getAllEditRows

public int[] getAllEditRows()

Returns an array of every rowNum for which we have pending (unsubmitted) edits.

Returns:: array of rowNums for rows with edit values pending submission

rowClick

public void rowClick(ListGridRecord record,
                     int recordNum,
                     int fieldNum)

Programatically simulate clicking of a row.

Parameters:: record - record object returned from getCellRecord(); recordNum - index of the row where the click occurred; fieldNum - index of the col where the click occurred

rowDoubleClick

public void rowDoubleClick(ListGridRecord record,
                           int recordNum,
                           int fieldNum)

Programatically simulate clicking of a row.

Default implementation fires 'editCell' if appropriate, and handles firing the 'recordDoubleClick' event

Parameters:: record - record object returned from getCellRecord(); recordNum - index of the row where the click occurred; fieldNum - index of the col where the click occurred

setInitialSort

public void setInitialSort(SortSpecifier[] initialSort)
                    throws IllegalStateException

An array of SortSpecifier objects used to set up the initial sort configuration for this grid.

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

getInitialSort

public SortSpecifier[] getInitialSort()

An array of ${isc.DocUtils.linkForRef('object:SortSpecifier')} objects used to set up the initial sort configuration for this grid.

Returns:: Array of SortSpecifier

getSortSpecifier

public SortSpecifier getSortSpecifier(String fieldName)

Returns the ${isc.DocUtils.linkForRef('object:SortSpecifier')} for the passed fieldName, or null if the field is not sorted.

Parameters:: fieldName - The name of a field, visible, hidden or existing only in the dataSource
Returns:: True if the passed field is sorted, false otherwise

addSort

public void addSort(SortSpecifier sortSpecifier)

Adds another SortSpecifierto this grid's sort configuration and resorts.

Parameters:: sortSpecifier - A SortSpecifier object indicating an additional field and direction to sort by

setSort

public void setSort(SortSpecifier[] sortSpecifiers)

This method sorts the grid on one or more fields. Pass in an array of SortSpecifiers to have the grid's data sorted by the fields in each specifier.property and in the directions specified. The grid can be sorted by any combination of fields, including fields specified in the fields array, whether visible or hidden, and 'unused fields from the underlying dataSource', if there is one. If multiple fields are sorted, those that are visible show a directional icon and a small 'sort-numeral' indicating that field's index in the sort configuration.

See addSort(com.smartgwt.client.data.SortSpecifier) and com.smartgwt.client.widgets.grid.ListGrid#alterSort APIs for information on making changes to the current sort configuration.

Parameters:: sortSpecifiers - Array of SortSpecifier objects

getSort

public SortSpecifier[] getSort()

Return the grids current sort specification.

Returns:: sort specifiers

addHeaderClickHandler

public HandlerRegistration addHeaderClickHandler(HeaderClickHandler handler)

Add a onHeaderClick handler.

Handler fired when the user clicks a header in this listGrid before any other processing occurs. Return false to suppress the default header click handling

Specified by:: addHeaderClickHandler in interface HasHeaderClickHandlers

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

willAcceptDrop

public Boolean willAcceptDrop()

This method overrides Canvas.willAcceptDrop() and works as follows:

If Canvas.willAcceptDrop() (the superclass definition) returns false, this method always returns false. This allows dragType and dropTypes to be used to configure eligibility for drop. By default, a ListGrid has no dropTypes configured and so this check will not prevent a drop.
If this is a self-drop, that is, the user is dragging a record within this list, this is an attempted drag-reorder. If canReorderRecords is false, this method returns false.
If the EventHandler.getDragTarget() is another widget, if canAcceptDroppedRecords is false this method returns false.
If a call to getDragData() on the dragTarget fails to return an record object or an array of records, this method returns false.
If a the drop target record is disabled or has canAcceptDrop set to false, return false.

Note that this method may be called repeatedly during a drag-drop interaction to update the UI and notify the user as to when they may validly drop data. Note : This is an override point

Overrides:: willAcceptDrop in class Canvas

Returns:: true if this component will accept a drop of the dragData

addRecordDropHandler

public HandlerRegistration addRecordDropHandler(RecordDropHandler handler)

Add a onRecordDrop handler.

Handler fired when the user drops a record onto this listGrid before any other processing of the drop occurs. Return false to suppress the default record drop handling.

Specified by:: addRecordDropHandler in interface HasRecordDropHandlers

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

addRecordExpandHandler

public HandlerRegistration addRecordExpandHandler(RecordExpandHandler handler)

Add a recordExpand handler.

Handler fired when a record is expanded in a grid with canExpandRecords set to true. Allows the expansion to be cancelled.

Specified by:: addRecordExpandHandler in interface HasRecordExpandHandlers

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

addRecordCollapseHandler

public HandlerRegistration addRecordCollapseHandler(RecordCollapseHandler handler)

Add a recordCollapse handler.

Handler fired when a record is collapsed in a grid with canExpandRecords set to true. Allows the collapse to be cancelled.

Specified by:: addRecordCollapseHandler in interface HasRecordCollapseHandlers

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

preloadImages

public static void preloadImages()

Preload primary ListGrid skin images.

getFieldWidth

public int getFieldWidth(Number fieldNum)

Returns a numeric value for the width of some field within this listGrid.

Parameters:: fieldNum - Index of field for which width is to be determined.
Returns:: width of the field in px, or null if the width can't be determined

getFieldWidth

public int getFieldWidth(String fieldName)

Returns a numeric value for the width of some field within this listGrid.

Parameters:: fieldName - Name of field for which width is to be determined.
Returns:: width of the field in px, or null if the width can't be determined

setShowRecordComponentsByCell

public void setShowRecordComponentsByCell(Boolean showRecordComponentsByCell)

If true, shows 'recordComponents' in cells, rather than just in records.

Note : This is an advanced setting

Parameters:: showRecordComponentsByCell - showRecordComponentsByCell Default value is null

getShowRecordComponentsByCell

public Boolean getShowRecordComponentsByCell()

If true, shows 'recordComponents' in cells, rather than just in records.

Returns:: Boolean

getOriginalResultSet

public ResultSet getOriginalResultSet()

Return the underlying, ungrouped data of this ListGrid as a ResultSet. Use this method to access the data when the grid is grouped.

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

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

getOriginalRecordList

public RecordList getOriginalRecordList()

Return the underlying, ungrouped data of this DataBoundComponent as a RecordList.

If this grid is grouped, DataBoundComponent.getRecordList() will return the grouped data as a Tree. Use this method to return the underlying Array of Records or ResultSet, as if the grid was ungrouped:

isGrouped() ? getOriginalRecordList() : getRecordList()

Returns:: the RecordList

setCellFormatter

public void setCellFormatter(CellFormatter formatter)

Formatter to apply to values displayed within cells.

The value passed to this method is either the field value found in the cell record or, if there are unsaved edits, the current user-entered value for the cell. NOTE: unsaved user edits may contain nulls, bad values or values of the wrong type, so formatters used for editable data should be bulletproof.

Note that this formatter will not be applied to the value displayed within editors for cells - use formatEditorValue to achieve this.

If formatCellValue is defined at the field level for some cell being edited, the field level method will be used to format the edit value and this method will not be called for that cell.

Parameters:: formatter - Formatter to apply to values displayed within cells

setHoverCustomizer

public void setHoverCustomizer(HoverCustomizer hoverCustomizer)

HTML to be shown in hovers over cells in the column described by this field. Note that the "value" passed to the HoverCustomizer callback will be null when the HoverCustomizer is applied to the ListGrid. However when applied to a ListGridField, the appropriate field value will be passed.

Parameters:: hoverCustomizer - the hover customizer
See Also:: ListGridField.setHoverCustomizer(HoverCustomizer)

setDataFetchMode

public void setDataFetchMode(FetchMode fetchMode)

Description copied from interface: DataBoundComponent

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

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

Specified by:: setDataFetchMode in interface DataBoundComponent

Parameters:: fetchMode - the fetch mode

getDataFetchMode

public FetchMode getDataFetchMode()

Description copied from interface: DataBoundComponent

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

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

Specified by:: getDataFetchMode in interface DataBoundComponent

Returns:: the fetch mode

setDataPageSize

public void setDataPageSize(int dataPageSize)

Description copied from interface: DataBoundComponent

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

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

Specified by:: setDataPageSize in interface DataBoundComponent

Parameters:: dataPageSize - dataPageSize Default value is 75

getDataPageSize

public int getDataPageSize()

Description copied from interface: DataBoundComponent

Specified by:: getDataPageSize in interface DataBoundComponent

Returns:: int

setUseAllDataSourceFields

public void setUseAllDataSourceFields(Boolean useAllDataSourceFields)

Description copied from interface: DataBoundComponent

If true, the set of fields given by the "default binding" (see fields) is used, with any fields specified in component.fields acting as overrides that can suppress or modify the display of individual fields, without having to list the entire set of fields that should be shown.

If component.fields contains fields that are not found in the DataSource, they will be shown after the most recently referred to DataSource field. If the new fields appear first, they will be shown first.

${isc.DocUtils.linkForExampleId('validationFieldBinding', 'This example')} shows a mixture of component fields and DataSource fields, and how they interact for validation.

Specified by:: setUseAllDataSourceFields in interface DataBoundComponent

Parameters:: useAllDataSourceFields - useAllDataSourceFields Default value is false

getUseAllDataSourceFields

public Boolean getUseAllDataSourceFields()

Description copied from interface: DataBoundComponent

${isc.DocUtils.linkForExampleId('validationFieldBinding', 'This example')} shows a mixture of component fields and DataSource fields, and how they interact for validation.

Specified by:: getUseAllDataSourceFields in interface DataBoundComponent

Returns:: Boolean

setShowHiddenFields

public void setShowHiddenFields(Boolean showHiddenFields)

Description copied from interface: DataBoundComponent

Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.

The hidden property is used on DataSource fields to mark fields that are never of meaning to an end user.

Specified by:: setShowHiddenFields in interface DataBoundComponent

Parameters:: showHiddenFields - showHiddenFields Default value is false

getShowHiddenFields

public Boolean getShowHiddenFields()

Description copied from interface: DataBoundComponent

Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.

The hidden property is used on DataSource fields to mark fields that are never of meaning to an end user.

Specified by:: getShowHiddenFields in interface DataBoundComponent

Returns:: Boolean

setShowDetailFields

public void setShowDetailFields(Boolean showDetailFields)

Description copied from interface: DataBoundComponent

Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.

The detail property is used on DataSource fields to mark fields that shouldn't appear by default in a view that tries to show many records in a small space.

Specified by:: setShowDetailFields in interface DataBoundComponent

Parameters:: showDetailFields - showDetailFields Default value is false

getShowDetailFields

public Boolean getShowDetailFields()

Description copied from interface: DataBoundComponent

Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.

The detail property is used on DataSource fields to mark fields that shouldn't appear by default in a view that tries to show many records in a small space.

Specified by:: getShowDetailFields in interface DataBoundComponent

Returns:: Boolean

setShowComplexFields

public void setShowComplexFields(Boolean showComplexFields)

Description copied from interface: DataBoundComponent

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

If true, the component will show fields that declare a complex type, for example, a field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a DataSource that declares the fields of a shipping address (city, street name, etc).

Such fields may need custom formatters or editors in order to create a usable interface, for example, an Address field in a ListGrid might use a custom formatter to combine the relevant fields of an address into one column, and might use a pop-up dialog for editing.

Note : This is an advanced setting

Specified by:: setShowComplexFields in interface DataBoundComponent

Parameters:: showComplexFields - showComplexFields Default value is true

getShowComplexFields

public Boolean getShowComplexFields()

Description copied from interface: DataBoundComponent

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

Specified by:: getShowComplexFields in interface DataBoundComponent

Returns:: Boolean

setFetchOperation

public void setFetchOperation(String fetchOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing fetch operations.

Specified by:: setFetchOperation in interface DataBoundComponent

Parameters:: fetchOperation - fetchOperation Default value is null

getFetchOperation

public String getFetchOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing fetch operations.

Specified by:: getFetchOperation in interface DataBoundComponent

Returns:: String

setUpdateOperation

public void setUpdateOperation(String updateOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing update operations.

Specified by:: setUpdateOperation in interface DataBoundComponent

Parameters:: updateOperation - updateOperation Default value is null

getUpdateOperation

public String getUpdateOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing update operations.

Specified by:: getUpdateOperation in interface DataBoundComponent

Returns:: String

setAddOperation

public void setAddOperation(String addOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing add operations.

Specified by:: setAddOperation in interface DataBoundComponent

Parameters:: addOperation - addOperation Default value is null

getAddOperation

public String getAddOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing add operations.

Specified by:: getAddOperation in interface DataBoundComponent

Returns:: String

setRemoveOperation

public void setRemoveOperation(String removeOperation)

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing remove operations.

Specified by:: setRemoveOperation in interface DataBoundComponent

Parameters:: removeOperation - removeOperation Default value is null

getRemoveOperation

public String getRemoveOperation()

Description copied from interface: DataBoundComponent

Operation ID this component should use when performing remove operations.

Specified by:: getRemoveOperation in interface DataBoundComponent

Returns:: String

setExportFields

public void setExportFields(String[] exportFields)

Description copied from interface: DataBoundComponent

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

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

Specified by:: setExportFields in interface DataBoundComponent

Parameters:: exportFields - exportFields Default value is null

getExportFields

public String[] getExportFields()

Description copied from interface: DataBoundComponent

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

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

Specified by:: getExportFields in interface DataBoundComponent

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

setExportAll

public void setExportAll(Boolean exportAll)

Description copied from interface: DataBoundComponent

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

If exportAll is false, an export operation will first consider exportFields, if it's set, and fall back on all visible fields from fields otherwise.

Specified by:: setExportAll in interface DataBoundComponent

Parameters:: exportAll - exportAll Default value is false

getExportAll

public Boolean getExportAll()

Description copied from interface: DataBoundComponent

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

If exportAll is false, an export operation will first consider exportFields, if it's set, and fall back on all visible fields from fields otherwise.

Specified by:: getExportAll in interface DataBoundComponent

Returns:: Boolean

setPreventDuplicates

public void setPreventDuplicates(Boolean preventDuplicates)
                          throws IllegalStateException

Description copied from interface: DataBoundComponent

If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). When a duplicate transfer is detected, a dialog will appear showing the duplicateDragMessage.

If the component either does not have a DataSource or has a DataSource with no primaryKey declared, duplicate checking is off by default. If duplicate checking is enabled, it looks for an existing record in the dataset that has all of the properties of the dragged record, and considers that a duplicate.

For DragDataAction:"copy" where the target DataSource is related to the source DataSource by foreignKey, a duplicate means that the target list, as filtered by the current criteria, already has a record whose value for the foreignKey field matches the primaryKey of the record being transferred.

For example, consider dragging "employees" to "teams", where "teams" has a field "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target grid has search criteria causing it to show all the members of one team. A duplicate - adding an employee to the same team twice - is when the target grid's dataset contains an record with "employeeId" matching the "id" field of the dropped employee.

Specified by:: setPreventDuplicates in interface DataBoundComponent

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

getPreventDuplicates

public Boolean getPreventDuplicates()

Description copied from interface: DataBoundComponent

Specified by:: getPreventDuplicates in interface DataBoundComponent

Returns:: Boolean

setDuplicateDragMessage

public void setDuplicateDragMessage(String duplicateDragMessage)
                             throws IllegalStateException

Description copied from interface: DataBoundComponent

Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled.

Specified by:: setDuplicateDragMessage in interface DataBoundComponent

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

getDuplicateDragMessage

public String getDuplicateDragMessage()

Description copied from interface: DataBoundComponent

Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled.

Specified by:: getDuplicateDragMessage in interface DataBoundComponent

Returns:: String

setAddDropValues

public void setAddDropValues(Boolean addDropValues)

Description copied from interface: DataBoundComponent

Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.

If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item dropped on this grid, and an update performed on the item

Specified by:: setAddDropValues in interface DataBoundComponent

Parameters:: addDropValues - addDropValues Default value is true

getAddDropValues

public Boolean getAddDropValues()

Description copied from interface: DataBoundComponent

If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item dropped on this grid, and an update performed on the item

Specified by:: getAddDropValues in interface DataBoundComponent

Returns:: Boolean

setDropValues

public void setDropValues(Map dropValues)

Description copied from interface: DataBoundComponent

When an item is dropped on this component, and addDropValues is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that SmartGWT will apply to the dropped object before updating it.

If this property is not defined, SmartGWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.

Note : This is an advanced setting

Specified by:: setDropValues in interface DataBoundComponent

Parameters:: dropValues - dropValues Default value is null

getDropValues

public Map getDropValues()

Description copied from interface: DataBoundComponent

Specified by:: getDropValues in interface DataBoundComponent

Returns:

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

This method returns the following:

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

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

setUseFlatFields

public void setUseFlatFields(Boolean useFlatFields)
                      throws IllegalStateException

Description copied from interface: DataBoundComponent

The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.

useFlatFields is typically used with imported metadata, such as XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback) from a XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML nesting that aren't meaningful in a user interface, without the cumbersome and fragile process of mapping form fields to XML structures.

For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message schema for a web service operation whose input message looks like this:


 <FindServices>
     <searchFor>search text</searchFor>
     <Options>
         <caseSensitive>false</caseSensitive>
     </Options>
     <IncludeInSearch>
         <serviceName>true</serviceName>
         <documentation>true</documentation>
         <keywords>true</keywords>
     </IncludeInSearch>
 </FindServices>

Setting useFlatFields on a DynamicForm that is bound to this input message schema would result in 5 FormItem reflecting the 5 simple type fields in the message.

For this form, the result of DynamicForm.getValues() might look like:

{
    searchFor: "search text",
    caseSensitive: false,
    serviceName: true,
    documentation : true,
    keywords : true
 }

When contacting a WebService, these values can be automatically mapped to the structure of the input message for a web service operation by setting useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting useFlatFields (for use with a DataSource that is 'bound to a WSDL web service' via wsOperation).

Using these two facilities in conjunction (component.useFlatFields and request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user presentation and when providing the data for XML messages.

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

Note that useFlatFields is not generally recommended for use with structures where multiple simple type fields exist with the same name, however if used with such a structure, the first field to use a given name wins. "first" means the first field encountered in a depth first search. "wins" means only the first field will be present as a field when data binding.

Specified by:: setUseFlatFields in interface DataBoundComponent

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

getUseFlatFields

public Boolean getUseFlatFields()

Description copied from interface: DataBoundComponent

The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.

For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message schema for a web service operation whose input message looks like this:


 <FindServices>
     <searchFor>search text</searchFor>
     <Options>
         <caseSensitive>false</caseSensitive>
     </Options>
     <IncludeInSearch>
         <serviceName>true</serviceName>
         <documentation>true</documentation>
         <keywords>true</keywords>
     </IncludeInSearch>
 </FindServices>

Setting useFlatFields on a DynamicForm that is bound to this input message schema would result in 5 FormItem reflecting the 5 simple type fields in the message.

For this form, the result of DynamicForm.getValues() might look like:

{
    searchFor: "search text",
    caseSensitive: false,
    serviceName: true,
    documentation : true,
    keywords : true
 }

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

Specified by:: getUseFlatFields in interface DataBoundComponent

Returns:: Boolean

setHiliteProperty

public void setHiliteProperty(String hiliteProperty)

Description copied from interface: DataBoundComponent

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

Specified by:: setHiliteProperty in interface DataBoundComponent

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

getHiliteProperty

public String getHiliteProperty()

Description copied from interface: DataBoundComponent

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

Specified by:: getHiliteProperty in interface DataBoundComponent

Returns:: String

setDragDataAction

public void setDragDataAction(DragDataAction dragDataAction)

Description copied from interface: DataBoundComponent

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

Specified by:: setDragDataAction in interface DataBoundComponent

Parameters:: dragDataAction - dragDataAction Default value is Canvas.MOVE

getDragDataAction

public DragDataAction getDragDataAction()

Description copied from interface: DataBoundComponent

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

Specified by:: getDragDataAction in interface DataBoundComponent

Returns:: DragDataAction

setDragTrackerStyle

public void setDragTrackerStyle(String dragTrackerStyle)

Description copied from interface: DataBoundComponent

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

Specified by:: setDragTrackerStyle in interface DataBoundComponent

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

getDragTrackerStyle

public String getDragTrackerStyle()

Description copied from interface: DataBoundComponent

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

Specified by:: getDragTrackerStyle in interface DataBoundComponent

Returns:: String

setCanAddFormulaFields

public void setCanAddFormulaFields(Boolean canAddFormulaFields)

Description copied from interface: DataBoundComponent

Adds an item to the header context menu allowing users to launch a dialog to define a new field based on values present in other fields, using the com.smartgwt.client..FormulaBuilder.

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

Specified by:: setCanAddFormulaFields in interface DataBoundComponent

Parameters:: canAddFormulaFields - canAddFormulaFields Default value is false

addSummaryField

public void addSummaryField()

Description copied from interface: DataBoundComponent

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

Specified by:: addSummaryField in interface DataBoundComponent

addFormulaField

public void addFormulaField()

Description copied from interface: DataBoundComponent

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

Specified by:: addFormulaField in interface DataBoundComponent

getCanAddFormulaFields

public Boolean getCanAddFormulaFields()

Description copied from interface: DataBoundComponent

Adds an item to the header context menu allowing users to launch a dialog to define a new field based on values present in other fields, using the com.smartgwt.client..FormulaBuilder.

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

Specified by:: getCanAddFormulaFields in interface DataBoundComponent

Returns:: Boolean

setAddFormulaFieldText

public void setAddFormulaFieldText(String addFormulaFieldText)

Description copied from interface: DataBoundComponent

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

Specified by:: setAddFormulaFieldText in interface DataBoundComponent

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

getAddFormulaFieldText

public String getAddFormulaFieldText()

Description copied from interface: DataBoundComponent

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

Specified by:: getAddFormulaFieldText in interface DataBoundComponent

Returns:: String

setEditFormulaFieldText

public void setEditFormulaFieldText(String editFormulaFieldText)

Description copied from interface: DataBoundComponent

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

Specified by:: setEditFormulaFieldText in interface DataBoundComponent

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

getEditFormulaFieldText

public String getEditFormulaFieldText()

Description copied from interface: DataBoundComponent

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

Specified by:: getEditFormulaFieldText in interface DataBoundComponent

Returns:: String

setCanAddSummaryFields

public void setCanAddSummaryFields(Boolean canAddSummaryFields)

Description copied from interface: DataBoundComponent

Adds an item to the header context menu allowing users to launch a dialog to define a new text field that can contain both user-defined text and the formatted values present in other fields, using the com.smartgwt.client..SummaryBuilder.

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

Specified by:: setCanAddSummaryFields in interface DataBoundComponent

Parameters:: canAddSummaryFields - canAddSummaryFields Default value is false

getCanAddSummaryFields

public Boolean getCanAddSummaryFields()

Description copied from interface: DataBoundComponent

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

Specified by:: getCanAddSummaryFields in interface DataBoundComponent

Returns:: Boolean

setAddSummaryFieldText

public void setAddSummaryFieldText(String addSummaryFieldText)

Description copied from interface: DataBoundComponent

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

Specified by:: setAddSummaryFieldText in interface DataBoundComponent

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

getAddSummaryFieldText

public String getAddSummaryFieldText()

Description copied from interface: DataBoundComponent

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

Specified by:: getAddSummaryFieldText in interface DataBoundComponent

Returns:: String

setEditSummaryFieldText

public void setEditSummaryFieldText(String editSummaryFieldText)

Description copied from interface: DataBoundComponent

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

Specified by:: setEditSummaryFieldText in interface DataBoundComponent

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

getEditSummaryFieldText

public String getEditSummaryFieldText()

Description copied from interface: DataBoundComponent

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

Specified by:: getEditSummaryFieldText in interface DataBoundComponent

Returns:: String

selectRecord

public void selectRecord(Record record)

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecord in interface DataBoundComponent

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

selectRecord

public void selectRecord(int record)

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecord in interface DataBoundComponent

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

selectRecord

public void selectRecord(int record,
                         boolean newState)

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecord in interface DataBoundComponent

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

selectRecord

public void selectRecord(Record record,
                         boolean newState)

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecord in interface DataBoundComponent

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

selectRecords

public void selectRecords(int[] records)

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecords in interface DataBoundComponent

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

selectRecords

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

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecords in interface DataBoundComponent

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

selectRecords

public void selectRecords(Record[] records)

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecords in interface DataBoundComponent

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

selectRecords

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

Description copied from interface: DataBoundComponent

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

Specified by:: selectRecords in interface DataBoundComponent

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

deselectRecord

public void deselectRecord(Record record)

Description copied from interface: DataBoundComponent

Deselect a Record passed in explicitly, or by index.

Synonym for selectRecord(record, false)

Specified by:: deselectRecord in interface DataBoundComponent

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

deselectRecord

public void deselectRecord(int record)

Description copied from interface: DataBoundComponent

Deselect a Record passed in explicitly, or by index.

Synonym for selectRecord(record, false)

Specified by:: deselectRecord in interface DataBoundComponent

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

deselectRecords

public void deselectRecords(int[] records)

Description copied from interface: DataBoundComponent

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

Synonym for selectRecords(records, false)

Specified by:: deselectRecords in interface DataBoundComponent

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

deselectRecords

public void deselectRecords(Record[] records)

Description copied from interface: DataBoundComponent

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

Synonym for selectRecords(records, false)

Specified by:: deselectRecords in interface DataBoundComponent

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

selectAllRecords

public void selectAllRecords()

Description copied from interface: DataBoundComponent

Select all records

Specified by:: selectAllRecords in interface DataBoundComponent

deselectAllRecords

public void deselectAllRecords()

Description copied from interface: DataBoundComponent

Deselect all records

Specified by:: deselectAllRecords in interface DataBoundComponent

anySelected

public Boolean anySelected()

Description copied from interface: DataBoundComponent

Whether at least one item is selected

Specified by:: anySelected in interface DataBoundComponent

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

enableHilite

public void enableHilite(String hiliteID)

Description copied from interface: DataBoundComponent

Enable / disable a hilites

Specified by:: enableHilite in interface DataBoundComponent

Parameters:: hiliteID - ID of hilite to enable

enableHilite

public void enableHilite(String hiliteID,
                         boolean enable)

Description copied from interface: DataBoundComponent

Enable / disable a hilites

Specified by:: enableHilite in interface DataBoundComponent

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

disableHilite

public void disableHilite(String hiliteID)

Description copied from interface: DataBoundComponent

Disable a hilite

Specified by:: disableHilite in interface DataBoundComponent

Parameters:: hiliteID - ID of hilite to disable

enableHiliting

public void enableHiliting()

Description copied from interface: DataBoundComponent

Enable all hilites.

Specified by:: enableHiliting in interface DataBoundComponent

enableHiliting

public void enableHiliting(boolean enable)

Description copied from interface: DataBoundComponent

Enable all hilites.

Specified by:: enableHiliting in interface DataBoundComponent

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

disableHiliting

public void disableHiliting()

Description copied from interface: DataBoundComponent

Disable all hilites.

Specified by:: disableHiliting in interface DataBoundComponent

getDragData

public Record[] getDragData()

Description copied from interface: DataBoundComponent

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

This method is generally called by com.smartgwt.client.widgets.DataBoundComponent#transferDragData and is consulted by willAcceptDrop().

Specified by:: getDragData in interface DataBoundComponent

Returns:: Array of Records that are currently selected.

transferSelectedData

public void transferSelectedData(DataBoundComponent source)

Description copied from interface: DataBoundComponent

Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by calling DataBoundComponent.getDropValues() for each dropped record.

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

See the Dragging documentation for an overview of list grid drag/drop data transfer.

Specified by:: transferSelectedData in interface DataBoundComponent

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

transferSelectedData

public void transferSelectedData(DataBoundComponent source,
                                 int index)

Description copied from interface: DataBoundComponent

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

See the Dragging documentation for an overview of list grid drag/drop data transfer.

Specified by:: transferSelectedData in interface DataBoundComponent

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

getRecordIndex

public int getRecordIndex(Record record)

Description copied from interface: DataBoundComponent

Get the index of the provided record.

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

Specified by:: getRecordIndex in interface DataBoundComponent

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

getTitleFieldValue

public String getTitleFieldValue(Record record)

Description copied from interface: DataBoundComponent

Get the value of the titleField for the passed record

Override in subclasses

Specified by:: getTitleFieldValue in interface DataBoundComponent

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

setTitleField

public void setTitleField(String titleField)

Specified by:: setTitleField in interface DataBoundComponent

getTitleField

public String getTitleField()

Description copied from interface: DataBoundComponent

Method to return the fieldName which represents the "title" for records in this Component.
If this.titleField is explicitly specified it will always be used. Otherwise, default implementation will check titleField for databound compounds.
For non databound components returns the first defined field name of "title", "name", or "id". If we dont find any field-names that match these titles, the first field in the component will be used instead.

Specified by:: getTitleField in interface DataBoundComponent

Returns:: fieldName for title field for this component.

setDataSource

public void setDataSource(DataSource dataSource)

Description copied from interface: DataBoundComponent

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

Can be specified as either a DataSource instance or the String ID of a DataSource. Bind to a new DataSource.

Like passing the "dataSource" property on creation, binding to a DataSource means that the component will use the DataSource to provide default data for its fields.

When binding to a new DataSource, if the component has any existing "fields" or has a dataset, these will be discarded by default, since it is assumed the new DataSource may represent a completely unrelated set of objects. If the old "fields" are still relevant, pass them to setDataSource().

Specified by:: setDataSource in interface DataBoundComponent

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

getDataSource

public DataSource getDataSource()

Description copied from interface: DataBoundComponent

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

Can be specified as either a DataSource instance or the String ID of a DataSource.

Specified by:: getDataSource in interface DataBoundComponent

Returns:: DataSource

setAutoFetchData

public void setAutoFetchData(Boolean autoFetchData)
                      throws IllegalStateException

Description copied from interface: DataBoundComponent

If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria.

Specified by:: setAutoFetchData in interface DataBoundComponent

Parameters:: autoFetchData - autoFetchData
Throws:: IllegalStateException

getAutoFetchData

public Boolean getAutoFetchData()

Description copied from interface: DataBoundComponent

Specified by:: getAutoFetchData in interface DataBoundComponent

Returns:: auto fetch data

setAutoFetchAsFilter

public void setAutoFetchAsFilter(Boolean autoFetchAsFilter)
                          throws IllegalStateException

Description copied from interface: DataBoundComponent

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

Specified by:: setAutoFetchAsFilter in interface DataBoundComponent

Parameters:: autoFetchAsFilter - autoFetchAsFilter
Throws:: IllegalStateException

getAutoFetchAsFilter

public Boolean getAutoFetchAsFilter()

Description copied from interface: DataBoundComponent

Specified by:: getAutoFetchAsFilter in interface DataBoundComponent

Returns:: auto fetch as filter

setInitialCriteria

public void setInitialCriteria(Criteria initialCriteria)
                        throws IllegalStateException

Description copied from interface: DataBoundComponent

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

Specified by:: setInitialCriteria in interface DataBoundComponent

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

getInitialCriteria

public Criteria getInitialCriteria()

Description copied from interface: DataBoundComponent

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

Specified by:: getInitialCriteria in interface DataBoundComponent

Returns:: the criteria

fetchData

public void fetchData()

Description copied from interface: DataBoundComponent

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

If there are a large number of matching records, paging will automatically be enabled, so that initially a smaller number of records will be retrieved and further records will be fetched as the user navigates the dataset.

When first called, this method will create a ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The ResultSet is then available as component.data.

Subsequent calls to fetchData() will simply call ResultSet.setCriteria(com.smartgwt.client.data.Criteria) on the created ResultSet with the passed criteria.

In some cases fetchData() will not need to context the server as the new criteria can be satisfied by performing a client-side filter against the currently cached set of data. You can determine whether criteria will cause a fetch by calling ResultSet.willFetchData(com.smartgwt.client.data.Criteria).

If you need to force a server fetch, you can call ResultSet.invalidateCache() via component.data.invalidateCache() to do so.

This method takes an optional callback parameter (set to a DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary we recomment using ResultSet.willFetchData(com.smartgwt.client.data.Criteria) before calling this method to determine whether or not a server fetch will occur.

In addition to the callback parameter for this method, developers can use ResultSet.dataArrived(int, int) to be notified every time ResultSet data is loaded. A dataArrived method can be installed in the automatically created ResultSet by adding it to dataProperties.

Specified by:: fetchData in interface DataBoundComponent

fetchData

public void fetchData(Criteria criteria)

Description copied from interface: DataBoundComponent

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

Subsequent calls to fetchData() will simply call ResultSet.setCriteria(com.smartgwt.client.data.Criteria) on the created ResultSet with the passed criteria.

If you need to force a server fetch, you can call ResultSet.invalidateCache() via component.data.invalidateCache() to do so.

Specified by:: fetchData in interface DataBoundComponent

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

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback)

Description copied from interface: DataBoundComponent

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

Subsequent calls to fetchData() will simply call ResultSet.setCriteria(com.smartgwt.client.data.Criteria) on the created ResultSet with the passed criteria.

If you need to force a server fetch, you can call ResultSet.invalidateCache() via component.data.invalidateCache() to do so.

Specified by:: fetchData in interface DataBoundComponent

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required

fetchData

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

Description copied from interface: DataBoundComponent

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

Subsequent calls to fetchData() will simply call ResultSet.setCriteria(com.smartgwt.client.data.Criteria) on the created ResultSet with the passed criteria.

If you need to force a server fetch, you can call ResultSet.invalidateCache() via component.data.invalidateCache() to do so.

Specified by:: fetchData in interface DataBoundComponent

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required; requestProperties - additional properties to set on the DSRequest that will be issued

filterData

public void filterData()

Description copied from interface: DataBoundComponent

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

This method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:: filterData in interface DataBoundComponent

filterData

public void filterData(Criteria criteria)

Description copied from interface: DataBoundComponent

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

This method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:: filterData in interface DataBoundComponent

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

filterData

public void filterData(Criteria criteria,
                       DSCallback callback)

Description copied from interface: DataBoundComponent

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

This method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:: filterData in interface DataBoundComponent

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required; see DataBoundComponent.fetchData() for details

filterData

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

Description copied from interface: DataBoundComponent

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

This method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:: filterData in interface DataBoundComponent

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required; see DataBoundComponent.fetchData() for details; requestProperties - for databound components only - optional additional properties to set on the DSRequest that will be issued

invalidateCache

public void invalidateCache()

Description copied from interface: DataBoundComponent

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

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

Specified by:: invalidateCache in interface DataBoundComponent

getResultSet

public ResultSet getResultSet()

Description copied from interface: DataBoundComponent

Return the underlying data of this DataBoundComponent as a ResultSet.

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

Specified by:: getResultSet in interface DataBoundComponent

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

getRecordList

public RecordList getRecordList()

Description copied from interface: DataBoundComponent

Return the underlying data of this DataBoundComponent as a RecordList.

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

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

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

Specified by:: getRecordList in interface DataBoundComponent

Returns:: the RecordList

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

ListGrid

ListGrid

getOrCreateRef

create

setAlternateBodyStyleName

getAlternateBodyStyleName

setAlternateRecordFrequency

getAlternateRecordFrequency

setAlternateRecordStyles

getAlternateRecordStyles

setAlwaysShowEditors

getAlwaysShowEditors

setAnimateRemoveRecord

getAnimateRemoveRecord

setAnimateRemoveSpeed

getAnimateRemoveSpeed

setAnimateRemoveTime

getAnimateRemoveTime

setAnimateRollOver

getAnimateRollOver

setAnimateRollUnder

getAnimateRollUnder

setAnimateSelectionUnder

getAnimateSelectionUnder

setArrowKeyAction

getArrowKeyAction

setAutoFetchDisplayMap

getAutoFetchDisplayMap

setAutoFetchTextMatchStyle

getAutoFetchTextMatchStyle

setAutoFitExtraRecords

getAutoFitExtraRecords

setAutoFitMaxColumns

getAutoFitMaxColumns

setAutoFitMaxHeight

getAutoFitMaxHeight

setAutoFitMaxRecords

getAutoFitMaxRecords

setAutoFitMaxWidth

getAutoFitMaxWidth

setAutoSaveEdits

getAutoSaveEdits

setBackgroundComponent

getBackgroundComponent

setBaseStyle

getBaseStyle

setBodyBackgroundColor

getBodyBackgroundColor

setBodyOverflow

getBodyOverflow

setBodyStyleName

getBodyStyleName

setBooleanFalseImage

getBooleanFalseImage

setBooleanImageHeight

getBooleanImageHeight

setBooleanImageWidth

getBooleanImageWidth

setBooleanPartialImage

getBooleanPartialImage

setBooleanTrueImage

getBooleanTrueImage

setCanAcceptDroppedRecords

getCanAcceptDroppedRecords

setCancelEditingConfirmationMessage

getCancelEditingConfirmationMessage

setCanDragRecordsOut

getCanDragRecordsOut

setCanDragSelect

getCanDragSelect

setCanDragSelectText

getCanDragSelectText

setCanEdit

getCanEdit

setCanExpandMultipleRecords

getCanExpandMultipleRecords

setCanExpandRecordProperty

getCanExpandRecordProperty

setCanExpandRecords

com.smartgwt.client.widgets.grid
Class ListGrid