Package com.smartgwt.client.widgets.grid
Class ListGrid
- All Implemented Interfaces:
HasAttachHandlers
,HasHandlers
,EventListener
,HasVisibility
,IsWidget
,LogicalStructure
,DataBoundComponent
,HasClearHandlers
,HasClickHandlers
,HasDoubleClickHandlers
,HasDragCompleteHandlers
,HasDragMoveHandlers
,HasDragRepositionMoveHandlers
,HasDragRepositionStartHandlers
,HasDragRepositionStopHandlers
,HasDragResizeMoveHandlers
,HasDragResizeStartHandlers
,HasDragResizeStopHandlers
,HasDragStartHandlers
,HasDragStopHandlers
,HasDropCompleteHandlers
,HasDropHandlers
,HasDropMoveHandlers
,HasDropOutHandlers
,HasDropOverHandlers
,HasFetchDataHandlers
,HasFocusChangedHandlers
,HasFormulaUpdatedHandlers
,HasHoverHandlers
,HasHoverHiddenHandlers
,HasKeyDownHandlers
,HasKeyPressHandlers
,HasMouseDownHandlers
,HasMouseMoveHandlers
,HasMouseOutHandlers
,HasMouseOverHandlers
,HasMouseStillDownHandlers
,HasMouseUpHandlers
,HasMouseWheelHandlers
,HasMovedHandlers
,HasParentMovedHandlers
,HasResizedHandlers
,HasRightMouseDownHandlers
,HasRuleContextChangedHandlers
,HasScrolledHandlers
,HasShowContextMenuHandlers
,HasVisibilityChangedHandlers
,HasBodyKeyPressHandlers
,HasCellClickHandlers
,HasCellContextClickHandlers
,HasCellDoubleClickHandlers
,HasCellErrorIconHoverHandlers
,HasCellErrorIconOutHandlers
,HasCellErrorIconOverHandlers
,HasCellHoverHandlers
,HasCellMouseDownHandlers
,HasCellMouseUpHandlers
,HasCellOutHandlers
,HasCellOverHandlers
,HasCellSavedHandlers
,HasCellSelectionChangedHandlers
,HasCellValueHoverHandlers
,HasCriteriaChangedHandlers
,HasDataArrivedHandlers
,HasDataChangedHandlers
,HasDrawAreaChangedHandlers
,HasEditCompleteHandlers
,HasEditFailedHandlers
,HasEditorEnterHandlers
,HasEditorExitHandlers
,HasFieldStateChangedHandlers
,HasFilterEditorSubmitHandlers
,HasGroupByCompleteHandlers
,HasGroupByHandlers
,HasGroupStateChangedHandlers
,HasGroupTreeChangedHandlers
,HasHeaderClickHandlers
,HasHeaderDoubleClickHandlers
,HasHeaderHoverHandlers
,HasHilitesChangedHandlers
,HasRecordClickHandlers
,HasRecordCollapseHandlers
,HasRecordDoubleClickHandlers
,HasRecordDropHandlers
,HasRecordExpandHandlers
,HasRegroupHandlers
,HasRemoveRecordClickHandlers
,HasRowContextClickHandlers
,HasRowEditorEnterHandlers
,HasRowEditorExitHandlers
,HasRowHoverHandlers
,HasRowMouseDownHandlers
,HasRowMouseUpHandlers
,HasRowOutHandlers
,HasRowOverHandlers
,HasSelectionChangedHandlers
,HasSelectionUpdatedHandlers
,HasSetSortHandlers
,HasSortChangedHandlers
,HasSorterClickHandlers
,HasSorterContextClickHandlers
,HasViewStateChangedHandlers
,HasMembersChangedHandlers
- Direct Known Subclasses:
CalendarView
,CubeGrid
,DateGrid
,ListPalette
,Menu
,PickListMenu
,RecordEditor
,TableView
,TreeGrid
public class ListGrid
extends VLayout
implements DataBoundComponent, HasCellSavedHandlers, HasCellClickHandlers, HasCellContextClickHandlers, HasCellDoubleClickHandlers, HasCellErrorIconHoverHandlers, HasCellErrorIconOutHandlers, HasCellErrorIconOverHandlers, HasCellHoverHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellSelectionChangedHandlers, HasCellValueHoverHandlers, HasCriteriaChangedHandlers, HasDataArrivedHandlers, HasDataChangedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasFilterEditorSubmitHandlers, HasFormulaUpdatedHandlers, HasGroupByCompleteHandlers, HasGroupStateChangedHandlers, HasGroupTreeChangedHandlers, HasGroupByHandlers, HasRegroupHandlers, HasHeaderDoubleClickHandlers, HasHeaderHoverHandlers, HasHilitesChangedHandlers, HasBodyKeyPressHandlers, HasRecordCollapseHandlers, HasRecordExpandHandlers, HasHeaderClickHandlers, HasRecordClickHandlers, HasRecordDropHandlers, HasRemoveRecordClickHandlers, HasRecordDoubleClickHandlers, HasRowContextClickHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasRowHoverHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRowOutHandlers, HasRowOverHandlers, HasSelectionChangedHandlers, HasSelectionUpdatedHandlers, HasSetSortHandlers, HasSortChangedHandlers, HasSorterClickHandlers, HasSorterContextClickHandlers, HasViewStateChangedHandlers
A ListGrid is a
DataBoundComponent
that displays a list of objects in a grid, where
each row represents one object and each cell in the row represents one property.- See Also:
-
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, factoryCreated, factoryProperties, id, nativeObject, scClassName
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAdd a bodyKeyPress handler.addCellClickHandler
(CellClickHandler handler) Add a cellClick handler.Add a cellContextClick handler.Add a cellDoubleClick handler.Add a cellErrorIconHover handler.Add a cellErrorIconOut handler.Add a cellErrorIconOver handler.addCellHoverHandler
(CellHoverHandler handler) Add a cellHover handler.Add a cellMouseDown handler.addCellMouseUpHandler
(CellMouseUpHandler handler) Add a cellMouseUp handler.addCellOutHandler
(CellOutHandler handler) Add a cellOut handler.addCellOverHandler
(CellOverHandler handler) Add a cellOver handler.addCellSavedHandler
(CellSavedHandler handler) Add a cellSaved handler.Add a cellSelectionChanged handler.Add a cellValueHover handler.Add a criteriaChanged handler.void
Perform a DataSource "add" operation to add new records to this component's DataSource.void
addData
(Record newRecord, DSCallback callback) void
addData
(Record newRecord, DSCallback callback, DSRequest requestProperties) Perform a DataSource "add" operation to add new records to this component's DataSource.addDataArrivedHandler
(DataArrivedHandler handler) Add a dataArrived handler.addDataChangedHandler
(DataChangedHandler handler) Add a dataChanged handler.Add acom.smartgwt.client.widgets.DragCompleteHandler
.Add a drawAreaChanged handler.Add acom.smartgwt.client.widgets.DropCompleteHandler
.Add a editComplete handler.addEditFailedHandler
(EditFailedHandler handler) Add a editFailed handler.addEditorEnterHandler
(EditorEnterHandler handler) Add a editorEnter handler.addEditorExitHandler
(EditorExitHandler handler) Add a editorExit handler.void
addEmbeddedComponent
(Canvas component, ListGridRecord record) Attaches the component to the provided record.void
addEmbeddedComponent
(Canvas component, ListGridRecord record, Integer rowNum) void
addEmbeddedComponent
(Canvas component, ListGridRecord record, Integer rowNum, Integer colNum) void
addEmbeddedComponent
(Canvas component, ListGridRecord record, Integer rowNum, Integer colNum, EmbeddedPosition position) Attaches the component to the provided record.addFetchDataHandler
(FetchDataHandler handler) Add a fetchData handler.Add a fieldStateChanged handler.Add a filterEditorSubmit handler.void
Convenience method to display a {@link com.smartgwt.client..FormulaBuilder} to create a new Formula Field.Add a formulaUpdated handler.Add a groupByComplete handler.addGroupByHandler
(GroupByHandler handler) Add a groupBy handler.Add a groupStateChanged handler.Add a groupTreeChanged handler.addHeaderClickHandler
(HeaderClickHandler handler) Add a headerClick handler.Add a headerDoubleClick handler.addHeaderHoverHandler
(HeaderHoverHandler handler) Add a headerHover handler.Add a hilitesChanged handler.addRecordClickHandler
(RecordClickHandler handler) Add a recordClick handler.Add a recordCollapse handler.Add a recordDoubleClick handler.addRecordDropHandler
(RecordDropHandler handler) Add a recordDrop handler.Add a recordExpand handler.addRegroupHandler
(RegroupHandler handler) Add a regroup handler.Add a removeRecordClick handler.Add a rowContextClick handler.Add a rowEditorEnter handler.Add a rowEditorExit handler.addRowHoverHandler
(RowHoverHandler handler) Add a rowHover handler.Add a rowMouseDown handler.addRowMouseUpHandler
(RowMouseUpHandler handler) Add a rowMouseUp handler.addRowOutHandler
(RowOutHandler handler) Add a rowOut handler.addRowOverHandler
(RowOverHandler handler) Add a rowOver handler.Add a selectionChanged handler.Add a selectionUpdated handler.addSetSortHandler
(SetSortHandler handler) Add a setSort handler.void
addSort
(SortSpecifier sortSpecifier) Adds anotherSortSpecifier
to this grid's sort configuration and resorts.addSortChangedHandler
(SortChangedHandler handler) Add a sortChanged handler.addSorterClickHandler
(SorterClickHandler handler) Add a sorterClick handler.Add a sorterContextClick handler.void
Convenience method to display a {@link com.smartgwt.client..SummaryBuilder} to create a new Summary Field.Add a viewStateChanged handler.Whether at least one item is selected
void
applyCellData
(RecordList cellData) Applies a set of Records containing coordinate-based data as returned bygetSelectedCellData()
and applies the data at the current selection.void
applyRecordData
(RecordList recordData) Applies a list of Records as changes to the current selection.void
applySortToData
(SortSpecifier... sortSpecifiers) Sort the grid's data to reflect the parameter sortSpecifiers.void
Show a dialog to configure the sorting of multiple fields on this component.int
autoFitField
(String fieldName) Programmatically cause a field to auto-fit horizontally to it's contents or title.void
Perform a one-time horizontal auto-fit of the fields passed.void
autoFitFields
(ListGridField... fields) Perform a one-time horizontal auto-fit of the fields passed.void
Cancel the current edit without saving.boolean
canEditCell
(int rowNum, int colNum) Can this cell be edited?boolean
canExpandRecord
(ListGridRecord record, int rowNum) Indicates whether a given record or rowNum can be expanded.boolean
canSelectCell
(int rowNum, int colNum) IfcanSelectCells
is set totrue
then, whenever an end-user or programmatic cell-selection is attempted, this method is called for each cell in the selection.boolean
canSelectRecord
(ListGridRecord record) IfselectionType
is not set to"none"
, this method will be called for each record the user attempts to select.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.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.
cellHasErrors
(int rowNum, String fieldID) Given a rowNum and a colNum or fieldName, determine whether we currently have stored validation errors for the record/field in question.cellValueHoverHTML
(ListGridRecord record, int rowNum, int colNum, String defaultHTML) Returns the HTML that is displayed by the default cellValueHover handler.cellValueIsClipped
(int rowNum, int colNum) Is the value in a given cell clipped?static void
changeAutoChildDefaults
(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName
.static void
changeAutoChildDefaults
(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName
.Chart the data in this listGrid as a multi-series chart.chartData
(String labelField, String[] dataFields, ListGridRecord... dataRows) chartData
(String labelField, String[] dataFields, ListGridRecord[] dataRows, FacetChart chartProperties) chartData
(String labelField, String[] dataFields, ListGridRecord[] dataRows, FacetChart chartProperties, boolean labelFieldFirst) Chart the data in this listGrid as a multi-series chart.void
This method, the equivalent of the builtinClear Filter menu-item
, clears all user-visible criteria applied to this grid, including values and filter-operators in thefilter-row
and criteria in theadvanced filter window
, and issues a re-filter.void
Clear the current criteria used to filter data.void
clearCriteria
(DSCallback callback) 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 fieldName) Clears any validation errors for some cell.void
clearFieldError
(int rowNum, String fieldName) void
clearFieldSearchOperator
(String fieldName, Boolean suppressFilter) Clears the current search operator from a field in the grid'sfilter row
.void
Clears criteria applied to this grid via theadvanced filter window
and issues a re-filter.void
clearRowErrors
(int rowNum) Clear any stored validation errors for some rowvoid
Clear this grid's auto-savedview state
as described inautoPersistViewState
.void
This method clears any existing sort on this grid by callingsetSort()
with a null parameter.boolean
closeGroup
(Record record) Closes the node represented by the "record" parameter, if it is a folder and is not already closed.void
closeRecord
(ListGridRecord record) Deprecated.void
collapseRecord
(ListGridRecord record) Collapses a givenrecord
which has been previously expanded usingexpandRecord()
.void
collapseRecords
(ListGridRecord... records) Collapses the passed list of expandedrecords
.void
Open a MultiGroupDialog to configure the fields used for grouping.protected JavaScriptObject
create()
protected Canvas
createRecordComponent
(ListGridRecord record, Integer colNum) WhenshowRecordComponents
is true, this method is called to create per-row or per-cell embedded components to display in the grid.void
Notification method fired when thegrid data has changed
.void
dataChangedComplete
(String operationType) Notification method fired when thegrid data has changed
.void

 Deselect all records

void
deselectRange
(int startRow, int endRow) Deselect a contiguous range of records by index.void
deselectRecord
(int record) Deselect aRecord
passed in explicitly, or by index.void
deselectRecord
(Record record) Deselect aRecord
passed in explicitly, or by index.void
deselectRecords
(int[] records) Deselect a list ofRecord
s passed in explicitly, or by index.void
deselectRecords
(Record[] records) Deselect a list ofRecord
s passed in explicitly, or by index.void
disableHilite
(String hiliteID) Disable a hilite

void
Disable all hilites.

void
Cancel outstanding edits, discarding edit values, and hiding editors for the record[s] passed in if appropriate.void
discardAllEdits
(int[] rows) void
discardAllEdits
(int[] rows, boolean dontHideEditor) Cancel outstanding edits, discarding edit values, and hiding editors for the record[s] passed in if appropriate.void
discardEdits
(int rowNum, int colNum) Cancel outstanding edits for the specified rows, discarding edit values, and hiding editors if appropriate.void
discardEdits
(int rowNum, int colNum, Boolean dontHideEditor) Cancel outstanding edits for the specified rows, discarding edit values, and hiding editors if appropriate.protected Boolean
displayHeaderContextMenu
(Canvas target, int[] position) IfshowHeaderContextMenu
istrue
this method is fired when the user right-clicks on the header for this grid.
Default implementation will display a menu with entries derived fromListGrid.getHeaderContextMenuItems
for the appropriate column.void
displaySort
(SortSpecifier... sortSpecifiers) Modify the grid UI to reflect the parameter sortSpecifiers.boolean
drop()
Handle a drop event.void
Start inline editing at a record identified by criteria.void
editExistingRecord
(Criteria criteria) Start inline editing at a record identified by criteria.void
Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent.void
Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.void
enableHilite
(String hiliteID) Enable / disable ahilites


void
enableHilite
(String hiliteID, boolean enable) Enable / disable ahilites


void
Enable all hilites.

void
enableHiliting
(boolean enable) Enable all hilites.

void
Complete the current edit by storing the value and hiding the inline editor.void
expandRecord
(ListGridRecord record) Expands a givenrecord
by creating a subcomponent and inserting it in to the record's grid-row.void
expandRecords
(ListGridRecord... records) Expands the passed list ofrecords
by creating a subcomponent for each record and inserting them it in to the record's grid-row.void
Exports this component's data with client-side formatters applied, so is suitable for direct display to users, using the specifiedexport format
.void
exportClientData
(DSRequest requestProperties) void
exportClientData
(DSRequest requestProperties, RPCCallback callback) Exports this component's data with client-side formatters applied, so is suitable for direct display to users, using the specifiedexport format
.void
void
exportData
(DSRequest requestProperties) void
exportData
(DSRequest requestProperties, RPCCallback callback) Uses a "fetch" operation on the currentDataSource
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
Retrieves data from the DataSource that matches the specified criteria.void
Retrieves data from the DataSource that matches the specified criteria.void
fetchData
(Criteria criteria, DSCallback callback) Retrieves data from the DataSource that matches the specified criteria.void
fetchData
(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data from the DataSource that matches the specified criteria.void
fetchRelatedData
(Record record, DataSource dataSource) void
fetchRelatedData
(Record record, DataSource dataSource, DSCallback callback, DSRequest requestProperties) void
fetchRelatedData
(ListGridRecord record, Canvas schema) 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
(ListGridRecord record, Canvas schema, DSCallback callback) void
fetchRelatedData
(ListGridRecord record, Canvas schema, 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.void
For databound grids, method will fall through toResultSet.fetchRowCount()
, allowing developers to request an accurate row count from the dataSource whenprogressive loading is active
.void
fetchRowCount
(RowCountCallback callback) void
fetchRowCount
(RowCountCallback callback, DSRequest dsRequest) For databound grids, method will fall through toResultSet.fetchRowCount()
, allowing developers to request an accurate row count from the dataSource whenprogressive loading is active
.boolean
fieldIsEditable
(int field) Can the field be edited? This method looks atcanEdit
for the grid as well as theListGridField.canEdit
value, to determine whether editing is allowed.boolean
fieldIsEditable
(ListGridField field) Can the field be edited? This method looks atcanEdit
for the grid as well as theListGridField.canEdit
value, to determine whether editing is allowed.boolean
fieldIsEditable
(String field) Can the field be edited? This method looks atcanEdit
for the grid as well as theListGridField.canEdit
value, to determine whether editing is allowed.boolean
fieldIsVisible
(String field) Check whether a field is currently visiblevoid
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
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.find
(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not foundRecord[]
findAll
(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passedint
findIndex
(AdvancedCriteria adCriteria) Finds the index of the first Record that matches with the AdvacendCriteria passed.int[]
findNextEditCell
(int rowNum, int colNum, boolean searchForward, boolean stepThroughFields, boolean checkStartingCell) Method to find the next editable cell given a starting row/col, and a direction, either iterating through fields within each row, or checking the same field in each row.int
findNextIndex
(int startIndex, AdvancedCriteria adCriteria) LikeRecordList.findIndex(java.util.Map)
, but considering the startIndex parameter.int
findNextIndex
(int startIndex, AdvancedCriteria adCriteria, int endIndex) LikeRecordList.findIndex(java.util.Map)
, but considering the startIndex and endIndex parameters.void
focusInCell
(Integer row, Integer col) Puts keyboard focus into the specified cell, showing a highlighted (roll-over style) appearance, and ensuring that arrow-key navigation will start from the specified cell.void
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
focusInRow
(Integer row) Puts keyboard focus into the specified row, showing a highlighted (roll-over style) appearance, and ensuring that arrow-key navigation will start from the specified row.void
freezeField
(ListGridField field) Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.void
freezeField
(Integer field) Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.void
freezeField
(String field) Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.void
freezeField
(String[] field) Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.void
freezeFields
(int[] colNums) void
freezeFields
(String[] fieldNames) 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.Text for a menu item allowing users to add a formula fieldoperationId
this component should use when performing add operations.Text for a menu item allowing users to add a formula fieldint
WhenuseAdvancedFieldPicker
is set, total number of available fields that must be present in the grid before the advanced field picker interface is used instead of the normal columns submenu.If we're showing aheaderContextMenu
for this grid, and afilter-editor
is visible andallowFilterWindow
is enabled, this attribute will be shown as the menu item title to configure advanced filtering.Instance ofAIWindow
that allows a user to enter a description of how they would like the AI to filter this grid.The inline hint-text displayed in the user-entry area in theaiFilterWindow
.The descriptive text displayed above the user-entry area in theaiFilterWindow
.The title for theAI-driven filter window
.Instance ofAIWindow
that allows a user to enter a description of how they would like the AI to filter this grid.Optional prefix for the AI-generated hover text displayed when hovering over fields specifying anaiHoverRequest
.Minimum number of milliseconds to wait before retrying to generate hover contents via AI.The message to show when a user asks the AI to sort more than themaximum allowed records
.Dialog that shows progress after requesting AI-sorting of a field.int[]
Returns an array of every rowNum for which we have pending (unsubmitted) edits.Get the complete array of fields for this ListGrid, including fields that are not currently visible or were specified implicitly viadataSource
.For use withshowFilterEditor
:true, allows simple search expressions to be entered into filter fields, as thoughDynamicForm.allowExpressions
were true.Causes a menu item titled"Filter using"
to appear in theheaderContextMenu
that allows the end user to pick an advancedsearch operator
to use for this field.Adds the ability for a user to define additional criteria above and beyond those expressed in thefilter editor
via aFilterBuilder
which appears in a modal Window over the grid and can be accessed by various menus within the grid or triggered by external controls.Should cells in this grid be allowed to span multiple rows? If set totrue
, thegetRowSpan()
method will be called for every cell when rendering out the listGrid to determine how many rows the cell should span.Optional css style to apply to the body ifalternateRecordStyles
is true for this grid.int
The number of consecutive columns to draw in the same style before alternating, whenalternateColumnStyles
is true.boolean
Whether alternating columns (or blocks of columns, depending onGridRenderer.alternateColumnFrequency
) should be drawn in alternating styles, in order to create a vertical "ledger" effect for easier reading.Suffix to append toalternate columns
.int
The number of consecutive rows to draw in the same style before alternating, whenalternateRowStyles
is true.Whether alternating rows (or blocks of rows, depending onGridRenderer.alternateRowFrequency
) should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.Suffix to append toalternate rows
.When this attribute is set, editors will be appear to be present in every row of the grid, allowing the user to immediately start editing any cell, rather than showing up in a single record at a time.
This attribute is only valid wheneditByCell
is false.WhenallowFilterOperators
is enabled, whether to show theoperatorIcon
for all filterable fields, or only for fields where the user has explicitly chosen a search operator different from the default operator for the field.When animating folder opening / closing, this property can be set to apply an animated acceleration effect.IfanimateFolders
is true for this grid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.If true, when folders are opened / closed children will be animated into view.int
When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second.int
When animating folder opening / closing, ifTreeGrid.animateFolderSpeed
is not set, this property designates the duration of the animation in ms.WhencanRemoveRecords
is enabled, should records be animated out of view when they are removed by the user?int
Whenanimating record removal
, this property designates the speed of the animation in pixels per second.int
When animating record removal(see animateRemoveRecord)
, ifanimateRemoveSpeed
is not set, this property designates the duration of the animation in ms.If therollOverCanvas
is enabled, setting this property totrue
ensures that when therollOverCanvas
is displayed it is animated into view viaCanvas.animateShow()
.If therollUnderCanvas
is enabled, setting this property totrue
ensures that when therollUnderCanvas
is displayed it is animated into view viaCanvas.animateShow()
.If theselectionCanvas
is enabled, setting this property totrue
ensures that when theselectionCanvas
is displayed it is animated into view viaCanvas.animateShow()
.If theselectionUnderCanvas
is enabled, setting this property totrue
ensures that when theselectionUnderCanvas
is displayed it is animated into view viaCanvas.animateShow()
.IfListGridField.userFormula
is set for some field, and this grid is showinggroup summaries
or agrid summary
, this property determines what field value should be present in those summary rows.This property allows developers to explicitly setResultSet.applyRowCountToLength
for this grid's data object.boolean
ARIA role for this ListGrid ifscreen reader mode
is enabled.Dynamically retrieves the aria properties to write out for this listGrid inscreen reader mode
.Retrieves dynamically calculated defaultARIA state mapping
properties for this listGrid.Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the arrow keys to navigate around the grid.What to do when a user hits arrow key while editing a field?
If not explicitly specifiedgetArrowKeyEditAction()
will return an appropriate action depending on the field type.The value to display for cells when an error occurred during asynchronous computation.The prompt to display while interactivity is blocked duringasynchronous grouping
.The value to display for cells whose value was not computed by the previous asynchronous operation to compute it, or will not be computed by an asynchronous operation due to currently being disabled.Whether to do inline autoComplete in text fields during inline editing
Overridden byListGridField.autoComplete
if specified.For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded by default.IfDataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
depending onDataBoundComponent.getAutoFetchAsFilter()
.If true, for fields whereListGridField.optionDataSource
is specified, a valueMap will be automatically created by making aDataSource.fetchData()
call against the specified dataSource and extracting a valueMap from the returned records based on the displayField and valueField.boolean
Depending on whetherDataSource.progressiveLoading
is active, the exact count of available rows may not be available as part of the standard data fetch response - settingautoFetchRowCount:true
will cause a fetch for an accurate row count to be issued as soon as data arrives (from aprogressive dataSource response
) without an accurate row count.IfautoFetchData
istrue
, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()
call.If we're showing aheaderContextMenu
for this grid, andcanAutoFitFields
is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via theautoFitField()
method.String[]
IfautoFitFieldWidths
is enabled and the calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear.Should this ListGrid automatically expand to accommodate the size of records and fields?Should listGrids automatically size date fields to fit their values or titles? If set to"value"
, fields of type date will be rendered at the size specified bydefaultDateFieldWidth
, (ordefaultEditableDateFieldWidth
for editable fields).The field to expand ifautoFitFieldWidths
andautoFitFieldsFillViewport
are enabled and auto-fitting will not fill all available horizontal space.IfautoFitData
is set to"vertical"
or"both"
, setting this property will cause the ListGrid body to size large enough to accommodate the actual data and also leave this many extra rows' worth of blank space below the last record.IfautoFitFieldWidths
is enabled, and extra space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.If we're showing aheaderContextMenu
for this grid, and user-driven auto fit of fields is enabled viaListGridField.canAutoFitWidth
orcanAutoFitFields
, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or content via a call toautoFitField()
.Should ListGrid fields autofit their widths to titles or content? This property may be overridden on a per-field basis viaListGridField.autoFitWidth
.If this property is set to true, header buttons for eitherfields
orheader spans
will automatically expand to accommodate their titles vertically.Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields withtype:"icon"
, fields displaying onlyvalue icons
, and boolean fields (which are rendered as a checkmark type icon by default.int
IfautoFitData
is set to"horizontal"
or"both"
this property provides the maximum number of columns for which the ListGrid will expand.IfautoFitData
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
IfautoFitData
is set to"vertical"
or"both"
this property provides the maximum number of records for which the ListGrid will expand.IfautoFitData
is set to"horizontal"
or"both"
this property provides an upper limit on how far the ListGrid will expand horizontally to accommodate its content.IfautoFitData
is set to"horizontal"
or"both"
this property provides an upper limit on how far the ListGrid will expand horizontally to accommodate its content.Should listGrids automatically size time fields to fit their values or titles? If set to"value"
, fields of type time will be rendered at the size specified bydefaultTimeFieldWidth
.When a user requests column autofitting via theheader context menu
or via amouse gesture
, what autofit approach is used.Setting this property to a non-null value will enable automatic saving ofview state
to offline storage.If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell ifsaveByCell
is true).If this listGrid has specifiedheaderSpans
, setting this attribute to true will cause spans to expand to accommodate long titles if necessary.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.If the result of a formula evaluation is invalid (specifically, if isNaN(result)==true), badFormulaResultValue is displayed instead.base cell style
for this listGrid.protected String
getBaseStyle
(ListGridRecord record, int rowNum, int colNum) Return the base styleName for this cell.If specified, this attribute will be applied to this grid'sdata object
for dataBound grids.getBody()
Returns the primary body, which, when there are frozen fields, is thecom.smartgwt.client.grid.GridRenderer
used to render the non-frozen portion of the dataset; otherwise, the primary body (the only body) is the GridRenderer used to render the entire dataset.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 setting for the "body", that is, the area of the grid where data values are rendered.Get the current scrollLeft for the body of this ListGridGet the current scrollTop for the body of this ListGridCSS style used for the body of this grid.An optional CSS style to apply to the checkbox image.Image to display for a false value in a boolean field.int
int
Image to display for a partially true value in a boolean field (typically selection).Image to display for a true value in a boolean field.Dynamic String specifying the format for therow range summary value
whenRowRangeDisplayStyle
is set to"brief"
.Indicates whether records can be dropped into this listGrid.Adds an item to the header context menu allowing users to launch a dialog to define a new field to be sorted by an AI score of the entire record and possibility related records.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 {@link com.smartgwt.client..FormulaBuilder}.
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 {@link com.smartgwt.client..SummaryBuilder}.
Can the user perform one-time autofit for specific columns in this grid?If this is an editable listGrid, andthis.confirmCancelEditing
is true this property is used as the message to display in the confirmation dismissal prompt.Can a group be collapsed/expanded? When true a collapse/expand icon is shown (groupIcon
) and the user can collapse or expand the group by clicking either the row as a whole or the opener icon (seecollapseGroupOnRowClick
); When false the group icon is not shown and clicking on the row does not change group state.Indicates whether records can be dragged from this listGrid and dropped elsewhere.If this property is true, users can drag the mouse to select several rows or cells.If this property is true, users can drag the mouse to select text within grid rows, ready to be cliped to clipboard.
This is mutually exclusive withrearranging rows or cells by dragging
, and withdrag selection of rows
.If set to false, dropping over an empty part of the grid body is disallowed and the no-drop indicator is displayed.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 unless a custom override ofcanEditCell()
allows it.
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
Adds an item to the header context menu allowing users to launch a dialog to define grid hilites using theHiliteEditor
.boolean
If set to true, theadvanced field picker
provides an interface allowing users to modify fields' titles.WhencanExpandRecords
is true, this property indicates whether multiple records can be expanded simultaneously.Property name on a record that will be checked to determine whether a record can be expanded.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
If the listGrid is empty, should the user be able to put focus into the grid body by tabbing to it?Whether an interface should be shown to allow user is allowed to dynamically "freeze" or "unfreeze" columns with respect to horizontally scrolling.If false, grouping via context menu will be disabled.When set totrue
and AI component views are enabled, shows an item in this component's header context menu that allows the user to ask the AI to hilite the records according to a natural language description of which records to hilite.If true, cellHover and rowHover events will fire and then a hover will be shown (if not canceled) when the user leaves the mouse over a row / cell unless the corresponding field hasshowHover
set to false.boolean
When true, indicates that this ListGrid supports grouping on multiple fields.When true, indicates that this ListGrid supports sorting on multiple fields.Indicates whether the field picker item and submenu should be present in the header context menu.If true, thefield picker menu
will include entries for all dataSource fields, including those not included in the specifiedfields array
.If set, provide UI for the user to remove records from the grid as an additional field showing theremoveIcon
, which, when clicked, will callremoveRecordClick()
which removes the row from the data set (or ifdeferRemoval
is true changes themarkRecordRemoved()
status for the record).Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.Indicates whether records can be reordered by dragging within thisListGrid
.boolean
Depending on whetherDataSource.progressiveLoading
is active, the exact count of available rows may not be known, andcanRequestRowCount
controls whether the end user may explicitly request it by clicking theRowRangeDisplay
label.Indicates whether fields in this listGrid can be resized by dragging header fields.boolean
When enabled (the default), causes a "Saved views >" submenu to appear in the header context menu, last, allowing the user to create new saved searches, select previously saved searches, and edit or copy existing searches.Controls whether a checkbox for selecting all records appears in the header withselectionAppearance
set to "checkbox"Enables cell-level selection behavior as well ascell-level rollover
.boolean
Controls whether a checkbox for selectinggroups
appears in the group node ifSelectionAppearance
is set to"checkbox"
boolean
Whether to allow selection of the summary row, for example by clicking on the record.boolean
Should a menu item allowing the user to show or hide thefilter editor
be displayed in theheaderContextmenu
?Enables or disables interactive sorting behavior for this listGrid.Should the header be included in the tab-order for the page? If not explicitly specified, the header will be included in the tab order for the page ifSC.setScreenReaderMode()
is called.Should thecorner sort button
be included in the tab-order for the page?getCellAriaState
(Integer rowNum, Integer colNum, ListGridRecord record, String role) Returns a map ofWAI ARIA state attribute values
to be written into cells within this grid.The menu displayed when a cell is right clicked on.MenuItem[]
getCellContextMenuItems
(Integer record, Integer rowNum, Integer colNum) IfshowCellContextMenus
istrue
this method returns the menu items to be displayed in the default cell context menu.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
Default height for each row in pixels.protected Canvas
getCellHoverComponent
(Record record, Integer rowNum, Integer colNum) WhenshowHoverComponents
is set, this method is called to get the component to show as a hover for the current cell.int
The amount of empty space, in pixels, surrounding each value in its cell.Integer[]
getCellPageRect
(int rowNum, int colNum) Returns the page offsets and size of the cell at the passed row and column.Returns the default WAI ARIA role for cells within this listGrid.int
getCellRowSpan
(int rowNum, int colNum) When usingrow spanning
, returns the number of cells spanned by the cell at the given coordinates.WhencanSelectCells
is active, returns theCellSelection
object that tracks and manages the current selection.int
getCellStartRow
(int rowNum, int colNum) When usingrow spanning
, returns the row number where a row-spanning cell starts.protected String
getCellStyle
(ListGridRecord record, int rowNum, int colNum) Return the CSS class for a cell.Name of the Smart GWT Class to be used when creating charts.Default type of chart to plot.IfselectionAppearance
is set to"checkbox"
this property determines the image to display in the checkbox field for an unselected row.IfselectionAppearance
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.IfselectionAppearance
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.IfselectionAppearance
is set to"checkbox"
this property determines the image to display in the checkbox field for a partially selected row.IfselectionAppearance
is set to"checkbox"
this property determines the image to display in the checkbox field for a selected row.ForexpansionModes
that show another grid or tree, what the child's expansionMode should be.If we're showing aheaderContextMenu
for this grid, this attribute will be shown as the menu item title to clear any existing sort on all fields.boolean
When set to false, this attribute prevents user-criteria in thefilterEditor
from being cleared when the user hides it.If we're showing aheaderContextMenu
for this grid, and afilter-editor
is visible, this attribute will be shown as the menu item title to clear any existing filter.Title for the menu-item displayed in this component's header context-menu whenAI-assisted filtering
is allowed and an AI filter in already in effect.If we're showing aheaderContextMenu
for this grid, this attribute will be shown as the menu item title to clear an existing sort on this field.Whether the ListGrid should manage the clipping of titles of header buttons, showing ellipses if the title is clipped, and potentially showing the full title onhover
.boolean
IfcanCollapseGroup
is true, will a click anywhere on the group row toggle the group's expanded state? If false, the user must click thegroupIcon
directly to toggle the group.getColumnLeft
(Integer colNum) Return the left offset (in local coordinate space) of a particular column.getColumnPageLeft
(Integer colNum) Return the left coordinate for a given column number as a GLOBAL coordinategetColumnWidth
(int colNum) Return the width of a particular column.If we're showing aheaderContextMenu
for this grid, and multi-grouping is enabled, this attribute is used as the title for a menu item that opens aMultiGroupDialog
to configure the grouping for this grid.If we're showing aheaderContextMenu
for this grid, and multi-sorting is enabled, this attribute is used as the title for a menu item that opens aMultiSortDialog
to configure the sort-specification for this grid.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?For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded.Ifthis.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.Retrieves a copy of the current criteria for this component (may be null).The color of thefilterWindow criteria indicator
.The color of thefilterWindow criteria indicator
when shown on thesorter button
or the lastheader button
in the grid header.Returns the expansion component derived fromgetExpansionComponent()
currently visible in some record, or null if the specified record is not showing an expansion component.getCurrentExpansionComponent
(Integer record) Returns the expansion component derived fromgetExpansionComponent()
currently visible in some record, or null if the specified record is not showing an expansion component.Integer[]
Returns an array of widths of the visible fields in thisListGrid
, in px.A ListGrid is adataArity
:multiple component.Return the grid data as aRecordList
.Delay in milliseconds before fetching data.How to fetch and manage records retrieve from the server.int
When usingdata paging
, how many records to fetch at a time.The DataSource that this component should bind to for default fields and for performingDataSource requests
.How should Date type values be displayed in this ListGrid by default?Display format to use for fields specified as type 'datetime'.Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.Default width for date type fields.Default width for datetime type fields.Default width for editable date type fields.Default width for editable datetime type fields.An array of listGrid field configuration objects.Defaultfilter operator
to use for text-based fields in this grid'sfilter editor
, when producingAdvancedCriteria
.Text to show after the name of the default filterOperator in theheaderContextMenu
whenallowFilterOperators
is enabled.getDefaultFormattedFieldValue
(Record record, ListGridField field) Get a field value for some record with default field formatters applied.getDefaultFormattedFieldValue
(Record record, ListGridField field, int rowNum) getDefaultFormattedFieldValue
(Record record, ListGridField field, int rowNum, int colNum) Get a field value for some record with default field formatters applied.getDefaultFormattedValue
(Record record, int rowNum, int colNum) Get the value for some cell with default formatters applied.Default width for time type fields.When enabled, the field shown bycanRemoveRecords
causes records to be marked for future removal viamarkRecordRemoved()
instead of immediately being removed.Should partially selected checkbox be deselected or selected on click? This setting affectsheader selection checkbox
,group\n checkboxes
and folder checkbox selection in a Tree data set.IfcanExpandRecords
is true andlistGrid.expansionMode
is"related"
, this property specifies the dataSource for the related records grid to be shown embedded in expanded records.The field whose contents to show in the expanded portion of a record whencanExpandRecords
istrue
andlistGrid.expansionMode
isdetailField
.Prompt to indicate that grouping is disabled as the data set size exceedsgroupByMaxRecords
.boolean
If a user is editing acanEdit:true
listGrid, and they hide a field while the editor is showing, should we discard any edits in the edit row for the field being hidden?IfconfirmDiscardEdits
is true this is the title for the save button appearing in the lost edits confirmation dialog.getDisplayValue
(String fieldName, boolean value) Given a field with a specifiedvalueMap
ordisplayField
, this method will return the display value for any underlying data value.getDisplayValue
(String fieldName, float value) Given a field with a specifiedvalueMap
ordisplayField
, this method will return the display value for any underlying data value.getDisplayValue
(String fieldName, int value) Given a field with a specifiedvalueMap
ordisplayField
, this method will return the display value for any underlying data value.getDisplayValue
(String fieldName, String value) Given a field with a specifiedvalueMap
ordisplayField
, this method will return the display value for any underlying data value.getDisplayValue
(String fieldName, Date value) Given a field with a specifiedvalueMap
ordisplayField
, this method will return the display value for any underlying data value.Record[]
During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.Indicates what to do with data dragged into another DataBoundComponent.An automatically generated field that can be dragged to drag the current selection (where otherwise the grid itself might be scrolled).The title to use for thedrag handle field
.Default icon to show in thedrag handle field
..int
Default width and height ofdrag handle icons
for this ListGrid.int
LikescrollRedrawDelay
, but applies when the component is being drag-scrolled (via a scrollbar).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.CSS Style to apply to the drag tracker when dragging occurs on this component.float
How far should we render records ahead of the currently visible area? This is expressed as a ratio from viewport size to rendered area size.int
If drawing all rows would cause less thandrawAllMaxCells
cells to be rendered, the full dataset will instead be drawn even ifshowAllRecords
is false and the viewport size anddrawAheadRatio
setting would normally have caused incremental rendering to be used.Integer[]
Returns the extents of the rows and columns currently visible in this grid's viewport.int
getDrawnRowHeight
(int rowNum) Get the drawn height of a row.Integer[]
Get the rows that are currently drawn (exist in the DOM), as an array of [firstRowNum, lastRowNum].When an item is dropped on this component, andaddDropValues
is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled.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
Returns the index of the column being edited or -1 if there is no current edit column.getEditedCell
(int record, int field) Returns the current value of a cell.getEditedCell
(int rowNum, String fieldName) getEditedCell
(Record record, int colNum) getEditedCell
(Record record, String fieldName) getEditedRecord
(int rowNum) Returns the combination of unsaved edits (if any) and original values (if any) for a given row being edited.Event that will trigger inline editing, seeListGridEditEvent
for options.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 fromthis.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, usethis.editFailedBaseStyle
instead.getEditFormItem
(Integer field) Method to retrieve a live edit form item for aneditable
ListGrid.getEditFormItem
(String field) Method to retrieve a live edit form item for aneditable
ListGrid.Text for a menu item allowing users to edit a formula fieldShould we start editing when the widget has focus and the user presses the "f2" key (if this ListGrid supports editing)?Should we start editing when this widget receives focus (if this ListGrid supports editing)?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.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 usethis.editPendingBaseStyle
instead.The name of a CSS class used to overlay regular cell styles with additional styling when a cell has unsaved edits - these styles are in addition to the styling applied byeditPendingCSSText
oreditPendingBaseStyle
.Default class used to construct theEditProxy
for this component when the component isfirst placed into edit mode
.int
Returns the index of the row being edited or -1 if there is no current edit row.IfselectOnEdit
is true, what should be the edit-selection behavior be?Text for a menu item allowing users to edit the formatter for a fieldgetEditValue
(int rowNum, int colNum) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValue
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValueAsBoolean
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValueAsDate
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValueAsFloat
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValueAsInt
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValueAsRecord
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.Record[]
getEditValueAsRecordArray
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValueAsString
(int rowNum, String fieldName) Returns the current temporary locally stored edit value for some field within a record being edited.getEditValues
(int rowNum) Returns the current set of unsaved edits for a given row being edited.getEditValues
(Record record) Returns the current set of unsaved edits for a given row being edited.This is the pixel-amount by which child components are offset within the grid-body, by default from the left, or from the right whenRTL
is in effect.This is the space to apply as margin around child-components embedded in this grid.Hover contents to use when the AI-generated hover text is empty.The value to display for cells whose value is null or the empty string after applyingformatting
and valueMap (if any).The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.The CSS style name applied to theemptyMessage
if displayed.Row range summary display value
when the grid is empty.For performance reasons, even whenfixedRecordHeights
is set, vertical clipping is not enforced by default for some kinds of content (such as images) on all browsers.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.In a ListGrid that has a DataSource and has filter criteria that include values for fields declared astype "enum"
in the DataSource, by default a newly edited row will use those filter criteria as initial values.Height of the error icon, if we're showing icons when validation errors occur.Src of the image to show as an error icon, if we're showing icons when validation errors occur.Height of the error icon, if we're showing icons when validation errors occur.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
Returns the column number of the provided X-coordinate, or the most recent mouse event if an X-coordinate is not provided.int
Returns the column number of the provided X-coordinate, or the most recent mouse event if an X-coordinate is not provided.int
Returns the row number of the provided Y-coordinate, or the most recent mouse event if a Y-coordinate is not provided.int
Returns the row number of the provided Y-coordinate, or the most recent mouse event if a Y-coordinate is not provided.ForexpansionModes
that show another grid or tree, is that component editable?protected Canvas
getExpansionComponent
(ListGridRecord record) WhencanExpandRecords
is true, gets the embedded-component to show as a given record's expansionComponent.The method ofcomponent-pooling
to employ forexpansionComponents
.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.WhenExpansionMode
is editor, should the row be collapsed following a save initiated by the expansion-component'ssave button
.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.The title for theexpansionEditorSaveButton
.WhencanExpandRecords
is true andexpansionMode
is editor, the prompt to display in a dialog when an expanded row is collapsed while it's nested editor has changed values.WhencanExpandRecords
is true andexpansionMode
is editor, whether a dialog should be displayed when an expanded row is collapsed while it's nested editor has changed values.The field providing the facility to expand and collapse rows.IfcanExpandRecords
is set totrue
, this property determines the image to display in the expansion field for collapsed rows.IfcanExpandRecords
is set totrue
, this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded.boolean
If this grid is in RTL mode, should an "_rtl" suffix be added to theexpansionFieldTrueImage
andexpansionFieldFalseImage
image URLs? This should only be enabled if RTL media for the true and false expansion field images are available.boolean
Should a "_selected" suffix be added to theexpansionFieldTrueImage
andexpansionFieldFalseImage
image URLs for selected rows?Custom style to apply to the image in theexpansionField
displayed in collapsible rows whencanExpandRecords
is true.IfcanExpandRecords
is set totrue
, this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded.IfcanExpandRecords
is set totrue
, this property determines the image to display in the expansion field for expanded rows.WhencanExpandRecords
is true, this is the pixel-amount by which child components are offset within the grid-body, by default from the left, or from the right whenRTL
is in effect.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.TheExpansionMode
for records in this grid.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.Screen to create (viacreateScreen()
) in lieu of callinggetExpansionComponent()
.int
If we're showing the filterEditor (showFilterEditor
is true), this property determines the delay in kicking off the filter request if the current filter values are submitted by clicking the filter button or hitting return.Setting exportAll to true prevents the component from passing its list of fields to the 
 export call.When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, background color to use for even-numbered rows, to create a "banded" or "ledger" effect.getExportBGColor
(int rowNum, int colNum, Record record) When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, background color to use for the cell at the given rowNum and colNum.getExportColumnBGColor
(int colNum) When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, background color to use for the given colNum.Default background color to use when exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
.boolean
When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, whether fieldhorizontal header alignments
anddata value alignments
should be replicated in the resulting spreadsheet.String[]
The list of field-names to export.boolean
When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, whether widths of fields should be replicated in the resulting spreadsheet.boolean
When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, causes theheaderHeight
andheaderSpan heights
to be applied to the corresponding cells in the spreadsheet.int
Width to size non-visible fields (which may be specified withexportFields
orDSRequest.exportFields
) duringexportData()
orexportClientData()
, if they have no defined numericwidth
.If Summary rows exist for this component, whether to include them when exporting client data.Dictates whether numeric values should be exported as raw numbers instead of formatted values when usingexportClientData()
.Dictates whether the data in this grid should be exported raw byexportClientData()
.getExportRowBGColor
(int rowNum, Record record) When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, background color to use for the given rowNum.getExportTextColor
(int rowNum, int colNum, Record record) When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, text color to use for the cell at the given rowNum and colNum.double
Scaling factor to translate from ListGrid field widths in pixels to Excel/OpenOffice units for field width, which are 1/256th of the width of the widest digit character in the default font for the spreadsheet.boolean
When exporting data to Excel/OpenOffice format usingexportData()
orexportClientData()
, whether titles in theListGrid header
andheaderSpans
should be allowed to wrap.int
If we're showing the filterEditor (showFilterEditor
is true), andfilterByCell
orfilterOnKeypress
are enabled, this property is the delay in milliseconds between the user changing the filter and the filter request being sent to the server.Fields that will be always requested from the server when the grid fetches data, even if they are not visible - may be either an array of fields or a CSV string.Fields that will be always requested from the server when the grid fetches data, even if they are not visible - may be either an array of fields or a CSV string.Operation ID this component should use when performing fetch operations.IfautoFetchData
istrue
, this attribute allows the developer to declaratively specifyDSRequest
properties for the initialfetchData()
call.getField
(int colNum) Given a column number or field name, return the field definition of a field which is visible in the grid.Given a column number or field name, return the field definition of a field which is visible in the grid.Returna an array of field alignments for this gridgetFieldByName
(String fieldName) Given a field name, return the appropriate field definition.Returns the pixel width of the content of a visible field in this grid.int
Return the number of fields.The field criteria prefix to show in filter editor field hover before the descriptive version of the field's criteria, if any.getFieldName
(int colNum) Given a column number or field id, return the field name of a field.int
getFieldNum
(int fieldID) Given a field or field id, return it's index in the fields arrayint
getFieldNum
(String fieldID) Given a field or field id, return it's index in the fields arrayString[]
Names of properties onListGridField
for which theFieldPicker
should show an editing interface, for convenience.When set to false, sample values of the FieldPicker are never shown.Instance ofFieldPickerWindow
used ifuseAdvancedFieldPicker
is set.An array of field objects, specifying the order, layout, formatting, and sorting behavior of each field in the listGrid object.Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.void
getFieldSearchOperator
(String fieldName) Returns the current search-operator applied to criteria for a given field in this grid'sfilter row
.Initialfield state
for the grid.getFieldTitle
(int fieldId) Return the title of a field, specified by name or index.getFieldTitle
(String fieldId) Return the title of a field, specified by name or index.If we're showing aheaderContextMenu
for this grid, andthis.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.getFieldWidth
(int fieldNum) Returns a numeric value for the width of some field within thisListGrid
.getFieldWidth
(String fieldName) Returns a numeric value for the width of some field within thisListGrid
.The prompt to show when the mouse hovers over the Filter button in the FilterEditor.IfshowFilterEditor
is true, this attribute may be used to customize the filter button shown to the right of the filterEditor row.boolean
If we're showing thefilterEditor
, should this list be filtered every time the user changes edit values for particular cells rather than waiting for an Enter keypress or a click on the filterEditor submit button.IfshowFilterEditor
is set to true, thefilterEditor
is automatically created as an AutoChild.IfshowFilterEditor
is true, this method will return the criteria currently displayed in thefilterEditor
.getFilterEditorCriteria
(Boolean omitHiddenFields) IfshowFilterEditor
is true, this method will return the criteria currently displayed in thefilterEditor
.Same asgetFilterEditorCriteria()
but returns anAdvancedCriteria
.getFilterEditorCriterion
(String fieldName) Extracts and returns the criteria for the passed field from thefilterEditor
.int
Height for the filterEditor, if shown.Properties to apply to the automatically generatedfilterEditor
ifshowFilterEditor
is true.Causes filtering to be performed against the local data set, even when adataSource
is provided.boolean
When this attribute is true and this component has been assigned asearchForm
or is showing thefilterEditor
, data will be filtered automatically as users change values in those components.Text for the menu item shown in theheaderContextMenu
whenallowFilterOperators
is enabled.If filtering of the grid is enabled, filtering-via-AI can also be enabled by setting theAIServiceMode
to use.The instruction text to display above the "Filter via AI" text box.Title for the menu-item displayed in this component's header context-menu whenAI-assisted filtering
is allowed.Advanced filtering criteria, eithersimple
oradvanced
, that is combined with thefilter editor criteria
during filtering.Instance ofCanvas
used to show visual indicator thatfilterWindowCriteria
is configured.The instruction text to display at the top of thefilterWindow
.The title for theadvanced filtering window
.The style to apply to the first cell in each row, whenstyledRowEnds
is true.Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?Get the row that currently has keyboard focus.Returns thecurrent total row count
for this grid as a formatted string.Uses therowRangeFormat
to return a formatted display value showing the currently visible set of rows in the listGrid viewport.If this grid has specifiedheaderSpans
, andshowHeaderSpanTitlesInFormulaBuilder
is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid in the FormulaBuilder and SummaryBuilder.getFormulaFieldValue
(ListGridField field, Record record) Get the computed value of acanAddFormulaFields
.If we're showing aheaderContextMenu
for this grid andthis.canFreezeFields
is true, this string will be shown as the title for the menu item to freeze a currently unfrozen field.If this listGrid contains any frozen fields, this property can be used to apply a custom baseStyle to all cells in those frozen fields.Maximum width available for anyfrozen fields
shown in this grid.Maximum width available for anyfrozen fields
shown in this grid.If this listGrid contains any frozen fields, this property can be used to apply a custom headerBaseStyle to the frozen set of fields.If this listGrid contains any frozen fields, this property can be used to apply a custom headerTitleStyle to the frozen set of fields.protected Canvas
getFrozenRollOverCanvas
(Integer rowNum, Integer colNum) For grids with frozen columns, this method is called to retrieve thefrozenRollOverCanvas
when the user moves over a new row or cell ifshowRollOverCanvas
is true, or when the user moves over the selected record ifshowSelectedRollOverCanvas
is true.protected Canvas
getFrozenRollUnderCanvas
(Integer rowNum, Integer colNum) For grids with frozen columns, this method is called to retrieve thefrozenRollUnderCanvas
whenshowing a rollUnder canvas
or showing arollUnder canvas for the selected record
.Dynamic String specifying the format for therow range summary value
whenRowRangeDisplayStyle
is set to"full"
.If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a click event.If true, when the user navigates to a cell using arrow keys and hits space, the cell will respond to a click event.If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a double click event.If true, when the user navigates to a cell using arrow keys and hits Space, the cell will respond to a double click event.The additional criteria prefix to show in filter editor field hover, the filter action button or the sorter button before the descriptive version of thefilterWindowCriteria
, if any.Array of components that make up this grid.Synonym ofgetBody()
.getGridSummary
(ListGridField field) WhenshowGridSummary
istrue
this method is called for each field which will show a grid summary value (as described inListGridField.showGridSummary
) to get the summary value to display below the relevant column.This method returns the data displayed in thesummaryRow
whenshowGridSummary
is true.IfshowGridSummary
is true, this attribute will be set to true on the record object representing the grid summary row.int
When grouping is requested with this number of records or more, an asynchronous approach is used to avoid the browser showing a "script is running slowly.." message prompting the user to stop execution of JavaScript.String[]
Get the current grouping of this listGrid as an array of fieldNames.String[]
If this grid isgrouped
, andshowGroupSummary
is true, this attribute may be set to an array of groupBy field names for which group summaries should appear.int
Maximum number of records to which a groupBy can be applied.Warning shown to the user when a grouping attempt failed as the data set length exceedsgroupByMaxRecords
.If we're showing aheaderContextMenu
for this grid andthis.canGroupBy
is true, this string will be shown as the title for the menu item to toggle the group by setting for a field.int
getGroupedRecordIndex
(ListGridRecord record) Returns the true row index for a grouped record excluding group and summary records.The URL of the base icon for the group icons in this listGrid.int
Default width and height of group icons for this ListGrid.Custom style to apply to thegroupIcon
displayed in collapsible rows whencanGroupBy
is true.int
Default number of pixels by which to indent subgroups relative to parent group.int
Default number of pixels by which to indent all groups.getGroupMembers
(GroupNode node, boolean recordsOnly) For agrouped
grid, returns all the direct children of the supplied node in thegroupTree
ifrecordsOnly
false.Base style
forgroup
rows.The CSS style thatgroup
rows will have.WhensortByGroupFirst
is active, the sorting direction applied for implicit sorting by the field(s) used for grouping.Initial group state for the grid.getGroupSummaryData
(Record[] records, Record groupNode) If this grid isgrouped
, andshowGroupSummary
is true, this method will return the group summary data displayed at the end of the group.getGroupSummaryData
(Record[] records, Record groupNode, Boolean recalculate) If this grid isgrouped
, andshowGroupSummary
is true, this method will return the group summary data displayed at the end of the group.getGroupSummaryData
(Record[] records, GroupNode groupNode) If this grid isgrouped
, andshowGroupSummary
is true, this method will return the group summary data displayed at the end of the group.getGroupSummaryData
(Record[] records, GroupNode groupNode, Boolean recalculate) If this grid isgrouped
, andshowGroupSummary
is true, this method will return the group summary data displayed at the end of the group.IfshowGroupSummary
is true, this attribute will be set to true on each record object representing a group-level summary row.ListGridRecord.customStyle
for the group-level summary row displayed whenshowGroupSummary
is true.Custom properties for the automatically generatedgroupTitleColumn
.When a list grid isgrouped
, each group shows under an auto generated header node.The data tree that results from a call togroupBy()
.If this gridis grouped
, this method will return the current selection.getGroupTreeSelection
(boolean excludePartialSelection) getGroupTreeSelection
(boolean excludePartialSelection, boolean groupNodesOnly) If this gridis grouped
, this method will return the current selection.A Toolbar used to manager the headers shown for each column of the grid.Event on a ListGrid header that triggers auto fitting to data and/or title.BackgroundColor for the header toolbar.Set the CSS style used for the header as a whole.Button.baseStyle
to apply to the buttons in the header, and the sorter, for this ListGrid.Defaultrole
forheader buttons
.DefaultARIA state
forheader buttons
.Properties to apply to all header buttons.The context menu displayed for column headers.protected MenuItem[]
getHeaderContextMenuItems
(Integer fieldNum) IfshowHeaderContextMenu
istrue
this method returns the menu items to be displayed in the default header context menu.int
The height of this listGrid's header, in pixels.This property may be set to customize the alignment for the hover shown onListGrid.headerHover()
.Optional default height for the hover shown onListGrid.headerHover()
.This property may be set to customize the opacity for the hover shown onListGrid.headerHover()
.This property may be set to customize the css style for the hover shown onListGrid.headerHover()
.This property may be set to customize the vertical alignment for the hover shown onListGrid.headerHover()
.Optional default width for the hover shown onListGrid.headerHover()
.This property may be set to customize thewrap
attribute for the hover shown onListGrid.headerHover()
.IfshowHeaderMenuButton
is true, when the user rolls over the header buttons in this grid the headerMenuButton will be shown over the header button in question.int
IfshowHeaderMenuButton
is true, this property governs the height of the auto-generatedheaderMenuButton
IfshowHeaderMenuButton
is true, this property governs the height of the auto-generatedheaderMenuButton
IfshowHeaderMenuButton
is true, this property governs the icon shown on the auto-generatedheaderMenuButton
int
IfshowHeaderMenuButton
is true, this property governs the height of the icon shown on the auto-generatedheaderMenuButton
int
IfshowHeaderMenuButton
is true, this property governs the width of the icon shown on the auto-generatedheaderMenuButton
Offset of the right edge of aheaderMenuButton
from the right edge of it's parent button.int
IfshowHeaderMenuButton
is true, this property governs the width of the auto-generatedheaderMenuButton
When set to any valid CSS border-radius string, allows for a rounded header in this grid by applying a corner-radius to the left of theheader
, and to the right of thecorner sort-button
if it's visible, or the right of theheader
otherwise.IfshowHeaderShadow
is true, theCanvas.shadowColor
for the header shadow.int
IfshowHeaderShadow
is true, theCanvas.shadowHOffset
for the header shadowint
IfshowHeaderShadow
is true, theCanvas.shadowSoftness
for the header shadowint
IfshowHeaderShadow
is true, theCanvas.shadowVOffset
for the header shadowNote : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.MenuItem[]
getHeaderSpanContextMenuItems
(HeaderSpan headerSpan) Return the menus items that should be shown in a menu triggered from aheaderSpan
.Default height for aheaderSpan
with no height specified.StretchImgButton.titleStyle
to apply to the buttons in the header, and the sorter, for this ListGrid.Specifies vertical alignment in the column headers: "top", "center", or "bottom".If true, causes thesummaryRow
component to be hidden if it has no data after summaries have been recalculatedWhencanShowFilterEditor
is true, this is the title for the filterEditor show/hide menu-item, in theheaderContextmenu
, when the filterEditor is visible.If set, end users can create advanced hiliting rules that will use theHilite.replacementValue
feature to cause values in hilited cells to be replaced with a user-entered value.If this grid has specifiedheaderSpans
, andshowHeaderSpanTitlesInHiliteEditor
is true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser grid.boolean
If set to true, custom HTML applied as part of hiliting will be applied afterformatting
for each cell.Height for hilite icons for this listGrid.int
How much padding should there be on the left ofhilite icons
by default? Can be overridden at the field levelWhenhiliteIcons
are present, where the hilite icon will be placed relative to the field value.int
How much padding should there be on the right ofhilite icons
by default? Can be overridden at the field levelString[]
Specifies a list of icons that can be used inhilites
.int
Default width and height ofhilite icons
for this component.Width for hilite icons for this component.Marker that can be set on a record to flag that record as hilited.Title used for the text box shown whenhiliteCanReplaceValue
is set.When the grid body gets keyboard focus, should we highlight the current focus row, using the rollover cell style?Hilite[]
Return the set of hilite-objects currently applied to this DataBoundComponent.Get the current hilites encoded as a String, for saving.WhencanHiliteViaAI
istrue
, the AI service mode to use.Title for the menu item displayed in this component's header context menu whenAI-assisted hiliting
is allowed.WhenshowHoverComponents
is true, the builtin mode to use when automatically creating a hover component for rows in this grid.Screen to create (viacreateScreen()
) in lieu of callinggetHoverComponent()
orgetCellHoverComponent()
.Style to apply to hovers shown over this grid.Default cursor to display when the user rolls over icons within cells of antype:icon
field.When usingautoFitFieldWidths
, padding in pixels left on each side of fields that show images.int
Default size of thumbnails shown for fieldTypes image and imageFile.Criteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria
,DataBoundComponent.setCriteria()
etc.boolean
When assembling a value for asummary field
, if a referenced field is hilited, should the hilite HTML be included in the summary field value?Property name on a record that will be checked to determine whether a record should be included when calculating totals for thegrid summary
.Criteria to use whenDataBoundComponent.setAutoFetchData(Boolean)
is used.An array ofSortSpecifier
objects used to set up the initial sort configuration for this grid.If true, if the user clicks on the scroll buttons at the end of the track or clicks once on the scroll track, there will be an instant redraw of the grid content so that the user doesn't see any blank space.Value to display to the user if showing summary values (throughshowGridSummary
,showGroupSummary
orlistGridFieldType:"summary"
), and the summary function returns"null"
(implying it was unable to calculate a valid summary value).boolean
True if this listGrid is grouped, false otherwiseIfrecord[this.isSeparatorProperty]
is set for some record, the record will be displayed as a simple separator row.The style to apply to the last cell in each row, whenstyledRowEnds
is true.Whether to leave a gap for the vertical scrollbar, even when it's not present.Property name on a record that will hold the link text for that record.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.The string to display in the body of a listGrid while data is being loaded.The CSS style name applied to the loadingDataMessage string if displayed.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.int
Height for theloadingRowCountDisplayIcon
The URL of the icon to display as arow count value
when the row count is loading.int
Width for theloadingRowCountDisplayIcon
WhenAutoTest.getElement()
is used to parse locator strings generated byAutoTest.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.WhenAutoTest.getElement()
is used to parse locator strings generated byAutoTest.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.Getter implementing theLogicalStructure
interface, which supports Eclipse's logical structure debugging facility.int
When the length of the field specified byDataSourceField.length
exceeds this value, the ListGrid shows an edit field of typelongTextEditorType
rather than the standard text field when the field enters inline edit mode.When the length of the field specified byDataSourceField.length
exceedsthis.longTextEditorThreshold
show an edit field of this type rather than the standard text field when the field enters inline edit mode.WhencanExpandRecords
andcanExpandMultipleRecords
are both true, this property dictates the number of records which can be expanded simultaneously.This is a dynamic string - text within${...}
will be evaluated as JS code when the message is displayed.IfshowGridSummary
is true, and summary records are being derived from a fetch against thesummaryRowDataSource
, this property may be set to specify the maximum expected number of results from the fetch opeeration.int
Minimum size, in pixels, for ListGrid headers.int
Sets theminimum height
for the entire list (smaller than this doesn't tend to work very well).int
Minimum height for ListGrid cells, settable by the skin, based on the size of the checkbox media used for boolean fields plus minimal surrounding padding.If a summary format string contains an invalid field reference, replace the reference with the missingSummaryFieldValue.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.Class-level defaults to apply to theMultiGroupDialog
which gets automatically generated whenconfigureGrouping()
is called.Properties to apply to theMultiGroupDialog
which gets automatically generated whenconfigureGrouping()
is called.IfcanSelectCells
is true, this property allows the user to navigate through the cells of a grid using Tab and Shift+Tab keypresses.If true, validation will not occur as a result of cell editing for this grid.If this listGrid is showing the 'newRecordRow' (used for adding new rows to the end of the data), this property determines what message should be displayed in this row.Text to show for saving the current view as a new "saved search"."Normal" baseStyle for this listGrid.int
IfbaseStyle
is unset, base style will be derived fromnormalBaseStyle
if this grid has fixed row heights and the specifiedcellHeight
matches this value.Text to show in menu listing saved searches when there are no saved searches.Default alias to use for groups with no valueThe CSS style name applied to theofflineMessage
if displayed.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.static ListGrid
getOrCreateRef
(JavaScriptObject jsObj) Return the underlying, ungrouped data of this DataBoundComponent as aRecordList
.Return the underlying, ungrouped data of this ListGrid as aResultSet
.Name of a CSS Style to use as thebaseStyle
for a cell that is currently a selection origin for shifted incremental cell selection.The value to display for cells whose value is pending asynchronous computation.Message to show in the hover while AI-generated hover text is being retrieved for fields specifying anaiHoverRequest
.Should recycledrecord components
, be pooled per column or per record.IfshowRollOver
orhiliteRowOnFocus
is true the current keyboard focus row for navigation via arrow keys, etc, will be hilighted with"Over"
styling.Should cells be written out with css that will preserve whitespace?If set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.Whether cell contents should wrap during printing.Style for non-header cells in printed output.If set, thebooleanBaseStyle
to use whenprinting
.If set, thebooleanFalseImage
to use whenprinting
.If set, thebooleanPartialImage
to use whenprinting
.If set, thebooleanTrueImage
to use whenprinting
.If set, thecheckboxFieldFalseImage
to use whenprinting
.If set, thecheckboxFieldPartialImage
to use whenprinting
.If set, thecheckboxFieldTrueImage
to use whenprinting
.Style for header cells in printed output.int
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.Whether cell contents should wrap during printing.Indicates whether or not this component will load its dataprogressively
float
Alternative todrawAheadRatio
, to be used when the user is rapidly changing the grids viewport (for example drag scrolling through the grid).getRecord
(int recordNum) Return the pointer to a particular record by record number.This attribute allows custom base styles to be displayed on a per-record basis.If set to false on a record andcanRemoveRecords
is true, removal of that record is disallowed in the UI.If set to false on a record, selection of that record is disallowed.If this property is set on a record it will designate the WAI ARIA role for cells within this records rowgetRecordComponent
(int rowNum) Retrieve therecordComponent
currently being shown at the given coordinates.getRecordComponent
(int rowNum, Integer colNum) Retrieve therecordComponent
currently being shown at the given coordinates.IfshowRecordComponents
is true, this attribute may be used to specify a standard height for record components.The method ofcomponent-pooling
to employ forrecordComponents
.ifshowRecordComponents
is true, how should the component appear within the cell.The name of the ListGridRecord property that specifies the DataSource to use whenlistGrid.expansionMode
is "related".IfcanAcceptDroppedRecords
is true for this listGrid, this property governs whether the user can drop between, or over records within the grid.Returns theRecordDropPosition
for some record drop operation.Property name on a record that should be checked to determine whether the record may be edited.Property name on a record that will be checked to determine whether a record is enabled.int
getRecordIndex
(Record record) Get the index of the provided record.
int
getRecordIndex
(ListGridRecord record) Get the index of the provided record.Return the underlying data of this DataBoundComponent as aRecordList
.When set to any valid CSS border-radius string, allows for rounded records in this grid by havinggetCellCSSText()
apply a corner-radius to the first and last cells in each record.Array ofRecordTypes
that should be rounded whenrecordRadius
is set to a valid CSS border-radius string.If this property is set on a record it will designate a mapping of WAI ARIA attribute names and values for this record's row.If this property is set on a record it will designate the WAI ARIA role for this record's row.Returns the current set of records displayed in this grid as an array of ListGridRecord objects.Screen to create (viacreateScreen()
) in lieu of callinggetRecordComponent()
.Name of the property that can be set on a per-record basis to disabled rollover for an individual record whenshowRollOver
is true.If showing any record summary fields (IE: fields oftype:"summary"
), this attribute specifies a custom base style to apply to cells in the summary fieldgetRelatedDataSource
(ListGridRecord record) Returns theDataSource
containing data related to the passed record.Custom CSS text to be applied to records that have beenmarked for removal
.Returns a JavaScriptObject containing defaultListGridField
attributes of remove fields.Configuration properties for the "remove field" displayed whencanRemoveRecords
is enabled.The title to use for theremove field
.WhencanRemoveRecords
is enabled, default icon to show in the auto-generated field that allows removing records.int
Default width and height ofremove icons
for this ListGrid.Custom style to apply to the image in theremoveField
displayed in rows whencanRemoveRecords
is true.operationId
this component should use when performing remove operations.boolean
If true, when an update operation occurs on a selected record in adatabound
listGrid, ensure the updated record is re-selected when the operation completes.ifreselectOnUpdate
is true, this property governs what selection changed notifications should be triggered when a selected record is edited then automatically reselected when the edited data is merged into the data set.boolean
Iftrue
, the grid contents are redrawn in real time as fields are resized.Return the underlying data of this DataBoundComponent as aResultSet
.If a page is rendered inRTL mode
, should cell alignments specifiedListGridField.cellAlign
be reversed (so analign:"right"
field will have content aligned on the left and vice versa)?protected Canvas
getRollOverCanvas
(Integer rowNum, Integer colNum) This method is called to retrieve therollOverCanvas
when the user moves over a new row or cell ifshowRollOverCanvas
is true, or when the user moves over the selected record ifshowSelectedRollOverCanvas
is true.protected Canvas
getRollUnderCanvas
(Integer rowNum, Integer colNum) This method is called to retrieve therollUnderCanvas
when the user moves over a new row or cell ifshowing a rollUnder canvas
or showing arollUnder canvas for the selected record
.int
IfshowHeaderMenuButton
is true, this property governs the height of the auto-generatedheaderMenuButton
over arotated
header button.IfshowHeaderMenuButton
is true, this property governs the height of the auto-generatedheaderMenuButton
over arotated
header button.int
IfshowHeaderMenuButton
is true, this property governs the width of the auto-generatedheaderMenuButton
over arotated
header button.Whether to rotate the field titles so they're rendered vertically from bottom to top.Returns a mapping of default WAI ARIA attributes for rows within this listGrid.Retrieves therow count
for the grid, which may differ from the reporteddata length
ifprogressive loading
is enabled.When an exactrow count
is not known due to progressive loading, this attribute allows the formatted row count returned bygetFormattedRowCount()
and ultimately displayed in therowRangeDisplay label
to be rounded to a multiple of the specified value.Integer[]
Retrieves therow count range
for listGrids whereprogressive loading
is active and the row count has been specified as arange
.This method indicates whethergetRowCount()
reflects an accurate row-count for this listGrid.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.getRowErrors
(int rowNum) Returns any currently stored validation errors for this row in the following format:
{fieldName:[array of error messages], ...}
int
getRowHeight
(ListGridRecord record, int rowNum) Return the height this row should be.IflocateRowsBy
has been set to "cellValue", this property may be used to specify which field's cell value to use.String[]
IflocateRowsBy
has been set to "cellValue", this property may be used to specify which field's cell value to use.int
getRowNum
(ListGridRecord record) Synonym ofgetRecordIndex()
.An automatically generated field that displays the current row number whenshowRowNumbers
is true.int
The number to start the row-count from - default value is 1.The CSS Style name for therowNumberField
.int
getRowPageTop
(int rowNum) Returns the Y-coordinate for a given row number as a page-relative coordinate.RowRangeDisplay
autoChild, which may be retrieved by callinggetRowRangeDisplay()
.How should thegetFormattedRowRange()
format the row range and row count for display to the user?This method will return a row range summary display value containing the currently visible row range and row count for the data set.Dynamic String specifying the format for thevisible row range
.Returns the default WAI ARIA role for rows within this listGrid.int
getRowSpan
(ListGridRecord record, int rowNum, int colNum) Return how many rows this cell should span.IfallowRowSpanning
is enabled, this property may be used to specify editing behavior for cells that span multiple rows.Chooses the selection mode whenuseRowSpanStyling
is enabled.int
getRowTop
(int rowNum) Returns the top coordinate for a given row number, relative to the top of body content.Whether edits should be saved whenever the user moves between cells in the current edit row.Should the currentfilter-criteria
be included along with other details when saving this grid'sview-state
?boolean
Saves the name of the default search to localStorage, under the key "sc_defaultSearch:" + minimal locator.Override ofSavedSearches.adminRole
for this component.Properties for the separator record between locally saved and admin searches.Override ofSavedSearches.defaultDataSource
for this component.Optional identifier for saved searches that should be applied to this component.Set to "criteria" if you want only criteria to be stored for ListGrids and TreeGrids instead of the full viewState of the component.Text to show for the saved searches submenu.Returns theview state
for this ListGrid as last saved by theautoPersistViewState
setting.For grids with a specifieddataSource
, this property can be set totrue
to cause the grid directly update its local data set instead of performing an operation against it's configured DataSource.For editable grids with a specifieddataSource
, wheresaveLocally
is false, this attribute may be used to specify standard DSRequest properties to apply to all save operations performed by this grid (whether triggered by user interaction, or explicit saveEdits or saveAllEdits call).Special cell-separator that may be inserted between cell values when screen-readers are reading the content of a row.Should column titles be read along with cell values when screen-readers are reading the content of a row? Only applies when screen-reader mode is enabled, and for ListGrids withariaRole:"list"
.boolean
Ifscreen reader mode is enabled
, andcanSelectCells
is true should the user be able to navigate the grid cell-by-cell, highlighting and focusing on individual cells within the selected row via left and right arrow keypresses?Special row-separator that may be inserted at the end of the row value when screen-readers are reading the content of a row.Whenscreen reader mode
is enabled, for grids withariaRole
set to"list"
, should a custom aria-labelledby attribute be written out in addition to any otherrow aria properties
to ensure thecolumn titles
,screenReaderCellSeparator
andscreenReaderRowSeparator
are read out along with cell content when reading rows?int
While drag scrolling in an incrementally rendered grid, time in milliseconds to wait before redrawing, after the last mouse movement by the user.When scrollToCell is called, this is used as defaults if xPosition weren't explicitly passed into the method.When scrollToCell is called, this is used as defaults if yPosition weren't explicitly passed into the method.While scrolling an incrementally rendered grid, using the mouseWheel, time in milliseconds to wait before redrawing, after the last mouseWheel movement by the user.When declared, the specified form is automatically used as a search form for this grid, that is,form.getValuesAsCriteria()
is called and the criteria returned are additive with any criteria present in theFilterEditor
orFilter Window
.When declared, the specified form is automatically used as a search form for this grid, that is,form.getValuesAsCriteria()
is called and the criteria returned are additive with any criteria present in theFilterEditor
orFilter Window
.If this property is set to true, clicking on a cell will natively select the cell's content, ready to be copied to the browser clipboard.Returns the selected cells as a series of Records where each field value is stored under it's offset from the top-left of the selection.Returns the first selected record in this grid.Returns all selected records in this grid.getSelectedRecords
(boolean excludePartialSelections) Returns all selected records in this grid.Returns a snapshot of the current selection within this listGrid as aListGridSelectedState
object.
This object can be passed tosetSelectedState()
to reset this grid's selection the current state (assuming the same data is present in the grid).If true, show the field-header for the sorted field (or the first field in amulti-sort
grid) in the selected state.Deprecated.usegetSelectedRecords()
insteadgetSelection
(boolean excludePartialSelections) Deprecated.usegetSelectedRecords(boolean)
insteadHow selection of rows should be presented to the user.If specified, the selection object for this list will use this property to mark records as selected.Defines a listGrid's clickable-selection behavior.When the user starts editing a row, should the row also be selected?boolean
When set to false, clicking a record'sexpansion field
will not add the record to the current selection.CSS class to apply to rows marked asseparators
in this grid.Whether all columns should be drawn all at once, or only columns visible in the viewport.Whether all records should be drawn all at once, or only records visible in the viewport.If set to false, do not show theasynchGroupingPrompt
dialog duringasynchronous grouping
.Iftrue
this grid will create and show per-row backgroundComponents as detailedhere
.Whether to show a context menu with standard items for all context clicks on rows in the body.boolean
If true and a header button's title is clipped, then a hover containing the full field title is enabled.If true and a cell's value is clipped, then a hover containing the full cell value is enabled.Should group summaries be visible when the group is collapsed?Whether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
Whether to include fields markeddetail:true
from this component'sDataSource
.Controls whether to show a drop-indicator during a drag and drop operation.boolean
Should ellipses be displayed when cell content is clipped? May be overridden at the field level viaListGridField.showEllipsisWhenClipped
Indicates whether the text of the emptyMessage property should be displayed if no data is available.boolean
If this grid is editable, and an edit has caused validation failure for some cell, should we show an icon to indicate validation failure?WhenExpansionMode
is editor, should a Save button be shown below the the expanded editor?boolean
Should this listGrid display a filter row.When set to false, no hover is shown for the filter editor fields.WhencanShowFilterEditor
is true, this is the title for the filterEditor show/hide menu-item, in theheaderContextmenu
, when the filterEditor is hidden.Should an indicator be shown to indicate thatfilterWindowCriteria
is configured? The indicator is a small triangle shown in the top-right of the grid header or filter.Should this ListGrid show a summary row beneath the last record of the grid.If this listGrid supportsgrouping
, 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.If this grid isgrouped
, andshowGroupSummary
is true, setting this property causes field summary values for each group to be displayed directly in the group header node, rather than showing up at the bottom of each expanded group.If this grid isgrouped
andshowGroupSummaryInHeader
is true, instead of group header nodes showing up with a single cell value spanning the full set of columns, summaries for each field will show up in the appropriate columns of the header node.boolean
If this isgrouped
and hasfrozen fields
, should the group title show in the frozen or unfrozen body?Should we show the header for this ListGrid?Whether to show a context menu on the header with standard items for showing and hiding fields.If set to true andshowHeaderContextMenu
is true, theheaderMenuButton
will be displayed when the user rolls over the header buttons in this grid.Should partial selection of all records be shown in header with a special icon? The partial icon will show in the header whencanSelectAll
is enabled and at least one record is selected but all records are not selected.Should the header show a drop-shadow? Shadow will be applied to the header, or for a grid with frozen columns, the header layout.Whether to show a context menu on the header span with standard items for showing and hiding fields.If this grid has specifiedheaderSpans
, should field titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or SummaryBuilder.If this grid has specifiedheaderSpans
, should field titles be prefixed with the titles of the headerSpans in which they are contained when using thehilite editor
.If this grid has specifiedheaderSpans
, should field titles be prefixed with the titles of the headerSpans in which they are contained when using themulti-sort editor
.Whether to show fields markedhidden:true
when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
boolean
Determines whether hiliting for any field in this grid is shown in a group summary.If true, andcanHover
is also true, shows popup hover text next to the mouse when the user hovers over a cell.When set to true and canHover is also true, shows a widget hovering at the mouse point.boolean
IfshowHover
is true, should cell hover HTML be displayed on disabled cells?When set to true, shows thedrag handle field
on initial draw.If this is an editable ListGrid, setting this property to true causes an extra row with thenewRecordRowMessage
to be displayed below the last record.Should partially selected parents (in a Tree data set) be shown with special icon? This has an impact in grouped grids wherecanSelectGroups
is true.When enabled,createRecordComponent()
will be called when saved rows are being rendered, and any returned component will be displayed embedded within the row or cell.If true, showsrecordComponents
in cells, rather than just in records.Should we show different styling for the cell the mouse is over?When enabled, when the mouse moves over a row or cell (depending onuseCellRollOvers
), an arbitrary Canvas can be shown layered on top of the row or cell (therollOverCanvas
), layered underneath the row or cell (therollUnderCanvas
), or both.This setting causes theroll over canvas
to be sized to cover the normal row and the expansion layout.If roll overs are enabled, should therollUnderCanvas
be displayed?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
Whether to associate saved searches by default with the currentDataSource
of a component when asavedSearchId
is not provided.This setting causes theroll over canvas
to be displayed when the user rolls over selected records in the grid (but not when rolling over other records).This setting causes theroll under canvas
to be displayed when the user rolls over selected records in the grid (but not when rolling over other records).Should the "Selected" style be applied to selected records?IfselectionType
is set toSelectionStyle.SINGLE
, setting this property totrue
means selection will be displayed to the user with theselectionCanvas
and/orselectionUnderCanvas
rather than with CSS styling.IfselectionType
is set toSelectionStyle.SINGLE
, and eithershowSelectionCanvas
istrue
andshowSelectionUnderCanvas
is unset, orshowSelectionUnderCanvas
is explicitly set totrue
, then selection will be displayed to the user with theselectionCanvas
and/orselectionUnderCanvas
rather than with CSS styling.Indicates whether a sorting arrow should appear for the listGrid, and its location.When multiple fields are sorted, set this to false to hide the sort-numeral displayed by default after the sort-arrows in the header-buttons of sorted fields.WhenheaderSpans
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 aTreeGrid
displays a Tree.If this list grid is showing anyfrozen
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 totrue
any backgroundColor or border applied to the ListGrid will show up below the bottom row of the frozen column(s).Ifrecord[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 ofrecord[this.singleCellValueProperty]
.Where do 'skin' images (those provided with the class) live?Whether to skip line breaks for all fields by default whenescaping HTML
.getSort()
Returns the currentSortSpecifiers
for this ListGrid.int
WhenleaveHeaderMenuButtonSpace
is true, configures the amount of space beyond theheaderMenuButtonWidth
on the right side of a ListGrid header button (left forRTL mode
) to reserve for the sort arrow if sorting is active for that field and the arrow will be shown.Image to show when sorted in ascending order.Image to show when sorted in ascending order.boolean
For any fields oftype "binary"
, should sorting be performed against the fileName of the value for the field? For Smart GWT server backed dataSources, this is applied to the record automatically as described in theBinaryFields
overview.If set, whenever grouping is performed by an end user or by a programmatic call togroupBy()
, data is implicitly sorted by all of the grouped columns, in the order they were passed to groupBy.Image to show when sorted in descending order.Image to show when sorted in descending order.Sorting direction of this ListGrid.If this grid has specifiedheaderSpans
, andshowHeaderSpanTitlesInSortEditor
is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid on themulti-sort editor
The title for the corner sort button.Specifies the field by which this grid should be initially sorted.If we're showing aheaderContextMenu
for this grid, this attribute will be shown as the menu item title to sort a field in ascending order.int
Returns the number of fields involved in this grid's current sort configuration.If we're showing aheaderContextMenu
for this grid, this attribute will be shown as the menu item title to sort a field in descending order.getSortNumeralHTML
(String fieldName, int sortIndex) When multiple fields are sorted, this method returns the HTML for the sort-numeral that appears after the sort-arrows in the header-buttons of sorted fields.int
WhenleaveHeaderMenuButtonSpace
is true, configures the amount of space beyond theheaderMenuButtonWidth
on the right side of a ListGrid header button (left forRTL mode
) to reserve for the sort numeral ifmulti-sorting
is active for that field and the numeral will be shown.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.getSortSpecifier
(String fieldName) Returns theSortSpecifier
for the passed fieldName, or null if the field is not sorted.Initial sort state for the grid.The menu displayed when a cell is right clicked on.Button.baseStyle
to apply to the field header buttons for this ListGrid when showing header spans.If true,getFieldState()
andsetFieldState(java.lang.String)
will omit state information for hidden fields by default.If this is an editable listGrid, this property determines how failure to save due to validation errors should be displayed to the user.When set to true, the first and last cells in each row will be styled with an additional CSS class, via thefirstCellStyle
andlastCellStyle
attributes.Default CSS class for the ListGrid as a whole.getSummaryFieldValue
(ListGridField field, Record record) Get the computed value of asummary field
.Automatically generated ListGrid for displaying grid summary information (seeshowGridSummary
).IfshowGridSummary
is true, and asummaryRowDataSource
is specified this property may be used to specify fetch criteria to apply when retrieving summary data to show in the summary row.IfshowGridSummary
is true, by default summary values are calculated on the client based on the current data-set for the grid (seegetGridSummary()
andgetGridSummaryFunction()
).IfshowGridSummary
is true, and asummaryRowDataSource
is specified this property may be used to customize the fetch request used when retrieving summary data to show in the summary row.int
Default height for thesummary row autoChild
.baseStyle
for thesummaryRow
The style to apply to <TR> tags in this grid's table."Tall" baseStyle for this listGrid.protected ListGrid
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 checktitleField
for databound
 components.

 For non databound components returns the first defined field name of"title"
, 
"name"
, or"id"
.getTitleFieldValue
(Record record) Get the value of the titleField for the passed record
getToggleFreezeText
(ListGridField field) If we're showing aheaderContextMenu
for this grid andthis.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
Return the total number of rows in the grid.While scrolling an incrementally rendered grid, using the inertial scrolling, time in milliseconds to wait before redrawing, after the last touchScroll by the user.Default image to use for the dragTracker when things are dragged within or out of this list.Default image to use for the dragTracker when things are dragged within or out of this list.If we're showing aheaderContextMenu
for this grid andthis.canFreezeFields
is true, this string will be shown as the title for the menu item to unfreeze a currently frozen field.If we're showing aheaderContextMenu
for this grid, andthis.isGrouped
is true, this attribute will be shown as the title for the menu item to ungroup the grid.Value to return fromgetFormattedRowCount()
when the row count is unknownWhencanRemoveRecords
is enabled, this icon will be shown in the auto generated field fro removing records if the record has been marked as removed viamarkRecordRemoved()
.operationId
this component should use when performing update operations.boolean
Should thesummary row
orgroup summaries
be updated during editing of grid records? This can be set false to improve performance when a large number ofListGridFields
orDataSourceFields
are present for the grid.Should thefilter-editor
in this grid always produceAdvancedCriteria
?If set to true, an advanced field picker based on theFieldPicker
will be shown instead of the column picker submenu if there are more fields in the grid thanadvancedFieldPickerThreshold
.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.
Are rollovers cell-level or row-level?Causes this grid to filter its data on the client where possible, eliminating trips to the server when criteria becomes more restrictive, since the filter must apply to data which is already on the client.For ListGrids withcanSelectCells:true
, enabling this property will cause the listGrid to intercept standard browser copy/paste shortcut keys and perform the following behavior.TheuseFlatFields
flag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding.boolean
IfshowFilterEditor
is true, when creating a SelectItem for editing criteria for a field with a ValueMap, should the SelectItem default tomultiple:true
?Returns a snapshot of the current user-provided criteria for this ListGrid.IfsaveLocally
is specified, but this grid is bound to a DataSource which includes remote field validators, by default edits will be saved synchronously and these validators will not be executed.
Set this property totrue
to ensure these remote validators are called when saving edits in saveLocally mode.Enables various styling behaviors that potentially make sense whengetRowSpan()
has been overridden to introduce spanning cells, and spanning is largest on the left and smaller as cells go to the right.Whether client-side validation checks should be performed when the user moves between cells in the current edit row.If true, validation will be performed on each edited cell when each editor's "change" handler is fired.getValueIcon
(ListGridField field, Object value, ListGridRecord record) Returns the appropriate valueIcon for a cell based on the field and the data value for the cell.getValueIconCursor
(ListGridField field, ListGridRecord record, Object value) Returns the cursor to display when the mouse pointer is over avalueIcon
in a a cell.Height for value icons for this listGrid.int
How much padding should there be on the left of valueIcons by default Can be overridden at the field levelint
How much padding should there be on the right of valueIcons by defaultint
Default width and height of value icons for this ListGrid.Width for value icons for this listGrid.Initial view state may be provided for the listGrid at init time.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 un-rendered rows to make the scrollbar and viewport appear correctly.Integer[]
Get the rows that are currently visible in the viewport, as an array of [firstRowNum, lastRowNum].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).IfcanRemoveRecords
is true, when the user clicks the remove icon for some record, should we show a warning message (defined aswarnOnRemovalMessage
) and allow the user to cancel removal?Warning message to show the user on a click on the 'remove' icon ifcanRemoveRecords
is true andwarnOnRemoval
is true.If a field hasListGridField.displayField
specified and has noListGridField.optionDataSource
, this field will display the value from thedisplayField
of each record by default (for more on this behavior seeListGridField.optionDataSource
).Should content within cells be allowed to wrap?IfHeaderSpan.wrap
is not explicitly set, should fields wrap? If autofitting, see the docs on that property for the details of how the minimum width for a field is determined.IfListGridField.wrap
is not explicitly set, should fields wrap? If autofitting, see the docs on that property for the details of how the minimum width for a field is determined.void
Display the current set of records grouped by their values for the given field or fields.groupSortNormalizer
(ListGridRecord record, String fieldName, ListGrid context) WhensortByGroupFirst
is active, the sortingnormalizer
applied for implicit sorting by the field(s) used for grouping.Whether the grid as a whole has any unsaved edits, in any row.hasChanges
(Boolean ignorePendingValues) Whether the grid as a whole has any unsaved edits, in any row.Does this grid currently have errors associated with editValues for any row in the grid.headerHoverHTML
(int fieldNum, String defaultHTML) Returns the HTML that is displayed by the defaultheaderHover
handler.boolean
headerTitleClipped
(int fieldNum) Is the field title for the specified field clipped?void
Hides thedrag handle field
, if currently shown.void
Force a field to be hidden.
NOTE: If a field.showIf expression exists, it will be destroyed.void
Force a field to be hidden.
NOTE: If a field.showIf expression exists, it will be destroyed.void
hideFields
(ListGridField... fields) Force an array of fields to be hidden.void
hideFields
(ListGridField[] fields, boolean suppressRelayout) void
hideFields
(String... fields) Force an array of fields to be hidden.void
hideFields
(String[] fields, boolean suppressRelayout) Force an array of fields to be hidden.void
Invalidate the current data cache for this databound component via a call to the dataset'sinvalidateCache()
method, for example,ResultSet.invalidateCache()
.void
Invalidates the currently visible set ofrecordComponents
and gets fresh ones for the visible rows in the grid according to therecordComponentPoolingMode
isCheckboxField
(ListGridField field) Identifies whether the passed-in field is the specially generatedcheckboxField
used whenSelectionAppearance
is "checkbox".isExpanded
(ListGridRecord record) Whether a givenrecord
is expanded or collapsed.isExpansionField
(ListGridField field) Identifies whether the passed-in field is the specially generatedexpansionField
used whencanExpandRecords
is true.boolean
Returns true if this component is currentlyexporting client data
.boolean
Return true if the ListGrid is grouped on a field.boolean
isGroupNode
(ListGridRecord record) If this listGrid isgrouped
, is the record passed in a group header node.isPartiallySelected
(ListGridRecord record) When using tree-oriented selection modes likeTreeGrid.cascadeSelection
, returns true if the record is considered partially selected because only some of it's children are selected.isRowNumberField
(ListGridField field) Identifies whether the passed-in field is the specially generatedrowNumberField
used whenshowRowNumbers
is true.isSelected
(ListGridRecord record) Returns true if the record is selected.isSortField
(String fieldName) Returnstrue
if the passed fieldName is in the current sort-specification.boolean
isSummaryRecord
(ListGridRecord record) Returns whether the supplied record is a group or grid summary record.Loads all records that match this grid's current filter-criteria, optionally firing a callback when the data arrives.loadAllRecords
(Integer maxRecords) loadAllRecords
(Integer maxRecords, DSCallback callback) Loads all records that match this grid's current filter-criteria, optionally firing a callback when the data arrives.void
Marks the widget as "dirty" so that it will be added to a queue for redraw.void
markForRedraw
(String reason) Marks the widget as "dirty" so that it will be added to a queue for redraw.void
markRecordRemoved
(int rowNum) Marks a record deleted such that a later call tosaveEdits()
orsaveAllEdits()
will cause a "remove"DSRequest
to be submitted.void
markRecordsRemoved
(int records) Marks an array of records deleted such that a later call tosaveEdits()
orsaveAllEdits()
will cause a "remove"DSRequest
to be submitted.void
markRecordsRemoved
(RecordList records) Marks an array of records deleted such that a later call tosaveEdits()
orsaveAllEdits()
will cause a "remove"DSRequest
to be submitted.void
markRecordsRemoved
(ListGridRecord... records) Marks an array of records deleted such that a later call tosaveEdits()
orsaveAllEdits()
will cause a "remove"DSRequest
to be submitted.void
Marks the currently selected records as removed, as thoughmarkRecordRemoved()
had been called.protected void
onInit()
protected void
boolean
Opens the node represented by the "record" parameter, if it is a folder and is not already open.void
openRecordDetailGrid
(ListGridRecord record, DataSource detailDataSource) Deprecated.void
openRecordEditor
(ListGridRecord record) Deprecated.static void
Preload primary ListGrid skin images.void
Refresh thegrid summary
, by either re-calculating from already-loaded data or doing a new fetch from thesummaryRowDataSource
.void
Recalculates values for fields withsummary-functions
oruser formulae
defined and for values displayed in thegrid summary
andgroup summary rows
.void
recalculateSummaries
(Record... records) void
recalculateSummaries
(Record[] records, ListGridField... fields) Recalculates values for fields withsummary-functions
oruser formulae
defined and for values displayed in thegrid summary
andgroup summary rows
.recordClick
(ListGrid viewer, ListGridRecord record, int recordNum, ListGridField field, int fieldNum, Object value, Object rawValue, ListGridRecord editedRecord) Executed when the listGrid receives a 'click' event on an enabled, non-separator record.recordMarkedAsRemoved
(int rowNum) Returns true if the specified record is marked as removed via a call tomarkRecordRemoved()
void
redrawHeader
(boolean rightNow) Redraw just thegrid header
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
UnlikeinvalidateCache
this will perform an asynchronous (background) refresh of this component's data and then call the provided callback method on completion.void
refreshData
(DSCallback callback) UnlikeinvalidateCache
this will perform an asynchronous (background) refresh of this component's data and then call the provided callback method on completion.void
Re-evaluatesListGridField.showIf()
for each field, dynamically showing and hiding the appropriate set of fieldsvoid
refreshRecordComponent
(int rowNum) Discards anyrecordComponent
currently assigned to the specified record (or cell) and gets a fresh one, according to therecordComponentPoolingMode
void
refreshRecordComponent
(int rowNum, Integer colNum) Discards anyrecordComponent
currently assigned to the specified record (or cell) and gets a fresh one, according to therecordComponentPoolingMode
void
refreshRow
(int rowNum) Refresh an entire row of cells without redrawing the grid.void
regroup()
Programmatically regroup the grid according to the current grouping configuration.void
removeData
(Record data) Remove a record from this ListGrid.void
removeData
(Record data, DSCallback callback) void
removeData
(Record data, DSCallback callback, DSRequest requestProperties) Remove a record from this ListGrid.void
removeEmbeddedComponent
(Canvas component) Removes an embedded component from a grid.void
Removes an embedded component previously associated with the provided record.void
removeEmbeddedComponent
(ListGridRecord record, Integer component) Removes an embedded component previously associated with the provided record.void
removeRecordClick
(int rowNum) Method fired when the user clicks the "remove" icon ifcanRemoveRecords
is true.void
Remove the currently selected records from this component.void
removeSelectedData
(DSCallback callback) void
removeSelectedData
(DSCallback callback, DSRequest requestProperties) void
removeSelectedData
(DSCallback callback, DSRequest requestProperties, RPCQueueCallback queueCallback) Remove the currently selected records from this component.void
reorderField
(int fieldNum, int moveToPosition) Reorder a particular fieldvoid
reorderFields
(int start, int end, int moveDelta) Reorder a set of adjacent fields, from start to end exclusive at the end, by distance moveDelta.
NOTE: start and end coordinates are in terms of the currently visible fields, not the full set of fields.void
resizeField
(int fieldNum, int newWidth) Resize a particular field to a new width.void
resort()
If a list has become unsorted due to data modification or a call tounsort()
, this method will resort the list by the previoussort-specifier
array, if there is one, or by the previous sort-field and -direction.void
rowClick
(ListGridRecord record, int recordNum, int fieldNum) Event handler for when rows in the body are clicked upon.void
rowClick
(ListGridRecord record, int recordNum, int fieldNum, boolean keyboardGenerated) Event handler for when rows in the body are clicked upon.void
rowDoubleClick
(ListGridRecord record, int recordNum, int fieldNum) Event handler for when a body record is double-clicked.void
rowDoubleClick
(ListGridRecord record, int recordNum, int fieldNum, boolean keyboardGenerated) Event handler for when a body record is double-clicked.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.rowHasChanges
(int rowNum, Boolean ignorePendingValues) 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.rowHasErrors
(int rowNum) Does the specified row have unresolved errors?boolean
Save a number of outstanding edits for this ListGrid.boolean
saveAllEdits
(Function callback) Save a number of outstanding edits for this ListGrid.boolean
saveAllEdits
(Function callback, int[] rows) Save a number of outstanding edits for this ListGrid.void
Validates and saves edits within the row currently being edited (or another row with unsaved edits, if indicated).void
saveEdits
(EditCompletionEvent editCompletionEvent) void
saveEdits
(EditCompletionEvent editCompletionEvent, String callback) void
saveEdits
(EditCompletionEvent editCompletionEvent, String callback, int rowNum) Validates and saves edits within the row currently being edited (or another row with unsaved edits, if indicated).void
scrollBodyTo
(Integer left, Integer top) Scroll the body of the grid to the specified coordinates.void
scrollToCell
(int rowNum, int colNum) Will scroll the listGrid body such that the specified cell is visible close to the center of the viewport.void
scrollToCell
(int rowNum, int colNum, Alignment xPosition) void
scrollToCell
(int rowNum, int colNum, Alignment xPosition, VerticalAlignment yPosition) Will scroll the listGrid body such that the specified cell is visible close to the center of the viewport.void
scrollToColumn
(int colNum) Scroll the grid to specified column such that the row appears near the center of the viewport.void
scrollToColumn
(int colNum, Alignment xPosition) Scroll the grid to specified column such that the row appears near the center of the viewport.void
scrollToRow
(int rowNum) Scroll the grid to specified row such that the row appears near the center of the viewport, loading data if necessary.void
scrollToRow
(int rowNum, VerticalAlignment yPosition) Scroll the grid to specified row such that the row appears near the center of the viewport, loading data if necessary.void
Select all records

void
selectRange
(int startRow, int endRow) Select a contiguous range of records by indexvoid
selectRange
(int startRow, int endRow, boolean newState) Select a contiguous range of records by indexvoid
selectRecord
(int record) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(int record, boolean newState) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(Record record) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(Record record, boolean newState) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecords
(int[] records) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(int[] records, boolean newState) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(Record[] records) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(Record[] records, boolean newState) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectSingleRecord
(int rowNum) Select a singleRecord
passed in explicitly, or by index, and deselect everything else.void
selectSingleRecord
(Record record) Select a singleRecord
passed in explicitly, or by index, and deselect everything else.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.setAddFormulaFieldText
(String addFormulaFieldText) Text for a menu item allowing users to add a formula fieldsetAddOperation
(String addOperation) operationId
this component should use when performing add operations.setAddSummaryFieldText
(String addSummaryFieldText) Text for a menu item allowing users to add a formula fieldsetAdvancedFieldPickerThreshold
(int advancedFieldPickerThreshold) WhenuseAdvancedFieldPicker
is set, total number of available fields that must be present in the grid before the advanced field picker interface is used instead of the normal columns submenu.setAdvancedFilteringText
(String advancedFilteringText) If we're showing aheaderContextMenu
for this grid, and afilter-editor
is visible andallowFilterWindow
is enabled, this attribute will be shown as the menu item title to configure advanced filtering.setAiFilterWindowHint
(String aiFilterWindowHint) The inline hint-text displayed in the user-entry area in theaiFilterWindow
.setAiFilterWindowInstructions
(String aiFilterWindowInstructions) The descriptive text displayed above the user-entry area in theaiFilterWindow
.setAiFilterWindowTitle
(String aiFilterWindowTitle) The title for theAI-driven filter window
.setAiHoverContentsPrefix
(String aiHoverContentsPrefix) Optional prefix for the AI-generated hover text displayed when hovering over fields specifying anaiHoverRequest
.setAiHoverRetryDelay
(Integer aiHoverRetryDelay) Minimum number of milliseconds to wait before retrying to generate hover contents via AI.setAiSortFieldMaxRecordsMessage
(String aiSortFieldMaxRecordsMessage) The message to show when a user asks the AI to sort more than themaximum allowed records
.setAllowFilterExpressions
(Boolean allowFilterExpressions) For use withshowFilterEditor
:true, allows simple search expressions to be entered into filter fields, as thoughDynamicForm.allowExpressions
were true.setAllowFilterOperators
(Boolean allowFilterOperators) Causes a menu item titled"Filter using"
to appear in theheaderContextMenu
that allows the end user to pick an advancedsearch operator
to use for this field.setAllowFilterWindow
(Boolean allowFilterWindow) Adds the ability for a user to define additional criteria above and beyond those expressed in thefilter editor
via aFilterBuilder
which appears in a modal Window over the grid and can be accessed by various menus within the grid or triggered by external controls.setAllowRowSpanning
(Boolean allowRowSpanning) Should cells in this grid be allowed to span multiple rows? If set totrue
, thegetRowSpan()
method will be called for every cell when rendering out the listGrid to determine how many rows the cell should span.setAlternateBodyStyleName
(String alternateBodyStyleName) Optional css style to apply to the body ifalternateRecordStyles
is true for this grid.setAlternateFieldFrequency
(int alternateFieldFrequency) The number of consecutive columns to draw in the same style before alternating, whenalternateColumnStyles
is true.setAlternateFieldStyles
(boolean alternateFieldStyles) Whether alternating columns (or blocks of columns, depending onGridRenderer.alternateColumnFrequency
) should be drawn in alternating styles, in order to create a vertical "ledger" effect for easier reading.setAlternateFieldSuffix
(String alternateFieldSuffix) Suffix to append toalternate columns
.setAlternateRecordFrequency
(int alternateRecordFrequency) The number of consecutive rows to draw in the same style before alternating, whenalternateRowStyles
is true.setAlternateRecordStyles
(Boolean alternateRecordStyles) Whether alternating rows (or blocks of rows, depending onGridRenderer.alternateRowFrequency
) should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.setAlternateRecordSuffix
(String alternateRecordSuffix) Suffix to append toalternate rows
.setAlwaysShowEditors
(Boolean alwaysShowEditors) When this attribute is set, editors will be appear to be present in every row of the grid, allowing the user to immediately start editing any cell, rather than showing up in a single record at a time.
This attribute is only valid wheneditByCell
is false.setAlwaysShowOperatorIcon
(Boolean alwaysShowOperatorIcon) WhenallowFilterOperators
is enabled, whether to show theoperatorIcon
for all filterable fields, or only for fields where the user has explicitly chosen a search operator different from the default operator for the field.setAnimateFolderEffect
(AnimationAcceleration animateFolderEffect) When animating folder opening / closing, this property can be set to apply an animated acceleration effect.setAnimateFolderMaxRows
(Integer animateFolderMaxRows) IfanimateFolders
is true for this grid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.setAnimateFolders
(Boolean animateFolders) If true, when folders are opened / closed children will be animated into view.setAnimateFolderSpeed
(int animateFolderSpeed) When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second.setAnimateFolderTime
(int animateFolderTime) When animating folder opening / closing, ifTreeGrid.animateFolderSpeed
is not set, this property designates the duration of the animation in ms.setAnimateRemoveRecord
(Boolean animateRemoveRecord) WhencanRemoveRecords
is enabled, should records be animated out of view when they are removed by the user?setAnimateRemoveSpeed
(int animateRemoveSpeed) Whenanimating record removal
, this property designates the speed of the animation in pixels per second.setAnimateRemoveTime
(int animateRemoveTime) When animating record removal(see animateRemoveRecord)
, ifanimateRemoveSpeed
is not set, this property designates the duration of the animation in ms.setAnimateRollOver
(Boolean animateRollOver) If therollOverCanvas
is enabled, setting this property totrue
ensures that when therollOverCanvas
is displayed it is animated into view viaCanvas.animateShow()
.setAnimateRollUnder
(Boolean animateRollUnder) If therollUnderCanvas
is enabled, setting this property totrue
ensures that when therollUnderCanvas
is displayed it is animated into view viaCanvas.animateShow()
.setAnimateSelection
(Boolean animateSelection) If theselectionCanvas
is enabled, setting this property totrue
ensures that when theselectionCanvas
is displayed it is animated into view viaCanvas.animateShow()
.setAnimateSelectionUnder
(Boolean animateSelectionUnder) If theselectionUnderCanvas
is enabled, setting this property totrue
ensures that when theselectionUnderCanvas
is displayed it is animated into view viaCanvas.animateShow()
.setApplyFormulaAfterSummary
(Boolean applyFormulaAfterSummary) IfListGridField.userFormula
is set for some field, and this grid is showinggroup summaries
or agrid summary
, this property determines what field value should be present in those summary rows.setApplyRowCountToLength
(Boolean applyRowCountToLength) This property allows developers to explicitly setResultSet.applyRowCountToLength
for this grid's data object.setApplyRowNumberStyle
(boolean applyRowNumberStyle) setApproximateRowCountFormat
(String approximateRowCountFormat) setAriaRole
(String ariaRole) ARIA role for this ListGrid ifscreen reader mode
is enabled.setArrowKeyAction
(String arrowKeyAction) Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the arrow keys to navigate around the grid.setArrowKeyEditAction
(ArrowKeyEditAction arrowKeyEditAction) What to do when a user hits arrow key while editing a field?
If not explicitly specifiedgetArrowKeyEditAction()
will return an appropriate action depending on the field type.setAsyncErrorCellValue
(String asyncErrorCellValue) The value to display for cells when an error occurred during asynchronous computation.setAsynchGroupingPrompt
(String asynchGroupingPrompt) The prompt to display while interactivity is blocked duringasynchronous grouping
.setAsyncMissingCellValue
(String asyncMissingCellValue) The value to display for cells whose value was not computed by the previous asynchronous operation to compute it, or will not be computed by an asynchronous operation due to currently being disabled.void
setAutoChildProperties
(String autoChildName, ListGridField properties) Sets the properties for creating aListGridField
AutoChild namedautoChildName
.setAutoComplete
(AutoComplete autoComplete) Whether to do inline autoComplete in text fields during inline editing
Overridden byListGridField.autoComplete
if specified.setAutoConfirmSaveEdits
(Boolean autoConfirmSaveEdits) For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded by default.setAutoFetchAsFilter
(Boolean autoFetchAsFilter) IfDataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
setAutoFetchData
(Boolean autoFetchData) If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
depending onDataBoundComponent.getAutoFetchAsFilter()
.setAutoFetchDisplayMap
(Boolean autoFetchDisplayMap) If true, for fields whereListGridField.optionDataSource
is specified, a valueMap will be automatically created by making aDataSource.fetchData()
call against the specified dataSource and extracting a valueMap from the returned records based on the displayField and valueField.setAutoFetchRowCount
(boolean autoFetchRowCount) Depending on whetherDataSource.progressiveLoading
is active, the exact count of available rows may not be available as part of the standard data fetch response - settingautoFetchRowCount:true
will cause a fetch for an accurate row count to be issued as soon as data arrives (from aprogressive dataSource response
) without an accurate row count.setAutoFetchTextMatchStyle
(TextMatchStyle autoFetchTextMatchStyle) IfautoFetchData
istrue
, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()
call.setAutoFitAllText
(String autoFitAllText) If we're showing aheaderContextMenu
for this grid, andcanAutoFitFields
is true, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via theautoFitField()
method.setAutoFitClipFields
(String... autoFitClipFields) IfautoFitFieldWidths
is enabled and the calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear.setAutoFitData
(Autofit autoFitData) Should this ListGrid automatically expand to accommodate the size of records and fields?setAutoFitDateFields
(AutoFitWidthApproach autoFitDateFields) Should listGrids automatically size date fields to fit their values or titles? If set to"value"
, fields of type date will be rendered at the size specified bydefaultDateFieldWidth
, (ordefaultEditableDateFieldWidth
for editable fields).setAutoFitExpandField
(String autoFitExpandField) The field to expand ifautoFitFieldWidths
andautoFitFieldsFillViewport
are enabled and auto-fitting will not fill all available horizontal space.setAutoFitExtraRecords
(Integer autoFitExtraRecords) IfautoFitData
is set to"vertical"
or"both"
, setting this property will cause the ListGrid body to size large enough to accommodate the actual data and also leave this many extra rows' worth of blank space below the last record.setAutoFitFieldsFillViewport
(Boolean autoFitFieldsFillViewport) IfautoFitFieldWidths
is enabled, and extra space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.setAutoFitFieldText
(String autoFitFieldText) If we're showing aheaderContextMenu
for this grid, and user-driven auto fit of fields is enabled viaListGridField.canAutoFitWidth
orcanAutoFitFields
, this attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or content via a call toautoFitField()
.setAutoFitFieldWidths
(Boolean autoFitFieldWidths) Should ListGrid fields autofit their widths to titles or content? This property may be overridden on a per-field basis viaListGridField.autoFitWidth
.setAutoFitHeaderHeights
(Boolean autoFitHeaderHeights) If this property is set to true, header buttons for eitherfields
orheader spans
will automatically expand to accommodate their titles vertically.setAutoFitIconFields
(AutoFitIconFieldType autoFitIconFields) Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields withtype:"icon"
, fields displaying onlyvalue icons
, and boolean fields (which are rendered as a checkmark type icon by default.setAutoFitMaxColumns
(int autoFitMaxColumns) IfautoFitData
is set to"horizontal"
or"both"
this property provides the maximum number of columns for which the ListGrid will expand.setAutoFitMaxHeight
(Integer autoFitMaxHeight) IfautoFitData
is set to"vertical"
or"both"
this property provides an upper limit on how far the ListGrid will expand vertically to accommodate its content.setAutoFitMaxRecords
(int autoFitMaxRecords) IfautoFitData
is set to"vertical"
or"both"
this property provides the maximum number of records for which the ListGrid will expand.setAutoFitMaxWidth
(Integer autoFitMaxWidth) IfautoFitData
is set to"horizontal"
or"both"
this property provides an upper limit on how far the ListGrid will expand horizontally to accommodate its content.setAutoFitMaxWidth
(String autoFitMaxWidth) IfautoFitData
is set to"horizontal"
or"both"
this property provides an upper limit on how far the ListGrid will expand horizontally to accommodate its content.setAutoFitTimeFields
(AutoFitWidthApproach autoFitTimeFields) Should listGrids automatically size time fields to fit their values or titles? If set to"value"
, fields of type time will be rendered at the size specified bydefaultTimeFieldWidth
.void
setAutoFitWidth
(String fieldName, boolean autoFit) Setter forListGridField.autoFitWidth
.setAutoFitWidthApproach
(AutoFitWidthApproach autoFitWidthApproach) When a user requests column autofitting via theheader context menu
or via amouse gesture
, what autofit approach is used.setAutoPersistViewState
(ListGridViewStatePart... autoPersistViewState) Setting this property to a non-null value will enable automatic saving ofview state
to offline storage.setAutoSaveEdits
(Boolean autoSaveEdits) If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell ifsaveByCell
is true).setAutoSizeHeaderSpans
(Boolean autoSizeHeaderSpans) If this listGrid has specifiedheaderSpans
, setting this attribute to true will cause spans to expand to accommodate long titles if necessary.setBadFormulaResultValue
(String badFormulaResultValue) If the result of a formula evaluation is invalid (specifically, if isNaN(result)==true), badFormulaResultValue is displayed instead.setBaseStyle
(String baseStyle) base cell style
for this listGrid.setBlockingRowCountFetch
(Boolean blockingRowCountFetch) If specified, this attribute will be applied to this grid'sdata object
for dataBound grids.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.setBodyOverflow
(Overflow bodyOverflow) Overflow setting for the "body", that is, the area of the grid where data values are rendered.setBodyStyleName
(String bodyStyleName) CSS style used for the body of this grid.setBooleanBaseStyle
(String booleanBaseStyle) An optional CSS style to apply to the checkbox image.setBooleanFalseImage
(String booleanFalseImage) Image to display for a false value in a boolean field.setBooleanImageHeight
(int booleanImageHeight) setBooleanImageWidth
(int booleanImageWidth) setBooleanPartialImage
(String booleanPartialImage) Image to display for a partially true value in a boolean field (typically selection).setBooleanTrueImage
(String booleanTrueImage) Image to display for a true value in a boolean field.setBriefRowRangeDisplayValue
(String briefRowRangeDisplayValue) Dynamic String specifying the format for therow range summary value
whenRowRangeDisplayStyle
is set to"brief"
.setCanAcceptDroppedRecords
(Boolean canAcceptDroppedRecords) Indicates whether records can be dropped into this listGrid.setCanAddAISortFields
(Boolean canAddAISortFields) Adds an item to the header context menu allowing users to launch a dialog to define a new field to be sorted by an AI score of the entire record and possibility related records.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 {@link com.smartgwt.client..FormulaBuilder}.
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 {@link com.smartgwt.client..SummaryBuilder}.
setCanAutoFitFields
(Boolean canAutoFitFields) Can the user perform one-time autofit for specific columns in this grid?setCancelEditingConfirmationMessage
(String cancelEditingConfirmationMessage) If this is an editable listGrid, andthis.confirmCancelEditing
is true this property is used as the message to display in the confirmation dismissal prompt.setCanCollapseGroup
(Boolean canCollapseGroup) Can a group be collapsed/expanded? When true a collapse/expand icon is shown (groupIcon
) and the user can collapse or expand the group by clicking either the row as a whole or the opener icon (seecollapseGroupOnRowClick
); When false the group icon is not shown and clicking on the row does not change group state.setCanDragRecordsOut
(Boolean canDragRecordsOut) Indicates whether records can be dragged from this listGrid and dropped elsewhere.setCanDragSelect
(Boolean canDragSelect) If this property is true, users can drag the mouse to select several rows or cells.setCanDragSelectText
(Boolean canDragSelectText) If this property is true, users can drag the mouse to select text within grid rows, ready to be cliped to clipboard.
This is mutually exclusive withrearranging rows or cells by dragging
, and withdrag selection of rows
.setCanDropInEmptyArea
(Boolean canDropInEmptyArea) If set to false, dropping over an empty part of the grid body is disallowed and the no-drop indicator is displayed.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 unless a custom override ofcanEditCell()
allows it.
If 'canEdit' is not set at the listGrid level, setting 'canEdit' to true at the field level enables the field to be edited inline.setCanEditHilites
(boolean canEditHilites) Adds an item to the header context menu allowing users to launch a dialog to define grid hilites using theHiliteEditor
.setCanEditTitles
(boolean canEditTitles) If set to true, theadvanced field picker
provides an interface allowing users to modify fields' titles.setCanExpandMultipleRecords
(Boolean canExpandMultipleRecords) WhencanExpandRecords
is true, this property indicates whether multiple records can be expanded simultaneously.setCanExpandRecordProperty
(String canExpandRecordProperty) Property name on a record that will be checked to determine whether a record can be expanded.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.setCanFocusInEmptyGrid
(boolean canFocusInEmptyGrid) If the listGrid is empty, should the user be able to put focus into the grid body by tabbing to it?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.setCanGroupBy
(Boolean canGroupBy) If false, grouping via context menu will be disabled.setCanHiliteViaAI
(Boolean canHiliteViaAI) When set totrue
and AI component views are enabled, shows an item in this component's header context menu that allows the user to ask the AI to hilite the records according to a natural language description of which records to hilite.setCanHover
(Boolean canHover) If true, cellHover and rowHover events will fire and then a hover will be shown (if not canceled) when the user leaves the mouse over a row / cell unless the corresponding field hasshowHover
set
setCanExpandRecords(Boolean)
withsetExpansionMode(com.smartgwt.client.types.ExpansionMode)
, or overridegetExpansionComponent(ListGridRecord)