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
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.Grid Filtering Overview
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
ListGrid() |
ListGrid(DataSource dataSource) |
ListGrid(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
com.google.gwt.event.shared.HandlerRegistration |
addBodyKeyPressHandler(BodyKeyPressHandler handler)
Add a bodyKeyPress handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellClickHandler(CellClickHandler handler)
Add a cellClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellContextClickHandler(CellContextClickHandler handler)
Add a cellContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellDoubleClickHandler(CellDoubleClickHandler handler)
Add a cellDoubleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellErrorIconHoverHandler(CellErrorIconHoverHandler handler)
Add a cellErrorIconHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellErrorIconOutHandler(CellErrorIconOutHandler handler)
Add a cellErrorIconOut handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellErrorIconOverHandler(CellErrorIconOverHandler handler)
Add a cellErrorIconOver handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellHoverHandler(CellHoverHandler handler)
Add a cellHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellMouseDownHandler(CellMouseDownHandler handler)
Add a cellMouseDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellMouseUpHandler(CellMouseUpHandler handler)
Add a cellMouseUp handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellOutHandler(CellOutHandler handler)
Add a cellOut handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellOverHandler(CellOverHandler handler)
Add a cellOver handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellSavedHandler(CellSavedHandler handler)
Add a cellSaved handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellSelectionChangedHandler(CellSelectionChangedHandler handler)
Add a cellSelectionChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCellValueHoverHandler(CellValueHoverHandler handler)
Add a cellValueHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addCriteriaChangedHandler(CriteriaChangedHandler handler)
Add a criteriaChanged handler.
|
void |
addData(Record newRecord)
Perform a DataSource "add" operation to add new records to this component's DataSource.
|
void |
addData(Record newRecord,
DSCallback callback) |
void |
addData(Record newRecord,
DSCallback callback,
DSRequest requestProperties)
Perform a DataSource "add" operation to add new records to this component's DataSource.
|
com.google.gwt.event.shared.HandlerRegistration |
addDataArrivedHandler(DataArrivedHandler handler)
Add a dataArrived handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDataChangedHandler(DataChangedHandler handler)
Add a dataChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragCompleteHandler(DragCompleteHandler handler)
Add a
com.smartgwt.client.widgets.DragCompleteHandler . |
com.google.gwt.event.shared.HandlerRegistration |
addDrawAreaChangedHandler(DrawAreaChangedHandler handler)
Add a drawAreaChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDropCompleteHandler(DropCompleteHandler handler)
Add a
com.smartgwt.client.widgets.DropCompleteHandler . |
com.google.gwt.event.shared.HandlerRegistration |
addEditCompleteHandler(EditCompleteHandler handler)
Add a editComplete handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEditFailedHandler(EditFailedHandler handler)
Add a editFailed handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEditorEnterHandler(EditorEnterHandler handler)
Add a editorEnter handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEditorExitHandler(EditorExitHandler handler)
Add a editorExit handler.
|
void |
addEmbeddedComponent(Canvas component,
ListGridRecord record)
Attaches the component to the provided record.
|
void |
addEmbeddedComponent(Canvas component,
ListGridRecord record,
java.lang.Integer rowNum) |
void |
addEmbeddedComponent(Canvas component,
ListGridRecord record,
java.lang.Integer rowNum,
java.lang.Integer colNum) |
void |
addEmbeddedComponent(Canvas component,
ListGridRecord record,
java.lang.Integer rowNum,
java.lang.Integer colNum,
EmbeddedPosition position)
Attaches the component to the provided record.
|
com.google.gwt.event.shared.HandlerRegistration |
addFetchDataHandler(FetchDataHandler handler)
Add a fetchData handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFieldStateChangedHandler(FieldStateChangedHandler handler)
Add a fieldStateChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFilterEditorSubmitHandler(FilterEditorSubmitHandler handler)
Add a filterEditorSubmit handler.
|
void |
addFormulaField()
Convenience method to display a
com.smartgwt.client..FormulaBuilder to create a new Formula Field. |
com.google.gwt.event.shared.HandlerRegistration |
addFormulaUpdatedHandler(FormulaUpdatedHandler handler)
Add a formulaUpdated handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addGroupByCompleteHandler(GroupByCompleteHandler handler)
Add a groupByComplete handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addGroupByHandler(GroupByHandler handler)
Add a groupBy handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addGroupStateChangedHandler(GroupStateChangedHandler handler)
Add a groupStateChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addGroupTreeChangedHandler(GroupTreeChangedHandler handler)
Add a groupTreeChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addHeaderClickHandler(HeaderClickHandler handler)
Add a headerClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addHeaderDoubleClickHandler(HeaderDoubleClickHandler handler)
Add a headerDoubleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addHeaderHoverHandler(HeaderHoverHandler handler)
Add a headerHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addHilitesChangedHandler(HilitesChangedHandler handler)
Add a hilitesChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordClickHandler(RecordClickHandler handler)
Add a recordClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordCollapseHandler(RecordCollapseHandler handler)
Add a recordCollapse handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordDoubleClickHandler(RecordDoubleClickHandler handler)
Add a recordDoubleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordDropHandler(RecordDropHandler handler)
Add a recordDrop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordExpandHandler(RecordExpandHandler handler)
Add a recordExpand handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRegroupHandler(RegroupHandler handler)
Add a regroup handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRemoveRecordClickHandler(RemoveRecordClickHandler handler)
Add a removeRecordClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowContextClickHandler(RowContextClickHandler handler)
Add a rowContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowEditorEnterHandler(RowEditorEnterHandler handler)
Add a rowEditorEnter handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowEditorExitHandler(RowEditorExitHandler handler)
Add a rowEditorExit handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowHoverHandler(RowHoverHandler handler)
Add a rowHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowMouseDownHandler(RowMouseDownHandler handler)
Add a rowMouseDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowMouseUpHandler(RowMouseUpHandler handler)
Add a rowMouseUp handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowOutHandler(RowOutHandler handler)
Add a rowOut handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRowOverHandler(RowOverHandler handler)
Add a rowOver handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addSelectionChangedHandler(SelectionChangedHandler handler)
Add a selectionChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addSelectionUpdatedHandler(SelectionUpdatedHandler handler)
Add a selectionUpdated handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addSetSortHandler(SetSortHandler handler)
Add a setSort handler.
|
void |
addSort(SortSpecifier sortSpecifier)
Adds another
SortSpecifier to this grid's sort configuration and resorts. |
com.google.gwt.event.shared.HandlerRegistration |
addSortChangedHandler(SortChangedHandler handler)
Add a sortChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addSorterClickHandler(SorterClickHandler handler)
Add a sorterClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addSorterContextClickHandler(SorterContextClickHandler handler)
Add a sorterContextClick handler.
|
void |
addSummaryField()
Convenience method to display a
com.smartgwt.client..SummaryBuilder to create a new Summary Field. |
com.google.gwt.event.shared.HandlerRegistration |
addViewStateChangedHandler(ViewStateChangedHandler handler)
Add a viewStateChanged handler.
|
java.lang.Boolean |
anySelected()
Whether at least one item is selected
|
void |
applyCellData(RecordList cellData)
Applies a set of Records containing coordinate-based data as returned by
getSelectedCellData() 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 |
askForSort()
Show a dialog to configure the sorting of multiple fields on this component.
|
int |
autoFitField(java.lang.String fieldName)
Programmatically cause a field to auto-fit horizontally to it's contents or title.
|
void |
autoFitFields()
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 |
cancelEditing()
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)
If
canSelectCells is set to true 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)
If
selectionType is not set to "none" ,
this method will be called for each record the user attempts to select. |
java.lang.Boolean |
cellHasChanges(int rowNum,
int colNum)
If this listGrid can be edited, this method will return true if the cell passed in has been edited, but the edits have
not yet been saved to the ListGrid's data object.
|
java.lang.Boolean |
cellHasErrors(int rowNum,
int colIndex)
Given a rowNum and a colNum or fieldName, determine whether we currently have stored
validation errors for the record/field in question.
|
java.lang.Boolean |
cellHasErrors(int rowNum,
java.lang.String fieldID)
Given a rowNum and a colNum or fieldName, determine whether we currently have stored validation errors for the
record/field in question.
|
java.lang.String |
cellValueHoverHTML(ListGridRecord record,
int rowNum,
int colNum,
java.lang.String defaultHTML)
Returns the HTML that is displayed by the default cellValueHover handler.
|
java.lang.Boolean |
cellValueIsClipped(int rowNum,
int colNum)
Is the value in a given cell clipped?
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
FacetChart |
chartData(java.lang.String labelField)
Chart the data in this listGrid as a multi-series chart.
|
FacetChart |
chartData(java.lang.String labelField,
java.lang.String[] dataFields) |
FacetChart |
chartData(java.lang.String labelField,
java.lang.String[] dataFields,
ListGridRecord... dataRows) |
FacetChart |
chartData(java.lang.String labelField,
java.lang.String[] dataFields,
ListGridRecord[] dataRows,
FacetChart chartProperties) |
FacetChart |
chartData(java.lang.String labelField,
java.lang.String[] dataFields,
ListGridRecord[] dataRows,
FacetChart chartProperties,
boolean labelFieldFirst)
Chart the data in this listGrid as a multi-series chart.
|
void |
clearAllCriteria()
This method, the equivalent of the builtin
Clear
Filter menu-item , clears all user-visible criteria applied to this grid, including values and filter-operators in the
filter-row and criteria in the advanced filter window , and issues a re-filter. |
void |
clearCriteria()
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,
java.lang.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,
java.lang.String fieldName) |
void |
clearFieldSearchOperator(java.lang.String fieldName,
java.lang.Boolean suppressFilter)
Clears the current search operator from a field in the grid's
filter row . |
void |
clearFilterWindowCriteria()
Clears criteria applied to this grid via the
advanced filter window and issues a re-filter. |
void |
clearRowErrors(int rowNum)
Clear any stored validation errors for some row
|
void |
clearSavedViewState()
Clear this grid's auto-saved
view state as described in autoPersistViewState . |
void |
clearSort()
This method clears any existing sort on this grid by calling
setSort() 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 given
record which has been previously expanded
using expandRecord() . |
void |
collapseRecords(ListGridRecord... records)
Collapses the passed list of expanded
records . |
void |
configureGrouping()
Open a MultiGroupDialog to configure the fields used for grouping.
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
protected Canvas |
createRecordComponent(ListGridRecord record,
java.lang.Integer colNum)
When
showRecordComponents is true, this method
is called to create per-row or per-cell embedded components to display in the grid. |
void |
dataChangedComplete()
Notification method fired when the
grid data has
changed . |
void |
dataChangedComplete(java.lang.String operationType)
Notification method fired when the
grid data has
changed . |
void |
deselectAllRecords()
Deselect all records
|
void |
deselectRange(int startRow,
int endRow)
Deselect a contiguous range of records by index.
|
void |
deselectRecord(int record)
Deselect a
Record passed in explicitly, or by index. |
void |
deselectRecord(Record record)
Deselect a
Record passed in explicitly, or by index. |
void |
deselectRecords(int[] records)
Deselect a list of
Record s passed in explicitly, or by index. |
void |
deselectRecords(Record[] records)
Deselect a list of
Record s passed in explicitly, or by index. |
void |
disableHilite(java.lang.String hiliteID)
Disable a hilite
|
void |
disableHiliting()
Disable all hilites.
|
void |
discardAllEdits()
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,
java.lang.Boolean dontHideEditor)
Cancel outstanding edits for the specified rows, discarding edit values, and hiding editors if appropriate.
|
protected java.lang.Boolean |
displayHeaderContextMenu(Canvas target,
int[] position)
If
showHeaderContextMenu is true
this method is fired when the user right-clicks on the header for this grid.Default implementation will display a menu with entries derived from ListGrid.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 |
editExistingRecord()
Start inline editing at a record identified by criteria.
|
void |
editExistingRecord(Criteria criteria)
Start inline editing at a record identified by criteria.
|
void |
editFields()
Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility
of the fields in the associated DataBoundComponent.
|
void |
editHilites()
Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.
|
void |
enableHilite(java.lang.String hiliteID)
Enable / disable a
hilites
|
void |
enableHilite(java.lang.String hiliteID,
boolean enable)
Enable / disable a
hilites
|
void |
enableHiliting()
Enable all hilites.
|
void |
enableHiliting(boolean enable)
Enable all hilites.
|
void |
endEditing()
Complete the current edit by storing the value and hiding the inline editor.
|
void |
expandRecord(ListGridRecord record)
Expands a given
record by creating a subcomponent and inserting
it in to the record's grid-row. |
void |
expandRecords(ListGridRecord... records)
Expands the passed list of
records by creating a subcomponent
for each record and inserting them it in to the record's grid-row. |
void |
exportClientData()
Exports this component's data with client-side formatters applied, so is suitable for direct display to users, using
the specified
export 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 specified
export format . |
void |
exportData()
|
void |
exportData(DSRequest requestProperties)
|
void |
exportData(DSRequest requestProperties,
RPCCallback callback)
Uses a "fetch" operation on the current
DataSource
to retrieve data that matches the current filter and sort criteria for this component,
then exports the resulting data to a file or window in the requested format. |
void |
fetchData()
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
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 |
fetchRelatedData(Record record,
DataSource dataSource) |
void |
fetchRelatedData(Record record,
DataSource dataSource,
DSCallback callback,
DSRequest requestProperties) |
void |
fetchRowCount()
For databound grids, method will fall through to
ResultSet.fetchRowCount() , allowing developers to request an accurate row count from the dataSource when progressive loading is active . |
void |
fetchRowCount(RowCountCallback callback) |
void |
fetchRowCount(RowCountCallback callback,
DSRequest dsRequest)
For databound grids, method will fall through to
ResultSet.fetchRowCount() , allowing developers to request an accurate row count from the dataSource when progressive loading is active . |
boolean |
fieldIsEditable(int field)
Can the field be edited? This method looks at
canEdit for
the grid as well as the ListGridField.canEdit value,
to determine whether editing is allowed. |
boolean |
fieldIsEditable(ListGridField field)
Can the field be edited? This method looks at
canEdit for
the grid as well as the ListGridField.canEdit value,
to determine whether editing is allowed. |
boolean |
fieldIsEditable(java.lang.String field)
Can the field be edited? This method looks at
canEdit for
the grid as well as the ListGridField.canEdit value,
to determine whether editing is allowed. |
boolean |
fieldIsVisible(java.lang.String field)
Check whether a field is currently visible
|
void |
filterByEditor()
If the filter editor (
showFilterEditor ) is visible
for this grid, this method will perform a filter based on the current values in the editor. |
void |
filterData()
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria,
DSCallback callback)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
Record |
find(AdvancedCriteria adCriteria)
Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found
|
Record[] |
findAll(AdvancedCriteria adCriteria)
Filters all objects according to the AdvancedCriteria passed
|
int |
findIndex(AdvancedCriteria adCriteria)
Finds the index of the first Record that matches with the AdvacendCriteria passed.
|
int[] |
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)
Like
RecordList.findIndex(java.util.Map) , but considering the startIndex parameter. |
int |
findNextIndex(int startIndex,
AdvancedCriteria adCriteria,
int endIndex)
Like
RecordList.findIndex(java.util.Map) , but considering the startIndex and endIndex parameters. |
void |
focusInCell(java.lang.Integer row,
java.lang.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 |
focusInFilterEditor()
If the filter editor (
showFilterEditor ) is visible
for this grid, this method will explicitly put focus into the specified field in the filter editor. |
void |
focusInFilterEditor(java.lang.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(java.lang.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(java.lang.Integer field)
Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.
|
void |
freezeField(ListGridField field)
Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.
|
void |
freezeField(java.lang.String field)
Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.
|
void |
freezeField(java.lang.String[] field)
Freeze the indicated field, so that it remains in place and visible when horizontal scrolling occurs.
|
void |
freezeFields(int[] colNums) |
void |
freezeFields(java.lang.String[] fieldNames) |
java.lang.Boolean |
getAddDropValues()
Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to
different DataSources that are related via a foreign key.
|
java.lang.String |
getAddFormulaFieldText()
Text for a menu item allowing users to add a formula field
|
java.lang.String |
getAddOperation()
operationId this component
should use when performing add operations. |
java.lang.String |
getAddSummaryFieldText()
Text for a menu item allowing users to add a formula field
|
int |
getAdvancedFieldPickerThreshold()
When
useAdvancedFieldPicker 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. |
java.lang.String |
getAdvancedFilteringText()
If we're showing a
headerContextMenu for this
grid, and a filter-editor is visible and allowFilterWindow is enabled, this attribute will be
shown as the menu item title to configure advanced filtering. |
Window |
getAiFilterWindow()
Instance of
AIWindow that allows a user to enter a description of how they would
like the AI to filter this grid. |
java.lang.String |
getAiFilterWindowHint()
The inline hint-text displayed in the user-entry area in the
aiFilterWindow . |
java.lang.String |
getAiFilterWindowInstructions()
The descriptive text displayed above the user-entry area in the
aiFilterWindow . |
java.lang.String |
getAiFilterWindowTitle()
The title for the
AI-driven filter window . |
Window |
getAiHiliteWindow()
Instance of
AIWindow that allows a user to enter a description of how they would
like the AI to filter this grid. |
java.lang.String |
getAiHoverContentsPrefix()
Optional prefix for the AI-generated hover text displayed when hovering over fields specifying an
aiHoverRequest . |
java.lang.Integer |
getAiHoverRetryDelay()
Minimum number of milliseconds to wait before retrying to generate hover contents via AI.
|
java.lang.String |
getAiSortFieldMaxRecordsMessage()
The message to show when a user asks the AI to sort more than the
maximum allowed records . |
Canvas |
getAiSortProgressDialog()
Dialog that shows progress after requesting AI-sorting of a field.
|
int[] |
getAllEditRows()
Returns an array of every rowNum for which we have pending (unsubmitted) edits.
|
ListGridField[] |
getAllFields()
Get the complete array of fields for this ListGrid, including fields that are not currently visible or were specified
implicitly via
dataSource . |
java.lang.Boolean |
getAllowFilterExpressions()
For use with
showFilterEditor :true, allows simple
search expressions to be entered into filter fields, as though DynamicForm.allowExpressions were true. |
java.lang.Boolean |
getAllowFilterOperators()
Causes a menu item titled
"Filter using" to appear
in the headerContextMenu that allows the end
user to pick an advanced search operator to use for this field. |
java.lang.Boolean |
getAllowFilterWindow()
Adds the ability for a user to define additional criteria above and beyond those expressed in the
filter editor via a FilterBuilder which appears in a modal Window over the grid and can be accessed by
various menus within the grid or triggered by external controls. |
java.lang.Boolean |
getAllowRowSpanning()
Should cells in this grid be allowed to span multiple rows? If set to
true , the getRowSpan() method will be called for every cell when rendering
out the listGrid to determine how many rows the cell should span. |
java.lang.String |
getAlternateBodyStyleName()
Optional css style to apply to the body if
alternateRecordStyles is true for this grid. |
int |
getAlternateFieldFrequency()
The number of consecutive columns to draw in the same style before alternating, when
alternateColumnStyles is true. |
boolean |
getAlternateFieldStyles()
Whether alternating columns (or blocks of columns, depending on
GridRenderer.alternateColumnFrequency ) should
be drawn in alternating styles, in order to create a vertical "ledger" effect for easier reading. |
java.lang.String |
getAlternateFieldSuffix()
Suffix to append to
alternate columns . |
int |
getAlternateRecordFrequency()
The number of consecutive rows to draw in the same style before alternating, when
alternateRowStyles is true. |
java.lang.Boolean |
getAlternateRecordStyles()
Whether alternating rows (or blocks of rows, depending on
GridRenderer.alternateRowFrequency ) should be
drawn in alternating styles, in order to create a "ledger" effect for easier reading. |
java.lang.String |
getAlternateRecordSuffix()
Suffix to append to
alternate rows . |
java.lang.Boolean |
getAlwaysShowEditors()
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 when editByCell is false. |
java.lang.Boolean |
getAlwaysShowOperatorIcon()
When
allowFilterOperators is enabled, whether
to show the operatorIcon 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. |
AnimationAcceleration |
getAnimateFolderEffect()
When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
|
java.lang.Integer |
getAnimateFolderMaxRows()
If
animateFolders is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder. |
java.lang.Boolean |
getAnimateFolders()
If true, when folders are opened / closed children will be animated into view.
|
int |
getAnimateFolderSpeed()
When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden)
per second.
|
int |
getAnimateFolderTime()
When animating folder opening / closing, if
TreeGrid.animateFolderSpeed is not set, this property designates the duration of the animation in ms. |
java.lang.Boolean |
getAnimateRemoveRecord()
When
canRemoveRecords is enabled, should records
be animated out of view when they are removed by the user? |
int |
getAnimateRemoveSpeed()
When
animating record removal , this property
designates the speed of the animation in pixels per second. |
int |
getAnimateRemoveTime()
When animating record removal
(see
animateRemoveRecord) , if animateRemoveSpeed is
not set, this property designates the duration of the animation in ms. |
java.lang.Boolean |
getAnimateRollOver()
If the
rollOverCanvas is enabled, setting this
property to true ensures that when the rollOverCanvas is displayed it is animated into view
via Canvas.animateShow() . |
java.lang.Boolean |
getAnimateRollUnder()
If the
rollUnderCanvas is enabled, setting this
property to true ensures that when the rollUnderCanvas is displayed it is animated into view
via Canvas.animateShow() . |
java.lang.Boolean |
getAnimateSelection()
If the
selectionCanvas is enabled, setting this
property to true ensures that when the selectionCanvas is displayed it is animated into view
via Canvas.animateShow() . |
java.lang.Boolean |
getAnimateSelectionUnder()
If the
selectionUnderCanvas is enabled,
setting this property to true ensures that when the selectionUnderCanvas is displayed it is
animated into view via Canvas.animateShow() . |
java.lang.Boolean |
getApplyFormulaAfterSummary()
If
ListGridField.userFormula is set for some
field, and this grid is showing group summaries or
a grid summary , this property determines what field
value should be present in those summary rows. |
java.lang.Boolean |
getApplyRowCountToLength()
This property allows developers to explicitly set
ResultSet.applyRowCountToLength for this grid's data object. |
boolean |
getApplyRowNumberStyle()
|
java.lang.String |
getApproximateRowCountFormat()
|
java.lang.String |
getAriaRole()
ARIA role for this ListGrid if
screen reader mode is enabled. |
java.util.Map |
getAriaState()
Dynamically retrieves the aria properties to write out for this listGrid in
screen reader mode . |
java.util.Map |
getAriaStateDefaults()
Retrieves dynamically calculated default
ARIA state mapping
properties for this listGrid. |
java.lang.String |
getArrowKeyAction()
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.
|
ArrowKeyEditAction |
getArrowKeyEditAction()
What to do when a user hits arrow key while editing a field?
If not explicitly specified getArrowKeyEditAction() will return an appropriate
action depending on the field type. |
java.lang.String |
getAsyncErrorCellValue()
The value to display for cells when an error occurred during asynchronous computation.
|
java.lang.String |
getAsynchGroupingPrompt()
The prompt to display while interactivity is blocked during
asynchronous grouping . |
java.lang.String |
getAsyncMissingCellValue()
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.
|
AutoComplete |
getAutoComplete()
Whether to do inline autoComplete in text fields during inline editing
Overridden by ListGridField.autoComplete if specified. |
java.lang.Boolean |
getAutoConfirmSaveEdits()
For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded by
default.
|
java.lang.Boolean |
getAutoFetchAsFilter()
If
DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData() |
java.lang.Boolean |
getAutoFetchData()
If true, when this component is first drawn, automatically call
DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . |
java.lang.Boolean |
getAutoFetchDisplayMap()
If true, for fields where
ListGridField.optionDataSource is specified, a valueMap will be automatically created by making a DataSource.fetchData() call against the specified dataSource and
extracting a valueMap from the returned records based on the displayField and valueField. |
boolean |
getAutoFetchRowCount()
Depending on whether
DataSource.progressiveLoading is
active, the exact count of available rows may not be available as part of the standard data fetch response - setting
autoFetchRowCount:true will cause a fetch for an accurate row count to be issued as soon as data arrives
(from a progressive dataSource response ) without an
accurate row count. |
TextMatchStyle |
getAutoFetchTextMatchStyle()
If
autoFetchData is true , this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call. |
java.lang.String |
getAutoFitAllText()
If we're showing a
headerContextMenu for this
grid, and canAutoFitFields is true, this attribute
will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via the autoFitField() method. |
java.lang.String[] |
getAutoFitClipFields()
If
autoFitFieldWidths is enabled and the
calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an
array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear. |
Autofit |
getAutoFitData()
Should this ListGrid automatically expand to accommodate the size of records and fields?
|
AutoFitWidthApproach |
getAutoFitDateFields()
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 by defaultDateFieldWidth , (or defaultEditableDateFieldWidth for editable
fields). |
java.lang.String |
getAutoFitExpandField()
The field to expand if
autoFitFieldWidths and
autoFitFieldsFillViewport are enabled and
auto-fitting will not fill all available horizontal space. |
java.lang.Integer |
getAutoFitExtraRecords()
If
autoFitData 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. |
java.lang.Boolean |
getAutoFitFieldsFillViewport()
If
autoFitFieldWidths is enabled, and extra
space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space. |
java.lang.String |
getAutoFitFieldText()
If we're showing a
headerContextMenu for this
grid, and user-driven auto fit of fields is enabled via ListGridField.canAutoFitWidth or canAutoFitFields , this attribute will be shown as the
menu item title for an item to perform a one-time autoFit of the field to its title or content via a call to autoFitField() . |
java.lang.Boolean |
getAutoFitFieldWidths()
Should ListGrid fields autofit their widths to titles or content? This property may be overridden on a per-field basis
via
ListGridField.autoFitWidth . |
java.lang.Boolean |
getAutoFitHeaderHeights()
If this property is set to true, header buttons for either
fields or header spans will automatically expand to
accommodate their titles vertically. |
AutoFitIconFieldType |
getAutoFitIconFields()
Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields with
type:"icon" , fields displaying only value icons , and boolean fields (which are rendered
as a checkmark type icon by default. |
int |
getAutoFitMaxColumns()
If
autoFitData is set to "horizontal" or
"both" this property provides the maximum number of columns for which the ListGrid will expand. |
java.lang.Integer |
getAutoFitMaxHeight()
If
autoFitData is set to "vertical" or
"both" this property provides an upper limit on how far the ListGrid will expand vertically to accommodate
its content. |
int |
getAutoFitMaxRecords()
If
autoFitData is set to "vertical" or
"both" this property provides the maximum number of records for which the ListGrid will expand. |
java.lang.Integer |
getAutoFitMaxWidth()
If
autoFitData is set to "horizontal" or
"both" this property provides an upper limit on how far the ListGrid will expand horizontally to
accommodate its content. |
java.lang.String |
getAutoFitMaxWidthAsString()
If
autoFitData is set to "horizontal" or
"both" this property provides an upper limit on how far the ListGrid will expand horizontally to
accommodate its content. |
AutoFitWidthApproach |
getAutoFitTimeFields()
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 by defaultTimeFieldWidth . |
AutoFitWidthApproach |
getAutoFitWidthApproach()
When a user requests column autofitting via the
header context menu or via a mouse gesture , what autofit approach is used. |
ListGridViewStatePart[] |
getAutoPersistViewState()
Setting this property to a non-null value will enable automatic saving of
view state to offline storage. |
java.lang.Boolean |
getAutoSaveEdits()
If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell if
saveByCell is true). |
java.lang.Boolean |
getAutoSizeHeaderSpans()
If this listGrid has specified
headerSpans , setting
this attribute to true will cause spans to expand to accommodate long titles if necessary. |
Canvas |
getBackgroundComponent()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getBadFormulaResultValue()
If the result of a formula evaluation is invalid (specifically, if isNaN(result)==true), badFormulaResultValue is
displayed instead.
|
java.lang.String |
getBaseStyle()
base cell style for this listGrid. |
protected java.lang.String |
getBaseStyle(ListGridRecord record,
int rowNum,
int colNum)
Return the base styleName for this cell.
|
java.lang.Boolean |
getBlockingRowCountFetch()
If specified, this attribute will be applied to this grid's
data object for dataBound grids. |
GridRenderer |
getBody()
Returns the primary body, which, when there are frozen fields, is the
com.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. |
java.lang.String |
getBodyBackgroundColor()
Background color applied to the ListGrid body (that is, the area of the grid where data values are rendered).
Note that this will typically not be visible to the user unless there are few enough rows that there is visible space in the body below the last row. |
Overflow |
getBodyOverflow()
Overflow setting for the "body", that is, the area of the grid where data values are rendered.
|
java.lang.Integer |
getBodyScrollLeft()
Get the current scrollLeft for the body of this ListGrid
|
java.lang.Integer |
getBodyScrollTop()
Get the current scrollTop for the body of this ListGrid
|
java.lang.String |
getBodyStyleName()
CSS style used for the body of this grid.
|
java.lang.String |
getBooleanBaseStyle()
An optional CSS style to apply to the checkbox image.
|
java.lang.String |
getBooleanFalseImage()
Image to display for a false value in a boolean field.
|
int |
getBooleanImageHeight()
|
int |
getBooleanImageWidth()
|
java.lang.String |
getBooleanPartialImage()
Image to display for a partially true value in a boolean field (typically selection).
|
java.lang.String |
getBooleanTrueImage()
Image to display for a true value in a boolean field.
|
java.lang.String |
getBriefRowRangeDisplayValue()
Dynamic String specifying the format for the
row range summary value when RowRangeDisplayStyle is set to "brief" . |
java.lang.Boolean |
getCanAcceptDroppedRecords()
Indicates whether records can be dropped into this listGrid.
|
java.lang.Boolean |
getCanAddAISortFields()
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.
|
java.lang.Boolean |
getCanAddFormulaFields()
Adds an item to the header context menu allowing users to launch a dialog to define a new
field based on values present in other fields, using the
com.smartgwt.client..FormulaBuilder .
|
java.lang.Boolean |
getCanAddSummaryFields()
Adds an item to the header context menu allowing users to launch a dialog to define a new
text field that can contain both user-defined text and the formatted values present in other
fields, using the
com.smartgwt.client..SummaryBuilder .
|
java.lang.Boolean |
getCanAutoFitFields()
Can the user perform one-time autofit for specific columns in this grid?
|
java.lang.String |
getCancelEditingConfirmationMessage()
If this is an editable listGrid, and
this.confirmCancelEditing is true this property is used as the message
to display in the confirmation dismissal prompt. |
java.lang.Boolean |
getCanCollapseGroup()
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 (see collapseGroupOnRowClick ); When false the group
icon is not shown and clicking on the row does not change group state. |
java.lang.Boolean |
getCanDragRecordsOut()
Indicates whether records can be dragged from this listGrid and dropped elsewhere.
|
java.lang.Boolean |
getCanDragSelect()
If this property is true, users can drag the mouse to select several rows or cells.
|
java.lang.Boolean |
getCanDragSelectText()
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 with rearranging rows
or cells by dragging , and with drag selection of
rows . |
java.lang.Boolean |
getCanDropInEmptyArea()
If set to false, dropping over an empty part of the grid body is disallowed and the no-drop indicator is displayed.
|
java.lang.Boolean |
getCanEdit()
Can the user edit cells in this listGrid? Can be set for the listGrid, and overridden for individual fields.
If 'canEdit' is false at the listGrid level, fields can never be edited - in this case the canEdit property on individual fields will be ignored. If 'canEdit' is set to true at the listGrid level, setting the 'canEdit' property to false at the field level will prevent the field from being edited inline unless a custom override of canEditCell() 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. |
java.lang.String |
getCanEditFieldAttribute()
If this component is bound to a dataSource, this attribute may be specified to customize what fields from the dataSource
may be edited by default.
|
boolean |
getCanEditHilites()
Adds an item to the header context menu allowing users to launch a dialog to define grid hilites using the
HiliteEditor . |
boolean |
getCanEditTitles()
If set to true, the
advanced field picker
provides an interface allowing users to modify fields' titles. |
java.lang.Boolean |
getCanExpandMultipleRecords()
When
canExpandRecords is true, this property
indicates whether multiple records can be expanded simultaneously. |
java.lang.String |
getCanExpandRecordProperty()
Property name on a record that will be checked to determine whether a record can be expanded.
|
java.lang.Boolean |
getCanExpandRecords()
When set to true, shows an additional field at the beginning of the field-list (respecting RTL) to allow users to expand
and collapse individual records.
|
boolean |
getCanFocusInEmptyGrid()
If the listGrid is empty, should the user be able to put focus into the grid body by tabbing to it?
|
java.lang.Boolean |
getCanFreezeFields()
Whether an interface should be shown to allow user is allowed to dynamically "freeze" or "unfreeze" columns with respect
to horizontally scrolling.
|
java.lang.Boolean |
getCanGroupBy()
If false, grouping via context menu will be disabled.
|
java.lang.Boolean |
getCanHiliteViaAI()
When set to
true 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. |
java.lang.Boolean |
getCanHover()
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 has
showHover set to false. |
boolean |
getCanMultiGroup()
When true, indicates that this ListGrid supports grouping on multiple fields.
|
java.lang.Boolean |
getCanMultiSort()
When true, indicates that this ListGrid supports sorting on multiple fields.
|
java.lang.Boolean |
getCanPickFields()
Indicates whether the field picker item and submenu should be present in the header context menu.
|
java.lang.Boolean |
getCanPickOmittedFields()
If true, the
field picker menu will include entries
for all dataSource fields, including those not included in the specified fields array . |
java.lang.Boolean |
getCanRemoveRecords()
If set, provide UI for the user to remove records from the grid as an additional field showing the
removeIcon , which, when clicked, will call removeRecordClick() which removes the row from the data set
(or if deferRemoval is true changes the markRecordRemoved() status for the record). |
java.lang.Boolean |
getCanReorderFields()
Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.
|
java.lang.Boolean |
getCanReorderRecords()
Indicates whether records can be reordered by dragging within this
ListGrid . |
boolean |
getCanRequestRowCount()
Depending on whether
DataSource.progressiveLoading is
active, the exact count of available rows may not be known, and canRequestRowCount controls whether the
end user may explicitly request it by clicking the RowRangeDisplay label. |
java.lang.Boolean |
getCanResizeFields()
Indicates whether fields in this listGrid can be resized by dragging header fields.
|
boolean |
getCanSaveSearches()
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.
|
java.lang.Boolean |
getCanSelectAll()
Controls whether a checkbox for selecting all records appears in the header with
selectionAppearance set to "checkbox" |
java.lang.Boolean |
getCanSelectCells()
Enables cell-level selection behavior as well as
cell-level rollover . |
boolean |
getCanSelectGroups()
Controls whether a checkbox for selecting
groups appears in
the group node if SelectionAppearance is set to "checkbox" |
boolean |
getCanSelectSummaryRows()
Whether to allow selection of the summary row, for example by clicking on the record.
|
boolean |
getCanShowFilterEditor()
Should a menu item allowing the user to show or hide the
filter editor be displayed in the headerContextmenu ? |
java.lang.Boolean |
getCanSort()
Enables or disables interactive sorting behavior for this listGrid.
|
java.lang.Boolean |
getCanTabToHeader()
Should the header be included in the tab-order for the page? If not explicitly specified, the header will be included in
the tab order for the page if
SC.setScreenReaderMode() is
called. |
java.lang.Boolean |
getCanTabToSorter()
Should the
corner sort button be included in the
tab-order for the page? |
java.util.Map |
getCellAriaState(java.lang.Integer rowNum,
java.lang.Integer colNum,
ListGridRecord record,
java.lang.String role)
Returns a map of
WAI ARIA state attribute values to be written
into cells within this grid. |
Layout |
getCellContextMenu()
The menu displayed when a cell is right clicked on.
|
MenuItem[] |
getCellContextMenuItems(java.lang.Integer record,
java.lang.Integer rowNum,
java.lang.Integer colNum)
If
showCellContextMenus is true
this method returns the menu items to be displayed in the default cell context menu. |
protected java.lang.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.
|
java.lang.String[] |
getCellErrors(int rowNum,
java.lang.String fieldName)
Returns the current set of errors for this cell.
|
int |
getCellHeight()
Default height for each row in pixels.
|
protected Canvas |
getCellHoverComponent(Record record,
java.lang.Integer rowNum,
java.lang.Integer colNum)
When
showHoverComponents is set, this method is
called to get the component to show as a hover for the current cell. |
int |
getCellPadding()
The amount of empty space, in pixels, surrounding each value in its cell.
|
java.lang.Integer[] |
getCellPageRect(int rowNum,
int colNum)
Returns the page offsets and size of the cell at the passed row and column.
|
java.lang.String |
getCellRole()
Returns the default WAI ARIA role for cells within this listGrid.
|
int |
getCellRowSpan(int rowNum,
int colNum)
When using
row spanning , returns the number of cells
spanned by the cell at the given coordinates. |
CellSelection |
getCellSelection()
When
canSelectCells is active, returns the CellSelection object that tracks and manages the current selection. |
int |
getCellStartRow(int rowNum,
int colNum)
When using
row spanning , returns the row number where a
row-spanning cell starts. |
protected java.lang.String |
getCellStyle(ListGridRecord record,
int rowNum,
int colNum)
Return the CSS class for a cell.
|
java.lang.String |
getChartConstructor()
Name of the Smart GWT Class to be used when creating charts.
|
ChartType |
getChartType()
Default type of chart to plot.
|
java.lang.String |
getCheckboxFieldFalseImage()
If
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for an unselected row. |
java.lang.Integer |
getCheckboxFieldImageHeight()
If
selectionAppearance is set to
"checkbox" this property may be set to govern the height of the checkbox image displayed to indicate
whether a row is selected. |
java.lang.Integer |
getCheckboxFieldImageWidth()
If
selectionAppearance is set to
"checkbox" this property may be set to govern the width of the checkbox image displayed to indicate whether
a row is selected. |
java.lang.String |
getCheckboxFieldPartialImage()
If
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a partially selected
row. |
java.lang.String |
getCheckboxFieldTrueImage()
If
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a selected row. |
ExpansionMode |
getChildExpansionMode()
For
expansionModes that show another grid or tree, what the child's
expansionMode should be. |
java.lang.String |
getClearAllSortingText()
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear any existing sort on all fields. |
boolean |
getClearCriteriaOnFilterEditorHide()
When set to false, this attribute prevents user-criteria in the
filterEditor from being cleared when the user hides it. |
java.lang.String |
getClearFilterText()
If we're showing a
headerContextMenu for this
grid, and a filter-editor is visible, this
attribute will be shown as the menu item title to clear any existing filter. |
java.lang.String |
getClearFilterViaAIText()
Title for the menu-item displayed in this component's header context-menu when
AI-assisted filtering is allowed and an AI filter in
already in effect. |
java.lang.String |
getClearSortFieldText()
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear an existing sort on this field. |
java.lang.Boolean |
getClipHeaderTitles()
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 on
hover . |
boolean |
getCollapseGroupOnRowClick()
If
canCollapseGroup is true, will a click anywhere
on the group row toggle the group's expanded state? If false, the user must click the groupIcon directly to toggle the group. |
java.lang.Integer |
getColumnLeft(java.lang.Integer colNum)
Return the left offset (in local coordinate space) of a particular column.
|
java.lang.Integer |
getColumnPageLeft(java.lang.Integer colNum)
Return the left coordinate for a given column number as a GLOBAL coordinate
|
java.lang.Integer |
getColumnWidth(int colNum)
Return the width of a particular column.
|
java.lang.String |
getConfigureGroupingText()
If we're showing a
headerContextMenu for this
grid, and multi-grouping is enabled, this attribute is used as the title for a menu item that opens a MultiGroupDialog to configure the grouping for this grid. |
java.lang.String |
getConfigureSortText()
If we're showing a
headerContextMenu for this
grid, and multi-sorting is enabled, this attribute is used as the title for a menu item that opens a MultiSortDialog to configure the sort-specification for this grid. |
java.lang.Boolean |
getConfirmCancelEditing()
If this is an editable listGrid, when the user attempts to cancel an edit, should we display a confirmation prompt
before discarding the edited values for the record?
|
java.lang.Boolean |
getConfirmDiscardEdits()
For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded.
|
java.lang.String |
getConfirmDiscardEditsMessage()
If
this.confirmDiscardEdits is true, this property can be used to customize the error message string
displayed to the user in a dialog with options to cancel the action, or save or discard pending edits in response to
sort/filter actions that would otherwise drop unsaved edit values. |
Criteria |
getCriteria()
Retrieves a copy of the current criteria for this component (may be null).
|
java.lang.String |
getCriteriaIndicatorColor()
The color of the
filterWindow
criteria indicator . |
java.lang.String |
getCriteriaIndicatorHeaderColor()
The color of the
filterWindow
criteria indicator when shown on the sorter
button or the last header button in the
grid header. |
Canvas |
getCurrentExpansionComponent(java.lang.Integer record)
Returns the expansion component derived from
getExpansionComponent() currently visible in some record, or null if the specified record is not showing an expansion
component. |
Canvas |
getCurrentExpansionComponent(ListGridRecord record)
Returns the expansion component derived from
getExpansionComponent() currently visible in some record, or null if the specified record is not showing an expansion
component. |
java.lang.Integer[] |
getCurrentFieldWidths()
Returns an array of widths of the visible fields in this
ListGrid , in px. |
java.lang.String |
getDataArity()
A ListGrid is a
dataArity :multiple component. |
com.google.gwt.core.client.JavaScriptObject |
getDataAsJSList() |
RecordList |
getDataAsRecordList()
Return the grid data as a
RecordList . |
java.lang.Integer |
getDataFetchDelay()
Delay in milliseconds before fetching data.
|
FetchMode |
getDataFetchMode()
How to fetch and manage records retrieve from the server.
|
int |
getDataPageSize()
When using
data
paging , how many records to fetch at a time. |
DataSource |
getDataSource()
The DataSource that this component should bind to for default fields and for performing
DataSource requests . |
DateDisplayFormat |
getDateFormatter()
How should Date type values be displayed in this ListGrid by default?
|
DateDisplayFormat |
getDatetimeFormatter()
Display format to use for fields specified as type 'datetime'.
|
java.lang.Boolean |
getDeepCloneOnEdit()
Before we start editing values in this DataBoundComponent, should we perform a deep clone
of the underlying values.
|
java.lang.Integer |
getDefaultDateFieldWidth()
Default width for date type fields.
|
java.lang.Integer |
getDefaultDateTimeFieldWidth()
Default width for datetime type fields.
|
java.lang.Integer |
getDefaultEditableDateFieldWidth()
Default width for editable date type fields.
|
java.lang.Integer |
getDefaultEditableDateTimeFieldWidth()
Default width for editable datetime type fields.
|
ListGridField[] |
getDefaultFields()
An array of listGrid field configuration objects.
|
OperatorId |
getDefaultFilterOperator()
Default
filter operator to use for text-based fields in this grid's filter editor , when producing AdvancedCriteria . |
java.lang.String |
getDefaultFilterOperatorSuffix()
Text to show after the name of the default filterOperator in the
headerContextMenu when allowFilterOperators is enabled. |
java.lang.String |
getDefaultFormattedFieldValue(Record record,
ListGridField field)
Get a field value for some record with default field formatters applied.
|
java.lang.String |
getDefaultFormattedFieldValue(Record record,
ListGridField field,
int rowNum) |
java.lang.String |
getDefaultFormattedFieldValue(Record record,
ListGridField field,
int rowNum,
int colNum)
Get a field value for some record with default field formatters applied.
|
java.lang.String |
getDefaultFormattedValue(Record record,
int rowNum,
int colNum)
Get the value for some cell with default formatters applied.
|
java.lang.Integer |
getDefaultTimeFieldWidth()
Default width for time type fields.
|
java.lang.Boolean |
getDeferRemoval()
When enabled, the field shown by
canRemoveRecords
causes records to be marked for future removal via markRecordRemoved() instead of immediately being removed. |
java.lang.Boolean |
getDeselectOnPartialCheckboxClick()
Should partially selected checkbox be deselected or selected on click? This setting affects
header selection checkbox , group\n checkboxes and folder checkbox selection in a Tree
data set. |
java.lang.String |
getDetailDS()
If
canExpandRecords is true and listGrid.expansionMode is "related" , this property specifies the
dataSource for the related records grid to be shown embedded in expanded records. |
java.lang.String |
getDetailField()
The field whose contents to show in the expanded portion of a record when
canExpandRecords is true and listGrid.expansionMode is detailField . |
java.lang.String |
getDisabledGroupByPrompt()
Prompt to indicate that grouping is disabled as the data set size exceeds
groupByMaxRecords . |
boolean |
getDiscardEditsOnHideField()
If a user is editing a
canEdit: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? |
java.lang.String |
getDiscardEditsSaveButtonTitle()
If
confirmDiscardEdits is true this is the
title for the save button appearing in the lost edits confirmation dialog. |
java.lang.Object |
getDisplayValue(java.lang.String fieldName,
boolean value)
Given a field with a specified
valueMap
or displayField ,
this method will return the display value for any underlying data value. |
java.lang.Object |
getDisplayValue(java.lang.String fieldName,
java.util.Date value)
Given a field with a specified
valueMap
or displayField ,
this method will return the display value for any underlying data value. |
java.lang.Object |
getDisplayValue(java.lang.String fieldName,
float value)
Given a field with a specified
valueMap
or displayField ,
this method will return the display value for any underlying data value. |
java.lang.Object |
getDisplayValue(java.lang.String fieldName,
int value)
Given a field with a specified
valueMap
or displayField ,
this method will return the display value for any underlying data value. |
java.lang.Object |
getDisplayValue(java.lang.String fieldName,
java.lang.String value)
Given a field with a specified
valueMap
or displayField ,
this method will return the display value for any underlying data value. |
Record[] |
getDragData()
During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.
|
DragDataAction |
getDragDataAction()
Indicates what to do with data dragged into another DataBoundComponent.
|
ListGridField |
getDragHandleField()
An automatically generated field that can be dragged to drag the current selection (where otherwise the grid itself
might be scrolled).
|
java.lang.String |
getDragHandleFieldTitle()
The title to use for the
drag handle field . |
java.lang.String |
getDragHandleIcon()
Default icon to show in the
drag handle field .. |
int |
getDragHandleIconSize()
Default width and height of
drag handle icons for
this ListGrid. |
int |
getDragScrollRedrawDelay()
Like
scrollRedrawDelay , but applies when the
component is being drag-scrolled (via a scrollbar). |
DragTrackerMode |
getDragTrackerMode()
When records are being dragged from within a ListGrid, what sort of drag-tracker should be displayed?
Note that if multiple records are being dragged the displayed tracker will be based on the first selected record. |
java.lang.String |
getDragTrackerStyle()
CSS Style to apply to the drag tracker when dragging occurs on this component.
|
float |
getDrawAheadRatio()
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 |
getDrawAllMaxCells()
If drawing all rows would cause less than
drawAllMaxCells cells to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
the viewport size and drawAheadRatio setting would
normally have caused incremental rendering to be used. |
java.lang.Integer[] |
getDrawArea()
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.
|
java.lang.Integer[] |
getDrawnRows()
Get the rows that are currently drawn (exist in the DOM), as an array of [firstRowNum, lastRowNum].
|
java.util.Map |
getDropValues()
When an item is dropped on this component, and
addDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it. |
java.lang.String |
getDuplicateDragMessage()
Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled. |
java.lang.Boolean |
getEditByCell()
Determines whether when the user edits a cell in this listGrid the entire row becomes editable, or just the cell that
received the edit event.
|
int |
getEditCol()
Returns the index of the column being edited or -1 if there is no current edit column.
|
java.lang.Object |
getEditedCell(int record,
int field)
Returns the current value of a cell.
|
java.lang.Object |
getEditedCell(int rowNum,
java.lang.String fieldName) |
java.lang.Object |
getEditedCell(Record record,
int colNum) |
java.lang.Object |
getEditedCell(Record record,
java.lang.String fieldName) |
Record |
getEditedRecord(int rowNum)
Returns the combination of unsaved edits (if any) and original values (if any) for a given row being edited.
|
ListGridEditEvent |
getEditEvent()
Event that will trigger inline editing, see
ListGridEditEvent for options. |
java.lang.String |
getEditFailedBaseStyle()
A base name for the CSS class applied to cells when editing has failed.
If this listGrid is editable, this style will be applied to any edited cells for which validation failed. As with the default 'baseStyle' property, this style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell. If null, cells for which editing has failed will be rendered using the normal base style classNames, but with custom CSSText applied as derived from this.editFailedCSSText |
java.lang.String |
getEditFailedCSSText()
Custom CSS text to be applied to cells when editing has failed.
If this listGrid is editable, this css text will be applied to any edited cells for which validation failed, on top of the base style for the cell. For further customization of styling for cells that failed editing validation, use this.editFailedBaseStyle instead. |
FormItem |
getEditFormItem(java.lang.Integer field)
Method to retrieve a live edit form item for an
editable
ListGrid. |
FormItem |
getEditFormItem(java.lang.String field)
Method to retrieve a live edit form item for an
editable
ListGrid. |
java.lang.String |
getEditFormulaFieldText()
Text for a menu item allowing users to edit a formula field
|
java.lang.Boolean |
getEditOnF2Keypress()
Should we start editing when the widget has focus and the user presses the "f2" key (if this ListGrid supports editing)?
|
java.lang.Boolean |
getEditOnFocus()
Should we start editing when this widget receives focus (if this ListGrid supports editing)?
|
java.lang.String |
getEditPendingBaseStyle()
A base name for the CSS class applied to cells containing pending (unsaved) edits
As with the default 'baseStyle' property, this style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell. |
java.lang.String |
getEditPendingCSSText()
Custom CSS text to be applied to cells with pending edits that have not yet been submitted.
For further customization of styling for cells with pending edits use this.editPendingBaseStyle instead. |
java.lang.String |
getEditPendingMarkerStyle()
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 by
editPendingCSSText or editPendingBaseStyle . |
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
int |
getEditRow()
Returns the index of the row being edited or -1 if there is no current edit row.
|
SelectionStyle |
getEditSelectionType()
If
selectOnEdit is true, what should be the
edit-selection behavior be? |
java.lang.String |
getEditSummaryFieldText()
Text for a menu item allowing users to edit the formatter for a field
|
java.lang.Object |
getEditValue(int rowNum,
int colNum)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
java.lang.Object |
getEditValue(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
java.lang.Boolean |
getEditValueAsBoolean(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
java.util.Date |
getEditValueAsDate(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
java.lang.Float |
getEditValueAsFloat(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
java.lang.Integer |
getEditValueAsInt(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
Record |
getEditValueAsRecord(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
Record[] |
getEditValueAsRecordArray(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
java.lang.String |
getEditValueAsString(int rowNum,
java.lang.String fieldName)
Returns the current temporary locally stored edit value for some field within a record being edited.
|
java.util.Map |
getEditValues(int rowNum)
Returns the current set of unsaved edits for a given row being edited.
|
java.util.Map |
getEditValues(Record record)
Returns the current set of unsaved edits for a given row being edited.
|
java.lang.Integer |
getEmbeddedComponentIndent()
This is the pixel-amount by which child components are offset within the grid-body, by default from the left, or from
the right when
RTL is in effect. |
java.lang.Integer |
getEmbeddedComponentMargin()
This is the space to apply as margin around child-components embedded in this grid.
|
java.lang.String |
getEmptyAIHoverContents()
Hover contents to use when the AI-generated hover text is empty.
|
java.lang.String |
getEmptyCellValue()
The value to display for cells whose value is null or the empty string after applying
formatting and valueMap (if any). |
java.lang.String |
getEmptyMessage()
The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.
|
java.lang.String |
getEmptyMessageStyle()
The CSS style name applied to the
emptyMessage if
displayed. |
java.lang.String |
getEmptyRowRangeDisplayValue()
Row range summary display value when the grid
is empty. |
java.lang.Boolean |
getEnforceVClipping()
For performance reasons, even when
fixedRecordHeights is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers. |
EnterKeyEditAction |
getEnterKeyEditAction()
What to do when a user hits enter while editing a cell: "nextCell": start editing the next editable cell in
this record (or the first editable cell in the next record if focus is in the last editable cell in the row)
"nextRow": start editing the same field in the next row (skipping any rows where that would be a non-editable
cell.
|
java.lang.Boolean |
getEnumCriteriaAsInitialValues()
In a ListGrid that has a DataSource and has filter criteria that include values for fields declared as
type "enum" in the DataSource, by default a newly edited row will use those filter
criteria as initial values. |
java.lang.Integer |
getErrorIconHeight()
Height of the error icon, if we're showing icons when validation errors occur.
|
java.lang.String |
getErrorIconSrc()
Src of the image to show as an error icon, if we're showing icons when validation errors occur.
|
java.lang.Integer |
getErrorIconWidth()
Height of the error icon, if we're showing icons when validation errors occur.
|
EscapeKeyEditAction |
getEscapeKeyEditAction()
What to do when a user hits escape while editing a cell: "cancel": close the editor and discard the current set
of edit values "done": just close the editor (the edit is complete, but the edited values are retained).
|
int |
getEventColumn()
Returns the column number of the provided X-coordinate, or the most recent mouse event if an X-coordinate is not
provided.
|
int |
getEventColumn(java.lang.Integer x)
Returns the column number of the provided X-coordinate, or the most recent mouse event if an X-coordinate is not
provided.
|
int |
getEventRow()
Returns the row number of the provided Y-coordinate, or the most recent mouse event if a Y-coordinate is not provided.
|
int |
getEventRow(java.lang.Integer y)
Returns the row number of the provided Y-coordinate, or the most recent mouse event if a Y-coordinate is not provided.
|
java.lang.String |
getExactRowCountFormat()
|
ListGridRecord[] |
getExpandedRecords()
|
java.lang.Boolean |
getExpansionCanEdit()
For
expansionModes that show another grid or tree, is that component
editable? |
protected Canvas |
getExpansionComponent(ListGridRecord record)
When
canExpandRecords is true, gets the
embedded-component to show as a given record's expansionComponent. |
ExpansionComponentPoolingMode |
getExpansionComponentPoolingMode()
The method of
component-pooling to employ for expansionComponents . |
HTMLFlow |
getExpansionDetailField()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
HLayout |
getExpansionDetailRelated()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
DetailViewer |
getExpansionDetails()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
DynamicForm |
getExpansionEditor()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.Boolean |
getExpansionEditorCollapseOnSave()
When
ExpansionMode is editor, should the row be collapsed following a save
initiated by the expansion-component's save button . |
IButton |
getExpansionEditorSaveButton()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getExpansionEditorSaveButtonTitle()
The title for the
expansionEditorSaveButton . |
java.lang.String |
getExpansionEditorSaveDialogPrompt()
When
canExpandRecords is true and expansionMode is editor, the prompt to display in a
dialog when an expanded row is collapsed while it's nested editor has changed values. |
java.lang.Boolean |
getExpansionEditorShowSaveDialog()
When
canExpandRecords is true and expansionMode is editor, whether a dialog should be
displayed when an expanded row is collapsed while it's nested editor has changed values. |
ListGridField |
getExpansionField()
The field providing the facility to expand and collapse rows.
|
java.lang.String |
getExpansionFieldFalseImage()
If
canExpandRecords is set to true ,
this property determines the image to display in the expansion field for collapsed rows. |
java.lang.Integer |
getExpansionFieldImageHeight()
If
canExpandRecords is set to true ,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded. |
boolean |
getExpansionFieldImageShowRTL()
If this grid is in RTL mode, should an "_rtl" suffix be added to the
expansionFieldTrueImage and expansionFieldFalseImage image URLs? This should
only be enabled if RTL media for the true and false expansion field images are available. |
boolean |
getExpansionFieldImageShowSelected()
Should a "_selected" suffix be added to the
expansionFieldTrueImage and expansionFieldFalseImage image URLs for selected rows? |
java.lang.String |
getExpansionFieldImageStyle()
Custom style to apply to the image in the
expansionField displayed in collapsible rows when canExpandRecords is true. |
java.lang.Integer |
getExpansionFieldImageWidth()
If
canExpandRecords is set to true ,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded. |
java.lang.String |
getExpansionFieldTrueImage()
If
canExpandRecords is set to true ,
this property determines the image to display in the expansion field for expanded rows. |
java.lang.Integer |
getExpansionIndent()
When
canExpandRecords 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 when
RTL is in effect. |
VLayout |
getExpansionLayout()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
ExpansionMode |
getExpansionMode()
The
ExpansionMode for records in this grid. |
ListGrid |
getExpansionRelated()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getExpansionScreen()
Screen to create (via
createScreen() ) in lieu of calling getExpansionComponent() . |
int |
getExplicitFetchDelay()
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. |
java.lang.Boolean |
getExportAll()
Setting exportAll to true prevents the component from passing its list of fields to the
export call.
|
java.lang.String |
getExportAlternateRowBGColor()
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , background color
to use for even-numbered rows, to create a "banded" or "ledger" effect. |
java.lang.String |
getExportBGColor(int rowNum,
int colNum,
Record record)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , background color
to use for the cell at the given rowNum and colNum. |
java.lang.String |
getExportColumnBGColor(int colNum)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , background color
to use for the given colNum. |
java.lang.String |
getExportDefaultBGColor()
Default background color to use when exporting data to Excel/OpenOffice format using
exportData() or exportClientData() . |
boolean |
getExportFieldAlignments()
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , whether field
horizontal header alignments and data value alignments should be replicated in the resulting
spreadsheet. |
java.lang.String[] |
getExportFields()
The list of field-names to export.
|
boolean |
getExportFieldWidths()
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , whether widths
of fields should be replicated in the resulting spreadsheet. |
boolean |
getExportHeaderHeights()
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , causes the
headerHeight and headerSpan heights to be applied to the corresponding cells in
the spreadsheet. |
int |
getExportHiddenFieldWidth()
Width to size non-visible fields (which may be specified with
exportFields or DSRequest.exportFields ) during exportData() or exportClientData() , if they have no defined numeric width . |
java.lang.Boolean |
getExportIncludeSummaries()
If Summary rows exist for this component, whether to include them when exporting client data.
|
java.lang.Boolean |
getExportRawNumbers()
Dictates whether numeric values should be exported as raw numbers instead of formatted values when using
exportClientData() . |
java.lang.Boolean |
getExportRawValues()
Dictates whether the data in this grid should be exported raw by
exportClientData() . |
java.lang.String |
getExportRowBGColor(int rowNum,
Record record)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , background color
to use for the given rowNum. |
java.lang.String |
getExportTextColor(int rowNum,
int colNum,
Record record)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , text color to
use for the cell at the given rowNum and colNum. |
double |
getExportWidthScale()
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 |
getExportWrapHeaderTitles()
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , whether titles
in the ListGrid header and headerSpans should be allowed to wrap. |
int |
getFetchDelay()
If we're showing the filterEditor (
showFilterEditor is true), and filterByCell or
filterOnKeypress are enabled, this property is the
delay in milliseconds between the user changing the filter and the filter request being sent to the server. |
ListGridField[] |
getFetchFields()
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.
|
java.lang.String |
getFetchFieldsAsString()
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.
|
java.lang.String |
getFetchOperation()
Operation ID this component should use when performing fetch operations.
|
DSRequest |
getFetchRequestProperties()
If
autoFetchData is true , this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. |
ListGridField |
getField(int colNum)
Given a column number or field name, return the field definition of a field which is visible in the grid.
|
ListGridField |
getField(java.lang.String colNum)
Given a column number or field name, return the field definition of a field which is visible in the grid.
|
Alignment[] |
getFieldAlignments()
Returna an array of field alignments for this grid
|
ListGridField |
getFieldByName(java.lang.String fieldName)
Given a field name, return the appropriate field definition.
|
java.lang.Integer |
getFieldContentWidth(ListGridField field)
Returns the pixel width of the content of a visible field in this grid.
|
int |
getFieldCount()
Return the number of fields.
|
java.lang.String |
getFieldCriteriaText()
The field criteria prefix to show in filter editor field hover before the descriptive version of the field's criteria,
if any.
|
java.lang.String |
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 array
|
int |
getFieldNum(java.lang.String fieldID)
Given a field or field id, return it's index in the fields array
|
java.lang.String[] |
getFieldPickerFieldProperties()
Names of properties on
ListGridField for which the FieldPicker should show an editing interface, for convenience. |
java.lang.Boolean |
getFieldPickerShowSampleValues()
When set to false, sample values of the FieldPicker are never shown.
|
FieldPickerWindow |
getFieldPickerWindow()
Instance of
FieldPickerWindow used if useAdvancedFieldPicker is set. |
ListGridField[] |
getFields()
An array of field objects, specifying the order, layout, formatting, and sorting behavior of each field in the listGrid
object.
|
com.google.gwt.core.client.JavaScriptObject[] |
getFieldsAsJavaScriptObjects()
Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field
class type
(e.g.
|
void |
getFieldSearchOperator(java.lang.String fieldName)
Returns the current search-operator applied to criteria for a given field in this grid's
filter row . |
java.lang.String |
getFieldState()
Initial
field state for the grid. |
java.lang.String |
getFieldTitle(int fieldId)
Return the title of a field, specified by name or index.
|
java.lang.String |
getFieldTitle(java.lang.String fieldId)
Return the title of a field, specified by name or index.
|
java.lang.String |
getFieldVisibilitySubmenuTitle()
If we're showing a
headerContextMenu for this
grid, and this.canPickFields is true, this attribute
will be shown as the title for the menu item which contains a submenu with items allowing the user to show and hide
fields in the grid. |
java.lang.Integer |
getFieldWidth(int fieldNum)
Returns a numeric value for the width of some field within this
ListGrid . |
java.lang.Integer |
getFieldWidth(java.lang.String fieldName)
Returns a numeric value for the width of some field within this
ListGrid . |
java.lang.String |
getFilterButtonPrompt()
The prompt to show when the mouse hovers over the Filter button in the FilterEditor.
|
Button |
getFilterButtonProperties()
If
showFilterEditor is true, this attribute may be
used to customize the filter button shown to the right of the filterEditor row. |
boolean |
getFilterByCell()
If we're showing the
filterEditor , 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. |
RecordEditor |
getFilterEditor()
If
showFilterEditor is set to true, the
filterEditor is automatically created as an AutoChild. |
Criteria |
getFilterEditorCriteria()
If
showFilterEditor is true, this method will
return the criteria currently displayed in the filterEditor . |
Criteria |
getFilterEditorCriteria(java.lang.Boolean omitHiddenFields)
If
showFilterEditor is true, this method will
return the criteria currently displayed in the filterEditor . |
AdvancedCriteria |
getFilterEditorCriteriaAsAdvancedCriteria()
Same as
getFilterEditorCriteria() but returns an
AdvancedCriteria . |
Criterion |
getFilterEditorCriterion(java.lang.String fieldName)
Extracts and returns the criteria for the passed field from the
filterEditor . |
int |
getFilterEditorHeight()
Height for the filterEditor, if shown.
|
RecordEditor |
getFilterEditorProperties()
Properties to apply to the automatically generated
filterEditor if showFilterEditor is true. |
java.lang.Boolean |
getFilterLocalData()
Causes filtering to be performed against the local data set, even when a
dataSource is provided. |
boolean |
getFilterOnKeypress()
When this attribute is true and this component has been assigned a
searchForm or is showing the filterEditor , data will be filtered automatically as
users change values in those components. |
java.lang.String |
getFilterUsingText()
Text for the menu item shown in the
headerContextMenu when allowFilterOperators
is enabled. |
AIServiceMode |
getFilterViaAIMode()
If filtering of the grid is enabled, filtering-via-AI can also be enabled by setting the
AIServiceMode to use. |
java.lang.String |
getFilterViaAIPanelInstructions()
The instruction text to display above the "Filter via AI" text box.
|
java.lang.String |
getFilterViaAIText()
Title for the menu-item displayed in this component's header context-menu when
AI-assisted filtering is allowed. |
Window |
getFilterWindow()
|
Criteria |
getFilterWindowCriteria()
Advanced filtering criteria, either
simple or advanced , that is combined with the filter editor criteria during filtering. |
Canvas |
getFilterWindowCriteriaIndicator()
Instance of
Canvas used to show visual indicator that filterWindowCriteria is configured. |
FilterBuilder |
getFilterWindowFilter()
|
java.lang.String |
getFilterWindowInstructions()
The instruction text to display at the top of the
filterWindow . |
java.lang.String |
getFilterWindowTitle()
The title for the
advanced filtering window . |
java.lang.String |
getFirstCellStyle()
The style to apply to the first cell in each row, when
styledRowEnds is true. |
java.lang.Boolean |
getFixedFieldWidths()
Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?
|
java.lang.Boolean |
getFixedRecordHeights()
Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?
|
java.lang.Integer |
getFocusRow()
Get the row that currently has keyboard focus.
|
java.lang.String |
getFormattedRowCount()
Returns the
current total row count for this grid as a
formatted string. |
java.lang.String |
getFormattedRowRange()
Uses the
rowRangeFormat to return a formatted
display value showing the currently visible set of rows in the listGrid viewport. |
java.lang.String |
getFormulaBuilderSpanTitleSeparator()
If this grid has specified
headerSpans , and showHeaderSpanTitlesInFormulaBuilder
is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid in
the FormulaBuilder and SummaryBuilder. |
java.lang.Double |
getFormulaFieldValue(ListGridField field,
Record record)
Get the computed value of a
canAddFormulaFields . |
java.lang.String |
getFreezeFieldText()
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze a currently unfrozen field. |
java.lang.String |
getFrozenBaseStyle()
If this listGrid contains any frozen fields, this property can be used to apply a custom baseStyle to all cells in those
frozen fields.
|
java.lang.String |
getFrozenFieldsMaxWidth()
Maximum width available for any
frozen fields shown in this grid. |
java.lang.Integer |
getFrozenFieldsMaxWidthAsInt()
Maximum width available for any
frozen fields shown in this grid. |
java.lang.String |
getFrozenHeaderBaseStyle()
If this listGrid contains any frozen fields, this property can be used to apply a custom headerBaseStyle to the frozen
set of fields.
|
java.lang.String |
getFrozenHeaderTitleStyle()
If this listGrid contains any frozen fields, this property can be used to apply a custom headerTitleStyle to the frozen
set of fields.
|
protected Canvas |
getFrozenRollOverCanvas(java.lang.Integer rowNum,
java.lang.Integer colNum)
For grids with frozen columns, this method is called to retrieve the
frozenRollOverCanvas when the user moves over a new
row or cell if showRollOverCanvas is true, or
when the user moves over the selected record if showSelectedRollOverCanvas is true. |
protected Canvas |
getFrozenRollUnderCanvas(java.lang.Integer rowNum,
java.lang.Integer colNum)
For grids with frozen columns, this method is called to retrieve the
frozenRollUnderCanvas when showing a rollUnder canvas or showing a rollUnder canvas for the selected record . |
java.lang.String |
getFullRowRangeDisplayValue()
Dynamic String specifying the format for the
row range summary value when RowRangeDisplayStyle is set to "full" . |
java.lang.Boolean |
getGenerateClickOnEnter()
If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a click event.
|
java.lang.Boolean |
getGenerateClickOnSpace()
If true, when the user navigates to a cell using arrow keys and hits space, the cell will respond to a click event.
|
java.lang.Boolean |
getGenerateDoubleClickOnEnter()
If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a double click
event.
|
java.lang.Boolean |
getGenerateDoubleClickOnSpace()
If true, when the user navigates to a cell using arrow keys and hits Space, the cell will respond to a double click
event.
|
java.lang.String |
getGridAdditionalCriteriaText()
The additional criteria prefix to show in filter editor field hover, the filter action button or the sorter button
before the descriptive version of the
filterWindowCriteria , if any. |
ListGridComponent[] |
getGridComponents()
Array of components that make up this grid.
|
GridRenderer |
getGridRenderer()
Synonym of
getBody() . |
java.lang.Object |
getGridSummary(ListGridField field)
When
showGridSummary is true this
method is called for each field which will show a grid summary value (as described in ListGridField.showGridSummary ) to get the summary
value to display below the relevant column. |
ListGridRecord[] |
getGridSummaryData()
This method returns the data displayed in the
summaryRow when showGridSummary is true. |
java.lang.String |
getGridSummaryRecordProperty()
If
showGridSummary is true, this attribute will be
set to true on the record object representing the grid summary row. |
int |
getGroupByAsyncThreshold()
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.
|
java.lang.String[] |
getGroupByFields()
Get the current grouping of this listGrid as an array of fieldNames.
|
java.lang.String[] |
getGroupByFieldSummaries()
If this grid is
grouped , and showGroupSummary is true, this attribute may be set to an
array of groupBy field names for which group summaries should appear. |
int |
getGroupByMaxRecords()
Maximum number of records to which a groupBy can be applied.
|
java.lang.String |
getGroupByMaxRecordsExceededMessage()
Warning shown to the user when a grouping attempt failed as the data set length exceeds
groupByMaxRecords . |
java.lang.String |
getGroupByText()
If we're showing a
headerContextMenu for this
grid and this.canGroupBy is true, this string will be
shown as the title for the menu item to toggle the group by setting for a field. |
int |
getGroupedRecordIndex(ListGridRecord record)
Returns the true row index for a grouped record excluding group and summary records.
|
java.lang.String |
getGroupIcon()
The URL of the base icon for the group icons in this listGrid.
|
int |
getGroupIconSize()
Default width and height of group icons for this ListGrid.
|
java.lang.String |
getGroupIconStyle()
Custom style to apply to the
groupIcon displayed in
collapsible rows when canGroupBy is true. |
int |
getGroupIndentSize()
Default number of pixels by which to indent subgroups relative to parent group.
|
int |
getGroupLeadingIndent()
Default number of pixels by which to indent all groups.
|
ListGridRecord[] |
getGroupMembers(GroupNode node,
boolean recordsOnly)
For a
grouped grid,
returns all the direct children of the supplied node in the
groupTree if
recordsOnly false. |
java.lang.String |
getGroupNodeBaseStyle()
Base style for group rows. |
java.lang.String |
getGroupNodeStyle()
The CSS style that
group rows will have. |
SortDirection |
getGroupSortDirection()
When
sortByGroupFirst is active, the sorting
direction applied for implicit sorting by the field(s) used for grouping. |
java.lang.String |
getGroupState()
Initial group state for the grid.
|
ListGridRecord[] |
getGroupSummaryData(Record[] records,
GroupNode groupNode)
If this grid is
grouped , and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. |
ListGridRecord[] |
getGroupSummaryData(Record[] records,
GroupNode groupNode,
java.lang.Boolean recalculate)
If this grid is
grouped , and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. |
ListGridRecord[] |
getGroupSummaryData(Record[] records,
Record groupNode)
If this grid is
grouped , and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. |
ListGridRecord[] |
getGroupSummaryData(Record[] records,
Record groupNode,
java.lang.Boolean recalculate)
If this grid is
grouped , and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. |
java.lang.String |
getGroupSummaryRecordProperty()
If
showGroupSummary is true, this attribute will
be set to true on each record object representing a group-level summary row. |
java.lang.String |
getGroupSummaryStyle()
ListGridRecord.customStyle for the group-level
summary row displayed when showGroupSummary is
true. |
ListGridField |
getGroupTitleColumnProperties()
Custom properties for the automatically generated
groupTitleColumn . |
java.lang.String |
getGroupTitleField()
When a list grid is
grouped , each group shows under an auto
generated header node. |
Tree |
getGroupTree()
The data tree that results from a call to
groupBy() . |
ListGridRecord[] |
getGroupTreeSelection()
If this grid
is grouped , this method will return the
current selection. |
ListGridRecord[] |
getGroupTreeSelection(boolean excludePartialSelection) |
ListGridRecord[] |
getGroupTreeSelection(boolean excludePartialSelection,
boolean groupNodesOnly)
If this grid
is grouped , this method will return the
current selection. |
Layout |
getHeader()
A Toolbar used to manager the headers shown for each column of the grid.
|
java.lang.String |
getHeaderAriaRole()
|
AutoFitEvent |
getHeaderAutoFitEvent()
Event on a ListGrid header that triggers auto fitting to data and/or title.
|
java.lang.String |
getHeaderBackgroundColor()
BackgroundColor for the header toolbar.
|
java.lang.String |
getHeaderBarStyle()
Set the CSS style used for the header as a whole.
|
java.lang.String |
getHeaderBaseStyle()
Button.baseStyle to apply to the buttons in the header, and the
sorter, for this ListGrid. |
java.lang.String |
getHeaderButtonAriaRole()
Default
role for header buttons . |
java.util.Map |
getHeaderButtonAriaState()
Default
ARIA state for header buttons . |
Button |
getHeaderButtonProperties()
Properties to apply to all header buttons.
|
Canvas |
getHeaderContextMenu()
The context menu displayed for column headers.
|
protected MenuItem[] |
getHeaderContextMenuItems(java.lang.Integer fieldNum)
If
showHeaderContextMenu is true
this method returns the menu items to be displayed in the default header context menu. |
int |
getHeaderHeight()
The height of this listGrid's header, in pixels.
|
Alignment |
getHeaderHoverAlign()
This property may be set to customize the alignment for the hover shown on
ListGrid.headerHover() . |
java.lang.Integer |
getHeaderHoverHeight()
Optional default height for the hover shown on
ListGrid.headerHover() . |
java.lang.Integer |
getHeaderHoverOpacity()
This property may be set to customize the opacity for the hover shown on
ListGrid.headerHover() . |
java.lang.String |
getHeaderHoverStyle()
This property may be set to customize the css style for the hover shown on
ListGrid.headerHover() . |
VerticalAlignment |
getHeaderHoverVAlign()
This property may be set to customize the vertical alignment for the hover shown on
ListGrid.headerHover() . |
java.lang.Integer |
getHeaderHoverWidth()
Optional default width for the hover shown on
ListGrid.headerHover() . |
java.lang.Boolean |
getHeaderHoverWrap()
This property may be set to customize the
wrap attribute for the hover shown on ListGrid.headerHover() . |
StatefulCanvas |
getHeaderMenuButton()
If
showHeaderMenuButton 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 |
getHeaderMenuButtonHeight()
If
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton |
java.lang.String |
getHeaderMenuButtonHeightAsString()
If
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton |
java.lang.String |
getHeaderMenuButtonIcon()
If
showHeaderMenuButton is true, this property
governs the icon shown on the auto-generated headerMenuButton |
int |
getHeaderMenuButtonIconHeight()
If
showHeaderMenuButton is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton |
int |
getHeaderMenuButtonIconWidth()
If
showHeaderMenuButton is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton |
java.lang.Integer |
getHeaderMenuButtonSnapOffsetLeft()
Offset of the right edge of a
headerMenuButton
from the right edge of it's parent button. |
int |
getHeaderMenuButtonWidth()
If
showHeaderMenuButton is true, this property
governs the width of the auto-generated headerMenuButton |
java.lang.String |
getHeaderRadius()
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 the
header , and to the right
of the corner sort-button if it's visible, or the
right of the header otherwise. |
java.lang.String |
getHeaderShadowColor()
If
showHeaderShadow is true, the Canvas.shadowColor for the header shadow. |
int |
getHeaderShadowHOffset()
If
showHeaderShadow is true, the Canvas.shadowHOffset for the header shadow |
int |
getHeaderShadowSoftness()
If
showHeaderShadow is true, the Canvas.shadowSoftness for the header shadow |
int |
getHeaderShadowVOffset()
If
showHeaderShadow is true, the Canvas.shadowVOffset for the header shadow |
StatefulCanvas |
getHeaderSpan()
Note : 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 a
headerSpan . |
java.lang.Integer |
getHeaderSpanHeight()
Default height for a
headerSpan with no height
specified. |
java.lang.String |
getHeaderTitleStyle()
StretchImgButton.titleStyle to apply to the buttons
in the header, and the sorter, for this ListGrid. |
VerticalAlignment |
getHeaderTitleVAlign()
Specifies vertical alignment in the column headers: "top", "center", or "bottom".
|
java.lang.Boolean |
getHideEmptySummaryRow()
If true, causes the
summaryRow component to be hidden if
it has no data after summaries have been recalculated |
java.lang.String |
getHideFilterEditorTitle()
When
canShowFilterEditor is true, this is the
title for the filterEditor show/hide menu-item, in the headerContextmenu , when the filterEditor is visible. |
java.lang.Boolean |
getHiliteCanReplaceValue()
If set, end users can create advanced hiliting rules that will use the
Hilite.replacementValue feature to cause values in hilited cells to
be replaced with a user-entered value. |
java.lang.String |
getHiliteEditorSpanTitleSeparator()
If this grid has specified
headerSpans , and showHeaderSpanTitlesInHiliteEditor is
true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser
grid. |
boolean |
getHiliteHTMLAfterFormat()
If set to true, custom HTML applied as part of hiliting will be applied after
formatting for each cell. |
java.lang.Integer |
getHiliteIconHeight()
Height for hilite icons for this listGrid.
|
int |
getHiliteIconLeftPadding()
How much padding should there be on the left of
hilite
icons by default? Can be overridden at the field level |
HiliteIconPosition |
getHiliteIconPosition()
When
hiliteIcons are present, where the hilite icon
will be placed relative to the field value. |
int |
getHiliteIconRightPadding()
How much padding should there be on the right of
hilite
icons by default? Can be overridden at the field level |
java.lang.String[] |
getHiliteIcons()
Specifies a list of icons that can be used in
hilites . |
int |
getHiliteIconSize()
Default width and height of
hilite icons for this
component. |
java.lang.Integer |
getHiliteIconWidth()
Width for hilite icons for this component.
|
java.lang.String |
getHiliteProperty()
Marker that can be set on a record to flag that record as hilited.
|
java.lang.String |
getHiliteReplaceValueFieldTitle()
Title used for the text box shown when
hiliteCanReplaceValue is set. |
java.lang.Boolean |
getHiliteRowOnFocus()
When the grid body gets keyboard focus, should we highlight the current focus row, using the rollover cell style?
|
Hilite[] |
getHilites()
Return the set of hilite-objects currently applied to this DataBoundComponent.
|
java.lang.String |
getHiliteState()
Get the current hilites encoded as a String, for saving.
|
AIServiceMode |
getHiliteViaAIMode()
When
canHiliteViaAI is true , the AI
service mode to use. |
java.lang.String |
getHiliteViaAIText()
Title for the menu item displayed in this component's header context menu when
AI-assisted hiliting is allowed. |
HoverMode |
getHoverMode()
When
showHoverComponents is true, the builtin
mode to use when automatically creating a hover component for rows in this grid. |
java.lang.String |
getHoverScreen()
Screen to create (via
createScreen() ) in lieu of calling getHoverComponent() or getCellHoverComponent() . |
java.lang.String |
getHoverStyle()
Style to apply to hovers shown over this grid.
|
Cursor |
getIconCursor()
Default cursor to display when the user rolls over icons within cells of an
type:icon field. |
java.lang.Integer |
getIconPadding()
When using
autoFitFieldWidths , padding in pixels
left on each side of fields that show images. |
int |
getImageSize()
Default size of thumbnails shown for fieldTypes image and imageFile.
|
Criteria |
getImplicitCriteria()
Criteria that are never shown to or edited by the user and are cumulative with any
criteria provided via
DataBoundComponent.initialCriteria ,
DataBoundComponent.setCriteria() etc. |
boolean |
getIncludeHilitesInSummaryFields()
When assembling a value for a
summary field , if
a referenced field is hilited, should the hilite HTML be included in the summary field value? |
java.lang.String |
getIncludeInSummaryProperty()
Property name on a record that will be checked to determine whether a record should be included when calculating totals
for the
grid summary . |
Criteria |
getInitialCriteria()
Criteria to use when
DataBoundComponent.setAutoFetchData(Boolean) is used. |
SortSpecifier[] |
getInitialSort()
An array of
SortSpecifier objects used to set up the initial sort configuration for
this grid. |
java.lang.Boolean |
getInstantScrollTrackRedraw()
If true, if the user clicks on the scroll buttons at the end of the track or clicks once on the scroll track, there will
be an instant redraw of the grid content so that the user doesn't see any blank space.
|
java.lang.String |
getInvalidSummaryValue()
Value to display to the user if showing summary values (through
showGridSummary , showGroupSummary or listGridFieldType:"summary" ), and the summary function returns
"null" (implying it was unable to calculate a valid summary value). |
boolean |
getIsGrouped()
True if this listGrid is grouped, false otherwise
|
java.lang.String |
getIsSeparatorProperty()
If
record[this.isSeparatorProperty] is set for some record, the record will be displayed as a simple
separator row. |
java.lang.String |
getLastCellStyle()
The style to apply to the last cell in each row, when
styledRowEnds is true. |
java.lang.Boolean |
getLeaveScrollbarGap()
Whether to leave a gap for the vertical scrollbar, even when it's not present.
|
java.lang.String |
getLinkTextProperty()
Property name on a record that will hold the link text for that record.
|
RowEndEditAction |
getListEndEditAction()
If the user is editing the last record in this listGrid, and attempts to navigate beyond the last row either by tabbing
off the last editable field, or using the down arrow key, this property determines what action to take: "next":
start editing a new record at the end of the list.
|
java.lang.String |
getLoadingDataMessage()
The string to display in the body of a listGrid while data is being loaded.
|
java.lang.String |
getLoadingDataMessageStyle()
The CSS style name applied to the loadingDataMessage string if displayed.
|
java.lang.String |
getLoadingMessage()
If you have a databound 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 |
getLoadingRowCountDisplayIcoHeight()
Height for the
loadingRowCountDisplayIcon |
java.lang.String |
getLoadingRowCountDisplayIcon()
The URL of the icon to display as a
row count
value when the row count is loading. |
int |
getLoadingRowCountDisplayIconWidth()
Width for the
loadingRowCountDisplayIcon |
java.lang.String |
getLocateColumnsBy()
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the column be identified? Note that getLocator() will actually store all available information about the column in the generated string -- this attribute effects how a stored string will be parsed only. |
java.lang.String |
getLocateRowsBy()
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the row be identified? Note that getLocator() will actually store all available information about the row in the generated string -- this attribute effects how a stored string will be parsed only. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
int |
getLongTextEditorThreshold()
When the length of the field specified by
DataSourceField.length exceeds this value, the ListGrid shows an edit field of type longTextEditorType rather than the standard text field
when the field enters inline edit mode. |
java.lang.String |
getLongTextEditorType()
When the length of the field specified by
DataSourceField.length exceeds this.longTextEditorThreshold show an edit field of this type rather than
the standard text field when the field enters inline edit mode. |
java.lang.Integer |
getMaxExpandedRecords()
When
canExpandRecords and canExpandMultipleRecords are both true, this
property dictates the number of records which can be expanded simultaneously. |
java.lang.String |
getMaxExpandedRecordsPrompt()
This is a dynamic string - text within
${...} will be evaluated as JS code when the message is
displayed. |
java.lang.String |
getMaximumRowCountFormat()
|
java.lang.Integer |
getMaxSummaryRowRecords()
If
showGridSummary is true, and summary records are
being derived from a fetch against the summaryRowDataSource , this property may be set to specify the maximum expected number of results from the fetch
opeeration. |
int |
getMinFieldWidth()
Minimum size, in pixels, for ListGrid headers.
|
int |
getMinHeight()
Sets the
minimum height for the entire list (smaller than this
doesn't tend to work very well). |
int |
getMinimumCellHeight()
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.
|
java.lang.String |
getMinimumRowCountFormat()
|
java.lang.String |
getMissingSummaryFieldValue()
If a summary format string contains an invalid field reference, replace the reference with the missingSummaryFieldValue.
|
java.lang.Boolean |
getModalEditing()
If this property is true, any mouse click outside of the open cell editors will end editing mode, hiding the cell
editors and saving any changes to those cell values.
|
MultiGroupDialog |
getMultiGroupDialogDefaults()
Class-level defaults to apply to the
MultiGroupDialog which gets automatically
generated when configureGrouping() is called. |
MultiGroupDialog |
getMultiGroupDialogProperties()
Properties to apply to the
MultiGroupDialog which gets automatically generated when
configureGrouping() is called. |
java.lang.Boolean |
getNavigateOnTab()
If
canSelectCells is true, this property allows the
user to navigate through the cells of a grid using Tab and Shift+Tab keypresses. |
java.lang.Boolean |
getNeverValidate()
If true, validation will not occur as a result of cell editing for this grid.
|
java.lang.String |
getNewRecordRowMessage()
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.
|
java.lang.String |
getNewSearchText()
Text to show for saving the current view as a new "saved search".
|
java.lang.String |
getNormalBaseStyle()
"Normal" baseStyle for this listGrid.
|
int |
getNormalCellHeight()
If
baseStyle is unset, base style will be derived from
normalBaseStyle if this grid has fixed row heights
and the specified cellHeight matches this value. |
java.lang.String |
getNoSavedSearchesText()
Text to show in menu listing saved searches when there are no saved searches.
|
java.lang.String |
getNullGroupTitle()
Default alias to use for groups with no value
|
java.lang.String |
getOfflineMessageStyle()
The CSS style name applied to the
offlineMessage if displayed. |
FormItemIcon |
getOperatorIcon()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
static ListGrid |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
RecordList |
getOriginalRecordList()
Return the underlying, ungrouped data of this DataBoundComponent as a
RecordList . |
ResultSet |
getOriginalResultSet()
Return the underlying, ungrouped data of this ListGrid as a
ResultSet . |
java.lang.String |
getOriginBaseStyle()
Name of a CSS Style to use as the
baseStyle for a cell
that is currently a selection origin for shifted incremental cell selection. |
Overflow |
getOverflow()
|
java.lang.String |
getPendingAsyncCellValue()
The value to display for cells whose value is pending asynchronous computation.
|
java.lang.String |
getPlaceholderAIHoverContents()
Message to show in the hover while AI-generated hover text is being retrieved for fields specifying an
aiHoverRequest . |
java.lang.Boolean |
getPoolComponentsPerColumn()
Should recycled
record components , be pooled
per column or per record. |
java.lang.Boolean |
getPreserveFocusStylingOnMouseOut()
If
showRollOver or hiliteRowOnFocus is true the current keyboard focus row
for navigation via arrow keys, etc, will be hilighted with "Over" styling. |
java.lang.Boolean |
getPreserveWhitespace()
Should cells be written out with css that will preserve whitespace?
|
java.lang.Boolean |
getPreventDuplicates()
If set, detect and prevent duplicate records from being transferred to this component, either via
drag and drop or via
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent) . |
java.lang.Boolean |
getPrintAutoFit()
Whether cell contents should wrap during printing.
|
java.lang.String |
getPrintBaseStyle()
Style for non-header cells in printed output.
|
java.lang.String |
getPrintBooleanBaseStyle()
If set, the
booleanBaseStyle to use when printing . |
java.lang.String |
getPrintBooleanFalseImage()
If set, the
booleanFalseImage to use when printing . |
java.lang.String |
getPrintBooleanPartialImage()
If set, the
booleanPartialImage to use when
printing . |
java.lang.String |
getPrintBooleanTrueImage()
If set, the
booleanTrueImage to use when printing . |
java.lang.String |
getPrintCheckboxFieldFalseImage()
If set, the
checkboxFieldFalseImage to use
when printing . |
java.lang.String |
getPrintCheckboxFieldPartialImage()
If set, the
checkboxFieldPartialImage to
use when printing . |
java.lang.String |
getPrintCheckboxFieldTrueImage()
If set, the
checkboxFieldTrueImage to use
when printing . |
java.lang.String |
getPrintHeaderStyle()
Style for header cells in printed output.
|
int |
getPrintMaxRows()
Advanced property - when generating printHTML for a large ListGrid, rows are printed in batches in order to avoid
triggering a native "script is running slowly" browser dialog.
|
java.lang.Boolean |
getPrintWrapCells()
Whether cell contents should wrap during printing.
|
java.lang.Boolean |
getProgressiveLoading()
Indicates whether or not this component will load its data
progressively |
float |
getQuickDrawAheadRatio()
Alternative to
drawAheadRatio , to be used when the
user is rapidly changing the grids viewport (for example drag scrolling through the grid). |
java.lang.String |
getRangeRowCountFormat()
|
ListGridRecord |
getRecord(int recordNum)
Return the pointer to a particular record by record number.
|
java.lang.String |
getRecordBaseStyleProperty()
This attribute allows custom base styles to be displayed on a per-record basis.
|
java.lang.String |
getRecordCanRemoveProperty()
If set to false on a record and
canRemoveRecords
is true, removal of that record is disallowed in the UI. |
java.lang.String |
getRecordCanSelectProperty()
If set to false on a record, selection of that record is disallowed.
|
java.lang.String |
getRecordCellRoleProperty()
If this property is set on a record it will designate the WAI ARIA role for cells within this records row
|
Canvas |
getRecordComponent(int rowNum)
Retrieve the
recordComponent currently being
shown at the given coordinates. |
Canvas |
getRecordComponent(int rowNum,
java.lang.Integer colNum)
Retrieve the
recordComponent currently being
shown at the given coordinates. |
java.lang.Integer |
getRecordComponentHeight()
If
showRecordComponents is true, this
attribute may be used to specify a standard height for record components. |
RecordComponentPoolingMode |
getRecordComponentPoolingMode()
The method of
component-pooling to employ for recordComponents . |
EmbeddedPosition |
getRecordComponentPosition()
if
showRecordComponents is true, how should
the component appear within the cell. |
java.lang.String |
getRecordDetailDSProperty()
The name of the ListGridRecord property that specifies the DataSource to use when
listGrid.expansionMode is "related". |
RecordDropAppearance |
getRecordDropAppearance()
If
canAcceptDroppedRecords is true for this
listGrid, this property governs whether the user can drop between, or over records within the grid. |
RecordDropPosition |
getRecordDropPosition()
Returns the
RecordDropPosition for some record drop operation. |
java.lang.String |
getRecordEditProperty()
Property name on a record that should be checked to determine whether the record may be edited.
|
java.lang.String |
getRecordEnabledProperty()
Property name on a record that will be checked to determine whether a record is enabled.
|
int |
getRecordIndex(ListGridRecord record)
Get the index of the provided record.
|
int |
getRecordIndex(Record record)
Get the index of the provided record.
|
RecordList |
getRecordList()
Return the underlying data of this DataBoundComponent as a
RecordList . |
java.lang.String |
getRecordRadius()
When set to any valid CSS border-radius string, allows for rounded records in this grid by having
getCellCSSText() apply a corner-radius to the first and last
cells in each record. |
RecordType[] |
getRecordRadiusTargets()
Array of
RecordTypes that should be rounded when recordRadius is set to a valid CSS border-radius
string. |
java.lang.String |
getRecordRowAriaStateProperty()
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.
|
java.lang.String |
getRecordRowRoleProperty()
If this property is set on a record it will designate the WAI ARIA role for this record's row.
|
ListGridRecord[] |
getRecords()
Returns the current set of records displayed in this grid as an array of ListGridRecord objects.
|
java.lang.String |
getRecordScreen()
Screen to create (via
createScreen() ) in lieu of calling getRecordComponent() . |
java.lang.String |
getRecordShowRollOverProperty()
Name of the property that can be set on a per-record basis to disabled rollover for an individual record when
showRollOver is true. |
java.lang.String |
getRecordSummaryAttributePrefix()
|
java.lang.String |
getRecordSummaryBaseStyle()
If showing any record summary fields (IE: fields of
type:"summary" ),
this attribute specifies a custom base style to apply to cells in the summary field |
DataSource |
getRelatedDataSource(ListGridRecord record)
Returns the
DataSource containing data related to the passed record. |
java.lang.String |
getRemovedCSSText()
Custom CSS text to be applied to records that have been
marked for removal . |
com.google.gwt.core.client.JavaScriptObject |
getRemoveFieldDefaults()
Returns a JavaScriptObject containing default
ListGridField
attributes of remove fields. |
ListGridField |
getRemoveFieldProperties()
Configuration properties for the "remove field" displayed when
canRemoveRecords is enabled. |
java.lang.String |
getRemoveFieldTitle()
The title to use for the
remove field . |
java.lang.String |
getRemoveIcon()
When
canRemoveRecords is enabled, default icon to
show in the auto-generated field that allows removing records. |
int |
getRemoveIconSize()
Default width and height of
remove icons for this
ListGrid. |
java.lang.String |
getRemoveIconStyle()
Custom style to apply to the image in the
removeField displayed in rows when canRemoveRecords is true. |
java.lang.String |
getRemoveOperation()
operationId this component
should use when performing remove operations. |
boolean |
getReselectOnUpdate()
If true, when an update operation occurs on a selected record in a
databound listGrid, ensure the updated record is re-selected
when the operation completes. |
SelectionNotificationType |
getReselectOnUpdateNotifications()
if
reselectOnUpdate is true, this property governs
what selection changed notifications should be triggered when a selected record is edited then automatically reselected
when the edited data is merged into the data set. |
boolean |
getResizeFieldsInRealTime()
If
true , the grid contents are redrawn in real time as fields are resized. |
ResultSet |
getResultSet()
Return the underlying data of this DataBoundComponent as a
ResultSet . |
java.lang.Boolean |
getReverseRTLAlign()
If a page is rendered in
RTL mode , should cell alignments specified ListGridField.cellAlign be reversed (so an
align:"right" field will have content aligned on the left and vice versa)? |
protected Canvas |
getRollOverCanvas(java.lang.Integer rowNum,
java.lang.Integer colNum)
This method is called to retrieve the
rollOverCanvas
when the user moves over a new row or cell if showRollOverCanvas is true, or when the user moves over the selected record if showSelectedRollOverCanvas is true. |
protected Canvas |
getRollUnderCanvas(java.lang.Integer rowNum,
java.lang.Integer colNum)
This method is called to retrieve the
rollUnderCanvas when the user moves over a new row or cell if showing a rollUnder canvas or showing a rollUnder canvas for the selected record . |
int |
getRotatedHeaderMenuButtonHeight()
If
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton over a rotated header button. |
java.lang.String |
getRotatedHeaderMenuButtonHeightAsString()
If
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton over a rotated header button. |
int |
getRotatedHeaderMenuButtonWidth()
If
showHeaderMenuButton is true, this property
governs the width of the auto-generated headerMenuButton over a rotated header button. |
java.lang.Boolean |
getRotateHeaderTitles()
Whether to rotate the field titles so they're rendered vertically from bottom to top.
|
java.util.Map |
getRowAriaState()
Returns a mapping of default WAI ARIA attributes for rows within this listGrid.
|
java.lang.Integer |
getRowCount()
Retrieves the
row count for the grid, which may differ from the
reported data length if progressive loading is enabled. |
java.lang.Integer |
getRowCountDisplayPrecision()
When an exact
row count is not known due to progressive
loading, this attribute allows the formatted row count returned by getFormattedRowCount() and ultimately displayed in the
rowRangeDisplay label to be rounded to a multiple
of the specified value. |
java.lang.Integer[] |
getRowCountRange()
Retrieves the
row count range for listGrids where progressive loading is active and the row count has been
specified as a range . |
RowCountStatus |
getRowCountStatus()
This method indicates whether
getRowCount() reflects an
accurate row-count for this listGrid. |
RowEndEditAction |
getRowEndEditAction()
If the user is editing a record in this listGrid, and attempts to navigate to a field beyond the end of the row, via tab
(or shift-tab off the first editable field), this property determines what action to take: "next": start editing
the next (or previous) record in the list "same": put focus back into the first editable field of the same record.
|
java.util.Map |
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.
|
java.lang.String |
getRowLocatorField()
If
locateRowsBy has been set to "cellValue", this
property may be used to specify which field's cell value to use. |
java.lang.String[] |
getRowLocatorFieldAsStringArray()
If
locateRowsBy has been set to "cellValue", this
property may be used to specify which field's cell value to use. |
int |
getRowNum(ListGridRecord record)
Synonym of
getRecordIndex() . |
ListGridField |
getRowNumberField()
An automatically generated field that displays the current row number when
showRowNumbers is true. |
int |
getRowNumberStart()
The number to start the row-count from - default value is 1.
|
java.lang.String |
getRowNumberStyle()
The CSS Style name for the
rowNumberField . |
int |
getRowPageTop(int rowNum)
Returns the Y-coordinate for a given row number as a page-relative coordinate.
|
RowRangeDisplay |
getRowRangeDisplay()
RowRangeDisplay autoChild, which may be retrieved by calling getRowRangeDisplay() . |
RowRangeDisplayStyle |
getRowRangeDisplayStyle()
How should the
getFormattedRowRange() format the
row range and row count for display to the user? |
java.lang.String |
getRowRangeDisplayValue()
This method will return a row range summary display value containing the currently visible row range and row count for
the data set.
|
java.lang.String |
getRowRangeFormat()
Dynamic String specifying the format for the
visible row range . |
java.lang.String |
getRowRole()
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.
|
RowSpanEditMode |
getRowSpanEditMode()
If
allowRowSpanning is enabled, this property may
be used to specify editing behavior for cells that span multiple rows. |
RowSpanSelectionMode |
getRowSpanSelectionMode()
Chooses the selection mode when
useRowSpanStyling
is enabled. |
int |
getRowTop(int rowNum)
Returns the top coordinate for a given row number, relative to the top of body content.
|
java.lang.Boolean |
getSaveByCell()
Whether edits should be saved whenever the user moves between cells in the current edit row.
|
java.lang.Boolean |
getSaveCriteriaInViewState()
Should the current
filter-criteria be included
along with other details when saving this grid's view-state ? |
boolean |
getSaveDefaultSearch()
Saves the name of the default search to localStorage, under the key "sc_defaultSearch:" + minimal locator.
|
java.lang.String |
getSavedSearchAdminRole()
Override of
SavedSearches.adminRole for this component. |
ListGridRecord |
getSavedSearchAdminSeparator()
Properties for the separator record between locally saved and admin searches.
|
java.lang.String |
getSavedSearchDS()
Override of
SavedSearches.defaultDataSource for this
component. |
java.lang.String |
getSavedSearchId()
Optional identifier for saved searches that should be applied to this component.
|
SavedSearchStoredState |
getSavedSearchStoredState()
Set to "criteria" if you want only criteria to be stored for ListGrids and TreeGrids instead of the full viewState of
the component.
|
java.lang.String |
getSavedSearchText()
Text to show for the saved searches submenu.
|
java.lang.String |
getSavedViewState()
Returns the
view state for this ListGrid as last saved by the autoPersistViewState setting. |
java.lang.Boolean |
getSaveLocally()
For grids with a specified
dataSource , this property can
be set to true to cause the grid directly update its local data set instead of performing an operation
against it's configured DataSource. |
DSRequest |
getSaveRequestProperties()
For editable grids with a specified
dataSource , where
saveLocally is false, this attribute may be used to
specify standard DSRequest properties to apply to all save operations performed by this grid (whether triggered by user
interaction, or explicit saveEdits or saveAllEdits call). |
java.lang.String |
getScreenReaderCellSeparator()
Special cell-separator that may be inserted between cell values when screen-readers are reading the content of a row.
|
java.lang.Boolean |
getScreenReaderIncludeFieldTitles()
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 with
ariaRole:"list" . |
boolean |
getScreenReaderNavigateByCell()
If
screen reader mode is enabled , and canSelectCells 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? |
java.lang.String |
getScreenReaderRowSeparator()
Special row-separator that may be inserted at the end of the row value when screen-readers are reading the content of a
row.
|
java.lang.Boolean |
getScreenReaderWriteRowLabelledBy()
When
screen reader mode is enabled, for grids with ariaRole set to "list" , should a custom aria-labelledby attribute be written out in addition to any other row aria properties to ensure the column titles , screenReaderCellSeparator and screenReaderRowSeparator are read out along with
cell content when reading rows? |
int |
getScrollRedrawDelay()
While drag scrolling in an incrementally rendered grid, time in milliseconds to wait before redrawing, after the last
mouse movement by the user.
|
Alignment |
getScrollToCellXPosition()
When scrollToCell is called, this is used as defaults if xPosition weren't explicitly passed into the method.
|
VerticalAlignment |
getScrollToCellYPosition()
When scrollToCell is called, this is used as defaults if yPosition weren't explicitly passed into the method.
|
java.lang.Integer |
getScrollWheelRedrawDelay()
While scrolling an incrementally rendered grid, using the mouseWheel, time in milliseconds to wait before redrawing,
after the last mouseWheel movement by the user.
|
DynamicForm |
getSearchForm()
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 the FilterEditor or Filter Window . |
ValuesManager |
getSearchFormAsValuesManager()
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 the FilterEditor or Filter Window . |
java.lang.Boolean |
getSelectCellTextOnClick()
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.
|
RecordList |
getSelectedCellData()
Returns the selected cells as a series of Records where each field value is stored under it's offset from the top-left
of the selection.
|
ListGridRecord |
getSelectedRecord()
Returns the first selected record in this grid.
|
ListGridRecord[] |
getSelectedRecords()
Returns all selected records in this grid.
|
ListGridRecord[] |
getSelectedRecords(boolean excludePartialSelections)
Returns all selected records in this grid.
|
java.lang.String |
getSelectedState()
Returns a snapshot of the current selection within this listGrid as a
ListGridSelectedState object.This object can be passed to setSelectedState() to reset this grid's selection the
current state (assuming the same data is present in the grid). |
java.lang.Boolean |
getSelectHeaderOnSort()
If true, show the field-header for the sorted field (or the first field in a
multi-sort grid) in the selected state. |
ListGridRecord[] |
getSelection()
Deprecated.
use
getSelectedRecords() instead |
ListGridRecord[] |
getSelection(boolean excludePartialSelections)
Deprecated.
use
getSelectedRecords(boolean) instead |
SelectionAppearance |
getSelectionAppearance()
How selection of rows should be presented to the user.
|
java.lang.String |
getSelectionProperty()
If specified, the selection object for this list will use this property to mark records as selected.
|
SelectionStyle |
getSelectionType()
Defines a listGrid's clickable-selection behavior.
|
java.lang.Boolean |
getSelectOnEdit()
When the user starts editing a row, should the row also be selected?
|
boolean |
getSelectOnExpandRecord()
When set to false, clicking a record's
expansion
field will not add the record to the current selection. |
java.lang.String |
getSeparatorRowStyle()
CSS class to apply to rows marked as
separators
in this grid. |
java.lang.Boolean |
getShowAllColumns()
Whether all columns should be drawn all at once, or only columns visible in the viewport.
|
java.lang.Boolean |
getShowAllRecords()
Whether all records should be drawn all at once, or only records visible in the viewport.
|
java.lang.Boolean |
getShowAsynchGroupingPrompt()
If set to false, do not show the
asynchGroupingPrompt dialog during asynchronous grouping . |
java.lang.Boolean |
getShowBackgroundComponents()
If
true this grid will create and show per-row backgroundComponents as detailed here . |
java.lang.Boolean |
getShowCellContextMenus()
Whether to show a context menu with standard items for all context clicks on rows in the body.
|
boolean |
getShowClippedHeaderTitlesOnHover()
If true and a header button's title is clipped, then a hover containing the full field title is enabled.
|
java.lang.Boolean |
getShowClippedValuesOnHover()
If true and a cell's value is clipped, then a hover containing the full cell value is enabled.
|
java.lang.Boolean |
getShowCollapsedGroupSummary()
Should group summaries be visible when the group is collapsed?
|
java.lang.Boolean |
getShowComplexFields()
Whether to show fields of non-atomic types when a DataBoundComponent is given a
DataSource but no
component.fields .
|
java.lang.Boolean |
getShowDetailFields()
Whether to include fields marked
detail:true from this component's DataSource . |
java.lang.Boolean |
getShowDropLines()
Controls whether to show a drop-indicator during a drag and drop operation.
|
boolean |
getShowEllipsisWhenClipped()
Should ellipses be displayed when cell content is clipped? May be overridden at the field level via
ListGridField.showEllipsisWhenClipped |
java.lang.Boolean |
getShowEmptyMessage()
Indicates whether the text of the emptyMessage property should be displayed if no data is available.
|
boolean |
getShowErrorIcons()
If this grid is editable, and an edit has caused validation failure for some cell, should we show an icon to indicate
validation failure?
|
java.lang.Boolean |
getShowExpansionEditorSaveButton()
When
ExpansionMode is editor, should a Save button be shown below the the
expanded editor? |
boolean |
getShowFilterEditor()
Should this listGrid display a filter row.
|
java.lang.Boolean |
getShowFilterEditorHovers()
When set to false, no hover is shown for the filter editor fields.
|
java.lang.String |
getShowFilterEditorTitle()
When
canShowFilterEditor is true, this is the
title for the filterEditor show/hide menu-item, in the headerContextmenu , when the filterEditor is hidden. |
java.lang.Boolean |
getShowFilterWindowCriteriaIndicator()
Should an indicator be shown to indicate that
filterWindowCriteria is configured? The indicator is a small triangle shown in the top-right of the grid header or
filter. |
java.lang.Boolean |
getShowGridSummary()
Should this ListGrid show a summary row beneath the last record of the grid.
|
java.lang.Boolean |
getShowGroupSummary()
If this listGrid supports
grouping , setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields. |
java.lang.Boolean |
getShowGroupSummaryInHeader()
If this grid is
grouped , and showGroupSummary is true, setting this property causes
field summary values for each group to be displayed directly in the group header node, rather than showing up at the
bottom of each expanded group. |
java.lang.Boolean |
getShowGroupTitleColumn()
If this grid is
grouped and showGroupSummaryInHeader is true, instead of
group header nodes showing up with a single cell value spanning the full set of columns, summaries for each field will
show up in the appropriate columns of the header node. |
boolean |
getShowGroupTitleInFrozenBody()
If this is
grouped and has frozen fields , should the group title show in the frozen or unfrozen body? |
java.lang.Boolean |
getShowHeader()
Should we show the header for this ListGrid?
|
java.lang.Boolean |
getShowHeaderContextMenu()
Whether to show a context menu on the header with standard items for showing and hiding fields.
|
java.lang.Boolean |
getShowHeaderMenuButton()
If set to true and
showHeaderContextMenu is
true, the headerMenuButton will be displayed when
the user rolls over the header buttons in this grid. |
java.lang.Boolean |
getShowHeaderPartialSelection()
Should partial selection of all records be shown in header with a special icon? The partial icon will show in the header
when
canSelectAll is enabled and at least one record
is selected but all records are not selected. |
java.lang.Boolean |
getShowHeaderShadow()
Should the header show a drop-shadow? Shadow will be applied to the header, or for a grid with frozen columns, the
header layout.
|
java.lang.Boolean |
getShowHeaderSpanContextMenu()
Whether to show a context menu on the header span with standard items for showing and hiding fields.
|
java.lang.Boolean |
getShowHeaderSpanTitlesInFormulaBuilder()
If this grid has specified
headerSpans , should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or
SummaryBuilder. |
java.lang.Boolean |
getShowHeaderSpanTitlesInHiliteEditor()
If this grid has specified
headerSpans , should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the hilite editor . |
java.lang.Boolean |
getShowHeaderSpanTitlesInSortEditor()
If this grid has specified
headerSpans , should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor . |
java.lang.Boolean |
getShowHiddenFields()
Whether to show fields marked
hidden:true when a DataBoundComponent is given a
DataSource but no component.fields .
|
boolean |
getShowHilitesInGroupSummary()
Determines whether hiliting for any field in this grid is shown in a group summary.
|
java.lang.Boolean |
getShowHover()
If true, and
canHover is also true, shows popup hover text
next to the mouse when the user hovers over a cell. |
java.lang.Boolean |
getShowHoverComponents()
When set to true and canHover is also true, shows a widget hovering at the mouse point.
|
boolean |
getShowHoverOnDisabledCells()
If
showHover is true, should cell hover HTML be displayed
on disabled cells? |
java.lang.Boolean |
getShowInitialDragHandles()
When set to true, shows the
drag handle field on
initial draw. |
java.lang.Boolean |
getShowNewRecordRow()
If this is an editable ListGrid, setting this property to true causes an extra row with the
newRecordRowMessage to be displayed below the last
record. |
java.lang.Boolean |
getShowPartialSelection()
Should partially selected parents (in a Tree data set) be shown with special icon? This has an impact in grouped grids
where
canSelectGroups is true. |
java.lang.Boolean |
getShowRecordComponents()
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. |
java.lang.Boolean |
getShowRecordComponentsByCell()
If true, shows
recordComponents in cells,
rather than just in records. |
java.lang.Boolean |
getShowRollOver()
Should we show different styling for the cell the mouse is over?
|
java.lang.Boolean |
getShowRollOverCanvas()
When enabled, when the mouse moves over a row or cell (depending on
useCellRollOvers ), an arbitrary Canvas can be shown
layered on top of the row or cell (the rollOverCanvas ), layered underneath the row or cell (the rollUnderCanvas ), or both. |
java.lang.Boolean |
getShowRollOverInExpansion()
This setting causes the
roll over canvas to be sized
to cover the normal row and the expansion layout. |
java.lang.Boolean |
getShowRollUnderCanvas()
If roll overs are enabled, should the
rollUnderCanvas be displayed? |
java.lang.Boolean |
getShowRowNumbers()
When set to true, shows an additional field at the beginning of the field-list (respecting RTL) that displays the
current rowNum for each record.
|
boolean |
getShowSavedSearchesByDS()
Whether to associate saved searches by default with the current
DataSource
of a component when a
savedSearchId is
not provided. |
java.lang.Boolean |
getShowSelectedRollOverCanvas()
This setting causes the
roll over canvas to be
displayed when the user rolls over selected records in the grid (but not when rolling over other records). |
java.lang.Boolean |
getShowSelectedRollUnderCanvas()
This setting causes the
roll under canvas to be
displayed when the user rolls over selected records in the grid (but not when rolling over other records). |
java.lang.Boolean |
getShowSelectedStyle()
Should the "Selected" style be applied to selected records?
|
java.lang.Boolean |
getShowSelectionCanvas()
If
selectionType is set to SelectionStyle.SINGLE , setting this property to true means selection will be
displayed to the user with the selectionCanvas
and/or selectionUnderCanvas rather than with
CSS styling. |
java.lang.Boolean |
getShowSelectionUnderCanvas()
If
selectionType is set to SelectionStyle.SINGLE , and either showSelectionCanvas is true and
showSelectionUnderCanvas is unset, or showSelectionUnderCanvas is explicitly set to
true , then selection will be displayed to the user with the selectionCanvas and/or selectionUnderCanvas rather than with CSS styling. |
SortArrow |
getShowSortArrow()
Indicates whether a sorting arrow should appear for the listGrid, and its location.
|
java.lang.Boolean |
getShowSortNumerals()
When multiple fields are sorted, set this to false to hide the sort-numeral displayed by default after the sort-arrows
in the header-buttons of sorted fields.
|
java.lang.Boolean |
getShowTreeColumnPicker()
When
headerSpans are in use, whether to show a
hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under
headerSpans similarly to how a TreeGrid displays a Tree. |
java.lang.Boolean |
getShrinkForFreeze()
If this list grid is showing any
frozen fields, and a
horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible
below the frozen columns?Note that if set to true any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s). |
java.lang.String |
getSingleCellValueProperty()
If
record[this.singleCellValueProperty] is set for some record, the record will be displayed as a single
cell spanning every column in the grid, with contents set to the value of
record[this.singleCellValueProperty] . |
java.lang.String |
getSkinImgDir()
Where do 'skin' images (those provided with the class) live?
|
java.lang.Boolean |
getSkipLineBreaks()
Whether to skip line breaks for all fields by default when
escaping HTML . |
SortSpecifier[] |
getSort()
Returns the current
SortSpecifiers for this ListGrid. |
int |
getSortArrowMenuButtonSpaceOffset()
When
leaveHeaderMenuButtonSpace is true,
configures the amount of space beyond the headerMenuButtonWidth on the right side of a ListGrid header button (left for RTL mode ) to reserve for the sort arrow if sorting is active for that field and the
arrow will be shown. |
java.lang.String |
getSortAscendingImage()
Image to show when sorted in ascending order.
|
ImgHTMLProperties |
getSortAscendingImageAsImgHTMLProperties()
Image to show when sorted in ascending order.
|
boolean |
getSortBinaryByFileName()
For any fields of
type "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 the BinaryFields overview. |
java.lang.Boolean |
getSortByGroupFirst()
If set, whenever grouping is performed by an end user or by a programmatic call to
groupBy() , data is implicitly sorted by all of the grouped columns,
in the order they were passed to groupBy. |
java.lang.String |
getSortDescendingImage()
Image to show when sorted in descending order.
|
ImgHTMLProperties |
getSortDescendingImageAsImgHTMLProperties()
Image to show when sorted in descending order.
|
SortDirection |
getSortDirection()
Sorting direction of this ListGrid.
|
java.lang.String |
getSortEditorSpanTitleSeparator()
If this grid has specified
headerSpans , and showHeaderSpanTitlesInSortEditor is true,
this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid on the multi-sort editor |
java.lang.String |
getSorterButtonTitle()
The title for the corner sort button.
|
java.lang.String |
getSortField()
Specifies the field by which this grid should be initially sorted.
|
java.lang.String |
getSortFieldAscendingText()
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in ascending order. |
int |
getSortFieldCount()
Returns the number of fields involved in this grid's current sort configuration.
|
java.lang.String |
getSortFieldDescendingText()
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in descending order. |
java.lang.String |
getSortNumeralHTML(java.lang.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 |
getSortNumeralMenuButtonSpaceOffset()
When
leaveHeaderMenuButtonSpace is true,
configures the amount of space beyond the headerMenuButtonWidth on the right side of a ListGrid header button (left for RTL mode ) to reserve for the sort numeral if multi-sorting is active for that field and the numeral will
be shown. |
java.lang.String |
getSortNumeralStyle()
When multiple fields are sorted, the Style to apply to the numeral that appears after the sort-arrows in the
header-buttons of sorted fields.
|
SortSpecifier |
getSortSpecifier(java.lang.String fieldName)
Returns the
SortSpecifier for the passed fieldName, or null if the field is not sorted. |
java.lang.String |
getSortState()
Initial sort state for the grid.
|
Layout |
getSpanContextMenu()
The menu displayed when a cell is right clicked on.
|
java.lang.String |
getSpannedHeaderBaseStyle()
Button.baseStyle to apply to the field header buttons for this
ListGrid when showing header spans. |
java.lang.Boolean |
getSparseFieldState()
If true,
getFieldState() and
setFieldState(java.lang.String) will omit state
information for hidden fields by default. |
java.lang.Boolean |
getStopOnErrors()
If this is an editable listGrid, this property determines how failure to save due to validation errors should be
displayed to the user.
|
java.lang.Boolean |
getStyledRowEnds()
When set to true, the first and last cells in each row will be styled with an additional CSS class, via the
firstCellStyle and lastCellStyle attributes. |
java.lang.String |
getStyleName()
Default CSS class for the ListGrid as a whole.
|
java.lang.String |
getSummaryFieldValue(ListGridField field,
Record record)
Get the computed value of a
summary field . |
ListGrid |
getSummaryRow()
Automatically generated ListGrid for displaying grid summary information (see
showGridSummary ). |
Criteria |
getSummaryRowCriteria()
If
showGridSummary is true, and a summaryRowDataSource is specified this property may
be used to specify fetch criteria to apply when retrieving summary data to show in the summary row. |
DataSource |
getSummaryRowDataSource()
If
showGridSummary is true, by default summary
values are calculated on the client based on the current data-set for the grid (see getGridSummary() and getGridSummaryFunction() ). |
DSRequest |
getSummaryRowFetchRequestProperties()
If
showGridSummary is true, and a summaryRowDataSource is specified this property may
be used to customize the fetch request used when retrieving summary data to show in the summary row. |
int |
getSummaryRowHeight()
Default height for the
summary row autoChild . |
java.lang.String |
getSummaryRowStyle()
baseStyle for the summaryRow |
java.lang.String |
getTableRowStyle()
The style to apply to <TR> tags in this grid's table.
|
java.lang.String |
getTallBaseStyle()
"Tall" baseStyle for this listGrid.
|
protected ListGrid |
getTestInstance() |
java.lang.String |
getTitleField()
Method to return the fieldName which represents the "title" for records in this
Component.
If this.titleField is explicitly specified it will always be used. Otherwise, default implementation will check titleField for databound
components.For non databound components returns the first defined field name of "title" ,
"name" , or "id" . |
java.lang.String |
getTitleFieldValue(Record record)
Get the value of the titleField for the passed record
|
java.lang.String |
getToggleFreezeText(ListGridField field)
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to toggle whether a field is frozen or unfrozen. |
int |
getTotalRows()
Return the total number of rows in the grid.
|
java.lang.Integer |
getTouchScrollRedrawDelay()
While scrolling an incrementally rendered grid, using the inertial scrolling, time in milliseconds to wait before
redrawing, after the last touchScroll by the user.
|
java.lang.String |
getTrackerImage()
Default image to use for the dragTracker when things are dragged within or out of this list.
|
ImgHTMLProperties |
getTrackerImageAsImgHTMLProperties()
Default image to use for the dragTracker when things are dragged within or out of this list.
|
java.lang.String |
getUnfreezeFieldText()
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to unfreeze a currently frozen field. |
java.lang.String |
getUngroupText()
If we're showing a
headerContextMenu for this
grid, and this.isGrouped is true, this attribute will be
shown as the title for the menu item to ungroup the grid. |
java.lang.String |
getUnknownRowCountDisplayValue()
Value to return from
getFormattedRowCount() when
the row count is unknown |
java.lang.String |
getUnremoveIcon()
When
canRemoveRecords is enabled, this icon will
be shown in the auto generated field fro removing records if the record has been marked as removed via markRecordRemoved() . |
java.lang.String |
getUpdateOperation()
operationId this component
should use when performing update operations. |
boolean |
getUpdateSummariesDuringEditing()
Should the
summary row or group summaries be updated during editing of grid
records? This can be set false to improve performance when a large number of ListGridFields or DataSourceFields are present for the grid. |
java.lang.Boolean |
getUseAdvancedCriteria()
Should the
filter-editor in this grid always
produce AdvancedCriteria ? |
java.lang.Boolean |
getUseAdvancedFieldPicker()
If set to true, an advanced field picker based on the
FieldPicker will be shown
instead of the column picker submenu if there are more fields in the grid than advancedFieldPickerThreshold . |
java.lang.Boolean |
getUseAllDataSourceFields()
If true, the set of fields given by the "default binding" (see
fields ) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
|
java.lang.Boolean |
getUseCellRollOvers()
Are rollovers cell-level or row-level?
|
java.lang.Boolean |
getUseClientFiltering()
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.
|
java.lang.Boolean |
getUseCopyPasteShortcuts()
For ListGrids with
canSelectCells:true , enabling
this property will cause the listGrid to intercept standard browser copy/paste shortcut keys and perform the following
behavior. |
java.lang.Boolean |
getUseFlatFields()
The
useFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding. |
boolean |
getUseMultiSelectForFilterValueMaps()
If
showFilterEditor is true, when creating a
SelectItem for editing criteria for a field with a ValueMap, should the SelectItem default to multiple:true ? |
java.lang.String |
getUserCriteriaState()
Returns a snapshot of the current user-provided criteria for this ListGrid.
|
java.lang.Boolean |
getUseRemoteValidators()
If
saveLocally is specified, but this grid is bound to
a DataSource which includes remote field validators, by default edits will be saved synchronously and these validators
will not be executed.Set this property to true to ensure these remote validators are called when
saving edits in saveLocally mode. |
java.lang.Boolean |
getUseRowSpanStyling()
Enables various styling behaviors that potentially make sense when
getRowSpan() has been overridden to introduce spanning cells, and
spanning is largest on the left and smaller as cells go to the right. |
java.lang.Boolean |
getValidateByCell()
Whether client-side validation checks should be performed when the user moves between cells in the current edit row.
|
java.lang.Boolean |
getValidateOnChange()
If true, validation will be performed on each edited cell when each editor's "change" handler is fired.
|
java.lang.String |
getValueIcon(ListGridField field,
java.lang.Object value,
ListGridRecord record)
Returns the appropriate valueIcon for a cell based on the field and the data value for the cell.
|
Cursor |
getValueIconCursor(ListGridField field,
ListGridRecord record,
java.lang.Object value)
Returns the cursor to display when the mouse pointer is over a
valueIcon in a a cell. |
java.lang.Integer |
getValueIconHeight()
Height for value icons for this listGrid.
|
int |
getValueIconLeftPadding()
How much padding should there be on the left of valueIcons by default Can be overridden at the field level
|
int |
getValueIconRightPadding()
How much padding should there be on the right of valueIcons by default
|
int |
getValueIconSize()
Default width and height of value icons for this ListGrid.
|
java.lang.Integer |
getValueIconWidth()
Width for value icons for this listGrid.
|
java.lang.String |
getViewState()
Initial view state may be provided for the listGrid at init time.
|
java.lang.Boolean |
getVirtualScrolling()
When incremental rendering is switched on and there are variable record heights, the virtual scrolling mechanism manages
the differences in scroll height calculations due to the unknown sizes of un-rendered rows to make the scrollbar and
viewport appear correctly.
|
java.lang.Integer[] |
getVisibleRows()
Get the rows that are currently visible in the viewport, as an array of [firstRowNum, lastRowNum].
|
java.lang.Boolean |
getWaitForSave()
If this is an editable listGrid, this property determines whether the user will be able to dismiss the edit form, or
navigate to another cell while the save is in process (before the asynchronous server response returns).
|
java.lang.Boolean |
getWarnOnRemoval()
If
canRemoveRecords is true, when the user clicks
the remove icon for some record, should we show a warning message (defined as warnOnRemovalMessage ) and allow the user to cancel
removal? |
java.lang.String |
getWarnOnRemovalMessage()
Warning message to show the user on a click on the 'remove' icon if
canRemoveRecords is true and warnOnRemoval is true. |
java.lang.Boolean |
getWarnOnUnmappedValueFieldChange()
If a field has
ListGridField.displayField
specified and has no ListGridField.optionDataSource , this field will display the value from the displayField of each record by
default (for more on this behavior see ListGridField.optionDataSource ). |
java.lang.Boolean |
getWrapCells()
Should content within cells be allowed to wrap?
|
java.lang.Boolean |
getWrapHeaderSpanTitles()
If
HeaderSpan.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. |
java.lang.Boolean |
getWrapHeaderTitles()
If
ListGridField.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 |
groupBy(java.lang.String... fields)
Display the current set of records grouped by their values for the given field or fields.
|
java.lang.Object |
groupSortNormalizer(ListGridRecord record,
java.lang.String fieldName,
ListGrid context)
When
sortByGroupFirst is active, the sorting
normalizer applied for implicit sorting by the field(s)
used for grouping. |
java.lang.Boolean |
hasChanges()
Whether the grid as a whole has any unsaved edits, in any row.
|
java.lang.Boolean |
hasChanges(java.lang.Boolean ignorePendingValues)
Whether the grid as a whole has any unsaved edits, in any row.
|
java.lang.Boolean |
hasErrors()
Does this grid currently have errors associated with editValues for any row in the grid.
|
java.lang.String |
headerHoverHTML(int fieldNum,
java.lang.String defaultHTML)
Returns the HTML that is displayed by the default
headerHover handler. |
boolean |
headerTitleClipped(int fieldNum)
Is the field title for the specified field clipped?
|
void |
hideDragHandles()
Hides the
drag handle field , if currently shown. |
void |
hideField(java.lang.String field)
Force a field to be hidden.
NOTE: If a field.showIf expression exists, it will be destroyed. |
void |
hideField(java.lang.String field,
boolean suppressRelayout)
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(java.lang.String... fields)
Force an array of fields to be hidden.
|
void |
hideFields(java.lang.String[] fields,
boolean suppressRelayout)
Force an array of fields to be hidden.
|
void |
invalidateCache()
Invalidate the current data cache for this databound component via a call to the dataset's
invalidateCache() method, for example,
ResultSet.invalidateCache() . |
void |
invalidateRecordComponents()
Invalidates the currently visible set of
recordComponents and gets fresh ones for the visible rows in the grid according to the recordComponentPoolingMode |
java.lang.Boolean |
isCheckboxField(ListGridField field)
Identifies whether the passed-in field is the specially generated
checkboxField used when SelectionAppearance is "checkbox". |
java.lang.Boolean |
isExpanded(ListGridRecord record)
Whether a given
record is expanded or collapsed. |
java.lang.Boolean |
isExpansionField(ListGridField field)
Identifies whether the passed-in field is the specially generated
expansionField used when canExpandRecords is true. |
boolean |
isExportingClientData()
Returns true if this component is currently
exporting
client data . |
boolean |
isGrouped()
Return true if the ListGrid is grouped on a field.
|
boolean |
isGroupNode(ListGridRecord record)
If this listGrid is
grouped , is the record passed in a group
header node. |
java.lang.Boolean |
isPartiallySelected(ListGridRecord record)
When using tree-oriented selection modes like
TreeGrid.cascadeSelection , returns true if the record is considered partially selected because only some of it's
children are selected. |
java.lang.Boolean |
isRowNumberField(ListGridField field)
Identifies whether the passed-in field is the specially generated
rowNumberField used when showRowNumbers is true. |
java.lang.Boolean |
isSelected(ListGridRecord record)
Returns true if the record is selected.
|
java.lang.Boolean |
isSortField(java.lang.String fieldName)
Returns
true 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.
|
java.lang.Boolean |
loadAllRecords()
Loads all records that match this grid's current filter-criteria, optionally firing a callback when the data arrives.
|
java.lang.Boolean |
loadAllRecords(java.lang.Integer maxRecords) |
java.lang.Boolean |
loadAllRecords(java.lang.Integer maxRecords,
DSCallback callback)
Loads all records that match this grid's current filter-criteria, optionally firing a callback when the data arrives.
|
void |
markForRedraw()
Marks the widget as "dirty" so that it will be added to a queue for redraw.
|
void |
markForRedraw(java.lang.String reason)
Marks the widget as "dirty" so that it will be added to a queue for redraw.
|
void |
markRecordRemoved(int rowNum)
Marks a record deleted such that a later call to
saveEdits()
or saveAllEdits() will cause a "remove" DSRequest to be submitted. |
void |
markRecordsRemoved(int records)
Marks an array of records deleted such that a later call to
saveEdits() or saveAllEdits() will cause a "remove"
DSRequest to be submitted. |
void |
markRecordsRemoved(ListGridRecord... records)
Marks an array of records deleted such that a later call to
saveEdits() or saveAllEdits() will cause a "remove"
DSRequest to be submitted. |
void |
markRecordsRemoved(RecordList records)
Marks an array of records deleted such that a later call to
saveEdits() or saveAllEdits() will cause a "remove"
DSRequest to be submitted. |
void |
markSelectionRemoved()
Marks the currently selected records as removed, as though
markRecordRemoved() had been called. |
protected void |
onInit_ListGrid() |
protected void |
onInit() |
boolean |
openGroup(Record record)
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 |
preloadImages()
Preload primary ListGrid skin images.
|
void |
recalculateGridSummary()
Refresh the
grid summary , by either re-calculating
from already-loaded data or doing a new fetch from the summaryRowDataSource . |
void |
recalculateSummaries()
Recalculates values for fields with
summary-functions or user formulae defined and
for values displayed in the grid summary and group summary rows . |
void |
recalculateSummaries(Record... records) |
void |
recalculateSummaries(Record[] records,
ListGridField... fields)
Recalculates values for fields with
summary-functions or user formulae defined and
for values displayed in the grid summary and group summary rows . |
java.lang.Boolean |
recordClick(ListGrid viewer,
ListGridRecord record,
int recordNum,
ListGridField field,
int fieldNum,
java.lang.Object value,
java.lang.Object rawValue,
ListGridRecord editedRecord)
Executed when the listGrid receives a 'click' event on an enabled, non-separator record.
|
java.lang.Boolean |
recordMarkedAsRemoved(int rowNum)
Returns true if the specified record is marked as removed via a call to
markRecordRemoved() |
void |
redrawHeader(boolean rightNow)
Redraw just the
grid 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 |
refreshData()
Unlike
invalidateCache 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)
Unlike
invalidateCache this will perform an
asynchronous (background) refresh of this component's data and then call the provided callback method on completion. |
void |
refreshFields()
Re-evaluates
ListGridField.showIf() for each field,
dynamically showing and hiding the appropriate set of fields |
void |
refreshRecordComponent(int rowNum)
Discards any
recordComponent currently
assigned to the specified record (or cell) and gets a fresh one, according to the recordComponentPoolingMode |
void |
refreshRecordComponent(int rowNum,
java.lang.Integer colNum)
Discards any
recordComponent currently
assigned to the specified record (or cell) and gets a fresh one, according to the recordComponentPoolingMode |
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 |
removeEmbeddedComponent(ListGridRecord record)
Removes an embedded component previously associated with the provided record.
|
void |
removeEmbeddedComponent(ListGridRecord record,
java.lang.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 if
canRemoveRecords is true. |
void |
removeSelectedData()
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 field
|
void |
reorderFields(int start,
int end,
int moveDelta)
Reorder a set of adjacent fields, from start to end exclusive at the end, by distance moveDelta.
NOTE: start and end coordinates are in terms of the currently visible fields, not the full set of fields. |
void |
resizeField(int fieldNum,
int newWidth)
Resize a particular field to a new width.
|
void |
resort()
If a list has become unsorted due to data modification or a call to
unsort() , this method will resort the list by the previous sort-specifier array, if there is one, or by the previous sort-field
and -direction. |
void |
rowClick(ListGridRecord record,
int recordNum,
int fieldNum)
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.
|
java.lang.Boolean |
rowHasChanges(int rowNum)
If this listGrid can be edited, this method will return true if the row passed in has been edited, but the edits have
not yet been saved to the ListGrid's data object.
|
java.lang.Boolean |
rowHasChanges(int rowNum,
java.lang.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.
|
java.lang.Boolean |
rowHasErrors(int rowNum)
Does the specified row have unresolved errors?
|
boolean |
saveAllEdits()
Save a number of outstanding edits for this ListGrid.
|
boolean |
saveAllEdits(Function callback)
Save a number of outstanding edits for this ListGrid.
|
boolean |
saveAllEdits(Function callback,
int[] rows)
Save a number of outstanding edits for this ListGrid.
|
void |
saveEdits()
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,
java.lang.String callback) |
void |
saveEdits(EditCompletionEvent editCompletionEvent,
java.lang.String callback,
int rowNum)
Validates and saves edits within the row currently being edited (or another row with unsaved edits, if indicated).
|
void |
scrollBodyTo(java.lang.Integer left,
java.lang.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 |
selectAllRecords()
Select all records
|
void |
selectRange(int startRow,
int endRow)
Select a contiguous range of records by index
|
void |
selectRange(int startRow,
int endRow,
boolean newState)
Select a contiguous range of records by index
|
void |
selectRecord(int record)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecord(int record,
boolean newState)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecord(Record record)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecord(Record record,
boolean newState)
Select/deselect a
Record passed in explicitly, or by index. |
void |
selectRecords(int[] records)
Select/deselect a list of
Record s passed in explicitly, or by index. |
void |
selectRecords(int[] records,
boolean newState)
Select/deselect a list of
Record s passed in explicitly, or by index. |
void |
selectRecords(Record[] records)
Select/deselect a list of
Record s passed in explicitly, or by index. |
void |
selectRecords(Record[] records,
boolean newState)
Select/deselect a list of
Record s passed in explicitly, or by index. |
void |
selectSingleRecord(int rowNum)
Select a single
Record passed in explicitly, or by index, and deselect everything else. |
void |
selectSingleRecord(Record record)
Select a single
Record passed in explicitly, or by index, and deselect everything else. |
ListGrid |
setAddDropValues(java.lang.Boolean addDropValues)
Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to
different DataSources that are related via a foreign key.
|
ListGrid |
setAddFormulaFieldText(java.lang.String addFormulaFieldText)
Text for a menu item allowing users to add a formula field
|
ListGrid |
setAddOperation(java.lang.String addOperation)
operationId this component
should use when performing add operations. |
ListGrid |
setAddSummaryFieldText(java.lang.String addSummaryFieldText)
Text for a menu item allowing users to add a formula field
|
ListGrid |
setAdvancedFieldPickerThreshold(int advancedFieldPickerThreshold)
When
useAdvancedFieldPicker 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. |
ListGrid |
setAdvancedFilteringText(java.lang.String advancedFilteringText)
If we're showing a
headerContextMenu for this
grid, and a filter-editor is visible and allowFilterWindow is enabled, this attribute will be
shown as the menu item title to configure advanced filtering. |
ListGrid |
setAiFilterWindowHint(java.lang.String aiFilterWindowHint)
The inline hint-text displayed in the user-entry area in the
aiFilterWindow . |
ListGrid |
setAiFilterWindowInstructions(java.lang.String aiFilterWindowInstructions)
The descriptive text displayed above the user-entry area in the
aiFilterWindow . |
ListGrid |
setAiFilterWindowTitle(java.lang.String aiFilterWindowTitle)
The title for the
AI-driven filter window . |
ListGrid |
setAiHoverContentsPrefix(java.lang.String aiHoverContentsPrefix)
Optional prefix for the AI-generated hover text displayed when hovering over fields specifying an
aiHoverRequest . |
ListGrid |
setAiHoverRetryDelay(java.lang.Integer aiHoverRetryDelay)
Minimum number of milliseconds to wait before retrying to generate hover contents via AI.
|
ListGrid |
setAiSortFieldMaxRecordsMessage(java.lang.String aiSortFieldMaxRecordsMessage)
The message to show when a user asks the AI to sort more than the
maximum allowed records . |
ListGrid |
setAllowFilterExpressions(java.lang.Boolean allowFilterExpressions)
For use with
showFilterEditor :true, allows simple
search expressions to be entered into filter fields, as though DynamicForm.allowExpressions were true. |
ListGrid |
setAllowFilterOperators(java.lang.Boolean allowFilterOperators)
Causes a menu item titled
"Filter using" to appear
in the headerContextMenu that allows the end
user to pick an advanced search operator to use for this field. |
ListGrid |
setAllowFilterWindow(java.lang.Boolean allowFilterWindow)
Adds the ability for a user to define additional criteria above and beyond those expressed in the
filter editor via a FilterBuilder which appears in a modal Window over the grid and can be accessed by
various menus within the grid or triggered by external controls. |
ListGrid |
setAllowRowSpanning(java.lang.Boolean allowRowSpanning)
Should cells in this grid be allowed to span multiple rows? If set to
true , the getRowSpan() method will be called for every cell when rendering
out the listGrid to determine how many rows the cell should span. |
ListGrid |
setAlternateBodyStyleName(java.lang.String alternateBodyStyleName)
Optional css style to apply to the body if
alternateRecordStyles is true for this grid. |
ListGrid |
setAlternateFieldFrequency(int alternateFieldFrequency)
The number of consecutive columns to draw in the same style before alternating, when
alternateColumnStyles is true. |
ListGrid |
setAlternateFieldStyles(boolean alternateFieldStyles)
Whether alternating columns (or blocks of columns, depending on
GridRenderer.alternateColumnFrequency ) should
be drawn in alternating styles, in order to create a vertical "ledger" effect for easier reading. |
ListGrid |
setAlternateFieldSuffix(java.lang.String alternateFieldSuffix)
Suffix to append to
alternate columns . |
ListGrid |
setAlternateRecordFrequency(int alternateRecordFrequency)
The number of consecutive rows to draw in the same style before alternating, when
alternateRowStyles is true. |
ListGrid |
setAlternateRecordStyles(java.lang.Boolean alternateRecordStyles)
Whether alternating rows (or blocks of rows, depending on
GridRenderer.alternateRowFrequency ) should be
drawn in alternating styles, in order to create a "ledger" effect for easier reading. |
ListGrid |
setAlternateRecordSuffix(java.lang.String alternateRecordSuffix)
Suffix to append to
alternate rows . |
ListGrid |
setAlwaysShowEditors(java.lang.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 when editByCell is false. |
ListGrid |
setAlwaysShowOperatorIcon(java.lang.Boolean alwaysShowOperatorIcon)
When
allowFilterOperators is enabled, whether
to show the operatorIcon 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. |
ListGrid |
setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)
When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
|
ListGrid |
setAnimateFolderMaxRows(java.lang.Integer animateFolderMaxRows)
If
animateFolders is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder. |
ListGrid |
setAnimateFolders(java.lang.Boolean animateFolders)
If true, when folders are opened / closed children will be animated into view.
|
ListGrid |
setAnimateFolderSpeed(int animateFolderSpeed)
When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden)
per second.
|
ListGrid |
setAnimateFolderTime(int animateFolderTime)
When animating folder opening / closing, if
TreeGrid.animateFolderSpeed is not set, this property designates the duration of the animation in ms. |
ListGrid |
setAnimateRemoveRecord(java.lang.Boolean animateRemoveRecord)
When
canRemoveRecords is enabled, should records
be animated out of view when they are removed by the user? |
ListGrid |
setAnimateRemoveSpeed(int animateRemoveSpeed)
When
animating record removal , this property
designates the speed of the animation in pixels per second. |
ListGrid |
setAnimateRemoveTime(int animateRemoveTime)
When animating record removal
(see
animateRemoveRecord) , if animateRemoveSpeed is
not set, this property designates the duration of the animation in ms. |
ListGrid |
setAnimateRollOver(java.lang.Boolean animateRollOver)
If the
rollOverCanvas is enabled, setting this
property to true ensures that when the rollOverCanvas is displayed it is animated into view
via Canvas.animateShow() . |
ListGrid |
setAnimateRollUnder(java.lang.Boolean animateRollUnder)
If the
rollUnderCanvas is enabled, setting this
property to true ensures that when the rollUnderCanvas is displayed it is animated into view
via Canvas.animateShow() . |
ListGrid |
setAnimateSelection(java.lang.Boolean animateSelection)
If the
selectionCanvas is enabled, setting this
property to true ensures that when the selectionCanvas is displayed it is animated into view
via Canvas.animateShow() . |
ListGrid |
setAnimateSelectionUnder(java.lang.Boolean animateSelectionUnder)
If the
selectionUnderCanvas is enabled,
setting this property to true ensures that when the selectionUnderCanvas is displayed it is
animated into view via Canvas.animateShow() . |
ListGrid |
setApplyFormulaAfterSummary(java.lang.Boolean applyFormulaAfterSummary)
If
ListGridField.userFormula is set for some
field, and this grid is showing group summaries or
a grid summary , this property determines what field
value should be present in those summary rows. |
ListGrid |
setApplyRowCountToLength(java.lang.Boolean applyRowCountToLength)
This property allows developers to explicitly set
ResultSet.applyRowCountToLength for this grid's data object. |
ListGrid |
setApplyRowNumberStyle(boolean applyRowNumberStyle)
|
ListGrid |
setApproximateRowCountFormat(java.lang.String approximateRowCountFormat)
|
ListGrid |
setAriaRole(java.lang.String ariaRole)
ARIA role for this ListGrid if
screen reader mode is enabled. |
ListGrid |
setArrowKeyAction(java.lang.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.
|
ListGrid |
setArrowKeyEditAction(ArrowKeyEditAction arrowKeyEditAction)
What to do when a user hits arrow key while editing a field?
If not explicitly specified getArrowKeyEditAction() will return an appropriate
action depending on the field type. |
ListGrid |
setAsyncErrorCellValue(java.lang.String asyncErrorCellValue)
The value to display for cells when an error occurred during asynchronous computation.
|
ListGrid |
setAsynchGroupingPrompt(java.lang.String asynchGroupingPrompt)
The prompt to display while interactivity is blocked during
asynchronous grouping . |
ListGrid |
setAsyncMissingCellValue(java.lang.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(java.lang.String autoChildName,
ListGridField properties)
Sets the properties for creating a
ListGridField AutoChild named
autoChildName . |
ListGrid |
setAutoComplete(AutoComplete autoComplete)
Whether to do inline autoComplete in text fields during inline editing
Overridden by ListGridField.autoComplete if specified. |
ListGrid |
setAutoConfirmSaveEdits(java.lang.Boolean autoConfirmSaveEdits)
For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded by
default.
|
ListGrid |
setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter)
If
DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData() |
ListGrid |
setAutoFetchData(java.lang.Boolean autoFetchData)
If true, when this component is first drawn, automatically call
DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . |
ListGrid |
setAutoFetchDisplayMap(java.lang.Boolean autoFetchDisplayMap)
If true, for fields where
ListGridField.optionDataSource is specified, a valueMap will be automatically created by making a DataSource.fetchData() call against the specified dataSource and
extracting a valueMap from the returned records based on the displayField and valueField. |
ListGrid |
setAutoFetchRowCount(boolean autoFetchRowCount)
Depending on whether
DataSource.progressiveLoading is
active, the exact count of available rows may not be available as part of the standard data fetch response - setting
autoFetchRowCount:true will cause a fetch for an accurate row count to be issued as soon as data arrives
(from a progressive dataSource response ) without an
accurate row count. |
ListGrid |
setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
If
autoFetchData is true , this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call. |
ListGrid |
setAutoFitAllText(java.lang.String autoFitAllText)
If we're showing a
headerContextMenu for this
grid, and canAutoFitFields is true, this attribute
will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via the autoFitField() method. |
ListGrid |
setAutoFitClipFields(java.lang.String... autoFitClipFields)
If
autoFitFieldWidths is enabled and the
calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an
array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear. |
ListGrid |
setAutoFitData(Autofit autoFitData)
Should this ListGrid automatically expand to accommodate the size of records and fields?
|
ListGrid |
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 by defaultDateFieldWidth , (or defaultEditableDateFieldWidth for editable
fields). |
ListGrid |
setAutoFitExpandField(java.lang.String autoFitExpandField)
The field to expand if
autoFitFieldWidths and
autoFitFieldsFillViewport are enabled and
auto-fitting will not fill all available horizontal space. |
ListGrid |
setAutoFitExtraRecords(java.lang.Integer autoFitExtraRecords)
If
autoFitData 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. |
ListGrid |
setAutoFitFieldsFillViewport(java.lang.Boolean autoFitFieldsFillViewport)
If
autoFitFieldWidths is enabled, and extra
space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space. |
ListGrid |
setAutoFitFieldText(java.lang.String autoFitFieldText)
If we're showing a
headerContextMenu for this
grid, and user-driven auto fit of fields is enabled via ListGridField.canAutoFitWidth or canAutoFitFields , this attribute will be shown as the
menu item title for an item to perform a one-time autoFit of the field to its title or content via a call to autoFitField() . |
ListGrid |
setAutoFitFieldWidths(java.lang.Boolean autoFitFieldWidths)
Should ListGrid fields autofit their widths to titles or content? This property may be overridden on a per-field basis
via
ListGridField.autoFitWidth . |
ListGrid |
setAutoFitHeaderHeights(java.lang.Boolean autoFitHeaderHeights)
If this property is set to true, header buttons for either
fields or header spans will automatically expand to
accommodate their titles vertically. |
ListGrid |
setAutoFitIconFields(AutoFitIconFieldType autoFitIconFields)
Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields with
type:"icon" , fields displaying only value icons , and boolean fields (which are rendered
as a checkmark type icon by default. |
ListGrid |
setAutoFitMaxColumns(int autoFitMaxColumns)
If
autoFitData is set to "horizontal" or
"both" this property provides the maximum number of columns for which the ListGrid will expand. |
ListGrid |
setAutoFitMaxHeight(java.lang.Integer autoFitMaxHeight)
If
autoFitData is set to "vertical" or
"both" this property provides an upper limit on how far the ListGrid will expand vertically to accommodate
its content. |
ListGrid |
setAutoFitMaxRecords(int autoFitMaxRecords)
If
autoFitData is set to "vertical" or
"both" this property provides the maximum number of records for which the ListGrid will expand. |
ListGrid |
setAutoFitMaxWidth(java.lang.Integer autoFitMaxWidth)
If
autoFitData is set to "horizontal" or
"both" this property provides an upper limit on how far the ListGrid will expand horizontally to
accommodate its content. |
ListGrid |
setAutoFitMaxWidth(java.lang.String autoFitMaxWidth)
If
autoFitData is set to "horizontal" or
"both" this property provides an upper limit on how far the ListGrid will expand horizontally to
accommodate its content. |
ListGrid |
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 by defaultTimeFieldWidth . |
void |
setAutoFitWidth(java.lang.String fieldName,
boolean autoFit)
Setter for
ListGridField.autoFitWidth . |
ListGrid |
setAutoFitWidthApproach(AutoFitWidthApproach autoFitWidthApproach)
When a user requests column autofitting via the
header context menu or via a mouse gesture , what autofit approach is used. |
ListGrid |
setAutoPersistViewState(ListGridViewStatePart... autoPersistViewState)
Setting this property to a non-null value will enable automatic saving of
view state to offline storage. |
ListGrid |
setAutoSaveEdits(java.lang.Boolean autoSaveEdits)
If this ListGrid is editable, should edits be saved out when the user finishes editing a row (or a cell if
saveByCell is true). |
ListGrid |
setAutoSizeHeaderSpans(java.lang.Boolean autoSizeHeaderSpans)
If this listGrid has specified
headerSpans , setting
this attribute to true will cause spans to expand to accommodate long titles if necessary. |
ListGrid |
setBadFormulaResultValue(java.lang.String badFormulaResultValue)
If the result of a formula evaluation is invalid (specifically, if isNaN(result)==true), badFormulaResultValue is
displayed instead.
|
ListGrid |
setBaseStyle(java.lang.String baseStyle)
base cell style for this listGrid. |
ListGrid |
setBlockingRowCountFetch(java.lang.Boolean blockingRowCountFetch)
If specified, this attribute will be applied to this grid's
data object for dataBound grids. |
ListGrid |
setBodyBackgroundColor(java.lang.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. |
ListGrid |
setBodyOverflow(Overflow bodyOverflow)
Overflow setting for the "body", that is, the area of the grid where data values are rendered.
|
ListGrid |
setBodyStyleName(java.lang.String bodyStyleName)
CSS style used for the body of this grid.
|
ListGrid |
setBooleanBaseStyle(java.lang.String booleanBaseStyle)
An optional CSS style to apply to the checkbox image.
|
ListGrid |
setBooleanFalseImage(java.lang.String booleanFalseImage)
Image to display for a false value in a boolean field.
|
ListGrid |
setBooleanImageHeight(int booleanImageHeight)
|
ListGrid |
setBooleanImageWidth(int booleanImageWidth)
|
ListGrid |
setBooleanPartialImage(java.lang.String booleanPartialImage)
Image to display for a partially true value in a boolean field (typically selection).
|
ListGrid |
setBooleanTrueImage(java.lang.String booleanTrueImage)
Image to display for a true value in a boolean field.
|
ListGrid |
setBriefRowRangeDisplayValue(java.lang.String briefRowRangeDisplayValue)
Dynamic String specifying the format for the
row range summary value when RowRangeDisplayStyle is set to "brief" . |
ListGrid |
setCanAcceptDroppedRecords(java.lang.Boolean canAcceptDroppedRecords)
Indicates whether records can be dropped into this listGrid.
|
ListGrid |
setCanAddAISortFields(java.lang.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.
|
ListGrid |
setCanAddFormulaFields(java.lang.Boolean canAddFormulaFields)
Adds an item to the header context menu allowing users to launch a dialog to define a new
field based on values present in other fields, using the
com.smartgwt.client..FormulaBuilder .
|
ListGrid |
setCanAddSummaryFields(java.lang.Boolean canAddSummaryFields)
Adds an item to the header context menu allowing users to launch a dialog to define a new
text field that can contain both user-defined text and the formatted values present in other
fields, using the
com.smartgwt.client..SummaryBuilder .
|
ListGrid |
setCanAutoFitFields(java.lang.Boolean canAutoFitFields)
Can the user perform one-time autofit for specific columns in this grid?
|
ListGrid |
setCancelEditingConfirmationMessage(java.lang.String cancelEditingConfirmationMessage)
If this is an editable listGrid, and
this.confirmCancelEditing is true this property is used as the message
to display in the confirmation dismissal prompt. |
ListGrid |
setCanCollapseGroup(java.lang.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 (see collapseGroupOnRowClick ); When false the group
icon is not shown and clicking on the row does not change group state. |
ListGrid |
setCanDragRecordsOut(java.lang.Boolean canDragRecordsOut)
Indicates whether records can be dragged from this listGrid and dropped elsewhere.
|
ListGrid |
setCanDragSelect(java.lang.Boolean canDragSelect)
If this property is true, users can drag the mouse to select several rows or cells.
|
ListGrid |
setCanDragSelectText(java.lang.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 with rearranging rows
or cells by dragging , and with drag selection of
rows . |
ListGrid |
setCanDropInEmptyArea(java.lang.Boolean canDropInEmptyArea)
If set to false, dropping over an empty part of the grid body is disallowed and the no-drop indicator is displayed.
|
ListGrid |
setCanEdit(java.lang.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 of canEditCell() 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. |
ListGrid |
setCanEditFieldAttribute(java.lang.String canEditFieldAttribute)
If this component is bound to a dataSource, this attribute may be specified to customize what fields from the dataSource
may be edited by default.
|
ListGrid |
setCanEditHilites(boolean canEditHilites)
Adds an item to the header context menu allowing users to launch a dialog to define grid hilites using the
HiliteEditor . |
ListGrid |
setCanEditTitles(boolean canEditTitles)
If set to true, the
advanced field picker
provides an interface allowing users to modify fields' titles. |
ListGrid |
setCanExpandMultipleRecords(java.lang.Boolean canExpandMultipleRecords)
When
canExpandRecords is true, this property
indicates whether multiple records can be expanded simultaneously. |
ListGrid |
setCanExpandRecordProperty(java.lang.String canExpandRecordProperty)
Property name on a record that will be checked to determine whether a record can be expanded.
|
ListGrid |
setCanExpandRecords(java.lang.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.
|
ListGrid |
setCanFocusInEmptyGrid(boolean canFocusInEmptyGrid)
If the listGrid is empty, should the user be able to put focus into the grid body by tabbing to it?
|
ListGrid |
setCanFreezeFields(java.lang.Boolean canFreezeFields)
Whether an interface should be shown to allow user is allowed to dynamically "freeze" or "unfreeze" columns with respect
to horizontally scrolling.
|
ListGrid |
setCanGroupBy(java.lang.Boolean canGroupBy)
If false, grouping via context menu will be disabled.
|
ListGrid |
setCanHiliteViaAI(java.lang.Boolean canHiliteViaAI)
When set to
true 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. |
ListGrid |
setCanHover(java.lang.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 has
showHover set to false. |
ListGrid |
setCanMultiGroup(boolean canMultiGroup)
When true, indicates that this ListGrid supports grouping on multiple fields.
|
ListGrid |
setCanMultiSort(java.lang.Boolean canMultiSort)
When true, indicates that this ListGrid supports sorting on multiple fields.
|
ListGrid |
setCanPickFields(java.lang.Boolean canPickFields)
Indicates whether the field picker item and submenu should be present in the header context menu.
|
ListGrid |
setCanPickOmittedFields(java.lang.Boolean canPickOmittedFields)
If true, the
field picker menu will include entries
for all dataSource fields, including those not included in the specified fields array . |
ListGrid |
setCanRemoveRecords(java.lang.Boolean canRemoveRecords)
If set, provide UI for the user to remove records from the grid as an additional field showing the
removeIcon , which, when clicked, will call removeRecordClick() which removes the row from the data set
(or if deferRemoval is true changes the markRecordRemoved() status for the record). |
ListGrid |
setCanReorderFields(java.lang.Boolean canReorderFields)
Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.
|
ListGrid |
setCanReorderRecords(java.lang.Boolean canReorderRecords)
Indicates whether records can be reordered by dragging within this
ListGrid . |
ListGrid |
setCanRequestRowCount(boolean canRequestRowCount)
Depending on whether
DataSource.progressiveLoading is
active, the exact count of available rows may not be known, and canRequestRowCount controls whether the
end user may explicitly request it by clicking the RowRangeDisplay label. |
ListGrid |
setCanResizeFields(java.lang.Boolean canResizeFields)
Indicates whether fields in this listGrid can be resized by dragging header fields.
|
ListGrid |
setCanSaveSearches(boolean canSaveSearches)
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.
|
ListGrid |
setCanSelectAll(java.lang.Boolean canSelectAll)
Controls whether a checkbox for selecting all records appears in the header with
selectionAppearance set to "checkbox" |
ListGrid |
setCanSelectCells(java.lang.Boolean canSelectCells)
Enables cell-level selection behavior as well as
cell-level rollover . |
ListGrid |
setCanSelectGroups(boolean canSelectGroups)
Controls whether a checkbox for selecting
groups appears in
the group node if SelectionAppearance is set to "checkbox" |
void |
setCanSelectRecordCustomizer(CanSelectRecordCustomizer customizer)
This customizer is called to determine whether a given record can be selected in this grid.
|
ListGrid |
setCanSelectSummaryRows(boolean canSelectSummaryRows)
Whether to allow selection of the summary row, for example by clicking on the record.
|
ListGrid |
setCanShowFilterEditor(boolean canShowFilterEditor)
Should a menu item allowing the user to show or hide the
filter editor be displayed in the headerContextmenu ? |
ListGrid |
setCanSort(java.lang.Boolean canSort)
Enables or disables interactive sorting behavior for this listGrid.
|
ListGrid |
setCanTabToHeader(java.lang.Boolean canTabToHeader)
Should the header be included in the tab-order for the page? If not explicitly specified, the header will be included in
the tab order for the page if
SC.setScreenReaderMode() is
called. |
ListGrid |
setCanTabToSorter(java.lang.Boolean canTabToSorter)
Should the
corner sort button be included in the
tab-order for the page? |
void |
setCellContextMenuItemsCustomizer(CellContextMenuItemsCustomizer customizer)
If
showCellContextMenus
is true , this method is fired when the user right-clicks a cell in this grid.Default implementation will display a menu with entries derived from ListGrid.getCellContextMenuItems for the appropriate cell. |
void |
setCellCSSTextCustomizer(CellCSSTextCustomizer customizer)
Sets a customizer that returns additional CSS-text for styling a given cell.
|
void |
setCellFormatter(CellFormatter formatter)
Sets a formatter that returns the HTML to display in each cell of the grid,
given the raw cell value.
|
ListGrid |
setCellHeight(int cellHeight)
Default height for each row in pixels.
|
ListGrid |
setCellPadding(int cellPadding)
The amount of empty space, in pixels, surrounding each value in its cell.
|
ListGrid |
setCellRole(java.lang.String cellRole)
Returns the default WAI ARIA role for cells within this listGrid.
|
void |
setCellValueHoverFormatter(CellValueHoverFormatter formatter)
Provide a custom implementation of
cellValueHoverHTML(ListGridRecord, int, int, String) . |
ListGrid |
setChartConstructor(java.lang.String chartConstructor)
Name of the Smart GWT Class to be used when creating charts.
|
ListGrid |
setChartType(ChartType chartType)
Default type of chart to plot.
|
ListGrid |
setCheckboxFieldFalseImage(java.lang.String checkboxFieldFalseImage)
If
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for an unselected row. |
ListGrid |
setCheckboxFieldImageHeight(java.lang.Integer checkboxFieldImageHeight)
If
selectionAppearance is set to
"checkbox" this property may be set to govern the height of the checkbox image displayed to indicate
whether a row is selected. |
ListGrid |
setCheckboxFieldImageWidth(java.lang.Integer checkboxFieldImageWidth)
If
selectionAppearance is set to
"checkbox" this property may be set to govern the width of the checkbox image displayed to indicate whether
a row is selected. |
ListGrid |
setCheckboxFieldPartialImage(java.lang.String checkboxFieldPartialImage)
If
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a partially selected
row. |
void |
setCheckboxFieldProperties(ListGridField checkboxFieldProperties)
Standard properties to apply to the automatically generated checkbox field, shown when
selectionAppearance is set to "checkbox". |
ListGrid |
setCheckboxFieldTrueImage(java.lang.String checkboxFieldTrueImage)
If
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a selected row. |
ListGrid |
setChildExpansionMode(ExpansionMode childExpansionMode)
For
expansionModes that show another grid or tree, what the child's
expansionMode should be. |
ListGrid |
setClearAllSortingText(java.lang.String clearAllSortingText)
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear any existing sort on all fields. |
ListGrid |
setClearCriteriaOnFilterEditorHide(boolean clearCriteriaOnFilterEditorHide)
When set to false, this attribute prevents user-criteria in the
filterEditor from being cleared when the user hides it. |
ListGrid |
setClearFilterText(java.lang.String clearFilterText)
If we're showing a
headerContextMenu for this
grid, and a filter-editor is visible, this
attribute will be shown as the menu item title to clear any existing filter. |
ListGrid |
setClearFilterViaAIText(java.lang.String clearFilterViaAIText)
Title for the menu-item displayed in this component's header context-menu when
AI-assisted filtering is allowed and an AI filter in
already in effect. |
ListGrid |
setClearSortFieldText(java.lang.String clearSortFieldText)
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear an existing sort on this field. |
ListGrid |
setClipHeaderTitles(java.lang.Boolean clipHeaderTitles)
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 on
hover . |
ListGrid |
setCollapseGroupOnRowClick(boolean collapseGroupOnRowClick)
If
canCollapseGroup is true, will a click anywhere
on the group row toggle the group's expanded state? If false, the user must click the groupIcon directly to toggle the group. |
ListGrid |
setConfigureGroupingText(java.lang.String configureGroupingText)
If we're showing a
headerContextMenu for this
grid, and multi-grouping is enabled, this attribute is used as the title for a menu item that opens a MultiGroupDialog to configure the grouping for this grid. |
ListGrid |
setConfigureSortText(java.lang.String configureSortText)
If we're showing a
headerContextMenu for this
grid, and multi-sorting is enabled, this attribute is used as the title for a menu item that opens a MultiSortDialog to configure the sort-specification for this grid. |
ListGrid |
setConfirmCancelEditing(java.lang.Boolean confirmCancelEditing)
If this is an editable listGrid, when the user attempts to cancel an edit, should we display a confirmation prompt
before discarding the edited values for the record?
|
ListGrid |
setConfirmDiscardEdits(java.lang.Boolean confirmDiscardEdits)
For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded.
|
ListGrid |
setConfirmDiscardEditsMessage(java.lang.String confirmDiscardEditsMessage)
If
this.confirmDiscardEdits is true, this property can be used to customize the error message string
displayed to the user in a dialog with options to cancel the action, or save or discard pending edits in response to
sort/filter actions that would otherwise drop unsaved edit values. |
void |
setCriteria(Criteria criteria)
Sets this component's filter criteria.
|
ListGrid |
setCriteriaIndicatorColor(java.lang.String criteriaIndicatorColor)
The color of the
filterWindow
criteria indicator . |
ListGrid |
setCriteriaIndicatorHeaderColor(java.lang.String criteriaIndicatorHeaderColor)
The color of the
filterWindow
criteria indicator when shown on the sorter
button or the last header button in the
grid header. |
ListGrid |
setData(ListGridRecord... data)
A list of ListGridRecord objects, specifying the data to be used to populate the ListGrid.
|
ListGrid |
setData(Record[] data) |
ListGrid |
setData(RecordList data) |
ListGrid |
setDataArity(java.lang.String dataArity)
A ListGrid is a
dataArity :multiple component. |
ListGrid |
setDataFetchDelay(java.lang.Integer dataFetchDelay)
Delay in milliseconds before fetching data.
|
ListGrid |
setDataFetchMode(FetchMode dataFetchMode)
How to fetch and manage records retrieve from the server.
|
ListGrid |
setDataPageSize(int dataPageSize)
When using
data
paging , how many records to fetch at a time. |
ListGrid |
setDataProperties(ResultSet resultSetProperties)
For databound ListGrids, this attribute can be used to customize the
ResultSet object created for this grid when data is
fetched. |
ListGrid |
setDataSource(DataSource dataSource)
The DataSource that this component should bind to for default fields and for performing
DataSource requests . |
void |
setDataSource(DataSource dataSource,
ListGridField... fields)
Bind to a DataSource.
|
ListGrid |
setDataSource(java.lang.String dataSource)
The DataSource that this component should bind to for default fields and for performing
DataSource requests . |
ListGrid |
setDateFormatter(DateDisplayFormat dateFormatter)
How should Date type values be displayed in this ListGrid by default?
|
ListGrid |
setDateInputFormat(java.lang.String dateInputFormat)
If this is an editable listGrid, this property will specify the
inputFormat applied to editors for fields of type
"date" . |
ListGrid |
setDatetimeFormatter(DateDisplayFormat datetimeFormatter)
Display format to use for fields specified as type 'datetime'.
|
ListGrid |
setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
Before we start editing values in this DataBoundComponent, should we perform a deep clone
of the underlying values.
|
ListGrid |
setDefaultDateFieldWidth(java.lang.Integer defaultDateFieldWidth)
Default width for date type fields.
|
ListGrid |
setDefaultDateTimeFieldWidth(java.lang.Integer defaultDateTimeFieldWidth)
Default width for datetime type fields.
|
ListGrid |
setDefaultEditableDateFieldWidth(java.lang.Integer defaultEditableDateFieldWidth)
Default width for editable date type fields.
|
ListGrid |
setDefaultEditableDateTimeFieldWidth(java.lang.Integer defaultEditableDateTimeFieldWidth)
Default width for editable datetime type fields.
|
ListGrid |
setDefaultFields(ListGridField... defaultFields)
An array of listGrid field configuration objects.
|
void |
setDefaultFieldWidthCustomizer(DefaultFieldWidthCustomizer customizer)
Method to calculate and return the default width of a field.
|
ListGrid |
setDefaultFilterOperator(OperatorId defaultFilterOperator)
Default
filter operator to use for text-based fields in this grid's filter editor , when producing AdvancedCriteria . |
ListGrid |
setDefaultFilterOperatorSuffix(java.lang.String defaultFilterOperatorSuffix)
Text to show after the name of the default filterOperator in the
headerContextMenu when allowFilterOperators is enabled. |
static void |
setDefaultProperties(ListGrid listGridProperties)
Class level method to set the default properties of this class.
|
ListGrid |
setDefaultTimeFieldWidth(java.lang.Integer defaultTimeFieldWidth)
Default width for time type fields.
|
ListGrid |
setDeferRemoval(java.lang.Boolean deferRemoval)
When enabled, the field shown by
canRemoveRecords
causes records to be marked for future removal via markRecordRemoved() instead of immediately being removed. |
ListGrid |
setDeselectOnPartialCheckboxClick(java.lang.Boolean deselectOnPartialCheckboxClick)
Should partially selected checkbox be deselected or selected on click? This setting affects
header selection checkbox , group\n checkboxes and folder checkbox selection in a Tree
data set. |
void |
setDetailDS(DataSource detailDS)
If
canExpandRecords is true and listGrid.expansionMode is "related" , this property specifies the
dataSource for the related records grid to be shown embedded in expanded records. |
ListGrid |
setDetailDS(java.lang.String detailDS)
If
canExpandRecords is true and listGrid.expansionMode is "related" , this property specifies the
dataSource for the related records grid to be shown embedded in expanded records. |
ListGrid |
setDetailField(java.lang.String detailField)
The field whose contents to show in the expanded portion of a record when
canExpandRecords is true and listGrid.expansionMode is detailField . |
ListGrid |
setDisabledGroupByPrompt(java.lang.String disabledGroupByPrompt)
Prompt to indicate that grouping is disabled as the data set size exceeds
groupByMaxRecords . |
ListGrid |
setDiscardEditsOnHideField(boolean discardEditsOnHideField)
If a user is editing a
canEdit: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? |
ListGrid |
setDiscardEditsSaveButtonTitle(java.lang.String discardEditsSaveButtonTitle)
If
confirmDiscardEdits is true this is the
title for the save button appearing in the lost edits confirmation dialog. |
void |
setDontAutoDestroyComponent(Canvas component,
boolean dontAutoDestroy)
If
showRecordComponents is true, by default
any created record components are destroyed once they are no longer in use (for example, if the ListGrid as a whole is
destroyed). |
ListGrid |
setDragDataAction(DragDataAction dragDataAction)
Indicates what to do with data dragged into another DataBoundComponent.
|
ListGrid |
setDragDataCustomizer(DragDataCustomizer customizer)
During a drag-and-drop interaction, this method returns the set of records being dragged
out of the component.
|
ListGrid |
setDragHandleFieldTitle(java.lang.String dragHandleFieldTitle)
The title to use for the
drag handle field . |
ListGrid |
setDragHandleIcon(java.lang.String dragHandleIcon)
Default icon to show in the
drag handle field .. |
ListGrid |
setDragHandleIconSize(int dragHandleIconSize)
Default width and height of
drag handle icons for
this ListGrid. |
ListGrid |
setDragScrollRedrawDelay(int dragScrollRedrawDelay)
Like
scrollRedrawDelay , but applies when the
component is being drag-scrolled (via a scrollbar). |
void |
setDragTrackerIconCustomizer(DragTrackerIconCustomizer dragTrackerIconCustomizer)
HTML to be shown in hovers over cells in the column described by this field.
|
ListGrid |
setDragTrackerMode(DragTrackerMode dragTrackerMode)
When records are being dragged from within a ListGrid, what sort of drag-tracker should be displayed?
Note that if multiple records are being dragged the displayed tracker will be based on the first selected record. |
ListGrid |
setDragTrackerStyle(java.lang.String dragTrackerStyle)
CSS Style to apply to the drag tracker when dragging occurs on this component.
|
void |
setDragTrackerTitleCustomizer(DragTrackerTitleCustomizer dragTrackerTitleCustomizer)
Return "title" HTML to display as a drag tracker when the user drags some record.
Default implementation will display the cell value for the title field (see +link{listGrid.getTitleField()}) for the record(s) being dragged (including any icons / custom formatting / styling, etc). |
ListGrid |
setDrawAheadRatio(float drawAheadRatio)
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.
|
ListGrid |
setDrawAllMaxCells(int drawAllMaxCells)
If drawing all rows would cause less than
drawAllMaxCells cells to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
the viewport size and drawAheadRatio setting would
normally have caused incremental rendering to be used. |
ListGrid |
setDropValues(java.util.Map dropValues)
When an item is dropped on this component, and
addDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it. |
ListGrid |
setDuplicateDragMessage(java.lang.String duplicateDragMessage)
Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled. |
ListGrid |
setEditByCell(java.lang.Boolean editByCell)
Determines whether when the user edits a cell in this listGrid the entire row becomes editable, or just the cell that
received the edit event.
|
ListGrid |
setEditEvent(ListGridEditEvent editEvent)
Event that will trigger inline editing, see
ListGridEditEvent for options. |
ListGrid |
setEditFailedBaseStyle(java.lang.String editFailedBaseStyle)
A base name for the CSS class applied to cells when editing has failed.
If this listGrid is editable, this style will be applied to any edited cells for which validation failed. As with the default 'baseStyle' property, this style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell. If null, cells for which editing has failed will be rendered using the normal base style classNames, but with custom CSSText applied as derived from this.editFailedCSSText |
ListGrid |
setEditFailedCSSText(java.lang.String editFailedCSSText)
Custom CSS text to be applied to cells when editing has failed.
If this listGrid is editable, this css text will be applied to any edited cells for which validation failed, on top of the base style for the cell. For further customization of styling for cells that failed editing validation, use this.editFailedBaseStyle instead. |
ListGrid |
setEditFormulaFieldText(java.lang.String editFormulaFieldText)
Text for a menu item allowing users to edit a formula field
|
ListGrid |
setEditOnF2Keypress(java.lang.Boolean editOnF2Keypress)
Should we start editing when the widget has focus and the user presses the "f2" key (if this ListGrid supports editing)?
|
ListGrid |
setEditOnFocus(java.lang.Boolean editOnFocus)
Should we start editing when this widget receives focus (if this ListGrid supports editing)?
|
void |
setEditorCustomizer(ListGridEditorCustomizer customizer)
This method allows developers to dynamically customize the form item displayed in an editable grid, based
on the cell being edited.
|
void |
setEditorValueMap(java.lang.String fieldName,
java.util.LinkedHashMap valueMap)
Set a valueMap to display for this field while editing.
This method sets the +link{ListGridField.editorValueMap, field.editorValueMap} property and may be called at runtime while editing the grid. |
void |
setEditorValueMap(java.lang.String fieldName,
java.lang.String... valueMap)
Set a valueMap to display for this field while editing.
This method sets the +link{ListGridField.editorValueMap, field.editorValueMap} property and may be called at runtime while editing the grid. |
ListGrid |
setEditPendingBaseStyle(java.lang.String editPendingBaseStyle)
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. |
ListGrid |
setEditPendingCSSText(java.lang.String editPendingCSSText)
Custom CSS text to be applied to cells with pending edits that have not yet been submitted.
For further customization of styling for cells with pending edits use this.editPendingBaseStyle instead. |
ListGrid |
setEditPendingMarkerStyle(java.lang.String editPendingMarkerStyle)
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 by
editPendingCSSText or editPendingBaseStyle . |
ListGrid |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
ListGrid |
setEditSelectionType(SelectionStyle editSelectionType)
If
selectOnEdit is true, what should be the
edit-selection behavior be? |
ListGrid |
setEditSummaryFieldText(java.lang.String editSummaryFieldText)
Text for a menu item allowing users to edit the formatter for a field
|
void |
setEditValue(int rowNum,
int colNum,
boolean value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
java.lang.Boolean value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
java.util.Date value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
double value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
float value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
int value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
java.lang.Integer value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
com.google.gwt.core.client.JavaScriptObject value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
java.lang.Object value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
Record value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
Record[] value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
int colNum,
java.lang.String value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
boolean value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.Boolean value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
java.util.Date value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
double value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
float value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
int value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.Integer value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
com.google.gwt.core.client.JavaScriptObject value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.Object value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
Record value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
Record[] value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.String value)
Modifies a field value being tracked as an unsaved user edit.
|
void |
setEditValues(int rowNum,
java.util.Map values)
This method sets up a set of editValues for some row / cell.
|
ListGrid |
setEmbeddedComponentIndent(java.lang.Integer embeddedComponentIndent)
This is the pixel-amount by which child components are offset within the grid-body, by default from the left, or from
the right when
RTL is in effect. |
ListGrid |
setEmbeddedComponentMargin(java.lang.Integer embeddedComponentMargin)
This is the space to apply as margin around child-components embedded in this grid.
|
ListGrid |
setEmptyAIHoverContents(java.lang.String emptyAIHoverContents)
Hover contents to use when the AI-generated hover text is empty.
|
ListGrid |
setEmptyCellValue(java.lang.String emptyCellValue)
The value to display for cells whose value is null or the empty string after applying
formatting and valueMap (if any). |
ListGrid |
setEmptyMessage(java.lang.String emptyMessage)
The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.
|
ListGrid |
setEmptyMessageStyle(java.lang.String emptyMessageStyle)
The CSS style name applied to the
emptyMessage if
displayed. |
ListGrid |
setEmptyRowRangeDisplayValue(java.lang.String emptyRowRangeDisplayValue)
Row range summary display value when the grid
is empty. |
ListGrid |
setEnforceVClipping(java.lang.Boolean enforceVClipping)
For performance reasons, even when
fixedRecordHeights is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers. |
ListGrid |
setEnterKeyEditAction(EnterKeyEditAction enterKeyEditAction)
What to do when a user hits enter while editing a cell: "nextCell": start editing the next editable cell in
this record (or the first editable cell in the next record if focus is in the last editable cell in the row)
"nextRow": start editing the same field in the next row (skipping any rows where that would be a non-editable
cell.
|
ListGrid |
setEnumCriteriaAsInitialValues(java.lang.Boolean enumCriteriaAsInitialValues)
In a ListGrid that has a DataSource and has filter criteria that include values for fields declared as
type "enum" in the DataSource, by default a newly edited row will use those filter
criteria as initial values. |
ListGrid |
setErrorIconHeight(java.lang.Integer errorIconHeight)
Height of the error icon, if we're showing icons when validation errors occur.
|
ListGrid |
setErrorIconSrc(java.lang.String errorIconSrc)
Src of the image to show as an error icon, if we're showing icons when validation errors occur.
|
ListGrid |
setErrorIconWidth(java.lang.Integer errorIconWidth)
Height of the error icon, if we're showing icons when validation errors occur.
|
ListGrid |
setEscapeKeyEditAction(EscapeKeyEditAction escapeKeyEditAction)
What to do when a user hits escape while editing a cell: "cancel": close the editor and discard the current set
of edit values "done": just close the editor (the edit is complete, but the edited values are retained).
|
ListGrid |
setExactRowCountFormat(java.lang.String exactRowCountFormat)
|
ListGrid |
setExpansionCanEdit(java.lang.Boolean expansionCanEdit)
For
expansionModes that show another grid or tree, is that component
editable? |
ListGrid |
setExpansionComponentPoolingMode(ExpansionComponentPoolingMode expansionComponentPoolingMode)
The method of
component-pooling to employ for expansionComponents . |
ListGrid |
setExpansionEditorSaveDialogPrompt(java.lang.String expansionEditorSaveDialogPrompt)
When
canExpandRecords is true and expansionMode is editor, the prompt to display in a
dialog when an expanded row is collapsed while it's nested editor has changed values. |
ListGrid |
setExpansionEditorShowSaveDialog(java.lang.Boolean expansionEditorShowSaveDialog)
When
canExpandRecords is true and expansionMode is editor, whether a dialog should be
displayed when an expanded row is collapsed while it's nested editor has changed values. |
ListGrid |
setExpansionFieldFalseImage(java.lang.String expansionFieldFalseImage)
If
canExpandRecords is set to true ,
this property determines the image to display in the expansion field for collapsed rows. |
ListGrid |
setExpansionFieldImageHeight(java.lang.Integer expansionFieldImageHeight)
If
canExpandRecords is set to true ,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded. |
ListGrid |
setExpansionFieldImageShowRTL(boolean expansionFieldImageShowRTL)
If this grid is in RTL mode, should an "_rtl" suffix be added to the
expansionFieldTrueImage and expansionFieldFalseImage image URLs? This should
only be enabled if RTL media for the true and false expansion field images are available. |
ListGrid |
setExpansionFieldImageShowSelected(boolean expansionFieldImageShowSelected)
Should a "_selected" suffix be added to the
expansionFieldTrueImage and expansionFieldFalseImage image URLs for selected rows? |
ListGrid |
setExpansionFieldImageStyle(java.lang.String expansionFieldImageStyle)
Custom style to apply to the image in the
expansionField displayed in collapsible rows when canExpandRecords is true. |
ListGrid |
setExpansionFieldImageWidth(java.lang.Integer expansionFieldImageWidth)
If
canExpandRecords is set to true ,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded. |
ListGrid |
setExpansionFieldTrueImage(java.lang.String expansionFieldTrueImage)
If
canExpandRecords is set to true ,
this property determines the image to display in the expansion field for expanded rows. |
ListGrid |
setExpansionIndent(java.lang.Integer expansionIndent)
When
canExpandRecords 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 when
RTL is in effect. |
ListGrid |
setExpansionMode(ExpansionMode expansionMode)
The
ExpansionMode for records in this grid. |
ListGrid |
setExpansionScreen(java.lang.String expansionScreen)
Screen to create (via
createScreen() ) in lieu of calling getExpansionComponent() . |
ListGrid |
setExplicitFetchDelay(int explicitFetchDelay)
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. |
ListGrid |
setExportAll(java.lang.Boolean exportAll)
Setting exportAll to true prevents the component from passing its list of fields to the
export call.
|
ListGrid |
setExportAlternateRowBGColor(java.lang.String exportAlternateRowBGColor)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , background color
to use for even-numbered rows, to create a "banded" or "ledger" effect. |
ListGrid |
setExportDefaultBGColor(java.lang.String exportDefaultBGColor)
Default background color to use when exporting data to Excel/OpenOffice format using
exportData() or exportClientData() . |
ListGrid |
setExportFieldAlignments(boolean exportFieldAlignments)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , whether field
horizontal header alignments and data value alignments should be replicated in the resulting
spreadsheet. |
ListGrid |
setExportFields(java.lang.String[] exportFields)
The list of field-names to export.
|
ListGrid |
setExportFieldWidths(boolean exportFieldWidths)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , whether widths
of fields should be replicated in the resulting spreadsheet. |
ListGrid |
setExportHeaderHeights(boolean exportHeaderHeights)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , causes the
headerHeight and headerSpan heights to be applied to the corresponding cells in
the spreadsheet. |
ListGrid |
setExportHiddenFieldWidth(int exportHiddenFieldWidth)
Width to size non-visible fields (which may be specified with
exportFields or DSRequest.exportFields ) during exportData() or exportClientData() , if they have no defined numeric width . |
ListGrid |
setExportIncludeSummaries(java.lang.Boolean exportIncludeSummaries)
If Summary rows exist for this component, whether to include them when exporting client data.
|
ListGrid |
setExportRawNumbers(java.lang.Boolean exportRawNumbers)
Dictates whether numeric values should be exported as raw numbers instead of formatted values when using
exportClientData() . |
ListGrid |
setExportRawValues(java.lang.Boolean exportRawValues)
Dictates whether the data in this grid should be exported raw by
exportClientData() . |
ListGrid |
setExportWidthScale(double exportWidthScale)
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.
|
ListGrid |
setExportWrapHeaderTitles(boolean exportWrapHeaderTitles)
When exporting data to Excel/OpenOffice format using
exportData() or exportClientData() , whether titles
in the ListGrid header and headerSpans should be allowed to wrap. |
ListGrid |
setFastCellUpdates(java.lang.Boolean fastCellUpdates)
Note: This property only has an effect in Internet Explorer
|
ListGrid |
setFetchDelay(int fetchDelay)
If we're showing the filterEditor (
showFilterEditor is true), and filterByCell or
filterOnKeypress are enabled, this property is the
delay in milliseconds between the user changing the filter and the filter request being sent to the server. |
ListGrid |
setFetchFields(ListGridField... fetchFields)
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.
|
ListGrid |
setFetchFields(java.lang.String fetchFields)
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.
|
ListGrid |
setFetchOperation(java.lang.String fetchOperation)
Operation ID this component should use when performing fetch operations.
|
ListGrid |
setFetchRequestProperties(DSRequest fetchRequestProperties)
If
autoFetchData is true , this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. |
void |
setFieldButtonProperties(java.lang.String name,
Canvas properties)
Method to update properties on a field's header button at runtime.
|
void |
setFieldCellIcon(java.lang.String fieldName,
java.lang.String cellIcon)
Change the
ListGridField.cellIcon for a field after
the grid is created |
ListGrid |
setFieldCriteriaText(java.lang.String fieldCriteriaText)
The field criteria prefix to show in filter editor field hover before the descriptive version of the field's criteria,
if any.
|
void |
setFieldError(int rowNum,
java.lang.String fieldName,
java.lang.String errorMessage)
Set a validation error for some cell.
|
void |
setFieldError(int rowNum,
java.lang.String fieldName,
java.lang.String[] errorMessages) |
void |
setFieldHeaderBaseStyle(java.lang.String name,
java.lang.String newStyle)
Update the
ListGridField.headerBaseStyle for a
field within the grid at runtime. |
void |
setFieldHeaderTitleStyle(java.lang.String name,
java.lang.String newStyle)
Update the
ListGridField.headerTitleStyle for
a field within the grid at runtime. |
void |
setFieldIcon(java.lang.String fieldName,
java.lang.String icon)
Change the
ListGridField.icon for a field after the grid
is created |
void |
setFieldMaxWidth(int fieldNum,
int width)
Updates
ListGridField.maxWidth for the specified
field and redraws the associated column if required. |
void |
setFieldMinWidth(int fieldNum,
int width)
Updates
ListGridField.minWidth for the specified
field and redraws the associated column if required. |
ListGrid |
setFieldPickerFieldProperties(java.lang.String... fieldPickerFieldProperties)
Names of properties on
ListGridField for which the FieldPicker should show an editing interface, for convenience. |
ListGrid |
setFieldPickerShowSampleValues(java.lang.Boolean fieldPickerShowSampleValues)
When set to false, sample values of the FieldPicker are never shown.
|
void |
setFieldProperties(int fieldNum,
ListGridField properties)
Dynamically set properties for a particular field.
|
void |
setFieldProperties(java.lang.String fieldNum,
ListGridField properties)
Dynamically set properties for a particular field.
|
ListGrid |
setFields(com.google.gwt.core.client.JavaScriptObject... fields)
Field setter variant (alternative to
setFields(FormItem...) ,
setFields(ListGridField...) ,
etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT
Java wrappers of the field class type (e.g. |
ListGrid |
setFields(ListGridField... fields)
An array of field objects, specifying the order, layout, formatting, and sorting behavior of each field in the listGrid
object.
|
void |
setFieldSearchOperator(java.lang.String fieldName,
OperatorId operator)
Applies a new
search operator to a field in the grid's filter row , and updates it's operatorIcon. |
ListGrid |
setFieldState(java.lang.String fieldState)
Initial
field state for the grid. |
void |
setFieldTitle(int fieldNum,
java.lang.String title)
Change the title of a field after the grid is created.
|
void |
setFieldTitle(java.lang.String fieldNum,
java.lang.String title)
Change the title of a field after the grid is created.
|
ListGrid |
setFieldVisibilitySubmenuTitle(java.lang.String fieldVisibilitySubmenuTitle)
If we're showing a
headerContextMenu for this
grid, and this.canPickFields is true, this attribute
will be shown as the title for the menu item which contains a submenu with items allowing the user to show and hide
fields in the grid. |
ListGrid |
setFilterButtonPrompt(java.lang.String filterButtonPrompt)
The prompt to show when the mouse hovers over the Filter button in the FilterEditor.
|
ListGrid |
setFilterButtonProperties(Button filterButtonProperties)
If
showFilterEditor is true, this attribute may be
used to customize the filter button shown to the right of the filterEditor row. |
ListGrid |
setFilterByCell(boolean filterByCell)
If we're showing the
filterEditor , 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. |
void |
setFilterEditorCriteria(Criteria criteria)
If
showFilterEditor is true, this method will
update the criteria shown in the filterEditor without performing a filter. |
ListGrid |
setFilterEditorHeight(int filterEditorHeight)
Height for the filterEditor, if shown.
|
void |
setFilterEditorProperties(ListGrid filterEditorProperties)
Deprecated.
in favor of
setFilterEditorProperties(RecordEditor) |
ListGrid |
setFilterEditorProperties(RecordEditor filterEditorProperties)
Properties to apply to the automatically generated
filterEditor if showFilterEditor is true. |
ListGrid |
setFilterLocalData(java.lang.Boolean filterLocalData)
Causes filtering to be performed against the local data set, even when a
dataSource is provided. |
ListGrid |
setFilterOnKeypress(boolean filterOnKeypress)
When this attribute is true and this component has been assigned a
searchForm or is showing the filterEditor , data will be filtered automatically as
users change values in those components. |
ListGrid |
setFilterUsingText(java.lang.String filterUsingText)
Text for the menu item shown in the
headerContextMenu when allowFilterOperators
is enabled. |
ListGrid |
setFilterViaAIMode(AIServiceMode filterViaAIMode)
If filtering of the grid is enabled, filtering-via-AI can also be enabled by setting the
AIServiceMode to use. |
ListGrid |
setFilterViaAIPanelInstructions(java.lang.String filterViaAIPanelInstructions)
The instruction text to display above the "Filter via AI" text box.
|
ListGrid |
setFilterViaAIText(java.lang.String filterViaAIText)
Title for the menu-item displayed in this component's header context-menu when
AI-assisted filtering is allowed. |
ListGrid |
setFilterWindowCriteria(Criteria filterWindowCriteria)
Advanced filtering criteria, either
simple or advanced , that is combined with the filter editor criteria during filtering. |
ListGrid |
setFilterWindowInstructions(java.lang.String filterWindowInstructions)
The instruction text to display at the top of the
filterWindow . |
ListGrid |
setFilterWindowTitle(java.lang.String filterWindowTitle)
The title for the
advanced filtering window . |
ListGrid |
setFirstCellStyle(java.lang.String firstCellStyle)
The style to apply to the first cell in each row, when
styledRowEnds is true. |
ListGrid |
setFixedFieldWidths(java.lang.Boolean fixedFieldWidths)
Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?
|
ListGrid |
setFixedRecordHeights(java.lang.Boolean fixedRecordHeights)
Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?
|
ListGrid |
setFormulaBuilderSpanTitleSeparator(java.lang.String formulaBuilderSpanTitleSeparator)
If this grid has specified
headerSpans , and showHeaderSpanTitlesInFormulaBuilder
is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid in
the FormulaBuilder and SummaryBuilder. |
ListGrid |
setFreezeFieldText(java.lang.String freezeFieldText)
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze a currently unfrozen field. |
ListGrid |
setFrozenBaseStyle(java.lang.String frozenBaseStyle)
If this listGrid contains any frozen fields, this property can be used to apply a custom baseStyle to all cells in those
frozen fields.
|
ListGrid |
setFrozenFieldsMaxWidth(java.lang.Integer frozenFieldsMaxWidth)
Maximum width available for any
frozen fields shown in this grid. |
ListGrid |
setFrozenFieldsMaxWidth(java.lang.String frozenFieldsMaxWidth)
Maximum width available for any
frozen fields shown in this grid. |
ListGrid |
setFrozenHeaderBaseStyle(java.lang.String frozenHeaderBaseStyle)
If this listGrid contains any frozen fields, this property can be used to apply a custom headerBaseStyle to the frozen
set of fields.
|
ListGrid |
setFrozenHeaderTitleStyle(java.lang.String frozenHeaderTitleStyle)
If this listGrid contains any frozen fields, this property can be used to apply a custom headerTitleStyle to the frozen
set of fields.
|
ListGrid |
setFullRowRangeDisplayValue(java.lang.String fullRowRangeDisplayValue)
Dynamic String specifying the format for the
row range summary value when RowRangeDisplayStyle is set to "full" . |
ListGrid |
setGenerateClickOnEnter(java.lang.Boolean generateClickOnEnter)
If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a click event.
|
ListGrid |
setGenerateClickOnSpace(java.lang.Boolean generateClickOnSpace)
If true, when the user navigates to a cell using arrow keys and hits space, the cell will respond to a click event.
|
ListGrid |
setGenerateDoubleClickOnEnter(java.lang.Boolean generateDoubleClickOnEnter)
If true, when the user navigates to a cell using arrow keys and hits Enter, the cell will respond to a double click
event.
|
ListGrid |
setGenerateDoubleClickOnSpace(java.lang.Boolean generateDoubleClickOnSpace)
If true, when the user navigates to a cell using arrow keys and hits Space, the cell will respond to a double click
event.
|
ListGrid |
setGridAdditionalCriteriaText(java.lang.String gridAdditionalCriteriaText)
The additional criteria prefix to show in filter editor field hover, the filter action button or the sorter button
before the descriptive version of the
filterWindowCriteria , if any. |
ListGrid |
setGridComponents(ListGridComponent... gridComponents)
Array of components that make up this grid.
|
ListGrid |
setGridComponents(java.lang.Object... gridComponents)
Array of components that make up this grid.
|
ListGrid |
setGridSummaryRecordProperty(java.lang.String gridSummaryRecordProperty)
If
showGridSummary is true, this attribute will be
set to true on the record object representing the grid summary row. |
ListGrid |
setGroupByAsyncThreshold(int groupByAsyncThreshold)
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.
|
ListGrid |
setGroupByField(java.lang.String... groupByField)
List of fields to group grid records.
|
ListGrid |
setGroupByField(java.lang.String groupByField)
List of fields to group grid records.
|
ListGrid |
setGroupByFieldSummaries(java.lang.String... groupByFieldSummaries)
If this grid is
grouped , and showGroupSummary is true, this attribute may be set to an
array of groupBy field names for which group summaries should appear. |
ListGrid |
setGroupByMaxRecords(int groupByMaxRecords)
Maximum number of records to which a groupBy can be applied.
|
ListGrid |
setGroupByMaxRecordsExceededMessage(java.lang.String groupByMaxRecordsExceededMessage)
Warning shown to the user when a grouping attempt failed as the data set length exceeds
groupByMaxRecords . |
ListGrid |
setGroupByText(java.lang.String groupByText)
If we're showing a
headerContextMenu for this
grid and this.canGroupBy is true, this string will be
shown as the title for the menu item to toggle the group by setting for a field. |
ListGrid |
setGroupIcon(java.lang.String groupIcon)
The URL of the base icon for the group icons in this listGrid.
|
ListGrid |
setGroupIconSize(int groupIconSize)
Default width and height of group icons for this ListGrid.
|
ListGrid |
setGroupIconStyle(java.lang.String groupIconStyle)
Custom style to apply to the
groupIcon displayed in
collapsible rows when canGroupBy is true. |
ListGrid |
setGroupIndentSize(int groupIndentSize)
Default number of pixels by which to indent subgroups relative to parent group.
|
ListGrid |
setGroupLeadingIndent(int groupLeadingIndent)
Default number of pixels by which to indent all groups.
|
ListGrid |
setGroupNodeBaseStyle(java.lang.String groupNodeBaseStyle)
Base style for group rows. |
ListGrid |
setGroupNodeStyle(java.lang.String groupNodeStyle)
The CSS style that
group rows will have. |
ListGrid |
setGroupSortDirection(SortDirection groupSortDirection)
When
sortByGroupFirst is active, the sorting
direction applied for implicit sorting by the field(s) used for grouping. |
void |
setGroupSortNormalizer(GroupSortNormalizer customizer)
When
sortByGroupFirst
is active, sets the GroupNode value
normalizer used for implicit sorting by the field(s) used for grouping. |
void |
setGroupStartOpen(GroupStartOpen group)
Describes the default state of ListGrid groups when groupBy is called.
|
void |
setGroupStartOpen(java.lang.Object... groupValues) |
ListGrid |
setGroupState(java.lang.String groupState)
Initial group state for the grid.
|
ListGrid |
setGroupSummaryRecordProperty(java.lang.String groupSummaryRecordProperty)
If
showGroupSummary is true, this attribute will
be set to true on each record object representing a group-level summary row. |
ListGrid |
setGroupSummaryStyle(java.lang.String groupSummaryStyle)
ListGridRecord.customStyle for the group-level
summary row displayed when showGroupSummary is
true. |
ListGrid |
setGroupTitleColumnProperties(ListGridField groupTitleColumnProperties)
Custom properties for the automatically generated
groupTitleColumn . |
ListGrid |
setGroupTitleField(java.lang.String groupTitleField)
When a list grid is
grouped , each group shows under an auto
generated header node. |
ListGrid |
setHeaderAriaRole(java.lang.String headerAriaRole)
|
ListGrid |
setHeaderAutoFitEvent(AutoFitEvent headerAutoFitEvent)
Event on a ListGrid header that triggers auto fitting to data and/or title.
|
ListGrid |
setHeaderBackgroundColor(java.lang.String headerBackgroundColor)
BackgroundColor for the header toolbar.
|
ListGrid |
setHeaderBarStyle(java.lang.String headerBarStyle)
Set the CSS style used for the header as a whole.
|
ListGrid |
setHeaderBaseStyle(java.lang.String headerBaseStyle)
Button.baseStyle to apply to the buttons in the header, and the
sorter, for this ListGrid. |
ListGrid |
setHeaderButtonAriaRole(java.lang.String headerButtonAriaRole)
Default
role for header buttons . |
ListGrid |
setHeaderButtonAriaState(java.util.Map headerButtonAriaState)
Default
ARIA state for header buttons . |
ListGrid |
setHeaderButtonProperties(Button headerButtonProperties)
Properties to apply to all header buttons.
|
ListGrid |
setHeaderHeight(int headerHeight)
The height of this listGrid's header, in pixels.
|
ListGrid |
setHeaderHoverAlign(Alignment headerHoverAlign)
This property may be set to customize the alignment for the hover shown on
ListGrid.headerHover() . |
void |
setHeaderHoverFormatter(HeaderHoverFormatter formatter)
Provide a custom implementation of
headerHoverHTML(int,java.lang.String) . |
ListGrid |
setHeaderHoverHeight(java.lang.Integer headerHoverHeight)
Optional default height for the hover shown on
ListGrid.headerHover() . |
ListGrid |
setHeaderHoverOpacity(java.lang.Integer headerHoverOpacity)
This property may be set to customize the opacity for the hover shown on
ListGrid.headerHover() . |
ListGrid |
setHeaderHoverStyle(java.lang.String headerHoverStyle)
This property may be set to customize the css style for the hover shown on
ListGrid.headerHover() . |
ListGrid |
setHeaderHoverVAlign(VerticalAlignment headerHoverVAlign)
This property may be set to customize the vertical alignment for the hover shown on
ListGrid.headerHover() . |
ListGrid |
setHeaderHoverWidth(java.lang.Integer headerHoverWidth)
Optional default width for the hover shown on
ListGrid.headerHover() . |
ListGrid |
setHeaderHoverWrap(java.lang.Boolean headerHoverWrap)
This property may be set to customize the
wrap attribute for the hover shown on ListGrid.headerHover() . |
ListGrid |
setHeaderMenuButtonHeight(int headerMenuButtonHeight)
If
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton |
ListGrid |
setHeaderMenuButtonHeight(java.lang.String headerMenuButtonHeight)
If
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton |
ListGrid |
setHeaderMenuButtonIcon(java.lang.String headerMenuButtonIcon)
If
showHeaderMenuButton is true, this property
governs the icon shown on the auto-generated headerMenuButton |
ListGrid |
setHeaderMenuButtonIconHeight(int headerMenuButtonIconHeight)
If
showHeaderMenuButton is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton |
ListGrid |
setHeaderMenuButtonIconWidth(int headerMenuButtonIconWidth)
If
showHeaderMenuButton is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton |
ListGrid |
setHeaderMenuButtonSnapOffsetLeft(java.lang.Integer headerMenuButtonSnapOffsetLeft)
Offset of the right edge of a
headerMenuButton
from the right edge of it's parent button. |
ListGrid |
setHeaderMenuButtonWidth(int headerMenuButtonWidth)
If
showHeaderMenuButton is true, this property
governs the width of the auto-generated headerMenuButton |
ListGrid |
setHeaderRadius(java.lang.String headerRadius)
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 the
header , and to the right
of the corner sort-button if it's visible, or the
right of the header otherwise. |
ListGrid |
setHeaderShadowColor(java.lang.String headerShadowColor)
If
showHeaderShadow is true, the Canvas.shadowColor for the header shadow. |
ListGrid |
setHeaderShadowHOffset(int headerShadowHOffset)
If
showHeaderShadow is true, the Canvas.shadowHOffset for the header shadow |
ListGrid |
setHeaderShadowSoftness(int headerShadowSoftness)
If
showHeaderShadow is true, the Canvas.shadowSoftness for the header shadow |
ListGrid |
setHeaderShadowVOffset(int headerShadowVOffset)
If
showHeaderShadow is true, the Canvas.shadowVOffset for the header shadow |
void |
setHeaderSpanBaseStyle(java.lang.String name,
java.lang.String newStyle)
Update the
HeaderSpan.headerBaseStyle for a span
within the grid at runtime. |
void |
setHeaderSpanButtonProperties(java.lang.String name,
Canvas properties)
Method to update properties on a headerSpan's header button at runtime.
|
void |
setHeaderSpanHeaderTitle(java.lang.String name,
java.lang.String newTitle)
Update the headerTitle of a
headerSpan dynamically. |
ListGrid |
setHeaderSpanHeight(java.lang.Integer headerSpanHeight)
Default height for a
headerSpan with no height
specified. |
ListGrid |
setHeaderSpans(HeaderSpan... headerSpans)
Header spans are a second level of headers that appear above the normal ListGrid headers,
spanning one or more listGrid fields in a manner similar to a column-spanning cell in an
HTML table.
|
void |
setHeaderSpanTitle(java.lang.String name,
java.lang.String newTitle)
Update the title of a
headerSpan dynamically. |
void |
setHeaderSpanTitleStyle(java.lang.String name,
java.lang.String newTitle)
Update the
HeaderSpan.headerTitleStyle for a
span within the grid at runtime. |
ListGrid |
setHeaderTitleStyle(java.lang.String headerTitleStyle)
StretchImgButton.titleStyle to apply to the buttons
in the header, and the sorter, for this ListGrid. |
ListGrid |
setHeaderTitleVAlign(VerticalAlignment headerTitleVAlign)
Specifies vertical alignment in the column headers: "top", "center", or "bottom".
|
ListGrid |
setHideEmptySummaryRow(java.lang.Boolean hideEmptySummaryRow)
If true, causes the
summaryRow component to be hidden if
it has no data after summaries have been recalculated |
ListGrid |
setHideFilterEditorTitle(java.lang.String hideFilterEditorTitle)
When
canShowFilterEditor is true, this is the
title for the filterEditor show/hide menu-item, in the headerContextmenu , when the filterEditor is visible. |
void |
setHideOnPhone(ListGridField field,
java.lang.Boolean hideOnPhone)
Updates the
ListGridField.hideOnPhone attribute at
runtime. |
void |
setHideOnTablet(ListGridField field,
java.lang.Boolean hideOnTablet)
Updates the
ListGridField.hideOnTablet attribute
at runtime. |
ListGrid |
setHiliteCanReplaceValue(java.lang.Boolean hiliteCanReplaceValue)
If set, end users can create advanced hiliting rules that will use the
Hilite.replacementValue feature to cause values in hilited cells to
be replaced with a user-entered value. |
ListGrid |
setHiliteEditorSpanTitleSeparator(java.lang.String hiliteEditorSpanTitleSeparator)
If this grid has specified
headerSpans , and showHeaderSpanTitlesInHiliteEditor is
true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser
grid. |
ListGrid |
setHiliteHTMLAfterFormat(boolean hiliteHTMLAfterFormat)
If set to true, custom HTML applied as part of hiliting will be applied after
formatting for each cell. |
ListGrid |
setHiliteIconHeight(java.lang.Integer hiliteIconHeight)
Height for hilite icons for this listGrid.
|
ListGrid |
setHiliteIconLeftPadding(int hiliteIconLeftPadding)
How much padding should there be on the left of
hilite
icons by default? Can be overridden at the field level |
ListGrid |
setHiliteIconPosition(HiliteIconPosition hiliteIconPosition)
When
hiliteIcons are present, where the hilite icon
will be placed relative to the field value. |
ListGrid |
setHiliteIconRightPadding(int hiliteIconRightPadding)
How much padding should there be on the right of
hilite
icons by default? Can be overridden at the field level |
ListGrid |
setHiliteIcons(java.lang.String... hiliteIcons)
Specifies a list of icons that can be used in
hilites . |
ListGrid |
setHiliteIconSize(int hiliteIconSize)
Default width and height of
hilite icons for this
component. |
ListGrid |
setHiliteIconWidth(java.lang.Integer hiliteIconWidth)
Width for hilite icons for this component.
|
ListGrid |
setHiliteProperty(java.lang.String hiliteProperty)
Marker that can be set on a record to flag that record as hilited.
|
ListGrid |
setHiliteReplaceValueFieldTitle(java.lang.String hiliteReplaceValueFieldTitle)
Title used for the text box shown when
hiliteCanReplaceValue is set. |
ListGrid |
setHiliteRowOnFocus(java.lang.Boolean hiliteRowOnFocus)
When the grid body gets keyboard focus, should we highlight the current focus row, using the rollover cell style?
|
ListGrid |
setHilites(Hilite[] hilites)
Accepts an array of hilite objects and applies them to this DataBoundComponent.
|
ListGrid |
setHiliteState(java.lang.String hiliteState)
Set the current hilites based on a hiliteState String previously returned from getHilitesState.
|
ListGrid |
setHiliteViaAIMode(AIServiceMode hiliteViaAIMode)
When
canHiliteViaAI is true , the AI
service mode to use. |
ListGrid |
setHiliteViaAIText(java.lang.String hiliteViaAIText)
Title for the menu item displayed in this component's header context menu when
AI-assisted hiliting is allowed. |
void |
setHoverCustomizer(HoverCustomizer hoverCustomizer)
HTML to be shown in hovers over cells in the column described by this field.
|
ListGrid |
setHoverMode(HoverMode hoverMode)
When
showHoverComponents is true, the builtin
mode to use when automatically creating a hover component for rows in this grid. |
ListGrid |
setHoverScreen(java.lang.String hoverScreen)
Screen to create (via
createScreen() ) in lieu of calling getHoverComponent() or getCellHoverComponent() . |
ListGrid |
setHoverStyle(java.lang.String hoverStyle)
Style to apply to hovers shown over this grid.
|
ListGrid |
setIconCursor(Cursor iconCursor)
Default cursor to display when the user rolls over icons within cells of an
type:icon field. |
ListGrid |
setIconPadding(java.lang.Integer iconPadding)
When using
autoFitFieldWidths , padding in pixels
left on each side of fields that show images. |
ListGrid |
setImageSize(int imageSize)
Default size of thumbnails shown for fieldTypes image and imageFile.
|
ListGrid |
setImplicitCriteria(Criteria implicitCriteria)
Criteria that are never shown to or edited by the user and are cumulative with any
criteria provided via
DataBoundComponent.initialCriteria ,
DataBoundComponent.setCriteria() etc. |
java.lang.Boolean |
setImplicitCriteria(Criteria implicitCriteria,
DSCallback callback) |
java.lang.Boolean |
setImplicitCriteria(Criteria criteria,
DSCallback callback,
java.lang.Boolean initialFetch) |
void |
setInactiveCellFormatter(CellFormatter formatter)
Formatter for inactive content.
|
ListGrid |
setIncludeHilitesInSummaryFields(boolean includeHilitesInSummaryFields)
When assembling a value for a
summary field , if
a referenced field is hilited, should the hilite HTML be included in the summary field value? |
ListGrid |
setIncludeInSummaryProperty(java.lang.String includeInSummaryProperty)
Property name on a record that will be checked to determine whether a record should be included when calculating totals
for the
grid summary . |
ListGrid |
setInitialCriteria(Criteria initialCriteria)
Criteria to use when
DataBoundComponent.setAutoFetchData(Boolean) is used. |
ListGrid |
setInitialSort(SortSpecifier... initialSort)
An array of
SortSpecifier objects used to set up the initial sort configuration for
this grid. |
ListGrid |
setInstantScrollTrackRedraw(java.lang.Boolean instantScrollTrackRedraw)
If true, if the user clicks on the scroll buttons at the end of the track or clicks once on the scroll track, there will
be an instant redraw of the grid content so that the user doesn't see any blank space.
|
ListGrid |
setInvalidSummaryValue(java.lang.String invalidSummaryValue)
Value to display to the user if showing summary values (through
showGridSummary , showGroupSummary or listGridFieldType:"summary" ), and the summary function returns
"null" (implying it was unable to calculate a valid summary value). |
ListGrid |
setIsSeparatorProperty(java.lang.String isSeparatorProperty)
If
record[this.isSeparatorProperty] is set for some record, the record will be displayed as a simple
separator row. |
ListGrid |
setLastCellStyle(java.lang.String lastCellStyle)
The style to apply to the last cell in each row, when
styledRowEnds is true. |
ListGrid |
setLeaveHeaderMenuButtonSpace(java.lang.Boolean leaveHeaderMenuButtonSpace)
If
showHeaderMenuButton is true, when
auto-fitting fields to the title width via autoFitFieldWidths or ListGridField.autoFitWidth , should the button be sized such that there is enough space for the header menu button to
show without covering the field title? |
ListGrid |
setLeaveScrollbarGap(java.lang.Boolean leaveScrollbarGap)
Whether to leave a gap for the vertical scrollbar, even when it's not present.
|
ListGrid |
setLinkTextProperty(java.lang.String linkTextProperty)
Property name on a record that will hold the link text for that record.
|
ListGrid |
setListEndEditAction(RowEndEditAction listEndEditAction)
If the user is editing the last record in this listGrid, and attempts to navigate beyond the last row either by tabbing
off the last editable field, or using the down arrow key, this property determines what action to take: "next":
start editing a new record at the end of the list.
|
ListGrid |
setLoadingDataMessage(java.lang.String loadingDataMessage)
The string to display in the body of a listGrid while data is being loaded.
|
ListGrid |
setLoadingDataMessageStyle(java.lang.String loadingDataMessageStyle)
The CSS style name applied to the loadingDataMessage string if displayed.
|
ListGrid |
setLoadingMessage(java.lang.String loadingMessage)
If you have a databound listGrid and you scroll out of the currently loaded dataset, by default you will see blank rows
until the server returns the data for those rows.
|
ListGrid |
setLoadingRowCountDisplayIcoHeight(int loadingRowCountDisplayIcoHeight)
Height for the
loadingRowCountDisplayIcon |
ListGrid |
setLoadingRowCountDisplayIcon(java.lang.String loadingRowCountDisplayIcon)
The URL of the icon to display as a
row count
value when the row count is loading. |
ListGrid |
setLoadingRowCountDisplayIconWidth(int loadingRowCountDisplayIconWidth)
Width for the
loadingRowCountDisplayIcon |
ListGrid |
setLocateColumnsBy(java.lang.String locateColumnsBy)
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the column be identified? Note that getLocator() will actually store all available information about the column in the generated string -- this attribute effects how a stored string will be parsed only. |
ListGrid |
setLocateRowsBy(java.lang.String locateRowsBy)
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the row be identified? Note that getLocator() will actually store all available information about the row in the generated string -- this attribute effects how a stored string will be parsed only. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.grid.ListGridLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
ListGrid |
setLongTextEditorThreshold(int longTextEditorThreshold)
When the length of the field specified by
DataSourceField.length exceeds this value, the ListGrid shows an edit field of type longTextEditorType rather than the standard text field
when the field enters inline edit mode. |
ListGrid |
setLongTextEditorType(java.lang.String longTextEditorType)
When the length of the field specified by
DataSourceField.length exceeds this.longTextEditorThreshold show an edit field of this type rather than
the standard text field when the field enters inline edit mode. |
ListGrid |
setMaxExpandedRecords(java.lang.Integer maxExpandedRecords)
When
canExpandRecords and canExpandMultipleRecords are both true, this
property dictates the number of records which can be expanded simultaneously. |
ListGrid |
setMaxExpandedRecordsPrompt(java.lang.String maxExpandedRecordsPrompt)
This is a dynamic string - text within
${...} will be evaluated as JS code when the message is
displayed. |
ListGrid |
setMaximumRowCountFormat(java.lang.String maximumRowCountFormat)
|
ListGrid |
setMaxSummaryRowRecords(java.lang.Integer maxSummaryRowRecords)
If
showGridSummary is true, and summary records are
being derived from a fetch against the summaryRowDataSource , this property may be set to specify the maximum expected number of results from the fetch
opeeration. |
ListGrid |
setMinFieldWidth(int minFieldWidth)
Minimum size, in pixels, for ListGrid headers.
|
ListGrid |
setMinHeight(int minHeight)
Sets the
minimum height for the entire list (smaller than this
doesn't tend to work very well). |