public class ListGrid extends VLayout implements DataBoundComponent, HasCellSavedHandlers, HasCellClickHandlers, HasCellContextClickHandlers, HasCellDoubleClickHandlers, HasCellErrorIconHoverHandlers, HasCellErrorIconOutHandlers, HasCellErrorIconOverHandlers, HasCellHoverHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellSelectionChangedHandlers, HasCellValueHoverHandlers, HasDataArrivedHandlers, HasDataChangedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasFilterEditorSubmitHandlers, HasFormulaUpdatedHandlers, HasGroupByCompleteHandlers, HasGroupStateChangedHandlers, HasGroupByHandlers, 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.Editing overview and related methodsconfig, 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.
|
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 |
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 |
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. |
protected 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 |
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 |
clearRowErrors(int rowNum)
Clear any stored validation errors for some row
|
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 |
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
Records passed in explicitly, or by index. |
void |
deselectRecords(Record[] records)
Deselect a list of
Records 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.
|
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.
|
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.
|
void |
exportData()
Uses a "fetch" operation on the current
DataSource
to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data
to a file or window in the requested format. |
void |
exportData(DSRequest requestProperties)
Uses a "fetch" operation on the current
DataSource
to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data
to a file or window in the requested format. |
void |
fetchData()
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchRelatedData(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) |
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 actually 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 actually 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 actually 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. |
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 |
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 should be drawn in alternating styles, in order to create a vertical "ledger" effect for
easier reading.
|
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 should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
|
java.lang.Boolean |
getAlwaysShowEditors()
When this attribute is set, editors will be rendered into every row of the grid rather than showing up in a single
record at a time.
|
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. |
boolean |
getApplyRowNumberStyle()
|
java.lang.String |
getArrowKeyAction()
Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the up or down arrow
key.
|
java.lang.String |
getAsynchGroupingPrompt()
The prompt to display while interactivity is blocked during
asynchronous grouping. |
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. |
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?
|
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" this property specifies the number of additional records for which the grid will expand. |
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. |
AutoFitWidthApproach |
getAutoFitWidthApproach()
When a user requests column autofitting via the
header context menu or via a mouse gesture, what autofit approach is used. |
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.
|
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.Boolean |
getCanAcceptDroppedRecords()
Indicates whether records can be dropped into this listGrid.
|
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.
|
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. 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 |
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 this grid has a specified
dataSource, and useAllDataSourceFields is false, setting this
property to true will cause all dataSource fields not included in the specified set of fields to show up in the field picker menu item. |
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. |
java.lang.Boolean |
getCanResizeFields()
Indicates whether fields in this listGrid can be resized by dragging header fields.
|
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" |
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
isc.setScreenReaderMode() is
called. |
Layout |
getCellContextMenu()
The menu displayed when a cell is right clicked on.
|
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()
The default height of 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.
|
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. |
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 |
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).
|
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. |
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.
|
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.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.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. |
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.
|
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 rows ahead of the currently visible area? This is expressed as a ratio from viewport size to
rendered area size.
|
int |
getDrawAllMaxCells()
If drawing all rows would cause less than
drawAllMaxCells cells to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
the viewport size and drawAheadRatio setting would
normally have caused incremental rendering to be used. |
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 |
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.
|
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.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.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 most recent mouse event.
|
int |
getEventColumn(java.lang.Integer x)
Returns the column number of the most recent mouse event.
|
int |
getEventRow()
Returns the row number of the most recent mouse event.
|
int |
getEventRow(java.lang.Integer y)
Returns the row number of the most recent mouse event.
|
ListGridRecord[] |
getExpandedRecords()
|
java.lang.Boolean |
getExpansionCanEdit()
For
expansionModes that show another grid or tree, is that component
editable? |
protected Canvas |
getExpansionComponent(ListGridRecord record)
Gets the embedded-component to show as a given record's expansionComponent.
|
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. |
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. |
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.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. |
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. |
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 we're re-filtering on every keypress (filterOnKeypress is true), this property is the delay in
milliseconds between the user changing the filter and the filter request being kicked off. |
java.lang.String |
getFetchOperation()
Operation ID this component should use when performing fetch operations.
|
ListGridField |
getField(int colNum)
Given a column number or field name, return the field definition of a field which is visible in the grid.
|
ListGridField |
getField(java.lang.String fieldName)
Given a column number or field name, return the field definition.
|
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 |
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.
|
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. |
java.lang.Boolean |
getFilterByCell()
If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be
filtered every time the user puts focus in a different field in the filter editor.
|
RecordEditor |
getFilterEditor()
If
showFilterEditor is set to true, the
filterEditor is automatically created as an AutoChild.Developers may customize the AutoChild using filterEditorProperties. |
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. |
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. |
java.lang.Boolean |
getFilterOnKeypress()
If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be
filtered every time the user modifies the value in a field of the filter-editor.
|
java.lang.String |
getFilterUsingText()
Text for the menu item shown in the
headerContextMenu when allowFilterOperators
is enabled. |
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 |
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 |
getFreezeOnLeftText()
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the left of the scrollable body. |
java.lang.String |
getFreezeOnRightText()
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the right of the scrollable body. |
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 |
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.
|
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.
|
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 |
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. |
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.
|
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.
|
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.
|
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. |
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 |
getHeaderMenuButtonIcon()
If
showHeaderMenuButton is true, this property
governs the icon shown on the auto-generated headerMenuButton |
int |
getHeaderMenuButtonIconHeight()
If
showHeaderMenuButton is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton |
int |
getHeaderMenuButtonIconWidth()
If
showHeaderMenuButton is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton |
int |
getHeaderMenuButtonWidth()
If
showHeaderMenuButton is true, this property
governs the width of the auto-generated headerMenuButton |
StatefulCanvas |
getHeaderSpan()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
protected 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. |
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.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.
|
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 |
getHoverStyle()
Style to apply to hovers shown over this grid.
|
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.
|
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.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.
|
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. |
int |
getMinFieldWidth()
Minimum size, in pixels, for ListGrid headers.
|
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.
|
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 |
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 |
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.Boolean |
getPoolComponentsPerColumn()
Should recycled
record components, be pooled
per column or per record. |
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). |
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.
|
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. |
ListGridRecord[] |
getRecords()
Returns the current set of records displayed in this grid as an array of ListGridRecord objects.
|
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 |
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)
If the
rollOverCanvas is enabled, this method will
be called to create the canvas to display over the current row or cell when a user moves their mouse over the row. |
protected Canvas |
getRollUnderCanvas(java.lang.Integer rowNum,
java.lang.Integer colNum)
If the
rollUnderCanvas is enabled, this method will
be called to create the canvas to display under the current row or cell when a user moves their mouse over the row. |
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.
|
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.
|
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 |
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()
When
screen reader mode is enabled, this invisible separator
string is written out between each cell value. |
java.lang.String |
getScreenReaderRowSeparator()
When
screen reader mode is enabled, this invisible string will
be written out after the last cell in a row. |
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.
|
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.Boolean |
getShowAllColumns()
Whether all columns should be drawn all at once, or only columns visible in the viewport.
|
java.lang.Boolean |
getShowAllRecords()
Whether all rows should be drawn all at once, or only rows 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 |
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 |
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. |
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 |
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, when the user hovers over a cell, hover text will pop up next to the mouse.
|
java.lang.Boolean |
getShowHoverComponents()
When set to true and canHover is also true, shows a widget hovering at the mouse point.
|
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 |
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.
|
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?
|
SortSpecifier[] |
getSort()
Returns the current
SortSpecifiers for this ListGrid. |
ImgProperties |
getSortAscendingImage()
Image to show when sorting ascending.
|
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. |
ImgProperties |
getSortDescendingImage()
Image to show when sorting descending.
|
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.
|
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.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.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 |
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.
|
ImgProperties |
getTrackerImage()
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 |
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. |
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 |
getUseCopyPasteShortcuts()
Enables copy/paste shortcuts, provided
canSelectCells is true |
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. |
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.
|
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 for the grid. |
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.Boolean |
hasChanges()
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 |
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.
|
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. |
boolean |
recordClick(ListGrid viewer,
ListGridRecord record,
int recordNum,
ListGridField field,
int fieldNum,
java.lang.Object value,
java.lang.Object rawValue)
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 components 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 components 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)
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 |
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
Records passed in explicitly, or by index. |
void |
selectRecords(int[] records,
boolean newState)
Select/deselect a list of
Records passed in explicitly, or by index. |
void |
selectRecords(Record[] records)
Select/deselect a list of
Records passed in explicitly, or by index. |
void |
selectRecords(Record[] records,
boolean newState)
Select/deselect a list of
Records passed in explicitly, or by index. |
void |
selectSingleRecord(int rowNum)
Select a single
Record passed in explicitly, or by index, and deselect everything else. |
void |
selectSingleRecord(Record record)
Select a single
Record passed in explicitly, or by index, and deselect everything else. |
void |
setAddDropValues(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.
|
void |
setAddFormulaFieldText(java.lang.String addFormulaFieldText)
Text for a menu item allowing users to add a formula field
|
void |
setAddOperation(java.lang.String addOperation)
operationId this component
should use when performing add operations. |
void |
setAddSummaryFieldText(java.lang.String addSummaryFieldText)
Text for a menu item allowing users to add a formula field
|
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
setAlternateBodyStyleName(java.lang.String alternateBodyStyleName)
Optional css style to apply to the body if
alternateRecordStyles is true for this grid. |
void |
setAlternateFieldFrequency(int alternateFieldFrequency)
The number of consecutive columns to draw in the same style before alternating, when
alternateColumnStyles is true. |
void |
setAlternateFieldStyles(boolean alternateFieldStyles)
Whether alternating columns should be drawn in alternating styles, in order to create a vertical "ledger" effect for
easier reading.
|
void |
setAlternateRecordFrequency(int alternateRecordFrequency)
The number of consecutive rows to draw in the same style before alternating, when
alternateRowStyles is true. |
void |
setAlternateRecordStyles(java.lang.Boolean alternateRecordStyles)
Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
|
void |
setAlwaysShowEditors(java.lang.Boolean alwaysShowEditors)
When this attribute is set, editors will be rendered into every row of the grid rather than showing up in a single
record at a time.
|
void |
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. |
void |
setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)
When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
|
void |
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. |
void |
setAnimateFolders(java.lang.Boolean animateFolders)
If true, when folders are opened / closed children will be animated into view.
|
void |
setAnimateFolderSpeed(int animateFolderSpeed)
When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden)
per second.
|
void |
setAnimateFolderTime(int animateFolderTime)
When animating folder opening / closing, if
TreeGrid.animateFolderSpeed is not set, this property designates the duration of the animation in ms. |
void |
setAnimateRemoveRecord(java.lang.Boolean animateRemoveRecord)
When
canRemoveRecords is enabled, should records
be animated out of view when they are removed by the user? |
void |
setAnimateRemoveSpeed(int animateRemoveSpeed)
When
animating record removal, this property
designates the speed of the animation in pixels per second. |
void |
setAnimateRemoveTime(int animateRemoveTime)
When animating record removal
(see
animateRemoveRecord), if animateRemoveSpeed is
not set, this property designates the duration of the animation in ms. |
void |
setAnimateRollOver(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(). |
void |
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(). |
void |
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(). |
void |
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(). |
void |
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. |
void |
setApplyRowNumberStyle(boolean applyRowNumberStyle)
|
void |
setArrowKeyAction(java.lang.String arrowKeyAction)
Action to perform when the listGrid has keyboard focus (but not editing focus) and a user presses the up or down arrow
key.
|
void |
setAsynchGroupingPrompt(java.lang.String asynchGroupingPrompt)
The prompt to display while interactivity is blocked during
asynchronous grouping. |
void |
setAutoComplete(AutoComplete autoComplete)
Whether to do inline autoComplete in text fields during inline editing
Overridden by ListGridField.autoComplete if specified. |
void |
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.
|
void |
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() |
void |
setAutoFetchData(java.lang.Boolean autoFetchData)
If true, when this component is first drawn, automatically call
DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . |
void |
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. |
void |
setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
If
autoFetchData is true, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call. |
void |
setAutoFitAllText(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. |
void |
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. |
void |
setAutoFitData(Autofit autoFitData)
Should this ListGrid automatically expand to accommodate the size of records and fields?
|
void |
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. |
void |
setAutoFitExtraRecords(java.lang.Integer autoFitExtraRecords)
If
autoFitData is set to "vertical" or
"both" this property specifies the number of additional records for which the grid will expand. |
void |
setAutoFitFieldsFillViewport(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. |
void |
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(). |
void |
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. |
void |
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. |
void |
setAutoFitIconFields(AutoFitIconFieldType autoFitIconFields)
Smart GWT listGrids have special logic to automatically size fields that are displayed as an icon - that is fields with
type:"icon", fields displaying only value icons, and boolean fields (which are rendered
as a checkmark type icon by default. |
void |
setAutoFitMaxColumns(int autoFitMaxColumns)
If
autoFitData is set to "horizontal" or
"both" this property provides the maximum number of columns for which the ListGrid will expand. |
void |
setAutoFitMaxHeight(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. |
void |
setAutoFitMaxRecords(int autoFitMaxRecords)
If
autoFitData is set to "vertical" or
"both" this property provides the maximum number of records for which the ListGrid will expand. |
void |
setAutoFitMaxWidth(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. |
void |
setAutoFitWidth(java.lang.String fieldName,
boolean autoFit)
Setter for
ListGridField.autoFitWidth. |
void |
setAutoFitWidthApproach(AutoFitWidthApproach autoFitWidthApproach)
When a user requests column autofitting via the
header context menu or via a mouse gesture, what autofit approach is used. |
void |
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). |
void |
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. |
void |
setBadFormulaResultValue(java.lang.String badFormulaResultValue)
If the result of a formula evaluation is invalid (specifically, if isNaN(result)==true), badFormulaResultValue is
displayed instead.
|
void |
setBaseStyle(java.lang.String baseStyle)
base cell style for this listGrid. |
void |
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. |
void |
setBodyOverflow(Overflow bodyOverflow)
Overflow setting for the "body", that is, the area of the grid where data values are rendered.
|
void |
setBodyStyleName(java.lang.String bodyStyleName)
CSS style used for the body of this grid.
|
void |
setBooleanBaseStyle(java.lang.String booleanBaseStyle)
An optional CSS style to apply to the checkbox image.
|
void |
setBooleanFalseImage(java.lang.String booleanFalseImage)
Image to display for a false value in a boolean field.
|
void |
setBooleanImageHeight(int booleanImageHeight)
|
void |
setBooleanImageWidth(int booleanImageWidth)
|
void |
setBooleanPartialImage(java.lang.String booleanPartialImage)
Image to display for a partially true value in a boolean field (typically selection).
|
void |
setBooleanTrueImage(java.lang.String booleanTrueImage)
Image to display for a true value in a boolean field.
|
void |
setCanAcceptDroppedRecords(java.lang.Boolean canAcceptDroppedRecords)
Indicates whether records can be dropped into this listGrid.
|
void |
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.
|
void |
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.
|
void |
setCanAutoFitFields(java.lang.Boolean canAutoFitFields)
Can the user perform one-time autofit for specific columns in this grid?
|
void |
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. |
void |
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. |
void |
setCanDragRecordsOut(java.lang.Boolean canDragRecordsOut)
Indicates whether records can be dragged from this listGrid and dropped elsewhere.
|
void |
setCanDragSelect(java.lang.Boolean canDragSelect)
If this property is true, users can drag the mouse to select several rows or cells.
|
void |
setCanDragSelectText(java.lang.Boolean canDragSelectText)
If this property is true, users can drag the mouse to select text within grid rows.
|
void |
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.
|
void |
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. If 'canEdit' is not set at the listGrid level, setting 'canEdit' to true at the field level enables the field to be edited inline. |
void |
setCanEditFieldAttribute(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.
|
void |
setCanEditHilites(boolean canEditHilites)
Adds an item to the header context menu allowing users to launch a dialog to define grid hilites using the
HiliteEditor. |
void |
setCanEditTitles(boolean canEditTitles)
If set to true, the
advanced field picker
provides an interface allowing users to modify fields' titles. |
void |
setCanExpandMultipleRecords(java.lang.Boolean canExpandMultipleRecords)
When
canExpandRecords is true, this property
indicates whether multiple records can be expanded simultaneously. |
void |
setCanExpandRecordProperty(java.lang.String canExpandRecordProperty)
Property name on a record that will be checked to determine whether a record can be expanded.
|
void |
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.
|
void |
setCanFocusInEmptyGrid(boolean canFocusInEmptyGrid)
If the listGrid is empty, should the user be able to put focus into the grid body by tabbing to it?
|
void |
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.
|
void |
setCanGroupBy(java.lang.Boolean canGroupBy)
If false, grouping via context menu will be disabled.
|
void |
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. |
void |
setCanMultiGroup(boolean canMultiGroup)
When true, indicates that this ListGrid supports grouping on multiple fields.
|
void |
setCanMultiSort(java.lang.Boolean canMultiSort)
When true, indicates that this ListGrid supports sorting on multiple fields.
|
void |
setCanPickFields(java.lang.Boolean canPickFields)
Indicates whether the field picker item and submenu should be present in the header context menu.
|
void |
setCanPickOmittedFields(java.lang.Boolean canPickOmittedFields)
If this grid has a specified
dataSource, and useAllDataSourceFields is false, setting this
property to true will cause all dataSource fields not included in the specified set of fields to show up in the field picker menu item. |
void |
setCanRemoveRecords(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). |
void |
setCanReorderFields(java.lang.Boolean canReorderFields)
Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.
|
void |
setCanReorderRecords(java.lang.Boolean canReorderRecords)
Indicates whether records can be reordered by dragging within this
ListGrid. |
void |
setCanResizeFields(java.lang.Boolean canResizeFields)
Indicates whether fields in this listGrid can be resized by dragging header fields.
|
void |
setCanSelectAll(java.lang.Boolean canSelectAll)
Controls whether a checkbox for selecting all records appears in the header with
selectionAppearance set to "checkbox" |
void |
setCanSelectCells(java.lang.Boolean canSelectCells)
Enables cell-level selection behavior as well as
cell-level rollover. |
void |
setCanSelectGroups(boolean canSelectGroups)
Controls whether a checkbox for selecting
groups appears in
the group node if SelectionAppearance is set to "checkbox" |
void |
setCanSort(java.lang.Boolean canSort)
Enables or disables interactive sorting behavior for this listGrid.
|
void |
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
isc.setScreenReaderMode() is
called. |
void |
setCellFormatter(CellFormatter formatter)
Sets a formatter that returns the HTML to display in each cell of the grid,
given the raw cell value.
|
void |
setCellHeight(int cellHeight)
The default height of each row in pixels.
|
void |
setCellPadding(int cellPadding)
The amount of empty space, in pixels, surrounding each value in its cell.
|
void |
setCellValueHoverFormatter(CellValueHoverFormatter formatter)
Provide a custom implementation of
cellValueHoverHTML(ListGridRecord, int, int, String). |
void |
setChartConstructor(java.lang.String chartConstructor)
Name of the Smart GWT Class to be used when creating charts.
|
void |
setChartType(ChartType chartType)
Default type of chart to plot.
|
void |
setCheckboxFieldFalseImage(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. |
void |
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. |
void |
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. |
void |
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 checkboxField)
Standard properties to apply to the automatically generated checkbox field, shown when
selectionAppearance is set to "checkbox". |
void |
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. |
void |
setChildExpansionMode(ExpansionMode childExpansionMode)
For
expansionModes that show another grid or tree, what the child's
expansionMode should be. |
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
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?
|
void |
setConfirmDiscardEdits(java.lang.Boolean confirmDiscardEdits)
For editable listGrids, outstanding unsaved edits when the user performs a new filter or sort will be discarded.
|
void |
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.
|
void |
setData(ListGridRecord... data)
A list of ListGridRecord objects, specifying the data to be used to populate the ListGrid.
|
void |
setData(Record[] data) |
void |
setData(RecordList data) |
void |
setDataFetchDelay(java.lang.Integer dataFetchDelay)
Delay in milliseconds before fetching data.
|
void |
setDataFetchMode(FetchMode dataFetchMode)
How to fetch and manage records retrieve from the server.
|
void |
setDataPageSize(int dataPageSize)
When using
data
paging, how many records to fetch at a time. |
void |
setDataProperties(ResultSet resultSetProperties)
For databound ListGrids, this attribute can be used to customize the
ResultSet object created for this grid when data is
fetched. |
void |
setDataSource(DataSource dataSource)
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.
|
void |
setDataSource(java.lang.String dataSource)
The DataSource that this component should bind to for default fields and for performing
DataSource requests. |
void |
setDateFormatter(DateDisplayFormat dateFormatter)
How should Date type values be displayed in this ListGrid by default?
|
void |
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". |
void |
setDatetimeFormatter(DateDisplayFormat datetimeFormatter)
Display format to use for fields specified as type 'datetime'.
|
void |
setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
Before we start editing values in this DataBoundComponent, should we perform a deep clone
of the underlying values.
|
void |
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.
|
void |
setDefaultFilterOperator(OperatorId defaultFilterOperator)
Default
filter operator to use for text-based fields in this grid's filter editor, when producing AdvancedCriteria. |
void |
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.
|
void |
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. |
void |
setDetailDS(DataSource detailDS)
If
canExpandRecords is true and listGrid.expansionMode is "related", this property specifies the
dataSource for the related records grid to be shown embedded in expanded records. |
void |
setDetailDS(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. |
void |
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. |
void |
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? |
void |
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). |
void |
setDragDataAction(DragDataAction dragDataAction)
Indicates what to do with data dragged into another DataBoundComponent.
|
void |
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.
|
void |
setDragTrackerMode(DragTrackerMode dragTrackerMode)
When records are being dragged from within a ListGrid, what sort of drag-tracker should be displayed?
Note that if multiple records are being dragged the displayed tracker will be based on the first selected record. |
void |
setDragTrackerStyle(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). |
void |
setDrawAheadRatio(float drawAheadRatio)
How far should we render rows ahead of the currently visible area? This is expressed as a ratio from viewport size to
rendered area size.
|
void |
setDrawAllMaxCells(int drawAllMaxCells)
If drawing all rows would cause less than
drawAllMaxCells cells to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
the viewport size and drawAheadRatio setting would
normally have caused incremental rendering to be used. |
void |
setDropValues(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. |
void |
setDuplicateDragMessage(java.lang.String duplicateDragMessage)
Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled. |
void |
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.
|
void |
setEditEvent(ListGridEditEvent editEvent)
Event that will trigger inline editing, see
ListGridEditEvent for options. |
void |
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 |
void |
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. |
void |
setEditFormulaFieldText(java.lang.String editFormulaFieldText)
Text for a menu item allowing users to edit a formula field
|
void |
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)?
|
void |
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. |
void |
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. |
void |
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. |
void |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
void |
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.
|
void |
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). |
void |
setEmptyMessage(java.lang.String emptyMessage)
The string to display in the body of a listGrid with an empty data array, if showEmptyMessage is true.
|
void |
setEmptyMessageStyle(java.lang.String emptyMessageStyle)
The CSS style name applied to the
emptyMessage if
displayed. |
void |
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. |
void |
setEnterKeyEditAction(EnterKeyEditAction enterKeyEditAction)
What to do when a user hits enter while editing a cell: "nextCell": start editing the next editable cell in
this record (or the first editable cell in the next record if focus is in the last editable cell in the row)
"nextRow": start editing the same field in the next row (skipping any rows where that would be a non-editable
cell.
|
void |
setEnumCriteriaAsInitialValues(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. |
void |
setErrorIconHeight(java.lang.Integer errorIconHeight)
Height of the error icon, if we're showing icons when validation errors occur.
|
void |
setErrorIconSrc(java.lang.String errorIconSrc)
Src of the image to show as an error icon, if we're showing icons when validation errors occur.
|
void |
setErrorIconWidth(java.lang.Integer errorIconWidth)
Height of the error icon, if we're showing icons when validation errors occur.
|
void |
setEscapeKeyEditAction(EscapeKeyEditAction escapeKeyEditAction)
What to do when a user hits escape while editing a cell: "cancel": close the editor and discard the current set
of edit values "done": just close the editor (the edit is complete, but the edited values are retained).
|
void |
setExpansionCanEdit(java.lang.Boolean expansionCanEdit)
For
expansionModes that show another grid or tree, is that component
editable? |
void |
setExpansionComponentPoolingMode(ExpansionComponentPoolingMode expansionComponentPoolingMode)
The method of
component-pooling to employ for expansionComponents. |
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
setExpansionMode(ExpansionMode expansionMode)
The
ExpansionMode for records in this grid. |
void |
setExportAll(java.lang.Boolean exportAll)
Setting exportAll to true prevents the component from passing its list of fields to the
export call.
|
void |
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. |
void |
setExportDefaultBGColor(java.lang.String exportDefaultBGColor)
Default background color to use when exporting data to Excel/OpenOffice format using
exportData() or exportClientData(). |
void |
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. |
void |
setExportFields(java.lang.String[] exportFields)
The list of field-names to export.
|
void |
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. |
void |
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. |
void |
setExportRawValues(java.lang.Boolean exportRawValues)
Dictates whether the data in this grid should be exported raw by
exportClientData(). |
void |
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.
|
void |
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. |
void |
setFastCellUpdates(java.lang.Boolean fastCellUpdates)
Note: This property only has an effect in Internet Explorer
|
void |
setFetchDelay(int fetchDelay)
If we're showing the filterEditor (
showFilterEditor is true), and we're re-filtering on every keypress (filterOnKeypress is true), this property is the delay in
milliseconds between the user changing the filter and the filter request being kicked off. |
void |
setFetchOperation(java.lang.String fetchOperation)
Operation ID this component should use when performing fetch operations.
|
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 |
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 |
setFieldPickerFieldProperties(java.lang.String... fieldPickerFieldProperties)
Names of properties on
ListGridField for which the FieldPicker should show an editing interface, for convenience. |
void |
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.
|
void |
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. |
void |
setFields(ListGridField... fields)
An array of field objects, specifying the order, layout, formatting, and sorting behavior of each field in the listGrid
object.
|
void |
setFieldState(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.
|
void |
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. |
void |
setFilterButtonPrompt(java.lang.String filterButtonPrompt)
The prompt to show when the mouse hovers over the Filter button in the FilterEditor.
|
void |
setFilterButtonProperties(Button filterButtonProperties)
If
showFilterEditor is true, this attribute may be
used to customize the filter button shown to the right of the filterEditor row. |
void |
setFilterByCell(java.lang.Boolean filterByCell)
If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be
filtered every time the user puts focus in a different field in the filter editor.
|
void |
setFilterEditorCriteria(Criteria criteria)
If
showFilterEditor is true, this method will
update the criteria shown in the filterEditor without performing a filter. |
void |
setFilterEditorHeight(int filterEditorHeight)
Height for the filterEditor, if shown.
|
void |
setFilterEditorProperties(ListGrid filterEditorProperties)
Deprecated.
in favor of
setFilterEditorProperties(RecordEditor) |
void |
setFilterEditorProperties(RecordEditor filterEditorProperties)
Properties to apply to the automatically generated
filterEditor if showFilterEditor is true. |
void |
setFilterLocalData(java.lang.Boolean filterLocalData)
Causes filtering to be performed against the local data set, even when a
dataSource is provided. |
void |
setFilterOnKeypress(java.lang.Boolean filterOnKeypress)
If we're showing the filterEditor (this.showFilterEditor is true), this property determines whether this list should be
filtered every time the user modifies the value in a field of the filter-editor.
|
void |
setFilterUsingText(java.lang.String filterUsingText)
Text for the menu item shown in the
headerContextMenu when allowFilterOperators
is enabled. |
void |
setFixedFieldWidths(java.lang.Boolean fixedFieldWidths)
Should we horizontally clip cell contents, or allow columns to expand horizontally to show all contents?
|
void |
setFixedRecordHeights(java.lang.Boolean fixedRecordHeights)
Should we vertically clip cell contents, or allow rows to expand vertically to show all contents?
|
void |
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. |
void |
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. |
void |
setFreezeOnLeftText(java.lang.String freezeOnLeftText)
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the left of the scrollable body. |
void |
setFreezeOnRightText(java.lang.String freezeOnRightText)
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the right of the scrollable body. |
void |
setFrozenBaseStyle(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.
|
void |
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.
|
void |
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.
|
void |
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.
|
void |
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.
|
void |
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.
|
void |
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.
|
void |
setGridComponents(ListGridComponent... gridComponents)
Array of components that make up this grid.
|
void |
setGridComponents(java.lang.Object... gridComponents)
Array of components that make up this grid.
|
void |
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. |
void |
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.
|
void |
setGroupByField(java.lang.String... groupByField)
List of fields to group grid records.
|
void |
setGroupByField(java.lang.String groupByField)
List of fields to group grid records.
|
void |
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. |
void |
setGroupByMaxRecords(int groupByMaxRecords)
Maximum number of records to which a groupBy can be applied.
|
void |
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. |
void |
setGroupIcon(java.lang.String groupIcon)
The URL of the base icon for the group icons in this listGrid.
|
void |
setGroupIconSize(int groupIconSize)
Default width and height of group icons for this ListGrid.
|
void |
setGroupIndentSize(int groupIndentSize)
Default number of pixels by which to indent subgroups relative to parent group.
|
void |
setGroupLeadingIndent(int groupLeadingIndent)
Default number of pixels by which to indent all groups.
|
void |
setGroupNodeBaseStyle(java.lang.String groupNodeBaseStyle)
Base style for group rows. |
void |
setGroupNodeStyle(java.lang.String groupNodeStyle)
The CSS style that
group rows will have. |
void |
setGroupSortDirection(SortDirection groupSortDirection)
When
sortByGroupFirst is active, the sorting
direction applied 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) |
void |
setGroupState(java.lang.String groupState)
Initial group state for the grid.
|
void |
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. |
void |
setGroupSummaryStyle(java.lang.String groupSummaryStyle)
ListGridRecord.customStyle for the group-level
summary row displayed when showGroupSummary is
true. |
void |
setGroupTitleColumnProperties(ListGridField groupTitleColumnProperties)
Custom properties for the automatically generated
groupTitleColumn. |
void |
setGroupTitleField(java.lang.String groupTitleField)
When a list grid is
grouped, each group shows under an auto
generated header node. |
void |
setHeaderAutoFitEvent(AutoFitEvent headerAutoFitEvent)
Event on a ListGrid header that triggers auto fitting to data and/or title.
|
void |
setHeaderBackgroundColor(java.lang.String headerBackgroundColor)
BackgroundColor for the header toolbar.
|
void |
setHeaderBarStyle(java.lang.String headerBarStyle)
Set the CSS style used for the header as a whole.
|
void |
setHeaderBaseStyle(java.lang.String headerBaseStyle)
Button.baseStyle to apply to the buttons in the header, and the
sorter, for this ListGrid. |
void |
setHeaderButtonProperties(Button headerButtonProperties)
Properties to apply to all header buttons.
|
void |
setHeaderHeight(int headerHeight)
The height of this listGrid's header, in pixels.
|
void |
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). |
void |
setHeaderHoverHeight(java.lang.Integer headerHoverHeight)
Optional default height for the hover shown on
ListGrid.headerHover(). |
void |
setHeaderHoverOpacity(java.lang.Integer headerHoverOpacity)
This property may be set to customize the opacity for the hover shown on
ListGrid.headerHover(). |
void |
setHeaderHoverStyle(java.lang.String headerHoverStyle)
This property may be set to customize the css style for the hover shown on
ListGrid.headerHover(). |
void |
setHeaderHoverVAlign(VerticalAlignment headerHoverVAlign)
This property may be set to customize the vertical alignment for the hover shown on
ListGrid.headerHover(). |
void |
setHeaderHoverWidth(java.lang.Integer headerHoverWidth)
Optional default width for the hover shown on
ListGrid.headerHover(). |
void |
setHeaderHoverWrap(java.lang.Boolean headerHoverWrap)
This property may be set to customize the
wrap attribute for the hover shown on ListGrid.headerHover(). |
void |
setHeaderMenuButtonHeight(int headerMenuButtonHeight)
If
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton |
void |
setHeaderMenuButtonIcon(java.lang.String headerMenuButtonIcon)
If
showHeaderMenuButton is true, this property
governs the icon shown on the auto-generated headerMenuButton |
void |
setHeaderMenuButtonIconHeight(int headerMenuButtonIconHeight)
If
showHeaderMenuButton is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton |
void |
setHeaderMenuButtonIconWidth(int headerMenuButtonIconWidth)
If
showHeaderMenuButton is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton |
void |
setHeaderMenuButtonWidth(int headerMenuButtonWidth)
If
showHeaderMenuButton is true, this property
governs the width of the auto-generated headerMenuButton |
void |
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. |
void |
setHeaderSpanHeight(java.lang.Integer headerSpanHeight)
Default height for a
headerSpan with no height
specified. |
void |
setHeaderSpans(HeaderSpan... headerSpans)
Header spans are a second level of headers that appear above the normal ListGrid headers,
spanning one or more listGrid fields in a manner similar to a column-spanning cell in an
HTML table.
|
void |
setHeaderSpanTitle(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. |
void |
setHeaderTitleStyle(java.lang.String headerTitleStyle)
StretchImgButton.titleStyle to apply to the buttons
in the header, and the sorter, for this ListGrid. |
void |
setHideEmptySummaryRow(java.lang.Boolean hideEmptySummaryRow)
If true, causes the
summaryRow component to be hidden if
it has no data after summaries have been recalculated |
void |
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. |
void |
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. |
void |
setHiliteHTMLAfterFormat(boolean hiliteHTMLAfterFormat)
If set to true, custom HTML applied as part of hiliting will be applied after
formatting for each cell. |
void |
setHiliteIconHeight(java.lang.Integer hiliteIconHeight)
Height for hilite icons for this listGrid.
|
void |
setHiliteIconLeftPadding(int hiliteIconLeftPadding)
How much padding should there be on the left of
hilite
icons by default? Can be overridden at the field level |
void |
setHiliteIconPosition(HiliteIconPosition hiliteIconPosition)
When
hiliteIcons are present, where the hilite icon
will be placed relative to the field value. |
void |
setHiliteIconRightPadding(int hiliteIconRightPadding)
How much padding should there be on the right of
hilite
icons by default? Can be overridden at the field level |
void |
setHiliteIcons(java.lang.String... hiliteIcons)
Specifies a list of icons that can be used in
hilites. |
void |
setHiliteIconSize(int hiliteIconSize)
Default width and height of
hilite icons for this
component. |
void |
setHiliteIconWidth(java.lang.Integer hiliteIconWidth)
Width for hilite icons for this component.
|
void |
setHiliteProperty(java.lang.String hiliteProperty)
Marker that can be set on a record to flag that record as hilited.
|
void |
setHiliteReplaceValueFieldTitle(java.lang.String hiliteReplaceValueFieldTitle)
Title used for the text box shown when
hiliteCanReplaceValue is set. |
void |
setHiliteRowOnFocus(java.lang.Boolean hiliteRowOnFocus)
When the grid body gets keyboard focus, should we highlight the current focus row, using the rollover cell style?
|
void |
setHilites(Hilite[] hilites)
Accepts an array of hilite objects and applies them to this DataBoundComponent.
|
void |
setHiliteState(java.lang.String hiliteState)
Set the current hilites based on a hiliteState String previously returned from getHilitesState.
|
void |
setHoverCustomizer(HoverCustomizer hoverCustomizer)
HTML to be shown in hovers over cells in the column described by this field.
|
void |
setHoverMode(HoverMode hoverMode)
When
showHoverComponents is true, the builtin
mode to use when automatically creating a hover component for rows in this grid. |
void |
setHoverStyle(java.lang.String hoverStyle)
Style to apply to hovers shown over this grid.
|
void |
setIconPadding(java.lang.Integer iconPadding)
When using
autoFitFieldWidths, padding in pixels
left on each side of fields that show images. |
void |
setImageSize(int imageSize)
Default size of thumbnails shown for fieldTypes image and imageFile.
|
void |
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? |
void |
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. |
void |
setInitialCriteria(Criteria initialCriteria)
Criteria to use when
DataBoundComponent.setAutoFetchData(Boolean) is used. |
void |
setInitialSort(SortSpecifier... initialSort)
An array of
SortSpecifier objects used to set up the initial sort configuration for
this grid. |
void |
setInstantScrollTrackRedraw(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.
|
void |
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). |
void |
setIsSeparatorProperty(java.lang.String isSeparatorProperty)
If
record[this.isSeparatorProperty] is set for some record, the record will be displayed as a simple
separator row. |
void |
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? |
void |
setLeaveScrollbarGap(java.lang.Boolean leaveScrollbarGap)
Whether to leave a gap for the vertical scrollbar, even when it's not present.
|
void |
setLinkTextProperty(java.lang.String linkTextProperty)
Property name on a record that will hold the link text for that record.
|
void |
setListEndEditAction(RowEndEditAction listEndEditAction)
If the user is editing the last record in this listGrid, and attempts to navigate beyond the last row either by tabbing
off the last editable field, or using the down arrow key, this property determines what action to take: "next":
start editing a new record at the end of the list.
|
void |
setLoadingDataMessage(java.lang.String loadingDataMessage)
The string to display in the body of a listGrid while data is being loaded.
|
void |
setLoadingDataMessageStyle(java.lang.String loadingDataMessageStyle)
The CSS style name applied to the loadingDataMessage string if displayed.
|
void |
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.
|
void |
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. |
void |
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. |
void |
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. |
void |
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. |
void |
setMaxExpandedRecords(java.lang.Integer maxExpandedRecords)
When
canExpandRecords and canExpandMultipleRecords are both true, this
property dictates the number of records which can be expanded simultaneously. |
void |
setMaxExpandedRecordsPrompt(java.lang.String maxExpandedRecordsPrompt)
This is a dynamic string - text within
${...} will be evaluated as JS code when the message is
displayed. |
void |
setMinFieldWidth(int minFieldWidth)
Minimum size, in pixels, for ListGrid headers.
|
void |
setMissingSummaryFieldValue(java.lang.String missingSummaryFieldValue)
If a summary format string contains an invalid field reference, replace the reference with the missingSummaryFieldValue.
|
void |
setModalEditing(java.lang.Boolean modalEditing)
If this property is true, any mouse click outside of the open cell editors will end editing mode, hiding the cell
editors and saving any changes to those cell values.
|
void |
setMultiSortDialogDefaults(MultiSortDialog multiSortDialogDefaults)
Class level defaults to apply to the
MultiSortDialog which gets automatically
generated when askForSort.() is called. |
void |
setMultiSortDialogProperties(MultiSortDialog multiSortDialogProperties)
Properties to apply to the
MultiSortDialog which gets automatically generated when
askForSort.() is called. |
void |
setNavigateOnTab(boolean navigateOnTab)
If
canSelectCells is true, this property allows the
user to navigate through the cells of a grid using Tab and Shift+Tab keypresses. |
void |
setNeverValidate(java.lang.Boolean neverValidate)
If true, validation will not occur as a result of cell editing for this grid.
|
void |
setNormalBaseStyle(java.lang.String normalBaseStyle)
"Normal" baseStyle for this listGrid.
|
void |
setNormalCellHeight(int normalCellHeight)
If
baseStyle is unset, base style will be derived from
normalBaseStyle if this grid has fixed row heights
and the specified cellHeight matches this value. |
void |
setNullGroupTitle(java.lang.String nullGroupTitle)
Default alias to use for groups with no value
|
void |
setOfflineMessageStyle(java.lang.String offlineMessageStyle)
The CSS style name applied to the
offlineMessage if displayed. |
void |
setOriginBaseStyle(java.lang.String originBaseStyle)
Name of a CSS Style to use as the
baseStyle for a cell
that is currently a selection origin for shifted incremental cell selection. |
void |
setOverflow(Overflow overflow)
|
void |
setPoolComponentsPerColumn(java.lang.Boolean poolComponentsPerColumn)
Should recycled
record components, be pooled
per column or per record. |
void |
setPreventDuplicates(java.lang.Boolean preventDuplicates)
If set, detect and prevent duplicate records from being transferred to this component, either via
drag and drop or via
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). |
void |
setPrintAutoFit(java.lang.Boolean printAutoFit)
Whether cell contents should wrap during printing.
|
void |
setPrintBaseStyle(java.lang.String printBaseStyle)
Style for non-header cells in printed output.
|
void |
setPrintBooleanBaseStyle(java.lang.String printBooleanBaseStyle)
If set, the
booleanBaseStyle to use when printing. |
void |
setPrintBooleanFalseImage(java.lang.String printBooleanFalseImage)
If set, the
booleanFalseImage to use when printing. |
void |
setPrintBooleanPartialImage(java.lang.String printBooleanPartialImage)
If set, the
booleanPartialImage to use when
printing. |
void |
setPrintBooleanTrueImage(java.lang.String printBooleanTrueImage)
If set, the
booleanTrueImage to use when printing. |
void |
setPrintCheckboxFieldFalseImage(java.lang.String printCheckboxFieldFalseImage)
If set, the
checkboxFieldFalseImage to use
when printing. |
void |
setPrintCheckboxFieldPartialImage(java.lang.String printCheckboxFieldPartialImage)
If set, the
checkboxFieldPartialImage to
use when printing. |
void |
setPrintCheckboxFieldTrueImage(java.lang.String printCheckboxFieldTrueImage)
If set, the
checkboxFieldTrueImage to use
when printing. |
void |
setPrintHeaderStyle(java.lang.String printHeaderStyle)
Style for header cells in printed output.
|
void |
setPrintMaxRows(int printMaxRows)
Advanced property - when generating printHTML for a large ListGrid, rows are printed in batches in order to avoid
triggering a native "script is running slowly" browser dialog.
|
void |
setPrintWrapCells(java.lang.Boolean printWrapCells)
Whether cell contents should wrap during printing.
|
void |
setProgressiveLoading(java.lang.Boolean progressiveLoading)
Indicates whether or not this component will load its data
progressively |
void |
setQuickDrawAheadRatio(float quickDrawAheadRatio)
Alternative to
drawAheadRatio, to be used when the
user is rapidly changing the grids viewport (for example drag scrolling through the grid). |
void |
setRecordBaseStyleProperty(java.lang.String recordBaseStyleProperty)
This attribute allows custom base styles to be displayed on a per-record basis.
|
void |
setRecordCanRemoveProperty(java.lang.String recordCanRemoveProperty)
If set to false on a record and
canRemoveRecords
is true, removal of that record is disallowed in the UI. |
void |
setRecordCanSelectProperty(java.lang.String recordCanSelectProperty)
If set to false on a record, selection of that record is disallowed.
|
void |
setRecordComponentHeight(java.lang.Integer recordComponentHeight)
If
showRecordComponents is true, this
attribute may be used to specify a standard height for record components. |
void |
setRecordComponentPoolingMode(RecordComponentPoolingMode recordComponentPoolingMode)
The method of
component-pooling to employ for recordComponents. |
void |
setRecordComponentPosition(EmbeddedPosition recordComponentPosition)
if
showRecordComponents is true, how should
the component appear within the cell. |
void |
setRecordDetailDSProperty(java.lang.String recordDetailDSProperty)
The name of the ListGridRecord property that specifies the DataSource to use when
listGrid.expansionMode is "related". |
void |
setRecordDropAppearance(RecordDropAppearance recordDropAppearance)
If
canAcceptDroppedRecords is true for this
listGrid, this property governs whether the user can drop between, or over records within the grid. |
void |
setRecordEditProperty(java.lang.String recordEditProperty)
Property name on a record that should be checked to determine whether the record may be edited.
|
void |
setRecordEnabledProperty(java.lang.String recordEnabledProperty)
Property name on a record that will be checked to determine whether a record is enabled.
|
void |
setRecords(ListGridRecord[] records)
Synonym for
setData(ListGridRecord[]) |
void |
setRecordSummaryBaseStyle(java.lang.String recordSummaryBaseStyle)
If showing any record summary fields (IE: fields of
type:"summary"),
this attribute specifies a custom base style to apply to cells in the summary field |
void |
setRemovedCSSText(java.lang.String removedCSSText)
Custom CSS text to be applied to records that have been
marked for removal. |
void |
setRemoveFieldProperties(ListGridField removeFieldProperties)
Configuration properties for the "remove field" displayed when
canRemoveRecords is enabled. |
void |
setRemoveFieldTitle(java.lang.String removeFieldTitle)
The title to use for the
remove field. |
void |
setRemoveIcon(java.lang.String removeIcon)
When
canRemoveRecords is enabled, default icon to
show in the auto-generated field that allows removing records. |
void |
setRemoveIconSize(int removeIconSize)
Default width and height of
remove icons for this
ListGrid. |
void |
setRemoveOperation(java.lang.String removeOperation)
operationId this component
should use when performing remove operations. |
void |
setReselectOnUpdate(boolean reselectOnUpdate)
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. |
void |
setReselectOnUpdateNotifications(SelectionNotificationType reselectOnUpdateNotifications)
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. |
void |
setResizeFieldsInRealTime(boolean resizeFieldsInRealTime)
If
true, the grid contents are redrawn in real time as fields are resized. |
void |
setReverseRTLAlign(java.lang.Boolean reverseRTLAlign)
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)? |
void |
setRollOverCanvasProperties(Canvas rollOverCanvasProperties)
Properties to apply to the auto-generated
rollOverCanvas
AutoChild when its use is enabled. |
void |
setRollUnderCanvasProperties(Canvas rollUnderCanvasProperties)
Properties to apply to the auto-generated
rollUnderCanvas
AutoChild when its use is enabled. |
void |
setRowEndEditAction(RowEndEditAction rowEndEditAction)
If the user is editing a record in this listGrid, and attempts to navigate to a field beyond the end of the row, via tab
(or shift-tab off the first editable field), this property determines what action to take: "next": start editing
the next (or previous) record in the list "same": put focus back into the first editable field of the same record.
|
void |
setRowErrors(int rowNum,
java.util.Map errors)
Set the validation errors for some row (replacing any pre-existent validation errors)
|
void |
setRowErrors(int rowNum,
java.lang.Object errors)
Set the validation errors for some row (replacing any pre-existent validation errors)
|
void |
setRowNumberFieldProperties(ListGridField rowNumberFieldProperties)
Set the properties generated field that displays the current row number when
showRowNumbers is true. |
void |
setRowNumberStart(int rowNumberStart)
The number to start the row-count from - default value is 1.
|
void |
setRowNumberStyle(java.lang.String rowNumberStyle)
The CSS Style name for the
rowNumberField. |
void |
setRowSpanEditMode(RowSpanEditMode rowSpanEditMode)
If
allowRowSpanning is enabled, this property may
be used to specify editing behavior for cells that span multiple rows. |
void |
setRowSpanSelectionMode(RowSpanSelectionMode rowSpanSelectionMode)
Chooses the selection mode when
useRowSpanStyling
is enabled. |
void |
setSaveByCell(java.lang.Boolean saveByCell)
Whether edits should be saved whenever the user moves between cells in the current edit row.
|
void |
setSaveLocally(java.lang.Boolean saveLocally)
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. |
void |
setSaveRequestProperties(DSRequest saveRequestProperties)
For editable grids with a specified
dataSource, where
saveLocally is false, this attribute may be used to
specify standard DSRequest properties to apply to all save operations performed by this grid (whether triggered by user
interaction, or explicit saveEdits or saveAllEdits call). |
void |
setScreenReaderCellSeparator(java.lang.String screenReaderCellSeparator)
When
screen reader mode is enabled, this invisible separator
string is written out between each cell value. |
void |
setScreenReaderRowSeparator(java.lang.String screenReaderRowSeparator)
When
screen reader mode is enabled, this invisible string will
be written out after the last cell in a row. |
void |
setScrollRedrawDelay(int scrollRedrawDelay)
While drag scrolling in an incrementally rendered grid, time in milliseconds to wait before redrawing, after the last
mouse movement by the user.
|
void |
setScrollToCellXPosition(Alignment scrollToCellXPosition)
When scrollToCell is called, this is used as defaults if xPosition weren't explicitly passed into the method.
|
void |
setScrollToCellYPosition(VerticalAlignment scrollToCellYPosition)
When scrollToCell is called, this is used as defaults if yPosition weren't explicitly passed into the method.
|
void |
setScrollWheelRedrawDelay(java.lang.Integer scrollWheelRedrawDelay)
While scrolling an incrementally rendered grid, using the mouseWheel, time in milliseconds to wait before redrawing,
after the last mouseWheel movement by the user.
|
void |
setSelectedState(java.lang.String selectedState)
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).If this method is called after the component has been drawn/initialized: Reset this grid's selection to match the ListGridSelectedState object passed in.Used to restore previous state retrieved from the grid by a call to getSelectedState(). |
void |
setSelectHeaderOnSort(java.lang.Boolean selectHeaderOnSort)
If true, show the field-header for the sorted field (or the first field in a
multi-sort grid) in the selected state. |
void |
setSelectionAppearance(SelectionAppearance selectionAppearance)
How selection of rows should be presented to the user.
|
void |
setSelectionCanvasProperties(Canvas selectionCanvasProperties)
Properties to apply to the auto-generated
selectionCanvas AutoChild when
its use is enabled. |
void |
setSelectionProperty(java.lang.String selectionProperty)
If specified, the selection object for this list will use this property to mark records as selected.
|
void |
setSelectionType(SelectionStyle selectionType)
Defines a listGrid's clickable-selection behavior.
|
void |
setSelectionUnderCanvasProperties(Canvas selectionUnderCanvasProperties)
Properties to apply to the auto-generated
selectionUnderCanvas AutoChild when
its use is enabled. |
void |
setSelectOnEdit(java.lang.Boolean selectOnEdit)
When the user starts editing a row, should the row also be selected?
|
void |
setSelectOnExpandRecord(boolean selectOnExpandRecord)
When set to false, clicking a record's
expansion
field will not add the record to the current selection. |
void |
setShowAllColumns(java.lang.Boolean showAllColumns)
Whether all columns should be drawn all at once, or only columns visible in the viewport.
|
void |
setShowAllRecords(java.lang.Boolean showAllRecords)
Whether all rows should be drawn all at once, or only rows visible in the viewport.
|
void |
setShowAsynchGroupingPrompt(java.lang.Boolean showAsynchGroupingPrompt)
If set to false, do not show the
asynchGroupingPrompt dialog during asynchronous grouping. |
void |
setShowBackgroundComponents(java.lang.Boolean showBackgroundComponents)
If
true this grid will create and show per-row backgroundComponents as detailed here. |
void |
setShowCellContextMenus(java.lang.Boolean showCellContextMenus)
Whether to show a context menu with standard items for all context clicks on rows in the body.
|
void |
setShowClippedHeaderTitlesOnHover(boolean showClippedHeaderTitlesOnHover)
If true and a header button's title is clipped, then a hover containing the full field title is enabled.
|
void |
setShowClippedValuesOnHover(java.lang.Boolean showClippedValuesOnHover)
If true and a cell's value is clipped, then a hover containing the full cell value is enabled.
|
void |
setShowCollapsedGroupSummary(java.lang.Boolean showCollapsedGroupSummary)
Should group summaries be visible when the group is collapsed?
|
void |
setShowComplexFields(java.lang.Boolean showComplexFields)
Whether to show fields of non-atomic types when a DataBoundComponent is given a
DataSource but no
component.fields.
|
void |
setShowDetailFields(java.lang.Boolean showDetailFields)
Whether to include fields marked
detail:true from this component's DataSource. |
void |
setShowEmptyMessage(java.lang.Boolean showEmptyMessage)
Indicates whether the text of the emptyMessage property should be displayed if no data is available.
|
void |
setShowErrorIcons(boolean showErrorIcons)
If this grid is editable, and an edit has caused validation failure for some cell, should we show an icon to indicate
validation failure?
|
void |
setShowFilterEditor(boolean showFilterEditor)
Should this listGrid display a filter row.
|
void |
setShowGridSummary(java.lang.Boolean showGridSummary)
Should this ListGrid show a summary row beneath the last record of the grid.
|
void |
setShowGroupSummary(java.lang.Boolean showGroupSummary)
If this listGrid supports
grouping, setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields. |
void |
setShowGroupSummaryInHeader(java.lang.Boolean showGroupSummaryInHeader)
If this grid is
grouped, and showGroupSummary is true, setting this property causes
field summary values for each group to be displayed directly in the group header node, rather than showing up at the
bottom of each expanded group. |
void |
setShowGroupTitleColumn(java.lang.Boolean showGroupTitleColumn)
If this grid is
grouped and showGroupSummaryInHeader is true, instead of
group header nodes showing up with a single cell value spanning the full set of columns, summaries for each field will
show up in the appropriate columns of the header node. |
void |
setShowHeader(java.lang.Boolean showHeader)
Should we show the header for this ListGrid?
If this method is called after the component has been drawn/initialized: Show or hide the ListGrid header. |
void |
setShowHeaderContextMenu(java.lang.Boolean showHeaderContextMenu)
Whether to show a context menu on the header with standard items for showing and hiding fields.
|
void |
setShowHeaderMenuButton(java.lang.Boolean showHeaderMenuButton)
If set to true and
showHeaderContextMenu is
true, the headerMenuButton will be displayed when
the user rolls over the header buttons in this grid. |
void |
setShowHeaderSpanTitlesInFormulaBuilder(java.lang.Boolean showHeaderSpanTitlesInFormulaBuilder)
If this grid has specified
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or
SummaryBuilder. |
void |
setShowHeaderSpanTitlesInHiliteEditor(java.lang.Boolean showHeaderSpanTitlesInHiliteEditor)
If this grid has specified
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the hilite editor. |
void |
setShowHeaderSpanTitlesInSortEditor(java.lang.Boolean showHeaderSpanTitlesInSortEditor)
If this grid has specified
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor. |
void |
setShowHiddenFields(java.lang.Boolean showHiddenFields)
Whether to show fields marked
hidden:true when a DataBoundComponent is given a
DataSource but no component.fields.
|
void |
setShowHilitesInGroupSummary(boolean showHilitesInGroupSummary)
Determines whether hiliting for any field in this grid is shown in a group summary.
|
void |
setShowHover(java.lang.Boolean showHover)
If true, and canHover is also true, when the user hovers over a cell, hover text will pop up next to the mouse.
|
void |
setShowHoverComponents(java.lang.Boolean showHoverComponents)
When set to true and canHover is also true, shows a widget hovering at the mouse point.
|
void |
setShowPartialSelection(java.lang.Boolean showPartialSelection)
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. |
void |
setShowRecordComponents(java.lang.Boolean showRecordComponents)
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. |
void |
setShowRecordComponentsByCell(java.lang.Boolean showRecordComponentsByCell)
If true, shows
recordComponents in cells,
rather than just in records. |
void |
setShowRollOver(java.lang.Boolean showRollOver)
Should we show different styling for the cell the mouse is over?
|
void |
setShowRollOverCanvas(java.lang.Boolean showRollOverCanvas)
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. |
void |
setShowRollUnderCanvas(java.lang.Boolean showRollUnderCanvas)
If roll overs are enabled, should the
rollUnderCanvas be displayed? |
void |
setShowRowNumbers(java.lang.Boolean showRowNumbers)
When set to true, shows an additional field at the beginning of the field-list (respecting RTL) that displays the
current rowNum for each record.
|
void |
setShowSelectedStyle(java.lang.Boolean showSelectedStyle)
Should the "Selected" style be applied to selected records?
|
void |
setShowSelectionCanvas(java.lang.Boolean showSelectionCanvas)
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. |
void |
setShowSelectionUnderCanvas(java.lang.Boolean showSelectionUnderCanvas)
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. |
void |
setShowSortArrow(SortArrow showSortArrow)
Indicates whether a sorting arrow should appear for the listGrid, and its location.
|
void |
setShowSortNumerals(java.lang.Boolean showSortNumerals)
When multiple fields are sorted, set this to false to hide the sort-numeral displayed by default after the sort-arrows
in the header-buttons of sorted fields.
|
void |
setShowTreeColumnPicker(java.lang.Boolean showTreeColumnPicker)
When
headerSpans are in use, whether to show a
hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under
headerSpans similarly to how a TreeGrid displays a Tree. |
void |
setShrinkForFreeze(java.lang.Boolean shrinkForFreeze)
If this list grid is showing any
frozen fields, and a
horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible
below the frozen columns?Note that if set to true any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s). |
void |
setSingleCellValueProperty(java.lang.String singleCellValueProperty)
If
record[this.singleCellValueProperty] is set for some record, the record will be displayed as a single
cell spanning every column in the grid, with contents set to the value of
record[this.singleCellValueProperty]. |
void |
setSkinImgDir(java.lang.String skinImgDir)
Where do 'skin' images (those provided with the class) live?
|
void |
setSort(SortSpecifier... sortSpecifiers)
Sort the grid on one or more fields.
|
void |
setSortAscendingImage(ImgProperties sortAscendingImage)
Image to show when sorting ascending.
|
void |
setSortBinaryByFileName(boolean sortBinaryByFileName)
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. |
void |
setSortByGroupFirst(java.lang.Boolean sortByGroupFirst)
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. |
void |
setSortDescendingImage(ImgProperties sortDescendingImage)
Image to show when sorting descending.
|
void |
setSortDirection(SortDirection sortDirection)
Sorting direction of this ListGrid.
|
void |
setSortEditorSpanTitleSeparator(java.lang.String sortEditorSpanTitleSeparator)
If this grid has specified
headerSpans, and showHeaderSpanTitlesInSortEditor is true,
this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid on the multi-sort editor |
void |
setSorterButtonTitle(java.lang.String sorterButtonTitle)
The title for the corner sort button.
|
void |
setSortField(int fieldIndex)
Specifies the field by which this grid should be initially sorted.
|
void |
setSortField(java.lang.Integer sortField)
Specifies the field by which this grid should be initially sorted.
|
void |
setSortField(java.lang.String sortField)
Specifies the field by which this grid should be initially sorted.
|
void |
setSortFieldAscendingText(java.lang.String sortFieldAscendingText)
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in ascending order. |
void |
setSortFieldDescendingText(java.lang.String sortFieldDescendingText)
If we're showing a
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in descending order. |
void |
setSortNumeralHTMLCustomizer(SortNumeralHTMLCustomizer customizer)
This customizer is called to generate the HTML for the sortNumeral displayed next to a
field's title when it is included in the current sort specification.
|
void |
setSortNumeralStyle(java.lang.String sortNumeralStyle)
When multiple fields are sorted, the Style to apply to the numeral that appears after the sort-arrows in the
header-buttons of sorted fields.
|
void |
setSortState(java.lang.String sortState)
Initial sort state for the grid.
|
void |
setStopOnErrors(java.lang.Boolean stopOnErrors)
If this is an editable listGrid, this property determines how failure to save due to validation errors should be
displayed to the user.
|
void |
setStyleName(java.lang.String styleName)
Default CSS class for the ListGrid as a whole.
|
void |
setSummaryRowCriteria(Criteria summaryRowCriteria)
If
showGridSummary is true, and a summaryRowDataSource is specified this property may
be used to specify fetch criteria to apply when retrieving summary data to show in the summary row. |
void |
setSummaryRowDataSource(DataSource summaryRowDataSource)
If
showGridSummary is true, by default summary
values are calculated on the client based on the current data-set for the grid (see getGridSummary() and getGridSummaryFunction()). |
void |
setSummaryRowFetchRequestProperties(DSRequest summaryRowFetchRequestProperties)
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. |
void |
setSummaryRowHeight(int summaryRowHeight)
Default height for the
summary row autoChild. |
void |
setSummaryRowStyle(java.lang.String summaryRowStyle)
baseStyle for the summaryRow |
void |
setTallBaseStyle(java.lang.String tallBaseStyle)
"Tall" baseStyle for this listGrid.
|
void |
setTitleField(java.lang.String titleField)
Sets the best field to use for a user-visible title for an individual record from this component.
|
void |
setTouchScrollRedrawDelay(java.lang.Integer touchScrollRedrawDelay)
While scrolling an incrementally rendered grid, using the inertial scrolling, time in milliseconds to wait before
redrawing, after the last touchScroll by the user.
|
void |
setTrackerImage(ImgProperties trackerImage)
Default image to use for the dragTracker when things are dragged within or out of this list.
|
void |
setUnfreezeFieldText(java.lang.String unfreezeFieldText)
If we're showing a
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to unfreeze a currently frozen field. |
void |
setUngroupText(java.lang.String ungroupText)
If we're showing a
headerContextMenu for this
grid, and this.isGrouped is true, this attribute will be
shown as the title for the menu item to ungroup the grid. |
void |
setUnremoveIcon(java.lang.String unremoveIcon)
When
canRemoveRecords is enabled, this icon will
be shown in the auto generated field fro removing records if the record has been marked as removed via markRecordRemoved(). |
void |
setUpdateOperation(java.lang.String updateOperation)
operationId this component
should use when performing update operations. |
void |
setUseAdvancedFieldPicker(java.lang.Boolean useAdvancedFieldPicker)
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. |
void |
setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
If true, the set of fields given by the "default binding" (see
fields) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
|
void |
setUseCellRollOvers(java.lang.Boolean useCellRollOvers)
Are rollovers cell-level or row-level?
|
void |
setUseCopyPasteShortcuts(java.lang.Boolean useCopyPasteShortcuts)
Enables copy/paste shortcuts, provided
canSelectCells is true |
void |
setUseFlatFields(java.lang.Boolean useFlatFields)
The
useFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding. |
void |
setUseRemoteValidators(java.lang.Boolean useRemoteValidators)
If
saveLocally is specified, but this grid is bound to
a DataSource which includes remote field validators, by default edits will be saved synchronously and these validators
will not be executed.Set this property to true to ensure these remote validators are called when
saving edits in saveLocally mode. |
void |
setUserFormula(ListGridField field)
Updates the user formula of the supplied field.
|
void |
setUserFormula(ListGridField field,
UserFormula userFormula)
Updates the user formula of the supplied field.
|
void |
setUserFormula(java.lang.String field)
Updates the user formula of the supplied field.
|
void |
setUserFormulaText(ListGridField field)
Updates the user formula text of the supplied field.
|
void |
setUserFormulaText(ListGridField field,
java.lang.String text)
Updates the user formula text of the supplied field.
|
void |
setUserFormulaText(java.lang.String field)
Updates the user formula text of the supplied field.
|
void |
setUseRowSpanStyling(java.lang.Boolean useRowSpanStyling)
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. |
void |
setUserSummary(ListGridField field)
Updates the user summary of the supplied field.
|
void |
setUserSummary(ListGridField field,
UserSummary userSummary)
Updates the user summary of the supplied field.
|
void |
setUserSummary(java.lang.String field)
Updates the user summary of the supplied field.
|
void |
setUserSummaryText(ListGridField field)
Updates the user summary text of the supplied field.
|
void |
setUserSummaryText(ListGridField field,
java.lang.String text)
Updates the user summary text of the supplied field.
|
void |
setUserSummaryText(java.lang.String field)
Updates the user summary text of the supplied field.
|
void |
setValidateByCell(java.lang.Boolean validateByCell)
Whether client-side validation checks should be performed when the user moves between cells in the current edit row.
|
void |
setValidateOnChange(java.lang.Boolean validateOnChange)
If true, validation will be performed on each edited cell when each editor's "change" handler is fired.
|
void |
setValueIconHeight(java.lang.Integer valueIconHeight)
Height for value icons for this listGrid.
|
void |
setValueIconLeftPadding(int valueIconLeftPadding)
How much padding should there be on the left of valueIcons by default Can be overridden at the field level
|
void |
setValueIconRightPadding(int valueIconRightPadding)
How much padding should there be on the right of valueIcons by default
|
void |
setValueIconSize(int valueIconSize)
Default width and height of value icons for this ListGrid.
|
void |
setValueIconWidth(java.lang.Integer valueIconWidth)
Width for value icons for this listGrid.
|
void |
setValueMap(java.lang.String fieldName,
java.util.LinkedHashMap valueMap)
Set the value map for a field.
See also the
setEditorValueMap(java.lang.String, java.util.LinkedHashMap)
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap methods which allow further
customization of the valueMap displayed while the field is in edit mode.
|
void |
setValueMap(java.lang.String fieldName,
java.lang.String... valueMap)
Set the value map for a field.
See also the
setEditorValueMap(java.lang.String, java.util.LinkedHashMap)
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap methods which allow further
customization of the valueMap displayed while the field is in edit mode.
|
void |
setViewState(java.lang.String viewState)
Initial
view state for the grid. |
void |
setVirtualScrolling(java.lang.Boolean virtualScrolling)
When incremental rendering is switched on and there are variable record heights, the virtual scrolling mechanism manages
the differences in scroll height calculations due to the unknown sizes of un-rendered rows to make the scrollbar and
viewport appear correctly.
|
void |
setWaitForSave(java.lang.Boolean waitForSave)
If this is an editable listGrid, this property determines whether the user will be able to dismiss the edit form, or
navigate to another cell while the save is in process (before the asynchronous server response returns).
|
void |
setWarnOnRemoval(java.lang.Boolean warnOnRemoval)
If
canRemoveRecords is true, when the user clicks
the remove icon for some record, should we show a warning message (defined as warnOnRemovalMessage) and allow the user to cancel
removal? |
void |
setWarnOnRemovalMessage(java.lang.String warnOnRemovalMessage)
Warning message to show the user on a click on the 'remove' icon if
canRemoveRecords is true and warnOnRemoval is true. |
void |
setWarnOnUnmappedValueFieldChange(java.lang.Boolean warnOnUnmappedValueFieldChange)
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). |
void |
setWrapCells(java.lang.Boolean wrapCells)
Should content within cells be allowed to wrap?
|
void |
setWrapHeaderSpanTitles(java.lang.Boolean wrapHeaderSpanTitles)
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. |
void |
setWrapHeaderTitles(java.lang.Boolean wrapHeaderTitles)
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. |
boolean |
shouldIncludeHiliteInSummaryField(java.lang.String summaryFieldName,
java.lang.String usedFieldName)
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? |
void |
showField(java.lang.String field)
Force a field to be shown.
|
void |
showField(java.lang.String field,
boolean suppressRelayout)
Force a field to be shown.
|
void |
showFields(ListGridField... field)
Force an array of fields to be shown.
|
void |
showFields(ListGridField[] fields,
boolean suppressRelayout) |
void |
showFields(java.lang.String... field)
Force an array of fields to be shown.
|
void |
showFields(java.lang.String[] field,
boolean suppressRelayout)
Force an array of fields to be shown.
|
protected boolean |
showRecordComponent(ListGridRecord record,
java.lang.Integer colNum)
When
showRecordComponents is true, return
false from this method to prevent showRecordComponent behavior for the passed record. |
java.lang.Boolean |
sort()
Sort this grid's data, with the option to explicitly specify a single field to sort by and sort direction.
|
java.lang.Boolean |
sort(int sortCol,
SortDirection sortDirection) |
java.lang.Boolean |
sort(java.lang.String sortField) |
java.lang.Boolean |
sort(java.lang.String sortField,
SortDirection sortDirection)
Sort this grid's data, with the option to explicitly specify a single field to sort by and sort direction.
|
java.lang.Boolean |
startEditing()
Start inline editing at the provided coordinates.
|
java.lang.Boolean |
startEditing(java.lang.Integer rowNum) |
java.lang.Boolean |
startEditing(java.lang.Integer rowNum,
java.lang.Integer colNum) |
java.lang.Boolean |
startEditing(java.lang.Integer rowNum,
java.lang.Integer colNum,
java.lang.Boolean suppressFocus)
Start inline editing at the provided coordinates.
|
void |
startEditingNew()
Start editing a new row, after the last pre-existing record in the current set of data.
|
void |
startEditingNew(java.util.Map newValues) |
void |
startEditingNew(java.util.Map newValues,
java.lang.Boolean suppressFocus)
Start editing a new row, after the last pre-existing record in the current set of data.
|
void |
startEditingNew(Record defaultRecordValue)
Start editing a new row, after the last pre-existing record in the current set of data.
|
void |
stopHover()
Notification that the user is no longer hovering over some cell.
|
void |
summaryUpdated(ListGridField field,
UserSummary summary)
Notification fired when a user either creates a new summary field or edits an existing summary field.
|
void |
toggleSort(java.lang.String fieldName)
Toggles the sort-direction of the field with the passed name and resorts the grid.
|
void |
transferSelectedData(DataBoundComponent source)
Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
|
void |
transferSelectedData(DataBoundComponent source,
int index)
Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
|
void |
unfreezeField(java.lang.Integer field)
Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.
|
void |
unfreezeField(ListGridField field)
Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.
|
void |
unfreezeField(java.lang.String field)
Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.
|
void |
unfreezeField(java.lang.String[] field)
Unfreeze a frozen field, so that it will now scroll along with other fields when horizontal scrolling occurs.
|
void |
unfreezeFields(int[] colNums) |
void |
unfreezeFields(java.lang.String[] fieldNames) |
void |
ungroup()
Removes the grouping from the listGrid, restoring its original data
|
void |
unmarkRecordRemoved(int rowNum)
Reverses a previous call to
markRecordRemoved(). |
void |
unsort()
Turn sorting off, typically because data has changed and is no longer sorted.
|
void |
updateData(Record updatedRecord)
Perform a DataSource "update" operation to update existing records in this component's DataSource.
|
void |
updateData(Record updatedRecord,
DSCallback callback) |
void |
updateData(Record updatedRecord,
DSCallback callback,
DSRequest requestProperties)
Perform a DataSource "update" operation to update existing records in this component's DataSource.
|
Canvas |
updateRecordComponent(ListGridRecord record,
java.lang.Integer colNum,
Canvas component,
boolean recordChanged)
When
showRecordComponents is true, this method
is called to update components created by createRecordComponent() when they are to be applied to a different record in the grid. |
void |
userSelectAllRecords()
Selects every user-selectable record in the grid.
|
java.lang.Boolean |
validateCell(int rowNum,
int colIndex)
Validate the current edit value for the cell in question.
|
java.lang.Boolean |
validateCell(int rowNum,
java.lang.String fieldName)
Validate the current edit value for the cell in question.
|
java.lang.Boolean |
validateRow(int rowNum)
Validate the current set of edit values for the row in question.
|
java.lang.Boolean |
willAcceptDrop()
This method overrides
Canvas.willAcceptDrop() and works as follows:If Canvas.willAcceptDrop() (the superclass definition) returns false, this method
always returns false. |
java.lang.Boolean |
willFetchData(Criteria newCriteria)
Compares the specified criteria with the current criteria applied to this component's data object and determines whether
the new criteria could be satisfied from the currently cached set of data, or if a new filter/fetch operation will be
required.
|
java.lang.Boolean |
willFetchData(Criteria newCriteria,
TextMatchStyle textMatchStyle)
Compares the specified criteria with the current criteria applied to this component's data object and determines whether
the new criteria could be satisfied from the currently cached set of data, or if a new filter/fetch operation will be
required.
|
setDefaultProperties, setLogicalStructureaddMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMemberaddChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPointaddDrawHandler, applyFactoryProperties, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getById, getByJSObject, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetOrCreateJsObjpublic ListGrid()
public ListGrid(com.google.gwt.core.client.JavaScriptObject jsObj)
public ListGrid(DataSource dataSource)
public static ListGrid getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
protected ListGrid getTestInstance()
getTestInstance in class Canvaspublic static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public void setAdvancedFieldPickerThreshold(int advancedFieldPickerThreshold)
throws java.lang.IllegalStateException
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. Set to 0 to have the advanced picker always used (when useAdvancedFieldPicker is true).
advancedFieldPickerThreshold - Default value is 25java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int getAdvancedFieldPickerThreshold()
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. Set to 0 to have the advanced picker always used (when useAdvancedFieldPicker is true).
public void setAllowFilterExpressions(java.lang.Boolean allowFilterExpressions)
throws java.lang.IllegalStateException
showFilterEditor:true, allows simple
search expressions to be entered into filter fields, as though DynamicForm.allowExpressions were true. This
attribute can also be set at the field
level.
allowFilterExpressions - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAllowFilterExpressions()
showFilterEditor:true, allows simple
search expressions to be entered into filter fields, as though DynamicForm.allowExpressions were true. This
attribute can also be set at the field
level.
public void setAllowFilterOperators(java.lang.Boolean allowFilterOperators)
throws java.lang.IllegalStateException
"Filter using" to appear
in the headerContextMenu that allows the end
user to pick an advanced search operator to use for this field. Once an
operator has been chosen, the active operator is indicated by an operatorIcon placed within the field (you can alternatively
cause the icon to always be present). The
operatorIcon shows the same textual representation of the search operator as is used by the FormItem.allowExpressions feature. Clicking on
the icon provides a second way to modify the search operator.
This feature is enabled by default if DataSource.supportsAdvancedCriteria() is true, for all
fields where it is normally possible to filter by typing in a search string. This excludes field types such as "date"
or "boolean" which show specialized filter controls. Use ListGridField.allowFilterOperators to disable
this interface for individual fields, or set DataSourceField.canFilter to false to disallow filtering entirely for a field.
Note that this feature is similar
to allowFilterExpressions, which allows the
end users to directly type in characters such as ">" to control filtering. allowFilterOperators is
easier to use and more discoverable than allowFilterExpressions, and also avoids the drawback where special
characters like ">" cannot be used in filter values. However, allowFilterExpressions allows users to
make use of certain operators that allowFilterOperators does not support, such as using the
"betweenInclusive" operator by typing "5...10".
When both allowfilterExpressions and
allowFilterOperators are set, filter expressions entered in to the edit-area are parsed and the operator
automatically applied to the operatorIcon.
allowFilterOperators - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAllowFilterOperators()
"Filter using" to appear
in the headerContextMenu that allows the end
user to pick an advanced search operator to use for this field. Once an
operator has been chosen, the active operator is indicated by an operatorIcon placed within the field (you can alternatively
cause the icon to always be present). The
operatorIcon shows the same textual representation of the search operator as is used by the FormItem.allowExpressions feature. Clicking on
the icon provides a second way to modify the search operator.
This feature is enabled by default if DataSource.supportsAdvancedCriteria() is true, for all
fields where it is normally possible to filter by typing in a search string. This excludes field types such as "date"
or "boolean" which show specialized filter controls. Use ListGridField.allowFilterOperators to disable
this interface for individual fields, or set DataSourceField.canFilter to false to disallow filtering entirely for a field.
Note that this feature is similar
to allowFilterExpressions, which allows the
end users to directly type in characters such as ">" to control filtering. allowFilterOperators is
easier to use and more discoverable than allowFilterExpressions, and also avoids the drawback where special
characters like ">" cannot be used in filter values. However, allowFilterExpressions allows users to
make use of certain operators that allowFilterOperators does not support, such as using the
"betweenInclusive" operator by typing "5...10".
When both allowfilterExpressions and
allowFilterOperators are set, filter expressions entered in to the edit-area are parsed and the operator
automatically applied to the operatorIcon.
public void setAllowRowSpanning(java.lang.Boolean allowRowSpanning)
throws java.lang.IllegalStateException
true, the getRowSpan() method will be called for every cell when rendering
out the listGrid to determine how many rows the cell should span. See getRowSpan() for more details
allowRowSpanning - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAllowRowSpanning()
true, the getRowSpan() method will be called for every cell when rendering
out the listGrid to determine how many rows the cell should span. See getRowSpan() for more details
public void setAlternateBodyStyleName(java.lang.String alternateBodyStyleName)
alternateRecordStyles is true for this grid. If unset bodyStyleName will be used to style the body regardless of the alternateRecordStyles setting.
alternateBodyStyleName for this listGrid.
Note : This is an advanced setting
alternateBodyStyleName - new body style name when showing alternateRecordStylesCSSStyleName . Default value is nullpublic java.lang.String getAlternateBodyStyleName()
alternateRecordStyles is true for this grid. If unset bodyStyleName will be used to style the body regardless of the alternateRecordStyles setting.CSSStyleNamepublic void setAlternateFieldFrequency(int alternateFieldFrequency)
alternateColumnStyles is true.alternateFieldFrequency - Default value is 1public int getAlternateFieldFrequency()
alternateColumnStyles is true.public void setAlternateFieldStyles(boolean alternateFieldStyles)
alternateFieldStyles - Default value is falsepublic boolean getAlternateFieldStyles()
public void setAlternateRecordFrequency(int alternateRecordFrequency)
alternateRowStyles is true.alternateRecordFrequency - Default value is 1public int getAlternateRecordFrequency()
alternateRowStyles is true.public void setAlternateRecordStyles(java.lang.Boolean alternateRecordStyles)
alternateRecordStylesalternateRecordStyles - New value for this.alternateRecordStyles. Default value is falsepublic java.lang.Boolean getAlternateRecordStyles()
public void setAlwaysShowEditors(java.lang.Boolean alwaysShowEditors)
throws java.lang.IllegalStateException
editByCell is falsealwaysShowEditors - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdEditing overview and related methodspublic java.lang.Boolean getAlwaysShowEditors()
editByCell is falseEditing overview and related methodspublic void setAlwaysShowOperatorIcon(java.lang.Boolean alwaysShowOperatorIcon)
throws java.lang.IllegalStateException
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. The default operator for a field is determined by autoFetchTextMatchStyle or by setting ListGridField.filterOperator for a specific field.
alwaysShowOperatorIcon - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAlwaysShowOperatorIcon()
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. The default operator for a field is determined by autoFetchTextMatchStyle or by setting ListGridField.filterOperator for a specific field.
public void setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)
For a ListGrid, this property applies when grouping is enabled.
animateFolderEffect - Default value is nullpublic AnimationAcceleration getAnimateFolderEffect()
For a ListGrid, this property applies when grouping is enabled.
public void setAnimateFolderMaxRows(java.lang.Integer animateFolderMaxRows)
animateFolders is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder. For a
ListGrid, this property applies when grouping is
enabled.
animateFolderMaxRows - Default value is nullTreeGrid.getAnimateFolderMaxRows()public java.lang.Integer getAnimateFolderMaxRows()
animateFolders is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder. For a
ListGrid, this property applies when grouping is
enabled.
TreeGrid.getAnimateFolderMaxRows()public void setAnimateFolders(java.lang.Boolean animateFolders)
For a ListGrid, this property applies
when grouping is enabled.
animateFolders - Default value is truepublic java.lang.Boolean getAnimateFolders()
For a ListGrid, this property applies
when grouping is enabled.
public void setAnimateFolderSpeed(int animateFolderSpeed)
TreeGrid.animateFolderTime property, which allows the developer to specify a duration for the animation rather than a
speed. For a ListGrid, this property applies when grouping is enabled.
animateFolderSpeed - Default value is 3000setAnimateFolderTime(int)public int getAnimateFolderSpeed()
TreeGrid.animateFolderTime property, which allows the developer to specify a duration for the animation rather than a
speed. For a ListGrid, this property applies when grouping is enabled.
getAnimateFolderTime()public void setAnimateFolderTime(int animateFolderTime)
TreeGrid.animateFolderSpeed is not set, this property designates the duration of the animation in ms. For a
ListGrid, this property applies when grouping is
enabled.
animateFolderTime - Default value is 100setAnimateFolderSpeed(int)public int getAnimateFolderTime()
TreeGrid.animateFolderSpeed is not set, this property designates the duration of the animation in ms. For a
ListGrid, this property applies when grouping is
enabled.
getAnimateFolderSpeed()public void setAnimateRemoveRecord(java.lang.Boolean animateRemoveRecord)
canRemoveRecords is enabled, should records
be animated out of view when they are removed by the user?animateRemoveRecord - Default value is truepublic java.lang.Boolean getAnimateRemoveRecord()
canRemoveRecords is enabled, should records
be animated out of view when they are removed by the user?public void setAnimateRemoveSpeed(int animateRemoveSpeed)
animating record removal, this property
designates the speed of the animation in pixels per second. Takes precedence over the animateRemoveTime property, which allows the developer
to specify a duration for the animation rather than a speed.animateRemoveSpeed - Default value is 200setAnimateRemoveRecord(java.lang.Boolean)public int getAnimateRemoveSpeed()
animating record removal, this property
designates the speed of the animation in pixels per second. Takes precedence over the animateRemoveTime property, which allows the developer
to specify a duration for the animation rather than a speed.getAnimateRemoveRecord()public void setAnimateRemoveTime(int animateRemoveTime)
(see
animateRemoveRecord), if animateRemoveSpeed is
not set, this property designates the duration of the animation in ms.animateRemoveTime - Default value is 100setAnimateRemoveRecord(java.lang.Boolean)public int getAnimateRemoveTime()
(see
animateRemoveRecord), if animateRemoveSpeed is
not set, this property designates the duration of the animation in ms.getAnimateRemoveRecord()public void setAnimateRollOver(java.lang.Boolean animateRollOver)
rollOverCanvas is enabled, setting this
property to true ensures that when the rollOverCanvas is displayed it is animated into view
via Canvas.animateShow(). Note that the animation effect may be
customized via Canvas.animateShowEffect, Canvas.animateShowTime and Canvas.animateShowAcceleration set in
rollOverCanvasProperties.
Note : This is an advanced setting
animateRollOver - Default value is falsepublic java.lang.Boolean getAnimateRollOver()
rollOverCanvas is enabled, setting this
property to true ensures that when the rollOverCanvas is displayed it is animated into view
via Canvas.animateShow(). Note that the animation effect may be
customized via Canvas.animateShowEffect, Canvas.animateShowTime and Canvas.animateShowAcceleration set in
rollOverCanvasProperties.public void setAnimateRollUnder(java.lang.Boolean animateRollUnder)
rollUnderCanvas is enabled, setting this
property to true ensures that when the rollUnderCanvas is displayed it is animated into view
via Canvas.animateShow(). Note that the animation effect may be
customized via Canvas.animateShowEffect, Canvas.animateShowTime and Canvas.animateShowAcceleration set in
rollUnderCanvasProperties.
Note : This is an advanced setting
animateRollUnder - Default value is falsepublic java.lang.Boolean getAnimateRollUnder()
rollUnderCanvas is enabled, setting this
property to true ensures that when the rollUnderCanvas is displayed it is animated into view
via Canvas.animateShow(). Note that the animation effect may be
customized via Canvas.animateShowEffect, Canvas.animateShowTime and Canvas.animateShowAcceleration set in
rollUnderCanvasProperties.public void setAnimateSelection(java.lang.Boolean animateSelection)
selectionCanvas is enabled, setting this
property to true ensures that when the selectionCanvas is displayed it is animated into view
via Canvas.animateShow(). Note that the animation effect may be
customized via Canvas.animateShowEffect, Canvas.animateShowTime and Canvas.animateShowAcceleration set in
selectionCanvasProperties.
Note : This is an advanced setting
animateSelection - Default value is falsesetAnimateSelectionUnder(java.lang.Boolean)public java.lang.Boolean getAnimateSelection()
selectionCanvas is enabled, setting this
property to true ensures that when the selectionCanvas is displayed it is animated into view
via Canvas.animateShow(). Note that the animation effect may be
customized via Canvas.animateShowEffect, Canvas.animateShowTime and Canvas.animateShowAcceleration set in
selectionCanvasProperties.getAnimateSelectionUnder()public void setAnimateSelectionUnder(java.lang.Boolean animateSelectionUnder)
selectionUnderCanvas is enabled,
setting this property to true ensures that when the selectionUnderCanvas is displayed it is
animated into view via Canvas.animateShow(). Note that the
animation effect may be customized via Canvas.animateShowEffect, Canvas.animateShowTime and
Canvas.animateShowAcceleration set in
selectionUnderCanvasProperties.
Note : This is an advanced setting
animateSelectionUnder - Default value is falsesetAnimateSelection(java.lang.Boolean),
Animated Selection Examplepublic java.lang.Boolean getAnimateSelectionUnder()
selectionUnderCanvas is enabled,
setting this property to true ensures that when the selectionUnderCanvas is displayed it is
animated into view via Canvas.animateShow(). Note that the
animation effect may be customized via Canvas.animateShowEffect, Canvas.animateShowTime and
Canvas.animateShowAcceleration set in
selectionUnderCanvasProperties.getAnimateSelection(),
Animated Selection Examplepublic void setApplyFormulaAfterSummary(java.lang.Boolean applyFormulaAfterSummary)
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. Should the field apply the user-formula to the calculated summary row, or
should it apply a standard grid or group summary to the user-formula values displayed in the grid? May be overridden
at the field level via ListGridField.applyAfterSummary
applyFormulaAfterSummary - Default value is falsepublic java.lang.Boolean getApplyFormulaAfterSummary()
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. Should the field apply the user-formula to the calculated summary row, or
should it apply a standard grid or group summary to the user-formula values displayed in the grid? May be overridden
at the field level via ListGridField.applyAfterSummary
public void setApplyRowNumberStyle(boolean applyRowNumberStyle)
showRowNumbers is true, should we apply the
rowNumberStyle to the rowNumberField
Note : This is an advanced setting
applyRowNumberStyle - Default value is truepublic boolean getApplyRowNumberStyle()
public void setArrowKeyAction(java.lang.String arrowKeyAction)
"select" : select the next row in the list (calls
recordClick handler)"focus" : move focus to the next row in the list without
changing the selection"activate" : select and activate the next row in the list (calls
recordDoubleClick handler)"none" : no actionnull : if selectionAppearance is "checkbox", behaves as if set
to "focus"; otherwise, behaves as if set to "select"Note : This is an advanced setting
arrowKeyAction - Default value is nullpublic java.lang.String getArrowKeyAction()
"select" : select the next row in the list (calls
recordClick handler)"focus" : move focus to the next row in the list without
changing the selection"activate" : select and activate the next row in the list (calls
recordDoubleClick handler)"none" : no actionnull : if selectionAppearance is "checkbox", behaves as if set
to "focus"; otherwise, behaves as if set to "select"public void setAsynchGroupingPrompt(java.lang.String asynchGroupingPrompt)
throws java.lang.IllegalStateException
asynchronous grouping.asynchGroupingPrompt - java.lang.IllegalStateException - this property cannot be changed after the component has been createdHTMLString . Default value is "${loadingImage} Grouping data..."public java.lang.String getAsynchGroupingPrompt()
asynchronous grouping.HTMLStringpublic void setAutoComplete(AutoComplete autoComplete)
ListGridField.autoComplete if specified. If unset picks
up the default from the appropriate editor class (subclass of FormItem).autoComplete - Default value is nullListGridField.setAutoComplete(com.smartgwt.client.types.AutoComplete)public AutoComplete getAutoComplete()
ListGridField.autoComplete if specified. If unset picks
up the default from the appropriate editor class (subclass of FormItem).ListGridField.getAutoComplete()public void setAutoConfirmSaveEdits(java.lang.Boolean autoConfirmSaveEdits)
confirmDiscardEdits, which allows the user to choose
whether to save or discard the unsaved edits.autoConfirmSaveEdits - Default value is falseEditing overview and related methodspublic java.lang.Boolean getAutoConfirmSaveEdits()
confirmDiscardEdits, which allows the user to choose
whether to save or discard the unsaved edits.Editing overview and related methodspublic void setAutoFetchDisplayMap(java.lang.Boolean autoFetchDisplayMap)
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. If set to false, valueMaps
will not be automatically fetched. In this case, setting field.optionDataSource is effectively a shortcut for setting
optionDataSource on the editor via ListGridField.editorProperties.
Can also be disabled on a per-field basis with ListGridField.autoFetchDisplayMap.
autoFetchDisplayMap - Default value is trueListGridField.setAutoFetchDisplayMap(java.lang.Boolean),
ListGridField.setOptionDataSource(com.smartgwt.client.data.DataSource)public java.lang.Boolean getAutoFetchDisplayMap()
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. If set to false, valueMaps
will not be automatically fetched. In this case, setting field.optionDataSource is effectively a shortcut for setting
optionDataSource on the editor via ListGridField.editorProperties.
Can also be disabled on a per-field basis with ListGridField.autoFetchDisplayMap.
ListGridField.getAutoFetchDisplayMap(),
com.smartgwt.client.widgets.grid.ListGridField#getOptionDataSourcepublic void setAutoFitAllText(java.lang.String autoFitAllText)
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.autoFitAllText - Default value is "Auto Fit All Columns"public java.lang.String getAutoFitAllText()
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.public void setAutoFitClipFields(java.lang.String... autoFitClipFields)
throws java.lang.IllegalStateException
autoFitFieldWidths is enabled and the
calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an
array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear. Note:
If any frozen columns are included in this list they
will not be clipped.
autoFitClipFields - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String[] getAutoFitClipFields()
autoFitFieldWidths is enabled and the
calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an
array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear. Note:
If any frozen columns are included in this list they
will not be clipped.
public void setAutoFitData(Autofit autoFitData)
Valid settings are
"vertical": expand vertically to accommodate records."horizontal":
expand horizontally to accommodate fields."both": expand horizontally and vertically to
accommodate content.autoFitMaxHeight, autoFitMaxRecords, autoFitMaxWidth, autoFitMaxColumns. Note that this property causes
the grid as a whole to expand to fit records or fields. To have the fields or records themselves expand to fit cell
contents, see autoFitFieldWidths and fixedRecordHeights.
If this method is called after the component has been drawn/initialized:
Setter for autoFitData.
autoFitData - One of "vertical", "horizontal" or "both". To disable auto fit behavior, pass in
null.. Default value is nullpublic Autofit getAutoFitData()
Valid settings are
"vertical": expand vertically to accommodate records."horizontal":
expand horizontally to accommodate fields."both": expand horizontally and vertically to
accommodate content.autoFitMaxHeight, autoFitMaxRecords, autoFitMaxWidth, autoFitMaxColumns. Note that this property causes
the grid as a whole to expand to fit records or fields. To have the fields or records themselves expand to fit cell
contents, see autoFitFieldWidths and fixedRecordHeights.
public void setAutoFitExpandField(java.lang.String autoFitExpandField)
throws java.lang.IllegalStateException
autoFitFieldWidths and
autoFitFieldsFillViewport are enabled and
auto-fitting will not fill all available horizontal space. If unset, will default to the text field with the longest
DataSourceField.length if length is set, otherwise, the first
text field with no width specified.
Note that expanding frozen columns is not supported.
autoFitExpandField - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getAutoFitExpandField()
autoFitFieldWidths and
autoFitFieldsFillViewport are enabled and
auto-fitting will not fill all available horizontal space. If unset, will default to the text field with the longest
DataSourceField.length if length is set, otherwise, the first
text field with no width specified.
Note that expanding frozen columns is not supported.
public void setAutoFitExtraRecords(java.lang.Integer autoFitExtraRecords)
autoFitData is set to "vertical" or
"both" this property specifies the number of additional records for which the grid will expand. If more
records are present, scrolling will be introduced to reach them as normal.
autoFitExtraRecords.autoFitExtraRecords - Number of extra rows beyond the data-size we'll expand to accommodate if auto fit is enabled vertically.. Default value is nullpublic java.lang.Integer getAutoFitExtraRecords()
autoFitData is set to "vertical" or
"both" this property specifies the number of additional records for which the grid will expand. If more
records are present, scrolling will be introduced to reach them as normal.public void setAutoFitFieldsFillViewport(java.lang.Boolean autoFitFieldsFillViewport)
throws java.lang.IllegalStateException
autoFitFieldWidths is enabled, and extra
space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.
When enabled, the field to expand may be specified via autoFitExpandField.
Note this logic will not expand
a frozen column.
autoFitFieldsFillViewport - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoFitFieldsFillViewport()
autoFitFieldWidths is enabled, and extra
space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.
When enabled, the field to expand may be specified via autoFitExpandField.
Note this logic will not expand
a frozen column.
public void setAutoFitFieldText(java.lang.String autoFitFieldText)
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().autoFitFieldText - Default value is "Auto Fit"public java.lang.String getAutoFitFieldText()
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().public void setAutoFitFieldWidths(java.lang.Boolean autoFitFieldWidths)
throws java.lang.IllegalStateException
ListGridField.autoFitWidth. Developers may
wish to consider disabling autoFit for fields known to have exceptionally long content as this can lead to large
horizontal scrollbars and unwieldy UI. The autoFitWidthApproach controls whether fitting is to values, titles or both. This property may also be overridden on a
per field basis.
If field.width is also set on the
field, it will be taken as a minimum width. minFieldWidth will also be respected.
By default, the entire available width of the grid will still be used, by
allocating any "extra" space to specific columns - see autoFitFieldsFillViewport for details on
controlling this behavior.
When this feature is enabled, autofitting is active on an ongoing basis. Autofitting will be performed:
autoFitField() or autoFitFields() canAutoFitFields is enabled. When autofitting to
column values, getDefaultFieldWidth() will be
called to determine the space required for a field's values. This method uses values from the rendered set of rows to
calculate the required column width, which means the field width may still be smaller than values from non-rendered
rows. See showAllRecords and drawAheadRatio) to control incremental rendering of rows.
Note that for icon type fields, the autoFitIconFields property setting may turn on
auto-fit-width behavior for specific fields by default, even if autoFitFieldWidths is false for the grid as
a whole.
Using this feature has a performance penalty roughly comparable to always rendering one additional field
per field where autofitting is enabled. Specifically, enabling it for all fields would be comparable to both
doubling the number of fields and disabling horizontal incremental rendering. In a grid where only half the fields are normally visible and hence only half are
normally rendered, this would be roughly 4 times slower overall.
This performance penalty is a result of getDefaultFieldWidth() having to render out the data set
offscreen and measure the rendered content - it does not apply for cases where this method can return a simple fixed
values (as with icon fields).
Which fields are currently autofitting is saved as part of the view state of the ListGrid.
If this method is called after the component has been drawn/initialized:
Setter for autoFitFieldWidths. Modifies the default auto-fit-width behavior for fields in this grid. Note that this may be overridden at the field level via ListGridField.autoFitWidth.
autoFitFieldWidths - New value for autoFitFieldWidths. Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoFitFieldWidths()
ListGridField.autoFitWidth. Developers may
wish to consider disabling autoFit for fields known to have exceptionally long content as this can lead to large
horizontal scrollbars and unwieldy UI. The autoFitWidthApproach controls whether fitting is to values, titles or both. This property may also be overridden on a
per field basis.
If field.width is also set on the
field, it will be taken as a minimum width. minFieldWidth will also be respected.
By default, the entire available width of the grid will still be used, by
allocating any "extra" space to specific columns - see autoFitFieldsFillViewport for details on
controlling this behavior.
When this feature is enabled, autofitting is active on an ongoing basis. Autofitting will be performed:
autoFitField() or autoFitFields() canAutoFitFields is enabled. When autofitting to
column values, getDefaultFieldWidth() will be
called to determine the space required for a field's values. This method uses values from the rendered set of rows to
calculate the required column width, which means the field width may still be smaller than values from non-rendered
rows. See showAllRecords and drawAheadRatio) to control incremental rendering of rows.
Note that for icon type fields, the autoFitIconFields property setting may turn on
auto-fit-width behavior for specific fields by default, even if autoFitFieldWidths is false for the grid as
a whole.
Using this feature has a performance penalty roughly comparable to always rendering one additional field
per field where autofitting is enabled. Specifically, enabling it for all fields would be comparable to both
doubling the number of fields and disabling horizontal incremental rendering. In a grid where only half the fields are normally visible and hence only half are
normally rendered, this would be roughly 4 times slower overall.
This performance penalty is a result of getDefaultFieldWidth() having to render out the data set
offscreen and measure the rendered content - it does not apply for cases where this method can return a simple fixed
values (as with icon fields).
Which fields are currently autofitting is saved as part of the view state of the ListGrid.
public void setAutoFitHeaderHeights(java.lang.Boolean autoFitHeaderHeights)
throws java.lang.IllegalStateException
fields or header spans will automatically expand to
accommodate their titles vertically. This means if you have a "tall" title - typically a long string where ListGridField.wrap is set to true such that you end up with
several lines of text - the button will render large enough to accommodate it. If necessary this will cause the header
for the grid as a whole to expand beyond the specified headerHeight. Note that you need not set HeaderSpan.height or headerSpanHeight if you set
this property, but if you do, they will be used as minimum values.
autoFitHeaderHeights - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoFitHeaderHeights()
fields or header spans will automatically expand to
accommodate their titles vertically. This means if you have a "tall" title - typically a long string where ListGridField.wrap is set to true such that you end up with
several lines of text - the button will render large enough to accommodate it. If necessary this will cause the header
for the grid as a whole to expand beyond the specified headerHeight. Note that you need not set HeaderSpan.height or headerSpanHeight if you set
this property, but if you do, they will be used as minimum values.
public void setAutoFitIconFields(AutoFitIconFieldType autoFitIconFields)
type:"icon", fields displaying only value icons, and boolean fields (which are rendered
as a checkmark type icon by default. This attribute controls this behavior - governing whether icon fields should be
sized to fit their content (icon), title, or whether to disable this behavior. Setting this value to
"title" or "iconWidth" will cause ListGridField.autoFitWidth to be enabled by default for
all icon fields with the ListGridField.autoFitWidthApproach set to "value" or "both" as appropriate. Note that the
width required for the icons is calculated by getDefaultFieldWidth() which performs a simple calculation based on the specified icon width for these types of fields.
This setting governs default behavior for icon fields - for specific fields within a grid, this default behavior can
be overridden by setting an explicit ListGridField.width
or explicitly enabling ListGridField.autoFitWidth
and setting ListGridField.autoFitWidthApproach on the field in question.
autoFitIconFields - Default value is "title"setAutoFitFieldWidths(java.lang.Boolean)public AutoFitIconFieldType getAutoFitIconFields()
type:"icon", fields displaying only value icons, and boolean fields (which are rendered
as a checkmark type icon by default. This attribute controls this behavior - governing whether icon fields should be
sized to fit their content (icon), title, or whether to disable this behavior. Setting this value to
"title" or "iconWidth" will cause ListGridField.autoFitWidth to be enabled by default for
all icon fields with the ListGridField.autoFitWidthApproach set to "value" or "both" as appropriate. Note that the
width required for the icons is calculated by getDefaultFieldWidth() which performs a simple calculation based on the specified icon width for these types of fields.
This setting governs default behavior for icon fields - for specific fields within a grid, this default behavior can
be overridden by setting an explicit ListGridField.width
or explicitly enabling ListGridField.autoFitWidth
and setting ListGridField.autoFitWidthApproach on the field in question.
getAutoFitFieldWidths()public void setAutoFitMaxColumns(int autoFitMaxColumns)
autoFitData is set to "horizontal" or
"both" this property provides the maximum number of columns for which the ListGrid will expand. If more
columns are present, scrolling will be introduced to reach them as normal. If unset the ListGrid will expand to
accommodate as many columns as are defined for the grid.
autoFitMaxColumns.autoFitMaxColumns - Maximum number of fields we'll expand to accommodate if auto fit is enabled horizontally.. Default value is 50public int getAutoFitMaxColumns()
autoFitData is set to "horizontal" or
"both" this property provides the maximum number of columns for which the ListGrid will expand. If more
columns are present, scrolling will be introduced to reach them as normal. If unset the ListGrid will expand to
accommodate as many columns as are defined for the grid.public void setAutoFitMaxHeight(java.lang.Integer autoFitMaxHeight)
autoFitData is set to "vertical" or
"both" this property provides an upper limit on how far the ListGrid will expand vertically to accommodate
its content. If content exceeds this height, scrollbars will be introduced as usual. In addition to this property,
autoFitMaxRecords allows you to limit vertical
expansion based on the number of rows to be rendered.
autoFitMaxHeight.autoFitMaxHeight - Maximum height in px we'll expand to accommodate if auto
fit is enabled vertically.. Default value is nullpublic java.lang.Integer getAutoFitMaxHeight()
autoFitData is set to "vertical" or
"both" this property provides an upper limit on how far the ListGrid will expand vertically to accommodate
its content. If content exceeds this height, scrollbars will be introduced as usual. In addition to this property,
autoFitMaxRecords allows you to limit vertical
expansion based on the number of rows to be rendered.public void setAutoFitMaxRecords(int autoFitMaxRecords)
autoFitData is set to "vertical" or
"both" this property provides the maximum number of records for which the ListGrid will expand. If more
records are present, scrolling will be introduced to reach them as normal. If unset, by default the ListGrid will expand
to accommodate as many records as are present.
autoFitMaxRecords.autoFitMaxRecords - Maximum number of rows we'll expand to accommodate if auto fit is enabled vertically.. Default value is 50public int getAutoFitMaxRecords()
autoFitData is set to "vertical" or
"both" this property provides the maximum number of records for which the ListGrid will expand. If more
records are present, scrolling will be introduced to reach them as normal. If unset, by default the ListGrid will expand
to accommodate as many records as are present.public void setAutoFitMaxWidth(java.lang.Integer autoFitMaxWidth)
autoFitData is set to "horizontal" or
"both" this property provides an upper limit on how far the ListGrid will expand horizontally to
accommodate its content. If content exceeds this width, scrollbars will be introduced as usual. In addition to this
property, autoFitMaxColumns allows you to limit
horizontal expansion based on the number of columns to be rendered.
autoFitMaxWidth.autoFitMaxWidth - Width in px we'll expand to accommodate if auto fit is
enabled horizontally.. Default value is nullpublic java.lang.Integer getAutoFitMaxWidth()
autoFitData is set to "horizontal" or
"both" this property provides an upper limit on how far the ListGrid will expand horizontally to
accommodate its content. If content exceeds this width, scrollbars will be introduced as usual. In addition to this
property, autoFitMaxColumns allows you to limit
horizontal expansion based on the number of columns to be rendered.public void setAutoFitWidthApproach(AutoFitWidthApproach autoFitWidthApproach)
header context menu or via a mouse gesture, what autofit approach is used.
autoFitWidthApproach.autoFitWidthApproach - new AutoFitWidth approach. Default value is "value"public AutoFitWidthApproach getAutoFitWidthApproach()
header context menu or via a mouse gesture, what autofit approach is used.public void setAutoSaveEdits(java.lang.Boolean autoSaveEdits)
saveByCell is true). The default of true
indicates that edits will be automatically saved as the
user navigates through the grid and/or hits 'Enter' to end editing.
See the Grid Editing overview for details.
Setting
autoSaveEdits false creates a "mass update" / "mass delete" interaction where edits will be retained for
all edited cells (across rows if appropriate) until saveEdits() is called to save a particular row, or saveAllEdits() is called to save all changes in a batch.
Note: when listGrid grouping is enabled, or when working with
hierarchical data in a TreeGrid, users have the option to hide records from
view by collapsing the parent folder or group. This, in conjunction with autoSaveEdits being set to
false can lead to a case where a user is unable to save edits due to validation errors on hidden rows.
Therefore we recommend developers consider having validators in place such that errors are caught and displayed to the
user on change or editor exit rather than being caught only when saving is attempted. If it's not possible for all
validation to be performed immediately on row exit, we recommend that a different UI design be used that does not
involve autoSaveEdits being set to false.
Note : This is an advanced setting
autoSaveEdits - Default value is trueEditing overview and related methodspublic java.lang.Boolean getAutoSaveEdits()
saveByCell is true). The default of true
indicates that edits will be automatically saved as the
user navigates through the grid and/or hits 'Enter' to end editing.
See the Grid Editing overview for details.
Setting
autoSaveEdits false creates a "mass update" / "mass delete" interaction where edits will be retained for
all edited cells (across rows if appropriate) until saveEdits() is called to save a particular row, or saveAllEdits() is called to save all changes in a batch.
Note: when listGrid grouping is enabled, or when working with
hierarchical data in a TreeGrid, users have the option to hide records from
view by collapsing the parent folder or group. This, in conjunction with autoSaveEdits being set to
false can lead to a case where a user is unable to save edits due to validation errors on hidden rows.
Therefore we recommend developers consider having validators in place such that errors are caught and displayed to the
user on change or editor exit rather than being caught only when saving is attempted. If it's not possible for all
validation to be performed immediately on row exit, we recommend that a different UI design be used that does not
involve autoSaveEdits being set to false.
Editing overview and related methodspublic void setAutoSizeHeaderSpans(java.lang.Boolean autoSizeHeaderSpans)
throws java.lang.IllegalStateException
headerSpans, setting
this attribute to true will cause spans to expand to accommodate long titles if necessary.autoSizeHeaderSpans - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoSizeHeaderSpans()
headerSpans, setting
this attribute to true will cause spans to expand to accommodate long titles if necessary.public Canvas getBackgroundComponent()
Using AutoChildren
for details.
Has no effect unless showBackgroundComponents is true.
Canvas created and embedded in the body behind a given record.
When ListGridRecord.backgroundComponent
is set, this autoChild canvas will be constructed (if listGridRecord.backgroundComponent is not already a Canvas) and
its properties combined with those of listGridRecord.backgroundComponent and then displayed behind a specific record in
the page's z-order, meaning it will only be visible if the cell styling is transparent.
public void setBadFormulaResultValue(java.lang.String badFormulaResultValue)
badFormulaResultValue - Default value is "."FormulaFields overview and related methodspublic java.lang.String getBadFormulaResultValue()
FormulaFields overview and related methodspublic void setBaseStyle(java.lang.String baseStyle)
throws java.lang.IllegalStateException
base cell style for this listGrid. If this property
is unset, base style may be derived from normalBaseStyle or tallBaseStyle as described in
getBaseStyle(). See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
baseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
Appearance overview and related methodspublic java.lang.String getBaseStyle()
base cell style for this listGrid. If this property
is unset, base style may be derived from normalBaseStyle or tallBaseStyle as described in
getBaseStyle(). See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
this.editFailedBaseStyle is defined, and the cell
is displaying a validation error return this value.this.editFailedPendingStyle is defined, and the
cell is displaying an edit value that has not yet been saved (see autoSaveEdits) return this value.record[listGrid.recordBaseStyleProperty],
if defined, otherwise field.baseStyle.baseStyle is specified this will be used. Otherwise for grids
showing fixed height rows which match normalCellHeight normalBaseStyle will be used. For
grids with variable, or modified cell heights, tallBaseStyle will be used. Note also that enabling fastCellUpdates will cause the tallBaseStyle
to be used rather than normalBaseStyle.
As
noted under enforceVClipping, cell content which
renders taller than the available space within a cell may cause rows to expand even if fixedRecordHeights is true. This can lead to
misaligned rows when frozen columns are used. Developers should be aware that changing cell styling such that there is
increased borders or padding will reduce the available space for content within the specified cell height, making this
scenario more common. To fix this, specify a larger cellHeight, or set enforceVClipping to true.
Note: This is an override point.
CSSStyleName,
Appearance overview and related methodspublic void setBodyBackgroundColor(java.lang.String bodyBackgroundColor)
baseStyle instead.bodyBackgroundColor - Default value is "white"Appearance overview and related methodspublic java.lang.String getBodyBackgroundColor()
baseStyle instead.Appearance overview and related methodspublic void setBodyOverflow(Overflow bodyOverflow)
This is a very
advanced setting which is typically only changed by subclasses of ListGrid which never show a header. To achieve
auto-fitting, instead use properties such as autoFitData, autoFitFieldWidths and fixedRecordHeights.
If this method is called after the component has been drawn/initialized:
Update the bodyOverflow for this listGrid.
Note : This is an advanced setting
bodyOverflow - new overflow setting for the body. Default value is Canvas.AUTOSizing overview and related methods,
Rows Examplepublic Overflow getBodyOverflow()
This is a very
advanced setting which is typically only changed by subclasses of ListGrid which never show a header. To achieve
auto-fitting, instead use properties such as autoFitData, autoFitFieldWidths and fixedRecordHeights.
Sizing overview and related methods,
Rows Examplepublic void setBodyStyleName(java.lang.String bodyStyleName)
bodyBackgroundColor to
null.
bodyStyleName for this listGrid.bodyStyleName - new body style nameCSSStyleName . Default value is null,
Appearance overview and related methodspublic java.lang.String getBodyStyleName()
bodyBackgroundColor to
null.CSSStyleName,
Appearance overview and related methodspublic void setBooleanBaseStyle(java.lang.String booleanBaseStyle)
throws java.lang.IllegalStateException
NOTE: This
attribute is not supported by TreeGrid.
Note : This is an advanced setting
booleanBaseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
setPrintBooleanBaseStyle(java.lang.String),
ImageColumns overview and related methodspublic java.lang.String getBooleanBaseStyle()
NOTE: This
attribute is not supported by TreeGrid.
CSSStyleName,
getPrintBooleanBaseStyle(),
ImageColumns overview and related methodspublic void setBooleanFalseImage(java.lang.String booleanFalseImage)
null value or the special value "blank"
means no image will be displayed. To turn this off explicitly set ListGridField.suppressValueIcon to true
If
this, booleanTrueImage and booleanPartialImage are unset, this will be set to the
default CheckboxItem.uncheckedImage.
When spriting is enabled, this property will not be used to locate an image,
instead, the image is drawn via CSS based on the booleanBaseStyle property.
Note : This is an advanced setting
booleanFalseImage - SCImgURL . Default value is null,
setBooleanTrueImage(java.lang.String),
setBooleanPartialImage(java.lang.String),
setPrintBooleanFalseImage(java.lang.String),
ImageColumns overview and related methodspublic java.lang.String getBooleanFalseImage()
null value or the special value "blank"
means no image will be displayed. To turn this off explicitly set ListGridField.suppressValueIcon to true
If
this, booleanTrueImage and booleanPartialImage are unset, this will be set to the
default CheckboxItem.uncheckedImage.
When spriting is enabled, this property will not be used to locate an image,
instead, the image is drawn via CSS based on the booleanBaseStyle property.
public void setBooleanImageHeight(int booleanImageHeight)
booleanTrueImage, booleanFalseImage and booleanPartialImage. Note: If booleanTrueImage is unset, the CheckboxItem.checkedImage will be used to indicate
a true value in a boolean field. In this case this property is ignored in favor of CheckboxItem.valueIconHeight.
Note : This is an advanced setting
booleanImageHeight - Default value is 16ImageColumns overview and related methodspublic int getBooleanImageHeight()
booleanTrueImage, booleanFalseImage and booleanPartialImage. Note: If booleanTrueImage is unset, the CheckboxItem.checkedImage will be used to indicate
a true value in a boolean field. In this case this property is ignored in favor of CheckboxItem.valueIconHeight.ImageColumns overview and related methodspublic void setBooleanImageWidth(int booleanImageWidth)
booleanTrueImage, booleanFalseImage and booleanPartialImage. Note: If booleanTrueImage is unset, the CheckboxItem.checkedImage will be used to indicate
a true value in a boolean field. In this case this property is ignored in favor of CheckboxItem.valueIconWidth.
Note : This is an advanced setting
booleanImageWidth - Default value is 16ImageColumns overview and related methodspublic int getBooleanImageWidth()
booleanTrueImage, booleanFalseImage and booleanPartialImage. Note: If booleanTrueImage is unset, the CheckboxItem.checkedImage will be used to indicate
a true value in a boolean field. In this case this property is ignored in favor of CheckboxItem.valueIconWidth.ImageColumns overview and related methodspublic void setBooleanPartialImage(java.lang.String booleanPartialImage)
To turn this off explicitly set ListGridField.suppressValueIcon to true.
If
this, booleanTrueImage and booleanFalseImage are unset, this will be set to the
default CheckboxItem.partialSelectedImage.
When spriting is enabled, this
property will not be used to locate an image, instead, the image is drawn via CSS based on the booleanBaseStyle property.
Note : This is an advanced setting
booleanPartialImage - SCImgURL . Default value is null,
setBooleanTrueImage(java.lang.String),
setBooleanFalseImage(java.lang.String),
setPrintBooleanPartialImage(java.lang.String),
ImageColumns overview and related methodspublic java.lang.String getBooleanPartialImage()
To turn this off explicitly set ListGridField.suppressValueIcon to true.
If
this, booleanTrueImage and booleanFalseImage are unset, this will be set to the
default CheckboxItem.partialSelectedImage.
When spriting is enabled, this
property will not be used to locate an image, instead, the image is drawn via CSS based on the booleanBaseStyle property.
public void setBooleanTrueImage(java.lang.String booleanTrueImage)
To turn this off explicitly set ListGridField.suppressValueIcon to true.
If this, booleanFalseImage and booleanPartialImage are unset, this will be set to the
default CheckboxItem.checkedImage.
When
spriting is enabled, this property will not be used to locate an image,
instead, the image is drawn via CSS based on the booleanBaseStyle property.
Note : This is an advanced setting
booleanTrueImage - SCImgURL . Default value is null,
setBooleanFalseImage(java.lang.String),
setBooleanPartialImage(java.lang.String),
setPrintBooleanTrueImage(java.lang.String),
ImageColumns overview and related methodspublic java.lang.String getBooleanTrueImage()
To turn this off explicitly set ListGridField.suppressValueIcon to true.
If this, booleanFalseImage and booleanPartialImage are unset, this will be set to the
default CheckboxItem.checkedImage.
When
spriting is enabled, this property will not be used to locate an image,
instead, the image is drawn via CSS based on the booleanBaseStyle property.
public void setCanAcceptDroppedRecords(java.lang.Boolean canAcceptDroppedRecords)
canAcceptDroppedRecords - Default value is falseListGridRecord.setCanDrag(java.lang.Boolean),
ListGridRecord.setCanAcceptDrop(java.lang.Boolean),
Drag list (move) Examplepublic java.lang.Boolean getCanAcceptDroppedRecords()
ListGridRecord.getCanDrag(),
ListGridRecord.getCanAcceptDrop(),
Drag list (move) Examplepublic void setCanAutoFitFields(java.lang.Boolean canAutoFitFields)
If set to true, the default header menu
will include options to auto fit all fields such
that they fit their content or titles as specified via ListGridField.autoFitWidthApproach.
Autofitting of individual fields via a header
context menu item, or the headerAutoFitEvent
will also be enabled when this property is set unless ListGridField.canAutoFitWidth is explicitly set to
false
Note that the ability to perform one-time autofitting of fields via this subsystem is separate from the
programmatic autofit behavior enabled via autoFitFieldWidths.
This subsystem is requires canResizeFields be enabled and will be disabled if that property is set to false
canAutoFitFields - Default value is truepublic java.lang.Boolean getCanAutoFitFields()
If set to true, the default header menu
will include options to auto fit all fields such
that they fit their content or titles as specified via ListGridField.autoFitWidthApproach.
Autofitting of individual fields via a header
context menu item, or the headerAutoFitEvent
will also be enabled when this property is set unless ListGridField.canAutoFitWidth is explicitly set to
false
Note that the ability to perform one-time autofitting of fields via this subsystem is separate from the
programmatic autofit behavior enabled via autoFitFieldWidths.
This subsystem is requires canResizeFields be enabled and will be disabled if that property is set to false
public void setCancelEditingConfirmationMessage(java.lang.String cancelEditingConfirmationMessage)
this.confirmCancelEditing is true this property is used as the message
to display in the confirmation dismissal prompt.cancelEditingConfirmationMessage - Default value is Cancelling this edit will discard unsaved changes for this record. Continue?Editing overview and related methodspublic java.lang.String getCancelEditingConfirmationMessage()
this.confirmCancelEditing is true this property is used as the message
to display in the confirmation dismissal prompt.Editing overview and related methodspublic void setCanCollapseGroup(java.lang.Boolean canCollapseGroup)
throws java.lang.IllegalStateException
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. Additionally groupStartOpen is initialized to "all".canCollapseGroup - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdgroupBy(java.lang.String...)public java.lang.Boolean getCanCollapseGroup()
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. Additionally groupStartOpen is initialized to "all".groupBy(java.lang.String...)public void setCanDragRecordsOut(java.lang.Boolean canDragRecordsOut)
NOTE: If
canDragRecordsOut is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a record starts a drag operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag and drop of records out of the grid.
canDragRecordsOut - Default value is falseListGridRecord.setCanDrag(java.lang.Boolean),
ListGridRecord.setCanAcceptDrop(java.lang.Boolean),
Drag list (move) Example,
Records across Windows Examplepublic java.lang.Boolean getCanDragRecordsOut()
NOTE: If
canDragRecordsOut is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a record starts a drag operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag and drop of records out of the grid.
ListGridRecord.getCanDrag(),
ListGridRecord.getCanAcceptDrop(),
Drag list (move) Example,
Records across Windows Examplepublic void setCanDragSelect(java.lang.Boolean canDragSelect)
NOTE: If canDragSelect is initially enabled or
might be dynamically enabled after the grid is created, it may be desirable to disable touch scrolling so that touch-dragging records/cells selects
them rather than starting a scroll. If Canvas.disableTouchScrollingForDrag is set to true, then touch scrolling will be disabled automatically.
However, for accessibility reasons, it is recommended to leave touch
scrolling enabled and provide an alternative set of controls that can be used to perform drag-selection.
canDragSelect - Default value is falseSelection overview and related methods,
Drag list (select) Examplepublic java.lang.Boolean getCanDragSelect()
NOTE: If canDragSelect is initially enabled or
might be dynamically enabled after the grid is created, it may be desirable to disable touch scrolling so that touch-dragging records/cells selects
them rather than starting a scroll. If Canvas.disableTouchScrollingForDrag is set to true, then touch scrolling will be disabled automatically.
However, for accessibility reasons, it is recommended to leave touch
scrolling enabled and provide an alternative set of controls that can be used to perform drag-selection.
Selection overview and related methods,
Drag list (select) Examplepublic void setCanDragSelectText(java.lang.Boolean canDragSelectText)
rearranging rows or cells by dragging, and with
drag selection of rows.canDragSelectText - Default value is falseSelection overview and related methodspublic java.lang.Boolean getCanDragSelectText()
rearranging rows or cells by dragging, and with
drag selection of rows.Selection overview and related methodspublic void setCanDropInEmptyArea(java.lang.Boolean canDropInEmptyArea)
canDropInEmptyArea - Default value is trueDragdrop overview and related methodspublic java.lang.Boolean getCanDropInEmptyArea()
Dragdrop overview and related methodspublic void setCanEdit(java.lang.Boolean canEdit)
canEdit - Default value is nullstartEditing(),
ListGridField.setCanEdit(java.lang.Boolean),
setRecordEditProperty(java.lang.String),
canEditCell(int, int),
setFields(com.smartgwt.client.widgets.grid.ListGridField...),
Editing overview and related methods,
Edit by row Examplepublic java.lang.Boolean getCanEdit()
startEditing(),
ListGridField.getCanEdit(),
getRecordEditProperty(),
canEditCell(int, int),
getFields(),
Editing overview and related methods,
Edit by row Examplepublic void setCanEditFieldAttribute(java.lang.String canEditFieldAttribute)
throws java.lang.IllegalStateException
SearchForm class has this attribute
set to "canFilter" which allows search forms to edit dataSource fields marked as canEdit:false
(but not those marked as canFilter:false). Note that if canEdit is explicitly specified on
a field in the DataBoundComponent.fields array, that
property will be respected in preference to the canEditAttribute value. (See FormItem.canEdit, ListGridField.canEdit). Also note that individual
dataBoundComponents may have additional logic around whether a field can be edited - for example canEditCell() may be overridden.
Note : This is an advanced setting
canEditFieldAttribute - Default value is "canEdit"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getCanEditFieldAttribute()
SearchForm class has this attribute
set to "canFilter" which allows search forms to edit dataSource fields marked as canEdit:false
(but not those marked as canFilter:false). Note that if canEdit is explicitly specified on
a field in the DataBoundComponent.fields array, that
property will be respected in preference to the canEditAttribute value. (See FormItem.canEdit, ListGridField.canEdit). Also note that individual
dataBoundComponents may have additional logic around whether a field can be edited - for example canEditCell() may be overridden.
public void setCanEditHilites(boolean canEditHilites)
HiliteEditor. User-added hilites can be persisted via DataBoundComponent.getHiliteState() and DataBoundComponent.setHiliteState().
canEditHilites - Default value is falseHiliting overview and related methodspublic boolean getCanEditHilites()
HiliteEditor. User-added hilites can be persisted via DataBoundComponent.getHiliteState() and DataBoundComponent.setHiliteState().
Hiliting overview and related methodspublic void setCanEditTitles(boolean canEditTitles)
advanced field picker
provides an interface allowing users to modify fields' titles. Note that when enabled, the field state for this component will include field titles.
canEditTitles - Default value is falsepublic boolean getCanEditTitles()
advanced field picker
provides an interface allowing users to modify fields' titles. Note that when enabled, the field state for this component will include field titles.
public void setCanExpandMultipleRecords(java.lang.Boolean canExpandMultipleRecords)
canExpandRecords is true, this property
indicates whether multiple records can be expanded simultaneously. If set to false, expanding a record will
automatically collapse any record which is already expanded. The default value is true.
Note : This is an advanced setting
canExpandMultipleRecords - Default value is truepublic java.lang.Boolean getCanExpandMultipleRecords()
canExpandRecords is true, this property
indicates whether multiple records can be expanded simultaneously. If set to false, expanding a record will
automatically collapse any record which is already expanded. The default value is true.public void setCanExpandRecordProperty(java.lang.String canExpandRecordProperty)
throws java.lang.IllegalStateException
canExpandRecordProperty - Default value is "canExpand"java.lang.IllegalStateException - this property cannot be changed after the component has been createdListGridRecord.setCanExpand(java.lang.Boolean)public java.lang.String getCanExpandRecordProperty()
ListGridRecord.getCanExpand()public void setCanExpandRecords(java.lang.Boolean canExpandRecords)
expandRecord() and
expansionMode for details on record expansion.
virtualScrolling is automatically enabled when
canExpandRecords is set to true.
Note that expanded records are not currently supported in conjunction with frozen fields.
If this method is called after the component has been drawn/initialized:
Setter for canExpandRecords
Note : This is an advanced setting
canExpandRecords - new value for listGrid.canExpandRecords.. Default value is falsepublic java.lang.Boolean getCanExpandRecords()
expandRecord() and
expansionMode for details on record expansion.
virtualScrolling is automatically enabled when
canExpandRecords is set to true.
Note that expanded records are not currently supported in conjunction with frozen fields.
public void setCanFocusInEmptyGrid(boolean canFocusInEmptyGrid)
throws java.lang.IllegalStateException
Note that if
editOnFocus is true for this grid and listEndEditAction is set to next, having this property
set to true will allow users to automatically create a new edit row by simply tabbing into the grid.
Note : This is an advanced setting
canFocusInEmptyGrid - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getCanFocusInEmptyGrid()
Note that if
editOnFocus is true for this grid and listEndEditAction is set to next, having this property
set to true will allow users to automatically create a new edit row by simply tabbing into the grid.
public void setCanFreezeFields(java.lang.Boolean canFreezeFields)
true unless:this.fixedRecordHeights is falsethis.bodyOverflow is "visible"this.autoFitData is set to
"horizontal" or "both""visible" Note that the canFreezeFields setting enables or disables the user interface for freezing and
unfreezing fields only. Fields can be programmatically frozen via setting field.frozen to true when the grid is created, or dynamically
frozen and unfrozen via freezeField() and unfreezeField().
If this method is called after the component has been drawn/initialized:
Setter method for canFreezeFields
canFreezeFields - New value for listGrid.canFreezeFields. Default value is nullFrozenFields overview and related methodspublic java.lang.Boolean getCanFreezeFields()
true unless:this.fixedRecordHeights is falsethis.bodyOverflow is "visible"this.autoFitData is set to
"horizontal" or "both""visible" Note that the canFreezeFields setting enables or disables the user interface for freezing and
unfreezing fields only. Fields can be programmatically frozen via setting field.frozen to true when the grid is created, or dynamically
frozen and unfrozen via freezeField() and unfreezeField().
FrozenFields overview and related methodspublic void setCanGroupBy(java.lang.Boolean canGroupBy)
canGroupBy - Default value is truegroupBy(java.lang.String...)public java.lang.Boolean getCanGroupBy()
groupBy(java.lang.String...)public void setCanHover(java.lang.Boolean canHover)
showHover set to false. If unset or null, the hover will be
shown if the corresponding field has showHover:true. If false, then hovers are disabled. Note that standard hovers
override clipped value hovers. Thus, to
enable clipped value hovers, canHover must be unset or null and the corresponding field must have showHover unset or
null as well.
setCanHover in class CanvascanHover - Default value is nullsetShowHover(java.lang.Boolean),
ListGridField.setShowHover(java.lang.Boolean),
Value hover tips Examplepublic java.lang.Boolean getCanHover()
showHover set to false. If unset or null, the hover will be
shown if the corresponding field has showHover:true. If false, then hovers are disabled. Note that standard hovers
override clipped value hovers. Thus, to
enable clipped value hovers, canHover must be unset or null and the corresponding field must have showHover unset or
null as well.
getCanHover in class CanvasgetShowHover(),
ListGridField.getShowHover(),
Value hover tips Examplepublic void setCanMultiGroup(boolean canMultiGroup)
canMultiGroup - Default value is falsepublic boolean getCanMultiGroup()
public void setCanMultiSort(java.lang.Boolean canMultiSort)
DataSource doesn't support multi-sort, or if sorting for a field is
client-only but not all data is available.canMultiSort - Default value is truepublic java.lang.Boolean getCanMultiSort()
DataSource doesn't support multi-sort, or if sorting for a field is
client-only but not all data is available.public void setCanPickFields(java.lang.Boolean canPickFields)
By default only fields explicitly included in the fields array will be available in this menu, unless canPickOmittedFields is set to true for a databound
grid.
A specific field can be omitted from the column picker via ListGridField.canHide.
canPickFields - Default value is truepublic java.lang.Boolean getCanPickFields()
By default only fields explicitly included in the fields array will be available in this menu, unless canPickOmittedFields is set to true for a databound
grid.
A specific field can be omitted from the column picker via ListGridField.canHide.
public void setCanPickOmittedFields(java.lang.Boolean canPickOmittedFields)
throws java.lang.IllegalStateException
dataSource, and useAllDataSourceFields is false, setting this
property to true will cause all dataSource fields not included in the specified set of fields to show up in the field picker menu item. Has no effect if fields is unset (as in this case all dataSource fields will be
displayed by default), or if canPickFields is false.
canPickOmittedFields - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanPickOmittedFields()
dataSource, and useAllDataSourceFields is false, setting this
property to true will cause all dataSource fields not included in the specified set of fields to show up in the field picker menu item. Has no effect if fields is unset (as in this case all dataSource fields will be
displayed by default), or if canPickFields is false.
public void setCanRemoveRecords(java.lang.Boolean canRemoveRecords)
throws java.lang.IllegalStateException
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). Individual
records can be marked to prevent removal - see recordCanRemoveProperty. To add a confirmation
dialog before a record is removed, set warnOnRemoval.
If deferring removal, the record will appear marked with the removedCSSText until the removal is committed via a call to
saveEdits(). Otherwise, the record will disappear from view.
If animateRemoveRecord is true, the removed
record will appear to shrink out of view when it is removed.
By default the field will display the removeIcon next to each record, and will be rendered as the
rightmost column. Two mechanisms exist to further modify this field:
isRemoveField:true set. This will then be used as
the remove field instead of adding a field to the beginning of the set of columns.removeFieldProperties.deferRemoval is true, when a record is marked as removed, the
the icon will change to display the unremoveIcon for
this row. Clicking on this icon will call unmarkRecordRemoved() to mark the record as no longer pending deletion.canRemoveRecords - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdDatabinding overview and related methodspublic java.lang.Boolean getCanRemoveRecords()
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). Individual
records can be marked to prevent removal - see recordCanRemoveProperty. To add a confirmation
dialog before a record is removed, set warnOnRemoval.
If deferring removal, the record will appear marked with the removedCSSText until the removal is committed via a call to
saveEdits(). Otherwise, the record will disappear from view.
If animateRemoveRecord is true, the removed
record will appear to shrink out of view when it is removed.
By default the field will display the removeIcon next to each record, and will be rendered as the
rightmost column. Two mechanisms exist to further modify this field:
isRemoveField:true set. This will then be used as
the remove field instead of adding a field to the beginning of the set of columns.removeFieldProperties.deferRemoval is true, when a record is marked as removed, the
the icon will change to display the unremoveIcon for
this row. Clicking on this icon will call unmarkRecordRemoved() to mark the record as no longer pending deletion.Databinding overview and related methodspublic void setCanReorderFields(java.lang.Boolean canReorderFields)
ListGridField.canReorder.canReorderFields - Default value is truepublic java.lang.Boolean getCanReorderFields()
ListGridField.canReorder.public void setCanReorderRecords(java.lang.Boolean canReorderRecords)
ListGrid. NOTE: If
canReorderRecords is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a record starts a reorder operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag-reordering of records.
If this method is called after the component has been drawn/initialized:
Setter for the canReorderRecords attribute.
canReorderRecords - new value for this.canReorderRecords. Default value is falseListGridRecord.setCanDrag(java.lang.Boolean),
ListGridRecord.setCanAcceptDrop(java.lang.Boolean),
Drag list (move) Example,
Drag reorder Examplepublic java.lang.Boolean getCanReorderRecords()
ListGrid. NOTE: If
canReorderRecords is initially enabled or might be dynamically enabled after the grid is created, it may be
desirable to disable touch scrolling so that
touch-dragging a record starts a reorder operation rather than a scroll. If Canvas.disableTouchScrollingForDrag is set to
true, then touch scrolling will be disabled automatically. However, for accessibility reasons, it is recommended to leave touch scrolling enabled and
provide an alternative set of controls that can be used to perform drag-reordering of records.
ListGridRecord.getCanDrag(),
ListGridRecord.getCanAcceptDrop(),
Drag list (move) Example,
Drag reorder Examplepublic void setCanResizeFields(java.lang.Boolean canResizeFields)
canResizeFields at runtime.canResizeFields - new value for this.canResizeFields. Default value is truepublic java.lang.Boolean getCanResizeFields()
public void setCanSelectAll(java.lang.Boolean canSelectAll)
selectionAppearance set to "checkbox"canSelectAll - Default value is nullSelection overview and related methodspublic java.lang.Boolean getCanSelectAll()
selectionAppearance set to "checkbox"Selection overview and related methodspublic void setCanSelectCells(java.lang.Boolean canSelectCells)
throws java.lang.IllegalStateException
cell-level rollover. To query and manipulate cell-level selections, use getCellSelection() to retrieve the CellSelection.
Note that the ListGrid has a data model of one Record per row, unlike the CubeGrid which supports
one CellRecord per cell. For this reason record-oriented APIs that act on the
selection will act on entire Records that have any selected cells (examples include drag and drop and
transferSelectedData()).
More generally, canSelectCells is primarily intended to enable developers to
build Excel-like interactions on local datasets, by using setData() plus saveLocally:true rather than
record-oriented DataSources and data binding.
The following keyboard selection behaviors are enabled with this property in addition to standard single-selection Arrow Key navigation:
SHIFT + [Arrow Key]: begin or continue incremental selection
SHIFT + CTRL + [Arrow Key]: incremental selection to the end of row or column
CTRL + A: select all cells (enabled only with canSelectAll)
Incremental selection allows selection of rows and columns of cells via keyboard or mouse provided the shift key is down. Behavior is designed to match Excel. Thus, if a previous selection has begun, cells will be selected from that origin.
Users may also navigate through cells using the Tab and Shift+Tab
keypresses if navigateOnTab is true. When a user tabs
to the end of the row, the rowEndEditAction is
used to determine whether to shift selection to the next row, return to the beginning of the same row, or simply move on
through the page's tab order.
canSelectCells - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanSelectCells()
cell-level rollover. To query and manipulate cell-level selections, use getCellSelection() to retrieve the CellSelection.
Note that the ListGrid has a data model of one Record per row, unlike the CubeGrid which supports
one CellRecord per cell. For this reason record-oriented APIs that act on the
selection will act on entire Records that have any selected cells (examples include drag and drop and
transferSelectedData()).
More generally, canSelectCells is primarily intended to enable developers to
build Excel-like interactions on local datasets, by using setData() plus saveLocally:true rather than
record-oriented DataSources and data binding.
The following keyboard selection behaviors are enabled with this property in addition to standard single-selection Arrow Key navigation:
SHIFT + [Arrow Key]: begin or continue incremental selection
SHIFT + CTRL + [Arrow Key]: incremental selection to the end of row or column
CTRL + A: select all cells (enabled only with canSelectAll)
Incremental selection allows selection of rows and columns of cells via keyboard or mouse provided the shift key is down. Behavior is designed to match Excel. Thus, if a previous selection has begun, cells will be selected from that origin.
Users may also navigate through cells using the Tab and Shift+Tab
keypresses if navigateOnTab is true. When a user tabs
to the end of the row, the rowEndEditAction is
used to determine whether to shift selection to the next row, return to the beginning of the same row, or simply move on
through the page's tab order.
public void setCanSelectGroups(boolean canSelectGroups)
groups appears in
the group node if SelectionAppearance is set to "checkbox"canSelectGroups - Default value is falseSelection overview and related methodspublic boolean getCanSelectGroups()
groups appears in
the group node if SelectionAppearance is set to "checkbox"Selection overview and related methodspublic void setCanSort(java.lang.Boolean canSort)
sort or setSort methods.canSort - Default value is truepublic java.lang.Boolean getCanSort()
sort or setSort methods.public void setCanTabToHeader(java.lang.Boolean canTabToHeader)
throws java.lang.IllegalStateException
isc.setScreenReaderMode() is
called.canTabToHeader - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdAccessibility overview and related methodspublic java.lang.Boolean getCanTabToHeader()
isc.setScreenReaderMode() is
called.Accessibility overview and related methodspublic Layout getCellContextMenu() throws java.lang.IllegalStateException
This component is an AutoChild named "cellContextMenu". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setCellHeight(int cellHeight)
cellHeight - Default value is 20public int getCellHeight()
public void setCellPadding(int cellPadding)
cellPadding - Default value is 2public int getCellPadding()
public void setChartConstructor(java.lang.String chartConstructor)
throws java.lang.IllegalStateException
chartConstructor - Default value is "FacetChart"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getChartConstructor()
public void setChartType(ChartType chartType)
chartType - Default value is "Column"public ChartType getChartType()
public void setCheckboxFieldFalseImage(java.lang.String checkboxFieldFalseImage)
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for an unselected row. If
unset, the booleanFalseImage will be used. Note
that the special value "blank" means that no image will be shown.
Note : This is an advanced setting
checkboxFieldFalseImage - SCImgURL . Default value is null,
setCheckboxFieldTrueImage(java.lang.String),
setCheckboxFieldImageWidth(java.lang.Integer),
setCheckboxFieldImageHeight(java.lang.Integer),
setPrintCheckboxFieldFalseImage(java.lang.String)public java.lang.String getCheckboxFieldFalseImage()
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for an unselected row. If
unset, the booleanFalseImage will be used. Note
that the special value "blank" means that no image will be shown.public void setCheckboxFieldImageHeight(java.lang.Integer checkboxFieldImageHeight)
throws java.lang.IllegalStateException
selectionAppearance is set to
"checkbox" this property may be set to govern the height of the checkbox image displayed to indicate
whether a row is selected. If unset, the checkboxField image will be sized to match the booleanImageHeight for this grid.checkboxFieldImageHeight - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getCheckboxFieldImageHeight()
selectionAppearance is set to
"checkbox" this property may be set to govern the height of the checkbox image displayed to indicate
whether a row is selected. If unset, the checkboxField image will be sized to match the booleanImageHeight for this grid.public void setCheckboxFieldImageWidth(java.lang.Integer checkboxFieldImageWidth)
throws java.lang.IllegalStateException
selectionAppearance is set to
"checkbox" this property may be set to govern the width of the checkbox image displayed to indicate whether
a row is selected. If unset, the checkboxField image will be sized to match the booleanImageWidth for this grid.checkboxFieldImageWidth - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getCheckboxFieldImageWidth()
selectionAppearance is set to
"checkbox" this property may be set to govern the width of the checkbox image displayed to indicate whether
a row is selected. If unset, the checkboxField image will be sized to match the booleanImageWidth for this grid.public void setCheckboxFieldPartialImage(java.lang.String checkboxFieldPartialImage)
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a partially selected
row. If unset, the booleanPartialImage will be
used. Note that the special value "blank" means that no image will be shown.
Note : This is an advanced setting
checkboxFieldPartialImage - SCImgURL . Default value is null,
setCheckboxFieldTrueImage(java.lang.String),
setCheckboxFieldImageWidth(java.lang.Integer),
setCheckboxFieldImageHeight(java.lang.Integer),
setPrintCheckboxFieldPartialImage(java.lang.String),
Printing overview and related methodspublic java.lang.String getCheckboxFieldPartialImage()
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a partially selected
row. If unset, the booleanPartialImage will be
used. Note that the special value "blank" means that no image will be shown.public void setCheckboxFieldTrueImage(java.lang.String checkboxFieldTrueImage)
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a selected row. If
unset, the booleanTrueImage will be used. Note
that the special value "blank" means that no image will be shown.
Note : This is an advanced setting
checkboxFieldTrueImage - SCImgURL . Default value is null,
setCheckboxFieldFalseImage(java.lang.String),
setCheckboxFieldImageWidth(java.lang.Integer),
setCheckboxFieldImageHeight(java.lang.Integer),
setPrintCheckboxFieldTrueImage(java.lang.String)public java.lang.String getCheckboxFieldTrueImage()
selectionAppearance is set to
"checkbox" this property determines the image to display in the checkbox field for a selected row. If
unset, the booleanTrueImage will be used. Note
that the special value "blank" means that no image will be shown.public void setChildExpansionMode(ExpansionMode childExpansionMode)
expansionModes that show another grid or tree, what the child's
expansionMode should be. Default value null means no further expansion.
Note : This is an advanced setting
childExpansionMode - Default value is nullpublic ExpansionMode getChildExpansionMode()
expansionModes that show another grid or tree, what the child's
expansionMode should be. Default value null means no further expansion.
public void setClearAllSortingText(java.lang.String clearAllSortingText)
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear any existing sort on all fields. This menu-item is
displayed only in the context menu for the sorter button.clearAllSortingText - Default value is "Clear All Sorting"public java.lang.String getClearAllSortingText()
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear any existing sort on all fields. This menu-item is
displayed only in the context menu for the sorter button.public void setClearFilterText(java.lang.String clearFilterText)
headerContextMenu for this
grid, and a filter-editor is visible, this
attribute will be shown as the menu item title to clear any existing filter. This menu-item is displayed only in the
context menu for the sorter button.clearFilterText - Default value is "Clear Filter"public java.lang.String getClearFilterText()
headerContextMenu for this
grid, and a filter-editor is visible, this
attribute will be shown as the menu item title to clear any existing filter. This menu-item is displayed only in the
context menu for the sorter button.public void setClearSortFieldText(java.lang.String clearSortFieldText)
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear an existing sort on this field.clearSortFieldText - Default value is "Clear Sort"public java.lang.String getClearSortFieldText()
headerContextMenu for this
grid, this attribute will be shown as the menu item title to clear an existing sort on this field.public void setClipHeaderTitles(java.lang.Boolean clipHeaderTitles)
throws java.lang.IllegalStateException
hover. In some cases this may be
preferable to the button component's default clipping behavior because if a sort arrow or sort numeral is displayed for a header, then
the button's default clipping behavior may clip the sort arrow/numeral whereas ListGrid-managed title clipping utilizes
special HTML which keeps the sort arrow/numeral visible.
This feature is automatically enabled if supported by the browser. The only supported use of this attribute is to disable the feature by setting clipHeaderTitles to false.
Note that this feature is incompatible with ListGridField.wrap, and will automatically be disabled for wrapping fields.
Note : This is an advanced setting
clipHeaderTitles - Default value is variesjava.lang.IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methodspublic java.lang.Boolean getClipHeaderTitles()
hover. In some cases this may be
preferable to the button component's default clipping behavior because if a sort arrow or sort numeral is displayed for a header, then
the button's default clipping behavior may clip the sort arrow/numeral whereas ListGrid-managed title clipping utilizes
special HTML which keeps the sort arrow/numeral visible.
This feature is automatically enabled if supported by the browser. The only supported use of this attribute is to disable the feature by setting clipHeaderTitles to false.
Note that this feature is incompatible with ListGridField.wrap, and will automatically be disabled for wrapping fields.
Appearance overview and related methodspublic void setCollapseGroupOnRowClick(boolean collapseGroupOnRowClick)
throws java.lang.IllegalStateException
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.collapseGroupOnRowClick - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdgroupBy(java.lang.String...)public boolean getCollapseGroupOnRowClick()
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.groupBy(java.lang.String...)public void setConfigureGroupingText(java.lang.String configureGroupingText)
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.configureGroupingText - Default value is "Configure Grouping..."public java.lang.String getConfigureGroupingText()
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.public void setConfigureSortText(java.lang.String configureSortText)
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. This menu-item is
displayed only in the context menu for the sorter button.configureSortText - Default value is "Configure Sort..."public java.lang.String getConfigureSortText()
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. This menu-item is
displayed only in the context menu for the sorter button.public void setConfirmCancelEditing(java.lang.Boolean confirmCancelEditing)
confirmCancelEditing - Default value is falseEditing overview and related methodspublic java.lang.Boolean getConfirmCancelEditing()
Editing overview and related methodspublic void setConfirmDiscardEdits(java.lang.Boolean confirmDiscardEdits)
confirmDiscardEdits - Default value is trueEditing overview and related methodspublic java.lang.Boolean getConfirmDiscardEdits()
Editing overview and related methodspublic void setConfirmDiscardEditsMessage(java.lang.String confirmDiscardEditsMessage)
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.confirmDiscardEditsMessage - Default value is "This action will discard unsaved changes for this list."Editing overview and related methodspublic java.lang.String getConfirmDiscardEditsMessage()
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.Editing overview and related methodspublic void setData(ListGridRecord... data)
When using a DataSource, rather than directly providing
data, you will typically call fetchData()
instead, which will automatically establish data as a ResultSet
(see the fetchData() docs for details).
If you call
fetchData, any previously supplied data is discarded. Also, it is not necessary to call
setData() after calling fetchData().
When
calling setData(), if data is provided as a RecordList or ResultSet, direct changes to the
list using Framework APIs such as RecordList.add() or RecordList.remove() will be automatically observed and the ListGrid will
redraw in response. However, direct changes to individual Records will not be automatically observed and require calls
to refreshCell() or refreshRow() to cause the ListGrid to visually update. Calling
methods such as updateData(), removeData() or addData() always causes automatic visual refresh.
If this method is called after the component has been drawn/initialized:
Provides a new data set to the ListGrid after the grid has been created or drawn. The ListGrid will redraw to show the new data automatically.
data - data to show in the list. Default value is nullListGridRecord,
Inline data Example,
Local data Examplepublic void setDataFetchDelay(java.lang.Integer dataFetchDelay)
Note: the floor value for this attribute is 1. If you set this value to zero, it will be defaulted to 1 for you instead.
Note : This is an advanced setting
dataFetchDelay - Default value is 1Databinding overview and related methodspublic java.lang.Integer getDataFetchDelay()
Note: the floor value for this attribute is 1. If you set this value to zero, it will be defaulted to 1 for you instead.
Databinding overview and related methodspublic void setDataFetchMode(FetchMode dataFetchMode) throws java.lang.IllegalStateException
FetchMode. This
setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData()
instead, it's existing setting for ResultSet.fetchMode applies.
setDataFetchMode in interface DataBoundComponentdataFetchMode - Default value is "paged"java.lang.IllegalStateException - this property cannot be changed after the component has been createdDatabinding overview and related methodspublic FetchMode getDataFetchMode()
FetchMode. This
setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData()
instead, it's existing setting for ResultSet.fetchMode applies.
getDataFetchMode in interface DataBoundComponentDatabinding overview and related methodspublic void setDataSource(DataSource dataSource)
DataSource requests. Can be specified as either a DataSource instance or the
String ID of a DataSource.
If this method is called after the component has been drawn/initialized:
Bind to a new DataSource.
Like passing the "dataSource" property on creation, binding to a DataSource means that the component will use the DataSource to provide default data for its fields.
When binding to a new DataSource, if the component has any existing "fields" or has a dataset, these will be discarded by default, since it is assumed the new DataSource may represent a completely unrelated set of objects. If the old "fields" are still relevant, pass them to setDataSource().
setDataSource in interface DataBoundComponentdataSource - DataSource to bind to. Default value is nullDatabinding overview and related methods,
DataSource fields Examplepublic void setDataSource(java.lang.String dataSource)
DataSource requests. Can be specified as either a DataSource instance or the
String ID of a DataSource.
If this method is called after the component has been drawn/initialized:
Bind to a new DataSource.
Like passing the "dataSource" property on creation, binding to a DataSource means that the component will use the DataSource to provide default data for its fields.
When binding to a new DataSource, if the component has any existing "fields" or has a dataset, these will be discarded by default, since it is assumed the new DataSource may represent a completely unrelated set of objects. If the old "fields" are still relevant, pass them to setDataSource().
setDataSource in interface DataBoundComponentdataSource - DataSource to bind to. Default value is nullDatabinding overview and related methods,
DataSource fields Examplepublic void setDateFormatter(DateDisplayFormat dateFormatter)
This property specifies the default
DateDisplayFormat to apply to Date values displayed in this grid for all fields except those of type "time" (See also timeFormatter).
If datetimeFormatter is specified, that will be applied by
default to fields of type "datetime".
Note that if ListGridField.dateFormatter or ListGridField.timeFormatter are specified those
properties will take precedence over the component level settings.
If unset, date values will be formatted according
to the system wide short display format or short datetime display format for datetime type fields.
If this field is editable the dateFormatter will also be passed to the editor created to edit this field as dateFormatter. In this case you may also need to set
dateInputFormat.
dateFormatter - Default value is nullpublic DateDisplayFormat getDateFormatter()
This property specifies the default
DateDisplayFormat to apply to Date values displayed in this grid for all fields except those of type "time" (See also timeFormatter).
If datetimeFormatter is specified, that will be applied by
default to fields of type "datetime".
Note that if ListGridField.dateFormatter or ListGridField.timeFormatter are specified those
properties will take precedence over the component level settings.
If unset, date values will be formatted according
to the system wide short display format or short datetime display format for datetime type fields.
If this field is editable the dateFormatter will also be passed to the editor created to edit this field as dateFormatter. In this case you may also need to set
dateInputFormat.
public void setDateInputFormat(java.lang.String dateInputFormat)
inputFormat applied to editors for fields of type
"date". May be overridden per field via ListGridField.inputFormat.
Note : This is an advanced setting
dateInputFormat - DateInputFormat . Default value is null,
setDateFormatter(com.smartgwt.client.types.DateDisplayFormat)public void setDatetimeFormatter(DateDisplayFormat datetimeFormatter)
Date.setShortDatetimeDisplayFormat(). Specify any valid DateDisplayFormat to change
the display format for datetimes used by this grid. May also be specified at the field level via ListGridField.dateFormatter
If this field is
editable the dateFormatter will also be passed to the editor created to edit this field as dateFormatter. In this case you may also need to set
dateInputFormat.
datetimeFormatter - Default value is nullListGridField.setDateFormatter(com.smartgwt.client.types.DateDisplayFormat),
Appearance overview and related methodspublic DateDisplayFormat getDatetimeFormatter()
Date.setShortDatetimeDisplayFormat(). Specify any valid DateDisplayFormat to change
the display format for datetimes used by this grid. May also be specified at the field level via ListGridField.dateFormatter
If this field is
editable the dateFormatter will also be passed to the editor created to edit this field as dateFormatter. In this case you may also need to set
dateInputFormat.
ListGridField.getDateFormatter(),
Appearance overview and related methodspublic void setDefaultFields(ListGridField... defaultFields) throws java.lang.IllegalStateException
fields attribute, this.fields will be defaulted to a generated array of field objects
duplicated from this array. This property is useful for cases where a standard set of fields will be displayed in
multiple listGrids - for example a subclass of ListGrid intended to display a particular type of data:
In this
example we would not assign a single fields array directly
to the class via addProperties() as every generated instance of this class would then point to the same
fields array object. This would cause unexpected behavior such as changes to the field order in one grid effecting other
grids on the page.
Instead we could use addProperties() on our new subclass to set
defaultFields to a standard array of fields to display. Each generated instance of the subclass would then
show up with default fields duplicated from this array.
Note : This is an advanced setting
defaultFields - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic ListGridField[] getDefaultFields()
fields attribute, this.fields will be defaulted to a generated array of field objects
duplicated from this array. This property is useful for cases where a standard set of fields will be displayed in
multiple listGrids - for example a subclass of ListGrid intended to display a particular type of data:
In this
example we would not assign a single fields array directly
to the class via addProperties() as every generated instance of this class would then point to the same
fields array object. This would cause unexpected behavior such as changes to the field order in one grid effecting other
grids on the page.
Instead we could use addProperties() on our new subclass to set
defaultFields to a standard array of fields to display. Each generated instance of the subclass would then
show up with default fields duplicated from this array.
public void setDefaultFilterOperator(OperatorId defaultFilterOperator) throws java.lang.IllegalStateException
filter operator to use for text-based fields in this grid's filter editor, when producing AdvancedCriteria. When allowFilterExpressions or allowFilterOperators are enabled for the grid, the
default is "iContainsPattern". Otherwise, the
default is "iContains". Does not apply to special fields where exact match is obviously the right default setting,
such as fields of type:"enum", or fields with a valueMap or optionDataSource.
defaultFilterOperator - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic OperatorId getDefaultFilterOperator()
filter operator to use for text-based fields in this grid's filter editor, when producing AdvancedCriteria. When allowFilterExpressions or allowFilterOperators are enabled for the grid, the
default is "iContainsPattern". Otherwise, the
default is "iContains". Does not apply to special fields where exact match is obviously the right default setting,
such as fields of type:"enum", or fields with a valueMap or optionDataSource.
public void setDefaultFilterOperatorSuffix(java.lang.String defaultFilterOperatorSuffix)
throws java.lang.IllegalStateException
headerContextMenu when allowFilterOperators is enabled.defaultFilterOperatorSuffix - Default value is "(default)"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getDefaultFilterOperatorSuffix()
headerContextMenu when allowFilterOperators is enabled.public void setDeferRemoval(java.lang.Boolean deferRemoval)
throws java.lang.IllegalStateException
canRemoveRecords
causes records to be marked for future removal via markRecordRemoved() instead of immediately being removed. When a record has been marked for removal, an icon in the
canRemoveRecords field allowing it to be unmarked will be displayed.
If not explicitly specified by
this property, removal of records will be deferred if autoSaveEdits is false for the grid.
deferRemoval - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdEditing overview and related methodspublic java.lang.Boolean getDeferRemoval()
canRemoveRecords
causes records to be marked for future removal via markRecordRemoved() instead of immediately being removed. When a record has been marked for removal, an icon in the
canRemoveRecords field allowing it to be unmarked will be displayed.
If not explicitly specified by
this property, removal of records will be deferred if autoSaveEdits is false for the grid.
Editing overview and related methodspublic void setDetailDS(java.lang.String detailDS)
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. This property may also be
specified on a per-record basis - see recordDetailDSProperty
Note : This is an advanced setting
detailDS - Default value is nullpublic java.lang.String getDetailDS()
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. This property may also be
specified on a per-record basis - see recordDetailDSProperty
public void setDetailField(java.lang.String detailField)
canExpandRecords is true and listGrid.expansionMode is detailField.
Note : This is an advanced setting
detailField - Default value is nullpublic java.lang.String getDetailField()
canExpandRecords is true and listGrid.expansionMode is detailField.public void setDiscardEditsOnHideField(boolean discardEditsOnHideField)
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? Default behavior is to discard the edits - set this flag to false to preserve edits
discardEditsOnHideField - Default value is truepublic boolean getDiscardEditsOnHideField()
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? Default behavior is to discard the edits - set this flag to false to preserve edits
public void setDiscardEditsSaveButtonTitle(java.lang.String discardEditsSaveButtonTitle)
confirmDiscardEdits is true this is the
title for the save button appearing in the lost edits confirmation dialog. Override this for localization if necessary.discardEditsSaveButtonTitle - Default value is "Save"Editing overview and related methodspublic java.lang.String getDiscardEditsSaveButtonTitle()
confirmDiscardEdits is true this is the
title for the save button appearing in the lost edits confirmation dialog. Override this for localization if necessary.Editing overview and related methodspublic void setDragScrollRedrawDelay(int dragScrollRedrawDelay)
scrollRedrawDelay, but applies when the
component is being drag-scrolled (via a scrollbar). This value is typically set higher than scrollRedrawDelay to avoid too many concurrent fetches
to the server for ResultSet-backed components since it's quite easy to induce such a
case with a scrollbar and a grid bound to a large databaset.dragScrollRedrawDelay - Default value is 75public int getDragScrollRedrawDelay()
scrollRedrawDelay, but applies when the
component is being drag-scrolled (via a scrollbar). This value is typically set higher than scrollRedrawDelay to avoid too many concurrent fetches
to the server for ResultSet-backed components since it's quite easy to induce such a
case with a scrollbar and a grid bound to a large databaset.public void setDragTrackerMode(DragTrackerMode dragTrackerMode) throws java.lang.IllegalStateException
Note : This is an advanced setting
dragTrackerMode - Default value is "icon"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic DragTrackerMode getDragTrackerMode()
public void setDrawAheadRatio(float drawAheadRatio)
Tweaking drawAheadRatio allows you to make tradeoffs between continuous scrolling speed vs initial render time and render time when scrolling by large amounts.
NOTE: Only applies when showAllRows is false.
drawAheadRatio - Default value is 2.0public float getDrawAheadRatio()
Tweaking drawAheadRatio allows you to make tradeoffs between continuous scrolling speed vs initial render time and render time when scrolling by large amounts.
NOTE: Only applies when showAllRows is false.
public void setDrawAllMaxCells(int drawAllMaxCells)
drawAllMaxCells cells to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
the viewport size and drawAheadRatio setting would
normally have caused incremental rendering to be used. The drawAllMaxCells setting prevents incremental
rendering from being used in situations where it's really unnecessary, such as a 40 row, 5 column dataset (only 200
cells) which happens to be in a grid with a viewport showing only 20 or so rows. Incremental rendering causes a brief
"flash" during scrolling as the visible portion of the dataset is redrawn, and a better scrolling experience can be
obtained in this situation by drawing the entire dataset up front, which in this example would have negligible effect on
initial draw time.
drawAllMaxCells:0 disables this features. You may want to disable this feature if
performance is an issue and:
Note : This is an advanced setting
drawAllMaxCells - Default value is 250public int getDrawAllMaxCells()
drawAllMaxCells cells to be rendered, the full dataset will
instead be drawn even if showAllRecords is false and
the viewport size and drawAheadRatio setting would
normally have caused incremental rendering to be used. The drawAllMaxCells setting prevents incremental
rendering from being used in situations where it's really unnecessary, such as a 40 row, 5 column dataset (only 200
cells) which happens to be in a grid with a viewport showing only 20 or so rows. Incremental rendering causes a brief
"flash" during scrolling as the visible portion of the dataset is redrawn, and a better scrolling experience can be
obtained in this situation by drawing the entire dataset up front, which in this example would have negligible effect on
initial draw time.
drawAllMaxCells:0 disables this features. You may want to disable this feature if
performance is an issue and:
public void setEditByCell(java.lang.Boolean editByCell)
No effect if this.canEdit is false or null.
editByCell - Default value is nullsetCanEdit(java.lang.Boolean),
Editing overview and related methods,
Edit by cell Examplepublic java.lang.Boolean getEditByCell()
No effect if this.canEdit is false or null.
getCanEdit(),
Editing overview and related methods,
Edit by cell Examplepublic void setEditEvent(ListGridEditEvent editEvent)
ListGridEditEvent for options. Note
this setting has no effect unless canEdit has been set to
enable editing.
See also editOnFocus and startEditing().
editEvent - Default value is "doubleClick"Editing overview and related methods,
Edit by row Examplepublic ListGridEditEvent getEditEvent()
ListGridEditEvent for options. Note
this setting has no effect unless canEdit has been set to
enable editing.
See also editOnFocus and startEditing().
Editing overview and related methods,
Edit by row Examplepublic void setEditFailedBaseStyle(java.lang.String editFailedBaseStyle)
this.editFailedCSSText
Note : This is an advanced setting
editFailedBaseStyle - CSSStyleName . Default value is null,
setBaseStyle(java.lang.String),
setEditFailedCSSText(java.lang.String),
Appearance overview and related methodspublic java.lang.String getEditFailedBaseStyle()
this.editFailedCSSTextCSSStyleName,
getBaseStyle(),
getEditFailedCSSText(),
Appearance overview and related methodspublic void setEditFailedCSSText(java.lang.String editFailedCSSText)
this.editFailedBaseStyle instead.
Note : This is an advanced setting
editFailedCSSText - Default value is "color:red;border:1px solid red;"setEditFailedBaseStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getEditFailedCSSText()
this.editFailedBaseStyle instead.getEditFailedBaseStyle(),
Appearance overview and related methodspublic void setEditOnF2Keypress(java.lang.Boolean editOnF2Keypress)
Note that if editEvent is set to "click"
or "doubleClick", the Space or Enter key may also be used to start editing,
depending on the value for generateClickOnSpace, generateDoubleClickOnSpace, generateClickOnEnter and generateDoubleClickOnEnter.
If canEdit is false, or
editEvent is set to "none" this property has no effect.
Note : This is an advanced setting
editOnF2Keypress - Default value is trueEditing overview and related methodspublic java.lang.Boolean getEditOnF2Keypress()
Note that if editEvent is set to "click"
or "doubleClick", the Space or Enter key may also be used to start editing,
depending on the value for generateClickOnSpace, generateDoubleClickOnSpace, generateClickOnEnter and generateDoubleClickOnEnter.
If canEdit is false, or
editEvent is set to "none" this property has no effect.
Editing overview and related methodspublic void setEditOnFocus(java.lang.Boolean editOnFocus)
Note that this property
being set to true will cause editing to occur on a single click, even if editEvent is "doubleClick", because single clicking
the grid will place keyboard focus there automatically.
If this property is set together with listEndEditAction being set to "next", users can create
a new edit row in an empty grid by simply tabbing into the grid.
Note : This is an advanced setting
editOnFocus - Default value is nullEditing overview and related methodspublic java.lang.Boolean getEditOnFocus()
Note that this property
being set to true will cause editing to occur on a single click, even if editEvent is "doubleClick", because single clicking
the grid will place keyboard focus there automatically.
If this property is set together with listEndEditAction being set to "next", users can create
a new edit row in an empty grid by simply tabbing into the grid.
Editing overview and related methodspublic void setEditPendingBaseStyle(java.lang.String editPendingBaseStyle)
throws java.lang.IllegalStateException
If this property is null (the default setting), cells with pending edits will pick up custom css text to be
applied on top of the normal base style from this.editPendingCSSText.
Note : This is an advanced setting
editPendingBaseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
setBaseStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getEditPendingBaseStyle()
If this property is null (the default setting), cells with pending edits will pick up custom css text to be
applied on top of the normal base style from this.editPendingCSSText.
CSSStyleName,
getBaseStyle(),
Appearance overview and related methodspublic void setEditPendingCSSText(java.lang.String editPendingCSSText)
this.editPendingBaseStyle instead.
Note : This is an advanced setting
editPendingCSSText - Default value is "color:#0066CC;"setEditFailedBaseStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getEditPendingCSSText()
this.editPendingBaseStyle instead.getEditFailedBaseStyle(),
Appearance overview and related methodspublic void setEditProxyConstructor(java.lang.String editProxyConstructor)
throws java.lang.IllegalStateException
EditProxy for this component when the component is
first placed into edit mode.setEditProxyConstructor in class LayouteditProxyConstructor - java.lang.IllegalStateException - this property cannot be changed after the component has been createdSCClassName . Default value is "GridEditProxy"public java.lang.String getEditProxyConstructor()
EditProxy for this component when the component is
first placed into edit mode.getEditProxyConstructor in class LayoutSCClassNamepublic void setEmptyCellValue(java.lang.String emptyCellValue)
formatting and valueMap (if any). This is the grid-wide attribute. You may also set the emptyCellValue on a per-field basis.
emptyCellValue - HTMLString . Default value is " ",
ListGridField.setEmptyCellValue(java.lang.String),
Empty values Examplepublic java.lang.String getEmptyCellValue()
formatting and valueMap (if any). This is the grid-wide attribute. You may also set the emptyCellValue on a per-field basis.
HTMLString,
ListGridField.getEmptyCellValue(),
Empty values Examplepublic void setEmptyMessage(java.lang.String emptyMessage)
emptyMessage - HTMLString . Default value is "No items to show.",
Empty grid Examplepublic java.lang.String getEmptyMessage()
HTMLString,
Empty grid Examplepublic void setEmptyMessageStyle(java.lang.String emptyMessageStyle)
emptyMessage if
displayed.emptyMessageStyle - CSSStyleName . Default value is "emptyMessage"public java.lang.String getEmptyMessageStyle()
emptyMessage if
displayed.CSSStyleNamepublic void setEnforceVClipping(java.lang.Boolean enforceVClipping)
fixedRecordHeights is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers. Set enforceVClipping:true to enforce
clipping for all types of content on all browsers. This additional setting is likely to be phased out as browsers improve.
enforceVClipping - Default value is falsepublic java.lang.Boolean getEnforceVClipping()
fixedRecordHeights is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers. Set enforceVClipping:true to enforce
clipping for all types of content on all browsers. This additional setting is likely to be phased out as browsers improve.
public void setEnterKeyEditAction(EnterKeyEditAction enterKeyEditAction)
enterKeyEditAction - Default value is "done"Editing overview and related methodspublic EnterKeyEditAction getEnterKeyEditAction()
Editing overview and related methodspublic void setEnumCriteriaAsInitialValues(java.lang.Boolean enumCriteriaAsInitialValues)
throws java.lang.IllegalStateException
type "enum" in the DataSource, by default a newly edited row will use those filter
criteria as initial values. For example, if a ListGrid is showing all Accounts that have status:"Active" and a new row is created, the new row will default to status:"Active" unless this flag is set to false.
enumCriteriaAsInitialValues - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdEditing overview and related methodspublic java.lang.Boolean getEnumCriteriaAsInitialValues()
type "enum" in the DataSource, by default a newly edited row will use those filter
criteria as initial values. For example, if a ListGrid is showing all Accounts that have status:"Active" and a new row is created, the new row will default to status:"Active" unless this flag is set to false.
Editing overview and related methodspublic void setErrorIconHeight(java.lang.Integer errorIconHeight)
errorIconHeight - Default value is 16public java.lang.Integer getErrorIconHeight()
public void setErrorIconSrc(java.lang.String errorIconSrc)
errorIconSrc - SCImgURL . Default value is "[SKIN]/ListGrid/validation_error_icon.png"public java.lang.String getErrorIconSrc()
SCImgURLpublic void setErrorIconWidth(java.lang.Integer errorIconWidth)
errorIconWidth - Default value is 16public java.lang.Integer getErrorIconWidth()
public void setEscapeKeyEditAction(EscapeKeyEditAction escapeKeyEditAction)
autoSaveEdits is true, this may cause a save
of the current edit valuesescapeKeyEditAction - Default value is "cancel"Editing overview and related methodspublic EscapeKeyEditAction getEscapeKeyEditAction()
autoSaveEdits is true, this may cause a save
of the current edit valuesEditing overview and related methodspublic void setExpansionCanEdit(java.lang.Boolean expansionCanEdit)
expansionModes that show another grid or tree, is that component
editable? The default value for this property is false.
Note : This is an advanced setting
expansionCanEdit - Default value is nullpublic java.lang.Boolean getExpansionCanEdit()
expansionModes that show another grid or tree, is that component
editable? The default value for this property is false.
public void setExpansionComponentPoolingMode(ExpansionComponentPoolingMode expansionComponentPoolingMode)
component-pooling to employ for expansionComponents. The default mode is "destroy", which means that automatically created expansionComponents are destroyed when rows are collapsed.
Note : This is an advanced setting
expansionComponentPoolingMode - Default value is "destroy"public ExpansionComponentPoolingMode getExpansionComponentPoolingMode()
component-pooling to employ for expansionComponents. The default mode is "destroy", which means that automatically created expansionComponents are destroyed when rows are collapsed.
public HTMLFlow getExpansionDetailField()
Using AutoChildren
for details.
Automatically generated HTMLFlow for displaying the contents of a specified field in a record's expanded section when listGrid.expansionMode is detailField.
This component is an
com.smartgwt.client.types.AutoChild and as such may be customized via
listGrid.expansionDetailFieldProperties and listGrid.expansionDetailFieldDefaults.
Note, however, that this is a multi-instance component (potentially one per record), so it is created using createAutoChild() not addAutoChild(), and no default single instance is created by name on the grid.
public HLayout getExpansionDetailRelated()
Using AutoChildren
for details.
Automatically generated HLayout appearing in a record's expanded section when
listGrid.expansionMode is detailRelated. This component
contains two other autoChild components, a DetailViewer for viewing fields
from the record which are not already present in the grid and a separate embedded ListGrid for displaying other data related to this record via record.detailDS. See
expansionDetails and expansionRelated for more information.
This component
is an com.smartgwt.client.types.AutoChild and as such may be customized via
listGrid.expansionDetailRelatedProperties and listGrid.expansionDetailRelatedDefaults.
Note, however, that this is a multi-instance component (potentially one per record), so it is created using createAutoChild() not addAutoChild(), and no default single instance is created by name on the grid.
public DetailViewer getExpansionDetails()
Using AutoChildren
for details.
Automatically generated DetailViewer for displaying the details of a record
in its expanded section when listGrid.expansionMode is
details. Note that only those fields which do not already appear in the grid are displayed in the expanded
section.
This component is an com.smartgwt.client.types.AutoChild and as such may be customized via
listGrid.expansionDetailsProperties and listGrid.expansionDetailsDefaults.
Note, however, that this is a multi-instance component (potentially one per record), so it is created using createAutoChild() not addAutoChild(), and no default single instance is created by name on the grid.
public DynamicForm getExpansionEditor()
Using AutoChildren
for details.
Automatically generated DynamicForm for editing the details of a record in its
expanded section when listGrid.expansionMode is editor.
Note that only those fields which do not already appear in the grid will appear in the expanded section.
According
to the value of showExpansionEditorSaveButton, a save button is shown beneath the editor. You can save the values in the editor by
clicking this button
This component is an com.smartgwt.client.types.AutoChild and as such may be customized
via listGrid.expansionEditorProperties and listGrid.expansionEditorDefaults.
Note, however, that this is a multi-instance component (potentially one per record), so it is created using createAutoChild() not addAutoChild(), and no default single instance is created by name on the grid.
public java.lang.Boolean getExpansionEditorCollapseOnSave()
throws java.lang.IllegalStateException
ExpansionMode is editor, should the row be collapsed following a save
initiated by the expansion-component's save button.
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException - if this widget has not yet been rendered.public IButton getExpansionEditorSaveButton()
Using AutoChildren
for details.
Automatically generated IButton for saving the values in the expanded portion of a
ListGrid row.
This component is an com.smartgwt.client.types.AutoChild and as such may be customized via
listGrid.expansionEditorSaveButtonProperties and listGrid.expansionEditorSaveButtonDefaults.
Note, however, that this is a multi-instance component (potentially one per record), so it is created using createAutoChild() not addAutoChild(), and no default single instance is created by name on the grid.
public java.lang.String getExpansionEditorSaveButtonTitle()
throws java.lang.IllegalStateException
expansionEditorSaveButton.
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setExpansionEditorSaveDialogPrompt(java.lang.String expansionEditorSaveDialogPrompt)
throws java.lang.IllegalStateException
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.expansionEditorSaveDialogPrompt - Default value is "You have unsaved changes - do you want to save them now?"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getExpansionEditorSaveDialogPrompt()
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.public void setExpansionEditorShowSaveDialog(java.lang.Boolean expansionEditorShowSaveDialog)
throws java.lang.IllegalStateException
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.expansionEditorShowSaveDialog - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getExpansionEditorShowSaveDialog()
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.public ListGridField getExpansionField() throws java.lang.IllegalStateException
This component is an AutoChild named "expansionField". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
canExpandRecords is true. Called during setFields(), this method can be overridden to add advanced dynamic
defaults to the expansion field (call Super, modify the default field returned by Super, return the modified field).
Normal customization can be handled by just setting com.smartgwt.client.types.AutoChild properties, as mentioned
under the docs for expansionField.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setExpansionFieldFalseImage(java.lang.String expansionFieldFalseImage)
canExpandRecords is set to true,
this property determines the image to display in the expansion field for collapsed rows. If unset, the booleanFalseImage will be used.
Note : This is an advanced setting
expansionFieldFalseImage - SCImgURL . Default value is null,
setExpansionFieldTrueImage(java.lang.String),
setExpansionFieldImageWidth(java.lang.Integer),
setExpansionFieldImageHeight(java.lang.Integer)public java.lang.String getExpansionFieldFalseImage()
canExpandRecords is set to true,
this property determines the image to display in the expansion field for collapsed rows. If unset, the booleanFalseImage will be used.SCImgURL,
getExpansionFieldTrueImage(),
getExpansionFieldImageWidth(),
getExpansionFieldImageHeight()public void setExpansionFieldImageHeight(java.lang.Integer expansionFieldImageHeight)
throws java.lang.IllegalStateException
canExpandRecords is set to true,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded. If
unset, the expansionField image will be sized to match the booleanImageHeight for this grid.expansionFieldImageHeight - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getExpansionFieldImageHeight()
canExpandRecords is set to true,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded. If
unset, the expansionField image will be sized to match the booleanImageHeight for this grid.public void setExpansionFieldImageWidth(java.lang.Integer expansionFieldImageWidth)
throws java.lang.IllegalStateException
canExpandRecords is set to true,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded. If
unset, the expansionField image will be sized to match the booleanImageWidth for this grid.expansionFieldImageWidth - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getExpansionFieldImageWidth()
canExpandRecords is set to true,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded. If
unset, the expansionField image will be sized to match the booleanImageWidth for this grid.public void setExpansionFieldTrueImage(java.lang.String expansionFieldTrueImage)
canExpandRecords is set to true,
this property determines the image to display in the expansion field for expanded rows. If unset, the booleanTrueImage will be used.
Note : This is an advanced setting
expansionFieldTrueImage - SCImgURL . Default value is null,
setExpansionFieldFalseImage(java.lang.String),
setExpansionFieldImageWidth(java.lang.Integer),
setExpansionFieldImageHeight(java.lang.Integer)public java.lang.String getExpansionFieldTrueImage()
canExpandRecords is set to true,
this property determines the image to display in the expansion field for expanded rows. If unset, the booleanTrueImage will be used.SCImgURL,
getExpansionFieldFalseImage(),
getExpansionFieldImageWidth(),
getExpansionFieldImageHeight()public VLayout getExpansionLayout()
Using AutoChildren
for details.
Automatically generated VLayout which fills a record's expanded section and
contains other builtin expansion-components. You can also override
getExpansionComponent() to provide components of
your own specification.
This component is an com.smartgwt.client.types.AutoChild and as such may be
customized via listGrid.expansionLayoutProperties and listGrid.expansionLayoutDefaults.
Note, however, that this is a multi-instance component (potentially one per record), so it is created using createAutoChild() not addAutoChild(), and no default single instance is created by name on the grid.
public void setExpansionMode(ExpansionMode expansionMode)
ExpansionMode for records in this grid. Default null value means no
expansion.
Note : This is an advanced setting
expansionMode - Default value is nullpublic ExpansionMode getExpansionMode()
ExpansionMode for records in this grid. Default null value means no
expansion.public ListGrid getExpansionRelated()
Using AutoChildren
for details.
Automatically generated ListGrid for displaying data related to a record in its
expanded section when listGrid.expansionMode is related.
The DataSource containing the related data is provided by getRelatedDataSource() which, by default, returns the
DataSource referred to in ListGridRecord.detailDS.
This component is an com.smartgwt.client.types.AutoChild and as such may be customized via
listGrid.expansionRelatedProperties and listGrid.expansionRelatedDefaults.
Note, however, that this is a multi-instance component (potentially one per record), so it is created using createAutoChild() not addAutoChild(), and no default single instance is created by name on the grid.
public void setExportAlternateRowBGColor(java.lang.String exportAlternateRowBGColor)
throws java.lang.IllegalStateException
exportData() or exportClientData(), background color
to use for even-numbered rows, to create a "banded" or "ledger" effect. Odd-numbered rows will use the exportDefaultBGColor. See ExportBGColor for an overview.
exportAlternateRowBGColor - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSColor . Default value is nullpublic java.lang.String getExportAlternateRowBGColor()
exportData() or exportClientData(), background color
to use for even-numbered rows, to create a "banded" or "ledger" effect. Odd-numbered rows will use the exportDefaultBGColor. See ExportBGColor for an overview.
CSSColorpublic void setExportDefaultBGColor(java.lang.String exportDefaultBGColor)
throws java.lang.IllegalStateException
exportData() or exportClientData(). If unset (the default), cells that are not provided a background color by more specific APIs will be the default background color used by the spreadsheet program where they are viewed.
See ExportBGColor for an overview.
exportDefaultBGColor - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSColor . Default value is nullpublic java.lang.String getExportDefaultBGColor()
exportData() or exportClientData(). If unset (the default), cells that are not provided a background color by more specific APIs will be the default background color used by the spreadsheet program where they are viewed.
See ExportBGColor for an overview.
CSSColorpublic void setExportFieldAlignments(boolean exportFieldAlignments)
exportData() or exportClientData(), whether field
horizontal header alignments and data value alignments should be replicated in the resulting
spreadsheet. If this attribute is not set, cells will be assigned a default alignment by the spreadsheet, which is
typically right-aligned for numeric and date values, and left-aligned for everything else (including dates and numbers
that have been exported as strings, as would be the case, for example, if DSRequest.exportDatesAsFormattedString is set)
exportFieldAlignments - Default value is falsepublic boolean getExportFieldAlignments()
exportData() or exportClientData(), whether field
horizontal header alignments and data value alignments should be replicated in the resulting
spreadsheet. If this attribute is not set, cells will be assigned a default alignment by the spreadsheet, which is
typically right-aligned for numeric and date values, and left-aligned for everything else (including dates and numbers
that have been exported as strings, as would be the case, for example, if DSRequest.exportDatesAsFormattedString is set)
public void setExportFieldWidths(boolean exportFieldWidths)
exportData() or exportClientData(), whether widths
of fields should be replicated in the resulting spreadsheet. Because Excel's unit of measurement for field widths is
based on the default system font, there is no exact way to translate field widths in pixels to Excel column widths. The
exportWidthScale property can be set to adjust
scaling; it's default value errs on the side of making Excel's columns slightly wider than the ListGrid field's actual
width to avoid clipping.
Note that you can switch off width export for individual fields with the ListGridField.exportFieldWidth flag.
exportFieldWidths - Default value is falsepublic boolean getExportFieldWidths()
exportData() or exportClientData(), whether widths
of fields should be replicated in the resulting spreadsheet. Because Excel's unit of measurement for field widths is
based on the default system font, there is no exact way to translate field widths in pixels to Excel column widths. The
exportWidthScale property can be set to adjust
scaling; it's default value errs on the side of making Excel's columns slightly wider than the ListGrid field's actual
width to avoid clipping.
Note that you can switch off width export for individual fields with the ListGridField.exportFieldWidth flag.
public void setExportHeaderHeights(boolean exportHeaderHeights)
exportData() or exportClientData(), causes the
headerHeight and headerSpan heights to be applied to the corresponding cells in
the spreadsheet.exportHeaderHeights - Default value is falsepublic boolean getExportHeaderHeights()
exportData() or exportClientData(), causes the
headerHeight and headerSpan heights to be applied to the corresponding cells in
the spreadsheet.public void setExportRawValues(java.lang.Boolean exportRawValues)
throws java.lang.IllegalStateException
exportClientData(). If set to true, data will not be
processed by field-formatters during exports. Decreases the time taken for large exports. This property can also be set
at the field level.exportRawValues - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getExportRawValues()
exportClientData(). If set to true, data will not be
processed by field-formatters during exports. Decreases the time taken for large exports. This property can also be set
at the field level.public void setExportWidthScale(double exportWidthScale)
exportFieldWidths for where this is used.exportWidthScale - Default value is 0.12public double getExportWidthScale()
exportFieldWidths for where this is used.public void setExportWrapHeaderTitles(boolean exportWrapHeaderTitles)
exportData() or exportClientData(), whether titles
in the ListGrid header and headerSpans should be allowed to wrap. Excel will wrap at the column boundary automatically; for explicit control over wrapping, insert "<br>" tags into your titles.
See also exportFieldWidths for replicating the
widths of fields in the exported spreadsheet.
exportWrapHeaderTitles - Default value is falsepublic boolean getExportWrapHeaderTitles()
exportData() or exportClientData(), whether titles
in the ListGrid header and headerSpans should be allowed to wrap. Excel will wrap at the column boundary automatically; for explicit control over wrapping, insert "<br>" tags into your titles.
See also exportFieldWidths for replicating the
widths of fields in the exported spreadsheet.
public void setFastCellUpdates(java.lang.Boolean fastCellUpdates)
throws java.lang.IllegalStateException
Advanced property to improve performance for dynamic styling of gridRenderer cells in Internet Explorer, at the expense of slightly slower initial drawing, and some limitations on supported styling options.
fastCellUpdates speeds up the dynamic styling system used by
rollovers, selections, and custom styling that calls GridRenderer.refreshCellStyle(), at the cost of slightly
slower draw() and redraw() times.
Notes:
tallBaseStyle. See getBaseStyle() for more information..css file loaded via @import. Instead the .css file should be loaded
via a <link ...> tag.GridRenderer.fastCellUpdates. Has no effect in browsers other than Internet Explorer.fastCellUpdates - whether to enable fastCellUpdates.. Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic void setFetchDelay(int fetchDelay)
showFilterEditor is true), and we're re-filtering on every keypress (filterOnKeypress is true), this property is the delay in
milliseconds between the user changing the filter and the filter request being kicked off. If multiple changes are made
to the filter within this fetch delay, only the most recent will actually cause a re-filter
Note : This is an advanced setting
fetchDelay - Default value is 300public int getFetchDelay()
showFilterEditor is true), and we're re-filtering on every keypress (filterOnKeypress is true), this property is the delay in
milliseconds between the user changing the filter and the filter request being kicked off. If multiple changes are made
to the filter within this fetch delay, only the most recent will actually cause a re-filterpublic void setFieldPickerFieldProperties(java.lang.String... fieldPickerFieldProperties)
throws java.lang.IllegalStateException
ListGridField for which the FieldPicker should show an editing interface, for convenience. For example, specify
["frozen", "decimalPrecision"] to allow end users to modify ListGridField.frozen and ListGridField.decimalPrecision respectively.
fieldPickerFieldProperties - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String[] getFieldPickerFieldProperties()
ListGridField for which the FieldPicker should show an editing interface, for convenience. For example, specify
["frozen", "decimalPrecision"] to allow end users to modify ListGridField.frozen and ListGridField.decimalPrecision respectively.
public void setFieldPickerShowSampleValues(java.lang.Boolean fieldPickerShowSampleValues)
throws java.lang.IllegalStateException
fieldPickerShowSampleValues - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getFieldPickerShowSampleValues()
public FieldPickerWindow getFieldPickerWindow() throws java.lang.IllegalStateException
FieldPickerWindow used if useAdvancedFieldPicker is set.
This component is an AutoChild named "fieldPickerWindow". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setFields(ListGridField... fields)
If dataSource is also set, this value acts as a set of overrides
as explained in DataBoundComponent.fields.
If this method is called after the component has been drawn/initialized:
Sets the fields array and/or field widths to newFields and sizes, respectively.
If newFields is specified, it is assumed that the new fields may have nothing in common with the old fields, and the component is substantially rebuilt. Furthermore, it's invalid to modify any of the existing ListGridFields after they've been passed to this function. Consider the following methods for more efficient, more incremental changes: resizeField(), reorderField(), showField(), hideField(), or setFieldProperties().
fields - array of fields to draw. Default value is nullListGridField,
setFields(com.smartgwt.client.widgets.grid.ListGridField...),
Databinding overview and related methods,
ListGrid fields Example,
Merged fields Examplepublic ListGridField[] getFields()
If dataSource is also set, this value acts as a set of overrides
as explained in DataBoundComponent.fields.
ListGridField,
setFields(com.smartgwt.client.widgets.grid.ListGridField...),
Databinding overview and related methods,
ListGrid fields Example,
Merged fields Examplepublic void setFieldState(java.lang.String fieldState)
field state for the grid. viewState can be used to initialize all view properties of the
grid. When doing so, fieldState is not needed because viewState includes it as well. If both
are provided, fieldState has priority for field state.
If this method is called after the component has been drawn/initialized:
Sets some presentation properties (visibility, width, userFormula and userSummary) of the listGrid fields based on the ListGridFieldState object passed in.
Used to restore previous state retrieved from the grid by a call to getFieldState().
fieldState - state to apply to the listGrid's fields.. Default value is nullpublic java.lang.String getFieldState()
field state for the grid. viewState can be used to initialize all view properties of the
grid. When doing so, fieldState is not needed because viewState includes it as well. If both
are provided, fieldState has priority for field state.
ListGridFieldState object. This object can later be passed to setFieldState() to reset this grid's fields to the current
state.
Note that the information stored includes the current width and visibility of each of this grid's fields, as
well as any formula or summary fields added by the user.
public void setFieldVisibilitySubmenuTitle(java.lang.String fieldVisibilitySubmenuTitle)
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.fieldVisibilitySubmenuTitle - Default value is "Columns"public java.lang.String getFieldVisibilitySubmenuTitle()
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.public void setFilterButtonPrompt(java.lang.String filterButtonPrompt)
throws java.lang.IllegalStateException
filterButtonPrompt - Default value is "Filter"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getFilterButtonPrompt()
public void setFilterButtonProperties(Button filterButtonProperties) throws java.lang.IllegalStateException
showFilterEditor is true, this attribute may be
used to customize the filter button shown to the right of the filterEditor row.filterButtonProperties - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdSGWTPropertiespublic Button getFilterButtonProperties()
showFilterEditor is true, this attribute may be
used to customize the filter button shown to the right of the filterEditor row.public void setFilterByCell(java.lang.Boolean filterByCell)
Note : This is an advanced setting
filterByCell - Default value is nullpublic java.lang.Boolean getFilterByCell()
public RecordEditor getFilterEditor() throws java.lang.IllegalStateException
showFilterEditor is set to true, the
filterEditor is automatically created as an AutoChild.filterEditorProperties.
This component is an AutoChild named "filterEditor". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setFilterEditorHeight(int filterEditorHeight)
filterEditorHeight - Default value is 22public int getFilterEditorHeight()
public void setFilterEditorProperties(RecordEditor filterEditorProperties) throws java.lang.IllegalStateException
filterEditor if showFilterEditor is true.filterEditorProperties - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdSGWTPropertiespublic RecordEditor getFilterEditorProperties()
filterEditor if showFilterEditor is true.public void setFilterLocalData(java.lang.Boolean filterLocalData)
throws java.lang.IllegalStateException
dataSource is provided. When using this mode, data must be
provided to the grid via setData(), and must be provided as
a RecordList.
Note that a dataSource must be
provided for filtering to occur even when filtering locally.
If this property is set to true, the supplied data is
applied as the complete dataset of a ResultSet, which is then filtered according to the specified criteria, and the results
displayed. If false, a normal databound fetch will occur, retrieving records that match the specified criteria from
this component's dataSource.
filterLocalData includes both calls to fetchData() and filterData() as well as automatic
filtering when the filterEditor is enabled.
If
this property is not explicitly set, default behavior will filter against the dataSource unless the grid has a specified
dataPath, in which case filtering will occur locally.
See also saveLocally to cause saves to ignore the DataSource and affect
the local data set only.
Note : This is an advanced setting
filterLocalData - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getFilterLocalData()
dataSource is provided. When using this mode, data must be
provided to the grid via setData(), and must be provided as
a RecordList.
Note that a dataSource must be
provided for filtering to occur even when filtering locally.
If this property is set to true, the supplied data is
applied as the complete dataset of a ResultSet, which is then filtered according to the specified criteria, and the results
displayed. If false, a normal databound fetch will occur, retrieving records that match the specified criteria from
this component's dataSource.
filterLocalData includes both calls to fetchData() and filterData() as well as automatic
filtering when the filterEditor is enabled.
If
this property is not explicitly set, default behavior will filter against the dataSource unless the grid has a specified
dataPath, in which case filtering will occur locally.
See also saveLocally to cause saves to ignore the DataSource and affect
the local data set only.
public void setFilterOnKeypress(java.lang.Boolean filterOnKeypress)
Note : This is an advanced setting
filterOnKeypress - Default value is nullpublic java.lang.Boolean getFilterOnKeypress()
public void setFilterUsingText(java.lang.String filterUsingText)
throws java.lang.IllegalStateException
headerContextMenu when allowFilterOperators
is enabled.filterUsingText - Default value is "Filter using"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getFilterUsingText()
headerContextMenu when allowFilterOperators
is enabled.public void setFixedFieldWidths(java.lang.Boolean fixedFieldWidths)
If we allow columns to expand, the column width is treated as a minimum.
NOTE: the header does not automatically respond to
expanded field widths. If your grid is showing a header we'd recommend developers consider setting autoFitFieldWidths rather than using this attribute.
Note : This is an advanced setting
fixedFieldWidths - Default value is truepublic java.lang.Boolean getFixedFieldWidths()
If we allow columns to expand, the column width is treated as a minimum.
NOTE: the header does not automatically respond to
expanded field widths. If your grid is showing a header we'd recommend developers consider setting autoFitFieldWidths rather than using this attribute.
public void setFixedRecordHeights(java.lang.Boolean fixedRecordHeights)
If we allow rows
to expand, the row height as derived from getRowHeight() or the default cellHeight is treated as
a minimum.
Setting fixedRecordHeights to false enables the virtualScrolling system.
NOTE:
CubeGrid is not supported, though a similar
option for the row headers is available as CubeGrid.autoSizeHeaders. enforceVClipping:true to enforce clipping for all types of content on all browsers. Note : This is an advanced setting
fixedRecordHeights - Default value is truepublic java.lang.Boolean getFixedRecordHeights()
If we allow rows
to expand, the row height as derived from getRowHeight() or the default cellHeight is treated as
a minimum.
Setting fixedRecordHeights to false enables the virtualScrolling system.
NOTE:
CubeGrid is not supported, though a similar
option for the row headers is available as CubeGrid.autoSizeHeaders. enforceVClipping:true to enforce clipping for all types of content on all browsers. public void setFormulaBuilderSpanTitleSeparator(java.lang.String formulaBuilderSpanTitleSeparator)
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.formulaBuilderSpanTitleSeparator - Default value is " - "public java.lang.String getFormulaBuilderSpanTitleSeparator()
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.public void setFreezeFieldText(java.lang.String freezeFieldText)
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze a currently unfrozen field. This is a dynamic string - text
within ${...} will be evaluated as JS code when the message is displayed, with title
available as a variable containing the field title.
Default value returns "Freeze " + the field's summary title.
Note : This is an advanced setting
freezeFieldText - HTMLString . Default value is "Freeze ${title}"public java.lang.String getFreezeFieldText()
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze a currently unfrozen field. This is a dynamic string - text
within ${...} will be evaluated as JS code when the message is displayed, with title
available as a variable containing the field title.
Default value returns "Freeze " + the field's summary title.
HTMLStringpublic void setFreezeOnLeftText(java.lang.String freezeOnLeftText)
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the left of the scrollable body.freezeOnLeftText - Default value is "Freeze on left"public java.lang.String getFreezeOnLeftText()
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the left of the scrollable body.public void setFreezeOnRightText(java.lang.String freezeOnRightText)
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the right of the scrollable body.freezeOnRightText - Default value is "Freeze on right"public java.lang.String getFreezeOnRightText()
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to freeze fields on the right of the scrollable body.public void setFrozenBaseStyle(java.lang.String frozenBaseStyle)
frozenBaseStyle - Default value is nullsetBaseStyle(java.lang.String),
ListGridField.setFrozen(java.lang.Boolean),
FrozenFields overview and related methodspublic java.lang.String getFrozenBaseStyle()
getBaseStyle(),
ListGridField.getFrozen(),
FrozenFields overview and related methodspublic void setFrozenHeaderBaseStyle(java.lang.String frozenHeaderBaseStyle)
throws java.lang.IllegalStateException
frozenHeaderBaseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
setHeaderBaseStyle(java.lang.String),
ListGridField.setFrozen(java.lang.Boolean),
FrozenFields overview and related methodspublic java.lang.String getFrozenHeaderBaseStyle()
CSSStyleName,
getHeaderBaseStyle(),
ListGridField.getFrozen(),
FrozenFields overview and related methodspublic void setFrozenHeaderTitleStyle(java.lang.String frozenHeaderTitleStyle)
throws java.lang.IllegalStateException
frozenHeaderTitleStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
setHeaderTitleStyle(java.lang.String),
ListGridField.setFrozen(java.lang.Boolean),
FrozenFields overview and related methodspublic java.lang.String getFrozenHeaderTitleStyle()
CSSStyleName,
getHeaderTitleStyle(),
ListGridField.getFrozen(),
FrozenFields overview and related methodspublic void setGenerateClickOnEnter(java.lang.Boolean generateClickOnEnter)
Note : This is an advanced setting
generateClickOnEnter - Default value is falsepublic java.lang.Boolean getGenerateClickOnEnter()
public void setGenerateClickOnSpace(java.lang.Boolean generateClickOnSpace)
Note : This is an advanced setting
generateClickOnSpace - Default value is truepublic java.lang.Boolean getGenerateClickOnSpace()
public void setGenerateDoubleClickOnEnter(java.lang.Boolean generateDoubleClickOnEnter)
Note : This is an advanced setting
generateDoubleClickOnEnter - Default value is truepublic java.lang.Boolean getGenerateDoubleClickOnEnter()
public void setGenerateDoubleClickOnSpace(java.lang.Boolean generateDoubleClickOnSpace)
Note : This is an advanced setting
generateDoubleClickOnSpace - Default value is falsepublic java.lang.Boolean getGenerateDoubleClickOnSpace()
public void setGridComponents(ListGridComponent... gridComponents) throws java.lang.IllegalStateException
ListGrid is a subclass of VLayout and consists of a number of member
components. The
standard set of members are automatically generated by the grid, and include (for example)
the header (a Toolbar of buttons for each field) and the body
(a GridRenderer displaying the actual data contained in the grid).
The default value of gridComponents is an Array of ListGridComponents
listing
the standard components in their default order:
[ListGridComponent.FILTER_EDITOR, ListGridComponent.HEADER, ListGridComponent.BODY,
ListGridComponent.SUMMARY_ROW]
You can override gridComponents to change the order of standard components.
You can also omit standard components this way, although it more efficient to
use the related "show" property if available (eg showFilterEditor). Note that
this array must contain an entry for the "body" - listGrids with no body showing
are unsupported.ListGridComponent types may differ across different listGrids. For example if this
grid has any frozen fields, the "body" entry will
actually
be created as an HLayout containing two GridRenderers (one for frozen fields,
and one for unfrozen fields). This is really an implementation detail - the "body" entry
in the gridComponents array simply specifies where the UI for the body should render within
the ListGrid layout.
By embedding a Canvas directly in this list you can add arbitrary additional components to the listGrid as members, and have them be displayed alongside the standard automatically generated parts of the ListGrid.
Note that having added controls to gridComponents, you can still call APIs directly on those controls to change their appearance, and you can also show() and hide() them if they should not be shown in some circumstances.
Tip: custom controls need to set layoutAlign:"center" to appear vertically centered.
gridComponents - Default value is (see below)java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic ListGridComponent[] getGridComponents()
ListGrid is a subclass of VLayout and consists of a number of member
components. The
standard set of members are automatically generated by the grid, and include (for example)
the header (a Toolbar of buttons for each field) and the body
(a GridRenderer displaying the actual data contained in the grid).
The default value of gridComponents is an Array of ListGridComponents
listing
the standard components in their default order:
[ListGridComponent.FILTER_EDITOR, ListGridComponent.HEADER, ListGridComponent.BODY,
ListGridComponent.SUMMARY_ROW]
You can override gridComponents to change the order of standard components.
You can also omit standard components this way, although it more efficient to
use the related "show" property if available (eg showFilterEditor). Note that
this array must contain an entry for the "body" - listGrids with no body showing
are unsupported.ListGridComponent types may differ across different listGrids. For example if this
grid has any frozen fields, the "body" entry will
actually
be created as an HLayout containing two GridRenderers (one for frozen fields,
and one for unfrozen fields). This is really an implementation detail - the "body" entry
in the gridComponents array simply specifies where the UI for the body should render within
the ListGrid layout.
By embedding a Canvas directly in this list you can add arbitrary additional components to the listGrid as members, and have them be displayed alongside the standard automatically generated parts of the ListGrid.
Note that having added controls to gridComponents, you can still call APIs directly on those controls to change their appearance, and you can also show() and hide() them if they should not be shown in some circumstances.
Tip: custom controls need to set layoutAlign:"center" to appear vertically centered.
public void setGridComponents(java.lang.Object... gridComponents)
throws java.lang.IllegalStateException
ListGrid is a subclass of VLayout and consists of a number of member
components. The
standard set of members are automatically generated by the grid, and include (for example)
the header (a Toolbar of buttons for each field) and the body
(a GridRenderer displaying the actual data contained in the grid).
The default value of gridComponents is an Array of ListGridComponents
listing
the standard components in their default order:
[ListGridComponent.FILTER_EDITOR, ListGridComponent.HEADER, ListGridComponent.BODY,
ListGridComponent.SUMMARY_ROW]
You can override gridComponents to change the order of standard components.
You can also omit standard components this way, although it more efficient to
use the related "show" property if available (eg showFilterEditor). Note that
this array must contain an entry for the "body" - listGrids with no body showing
are unsupported.ListGridComponent types may differ across different listGrids. For example if this
grid has any frozen fields, the "body" entry will
actually
be created as an HLayout containing two GridRenderers (one for frozen fields,
and one for unfrozen fields). This is really an implementation detail - the "body" entry
in the gridComponents array simply specifies where the UI for the body should render within
the ListGrid layout.
By embedding a Canvas directly in this list you can add arbitrary additional components to the listGrid as members, and have them be displayed alongside the standard automatically generated parts of the ListGrid.
Note that having added controls to gridComponents, you can still call APIs directly on those controls to change their appearance, and you can also show() and hide() them if they should not be shown in some circumstances.
Tip: custom controls need to set layoutAlign:"center" to appear vertically centered.
gridComponents - Default value is (see below)java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic void setGridSummaryRecordProperty(java.lang.String gridSummaryRecordProperty)
showGridSummary is true, this attribute will be
set to true on the record object representing the grid summary row.gridSummaryRecordProperty - Default value is "isGridSummary"public java.lang.String getGridSummaryRecordProperty()
showGridSummary is true, this attribute will be
set to true on the record object representing the grid summary row.public void setGroupByAsyncThreshold(int groupByAsyncThreshold)
Note that groupByMaxRecords must be set at least as high as groupByAsyncThreshold or asynchronous grouping will
never be used.
During async grouping, interactivity is blocked and the asynchGroupingPrompt is shown to the user, then
hidden when grouping completes; ListGrid.groupByComplete() then fires.
Note that this async processing covers grouping only - it does not cover whole grid or per-group summaries, client-side sort or filter, or other operations that may cause the browser to show the "script is running slowly" prompt when working with very large sets of records in a grid.
At this time, there is no generally effective way to avoid this warning dialog appearing with very large datasets in Microsoft's Internet Explorer (IE). IE's severely flawed detection algorithm for runaway scripts has been shown to interrupt computations after only 0.2 seconds elapsed time even if the computation would have finished in 0.3 seconds. Optimizations that reduce execution time can sometimes trigger the "script running slowly" dialog sooner. Since not every operation can reasonably be made asynchronous, the current recommendation is to avoid working with overly large datasets until the affected versions of IE are obsoleted.
groupByAsyncThreshold - Default value is 50public int getGroupByAsyncThreshold()
Note that groupByMaxRecords must be set at least as high as groupByAsyncThreshold or asynchronous grouping will
never be used.
During async grouping, interactivity is blocked and the asynchGroupingPrompt is shown to the user, then
hidden when grouping completes; ListGrid.groupByComplete() then fires.
Note that this async processing covers grouping only - it does not cover whole grid or per-group summaries, client-side sort or filter, or other operations that may cause the browser to show the "script is running slowly" prompt when working with very large sets of records in a grid.
At this time, there is no generally effective way to avoid this warning dialog appearing with very large datasets in Microsoft's Internet Explorer (IE). IE's severely flawed detection algorithm for runaway scripts has been shown to interrupt computations after only 0.2 seconds elapsed time even if the computation would have finished in 0.3 seconds. Optimizations that reduce execution time can sometimes trigger the "script running slowly" dialog sooner. Since not every operation can reasonably be made asynchronous, the current recommendation is to avoid working with overly large datasets until the affected versions of IE are obsoleted.
public void setGroupByField(java.lang.String groupByField)
throws java.lang.IllegalStateException
groupBy() to update the grouping field
list, instead of modifying groupByField directly.groupByField - Default value is see belowjava.lang.IllegalStateException - this property cannot be changed after the component has been createdgroupBy(java.lang.String...),
Dynamic Grouping Examplepublic void setGroupByField(java.lang.String... groupByField)
throws java.lang.IllegalStateException
groupBy() to update the grouping field
list, instead of modifying groupByField directly.groupByField - Default value is see belowjava.lang.IllegalStateException - this property cannot be changed after the component has been createdgroupBy(java.lang.String...),
Dynamic Grouping Examplepublic void setGroupByFieldSummaries(java.lang.String... groupByFieldSummaries)
grouped, and showGroupSummary is true, this attribute may be set to an
array of groupBy field names for which group summaries should appear. This is particularly useful for listGrids
grouped by more than one field as it allows developers to display the group summary for a particular nested group
without showing a summary for every level of the tree.
If this method is called after the component has been drawn/initialized:
Setter for the groupByFieldSummaries attribute
Note : This is an advanced setting
groupByFieldSummaries - new value for this.groupByFieldSummaries. Default value is nullsetShowGroupSummary(java.lang.Boolean)public java.lang.String[] getGroupByFieldSummaries()
grouped, and showGroupSummary is true, this attribute may be set to an
array of groupBy field names for which group summaries should appear. This is particularly useful for listGrids grouped by more than one field as it allows developers to display the group summary for a particular nested group without showing a summary for every level of the tree.
getShowGroupSummary()public void setGroupByMaxRecords(int groupByMaxRecords)
groupBy()
will be ignored. The maximum exists because ListGrid grouping is performed in-browser, hence requires loading of all records that match the current filter criteria before records can be grouped. The default maximum represents a number of records which are safe to load in legacy browsers such as Internet Explorer 8 (modern browsers can handle far more), and is also a good upper limit from the perspective of loading data from a database.
Going beyond this limit can
cause "script running slowly" errors from legacy browsers (as well as high database load). To build an interface for
grouping that handles arbitrary data volume, use a TreeGrid with TreeGrid.loadDataOnDemand with server-side grouping code.
groupByMaxRecords - Default value is 1000groupBy(java.lang.String...)public int getGroupByMaxRecords()
groupBy()
will be ignored. The maximum exists because ListGrid grouping is performed in-browser, hence requires loading of all records that match the current filter criteria before records can be grouped. The default maximum represents a number of records which are safe to load in legacy browsers such as Internet Explorer 8 (modern browsers can handle far more), and is also a good upper limit from the perspective of loading data from a database.
Going beyond this limit can
cause "script running slowly" errors from legacy browsers (as well as high database load). To build an interface for
grouping that handles arbitrary data volume, use a TreeGrid with TreeGrid.loadDataOnDemand with server-side grouping code.
groupBy(java.lang.String...)public void setGroupByText(java.lang.String groupByText)
headerContextMenu for this
grid and this.canGroupBy is true, this string will be
shown as the title for the menu item to toggle the group by setting for a field. This is a dynamic string - text
within ${...} will be evaluated as JS code when the message is displayed, with title
available as a variable containing the field title.
Default value returns "Group by " + the field's summary title.
Note : This is an advanced setting
groupByText - HTMLString . Default value is "Group by ${title}"public java.lang.String getGroupByText()
headerContextMenu for this
grid and this.canGroupBy is true, this string will be
shown as the title for the menu item to toggle the group by setting for a field. This is a dynamic string - text
within ${...} will be evaluated as JS code when the message is displayed, with title
available as a variable containing the field title.
Default value returns "Group by " + the field's summary title.
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.groupByText string.HTMLStringpublic void setGroupIcon(java.lang.String groupIcon)
current skin.groupIcon - SCImgURL . Default value is "[SKINIMG]/TreeGrid/opener.gif"public java.lang.String getGroupIcon()
current skin.SCImgURLpublic void setGroupIconSize(int groupIconSize)
groupIconSize - Default value is 16groupBy(java.lang.String...)public int getGroupIconSize()
groupBy(java.lang.String...)public void setGroupIndentSize(int groupIndentSize)
groupIndentSize - Default value is 20groupBy(java.lang.String...),
com.smartgwt.client.widgets.grid.ListGrid#getGroupNodeHTMLpublic int getGroupIndentSize()
groupBy(java.lang.String...),
com.smartgwt.client.widgets.grid.ListGrid#getGroupNodeHTMLpublic void setGroupLeadingIndent(int groupLeadingIndent)
groupLeadingIndent - Default value is 10groupBy(java.lang.String...),
com.smartgwt.client.widgets.grid.ListGrid#getGroupNodeHTMLpublic int getGroupLeadingIndent()
groupBy(java.lang.String...),
com.smartgwt.client.widgets.grid.ListGrid#getGroupNodeHTMLpublic void setGroupNodeBaseStyle(java.lang.String groupNodeBaseStyle)
groupNodeBaseStyle - Default value is nullpublic java.lang.String getGroupNodeBaseStyle()
public void setGroupNodeStyle(java.lang.String groupNodeStyle)
group rows will have. Note that this is
not a base style, so, if this property is set, group
nodes will not show stateful styling (different styles for showRollOver, alternateRecordStyles, etc). To enable stateful
styling for groupNodes, set this property to null and specify a groupNodeBaseStyle
groupNodeStyle - Default value is "groupNode"public java.lang.String getGroupNodeStyle()
group rows will have. Note that this is
not a base style, so, if this property is set, group
nodes will not show stateful styling (different styles for showRollOver, alternateRecordStyles, etc). To enable stateful
styling for groupNodes, set this property to null and specify a groupNodeBaseStyle
public void setGroupSortDirection(SortDirection groupSortDirection)
sortByGroupFirst is active, the sorting
direction applied for implicit sorting by the field(s) used for grouping. Default of null means that sort direction is
based on the current direction of user-configured sort, or is "ascending" if the user has not sorted the data.groupSortDirection - Default value is nullpublic SortDirection getGroupSortDirection()
sortByGroupFirst is active, the sorting
direction applied for implicit sorting by the field(s) used for grouping. Default of null means that sort direction is
based on the current direction of user-configured sort, or is "ascending" if the user has not sorted the data.public void setGroupState(java.lang.String groupState)
viewState can be
used to initialize all view properties of the grid. When doing so, groupState is not needed because
viewState includes it as well. If both are provided, groupState has priority for group state.
If this method is called after the component has been drawn/initialized:
Reset this grid's grouping to match the ListGridGroupState object passed in.
Used to restore previous state retrieved from the grid by a call to getGroupState().
groupState - Object describing the desired grouping state of the gridListGridGroupState . Default value is nullpublic java.lang.String getGroupState()
viewState can be
used to initialize all view properties of the grid. When doing so, groupState is not needed because
viewState includes it as well. If both are provided, groupState has priority for group state.
setGroupState() to reset this grid's grouping to the current
state (assuming the same data / fields are present in the grid).ListGridGroupStatepublic void setGroupSummaryRecordProperty(java.lang.String groupSummaryRecordProperty)
showGroupSummary is true, this attribute will
be set to true on each record object representing a group-level summary row.groupSummaryRecordProperty - Default value is "isGroupSummary"public java.lang.String getGroupSummaryRecordProperty()
showGroupSummary is true, this attribute will
be set to true on each record object representing a group-level summary row.public void setGroupSummaryStyle(java.lang.String groupSummaryStyle)
throws java.lang.IllegalStateException
ListGridRecord.customStyle for the group-level
summary row displayed when showGroupSummary is
true.groupSummaryStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is "gridSummaryCell"public java.lang.String getGroupSummaryStyle()
ListGridRecord.customStyle for the group-level
summary row displayed when showGroupSummary is
true.CSSStyleNamepublic void setGroupTitleColumnProperties(ListGridField groupTitleColumnProperties) throws java.lang.IllegalStateException
groupTitleColumn. See showGroupTitleColumn for an overview of the
groupTitleColumn.
groupTitleColumnProperties - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic ListGridField getGroupTitleColumnProperties()
groupTitleColumn. See showGroupTitleColumn for an overview of the
groupTitleColumn.
public void setGroupTitleField(java.lang.String groupTitleField)
throws java.lang.IllegalStateException
grouped, each group shows under an auto
generated header node. By default the title of the group will be shown, with a hanging indent in this node, and will
span all columns in the grid. Setting this property causes the titles of auto-generated group nodes to appear as though
they were values of the designated field instead of spanning all columns and record values in the designated
groupTitleField will appear indented under the group title in a manner similar to how a TreeGrid shows a Tree. Note
if showGroupSummaryInHeader is true, the
header nodes will not show a single spanning title value by default - instead they will show the summary values for each
field. In this case, if groupTitleField is unset, a groupTitleColumn can be automatically generated to
show the title for each group.
groupTitleField - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdgroupBy(java.lang.String...)public java.lang.String getGroupTitleField()
grouped, each group shows under an auto
generated header node. By default the title of the group will be shown, with a hanging indent in this node, and will
span all columns in the grid. Setting this property causes the titles of auto-generated group nodes to appear as though
they were values of the designated field instead of spanning all columns and record values in the designated
groupTitleField will appear indented under the group title in a manner similar to how a TreeGrid shows a Tree. Note
if showGroupSummaryInHeader is true, the
header nodes will not show a single spanning title value by default - instead they will show the summary values for each
field. In this case, if groupTitleField is unset, a groupTitleColumn can be automatically generated to
show the title for each group.
groupBy(java.lang.String...)public Tree getGroupTree()
groupBy(). This
will be a ResultTree if dataSource is present, otherwise it will be a Tree.
This component is an AutoChild named "groupTree". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
groupBy(java.lang.String...)public Layout getHeader() throws java.lang.IllegalStateException
This component is an AutoChild named "header". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.GridHeader overview and related methodspublic void setHeaderAutoFitEvent(AutoFitEvent headerAutoFitEvent) throws java.lang.IllegalStateException
Note that if sorting is enabled for the field and the headerAutoFitEvent is "click", both sorting and autofit occur on a click.
Only has an impact when
canAutoFitFields or ListGridField.canAutoFitWidth is set to
true.
headerAutoFitEvent - Default value is "doubleClick"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic AutoFitEvent getHeaderAutoFitEvent()
Note that if sorting is enabled for the field and the headerAutoFitEvent is "click", both sorting and autofit occur on a click.
Only has an impact when
canAutoFitFields or ListGridField.canAutoFitWidth is set to
true.
public void setHeaderBackgroundColor(java.lang.String headerBackgroundColor)
headerBackgroundColor - Color . Default value is "#CCCCCC",
Appearance overview and related methodspublic java.lang.String getHeaderBackgroundColor()
Color,
Appearance overview and related methodspublic void setHeaderBarStyle(java.lang.String headerBarStyle)
throws java.lang.IllegalStateException
headerBarStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
Appearance overview and related methodspublic java.lang.String getHeaderBarStyle()
CSSStyleName,
Appearance overview and related methodspublic void setHeaderBaseStyle(java.lang.String headerBaseStyle)
throws java.lang.IllegalStateException
Button.baseStyle to apply to the buttons in the header, and the
sorter, for this ListGrid. Note that, depending on the Class of the header buttons, you may also need to
set headerTitleStyle.headerBaseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
Appearance overview and related methodspublic java.lang.String getHeaderBaseStyle()
Button.baseStyle to apply to the buttons in the header, and the
sorter, for this ListGrid. Note that, depending on the Class of the header buttons, you may also need to
set headerTitleStyle.CSSStyleName,
Appearance overview and related methodspublic void setHeaderButtonProperties(Button headerButtonProperties) throws java.lang.IllegalStateException
headerButtonDefaults.
Note : This is an advanced setting
headerButtonProperties - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methods,
SGWTPropertiespublic Button getHeaderButtonProperties()
headerButtonDefaults.Appearance overview and related methodspublic Canvas getHeaderContextMenu() throws java.lang.IllegalStateException
This component is an AutoChild named "headerContextMenu". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.GridHeader overview and related methodspublic void setHeaderHeight(int headerHeight)
headerHeight - new height for the header. Default value is 22Sizing overview and related methodspublic int getHeaderHeight()
Sizing overview and related methodspublic void setHeaderHoverAlign(Alignment headerHoverAlign)
ListGrid.headerHover().headerHoverAlign - Default value is nullpublic Alignment getHeaderHoverAlign()
ListGrid.headerHover().public void setHeaderHoverHeight(java.lang.Integer headerHoverHeight)
ListGrid.headerHover().headerHoverHeight - Default value is nullpublic java.lang.Integer getHeaderHoverHeight()
ListGrid.headerHover().public void setHeaderHoverOpacity(java.lang.Integer headerHoverOpacity)
ListGrid.headerHover().headerHoverOpacity - Default value is nullpublic java.lang.Integer getHeaderHoverOpacity()
ListGrid.headerHover().public void setHeaderHoverStyle(java.lang.String headerHoverStyle)
ListGrid.headerHover().headerHoverStyle - CSSStyleName . Default value is nullpublic java.lang.String getHeaderHoverStyle()
ListGrid.headerHover().CSSStyleNamepublic void setHeaderHoverVAlign(VerticalAlignment headerHoverVAlign)
ListGrid.headerHover().headerHoverVAlign - Default value is nullpublic VerticalAlignment getHeaderHoverVAlign()
ListGrid.headerHover().public void setHeaderHoverWidth(java.lang.Integer headerHoverWidth)
ListGrid.headerHover().headerHoverWidth - Default value is nullpublic java.lang.Integer getHeaderHoverWidth()
ListGrid.headerHover().public void setHeaderHoverWrap(java.lang.Boolean headerHoverWrap)
wrap attribute for the hover shown on ListGrid.headerHover().headerHoverWrap - Default value is nullpublic java.lang.Boolean getHeaderHoverWrap()
wrap attribute for the hover shown on ListGrid.headerHover().public StatefulCanvas getHeaderMenuButton() throws java.lang.IllegalStateException
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. When
clicked this button will display the standard header context menu (see displayHeaderContextMenu()). Several properties exist to customize the appearance of the headerMenuButton.
Also see the com.smartgwt.client.types.AutoChild documentation for information on how to make free-form
modifications to autoChild widgets
This component is an AutoChild named "headerMenuButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setHeaderMenuButtonHeight(int headerMenuButtonHeight)
throws java.lang.IllegalStateException
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButton
Note : This is an advanced setting
headerMenuButtonHeight - Default value is "100%"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int getHeaderMenuButtonHeight()
showHeaderMenuButton is true, this property
governs the height of the auto-generated headerMenuButtonpublic void setHeaderMenuButtonIcon(java.lang.String headerMenuButtonIcon)
throws java.lang.IllegalStateException
showHeaderMenuButton is true, this property
governs the icon shown on the auto-generated headerMenuButton
Note : This is an advanced setting
headerMenuButtonIcon - Default value is "[SKIN]/ListGrid/headerMenuButton_icon.gif"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getHeaderMenuButtonIcon()
showHeaderMenuButton is true, this property
governs the icon shown on the auto-generated headerMenuButtonpublic void setHeaderMenuButtonIconHeight(int headerMenuButtonIconHeight)
throws java.lang.IllegalStateException
showHeaderMenuButton is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton
Note : This is an advanced setting
headerMenuButtonIconHeight - Default value is 7java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int getHeaderMenuButtonIconHeight()
showHeaderMenuButton is true, this property
governs the height of the icon shown on the auto-generated headerMenuButtonpublic void setHeaderMenuButtonIconWidth(int headerMenuButtonIconWidth)
throws java.lang.IllegalStateException
showHeaderMenuButton is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton
Note : This is an advanced setting
headerMenuButtonIconWidth - Default value is 7java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int getHeaderMenuButtonIconWidth()
showHeaderMenuButton is true, this property
governs the width of the icon shown on the auto-generated headerMenuButtonpublic void setHeaderMenuButtonWidth(int headerMenuButtonWidth)
throws java.lang.IllegalStateException
showHeaderMenuButton is true, this property
governs the width of the auto-generated headerMenuButton
Note : This is an advanced setting
headerMenuButtonWidth - Default value is 16java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int getHeaderMenuButtonWidth()
showHeaderMenuButton is true, this property
governs the width of the auto-generated headerMenuButtonpublic StatefulCanvas getHeaderSpan()
Using AutoChildren
for details.
headerSpans are created via the com.smartgwt.client.types.AutoChild pattern, hence headerSpanConstructor, headerSpanDefaults
and headerSpanProperties are valid.
public void setHeaderSpanHeight(java.lang.Integer headerSpanHeight)
throws java.lang.IllegalStateException
headerSpan with no height
specified. If headerSpanHeight is not specified (the default), headerSpans will be 1/2 of headerHeight.
headerSpanHeight - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getHeaderSpanHeight()
headerSpan with no height
specified. If headerSpanHeight is not specified (the default), headerSpans will be 1/2 of headerHeight.
public void setHeaderSpans(HeaderSpan... headerSpans)
A header span can be created by simply naming the fields the header should span. The example below creates a headerSpan that spans the first two fields of the ListGrid.
ListGrid grid = new ListGrid();
grid.setHeaderHeight(40);
grid.setFields(new ListGridField[] {
new ListGridField("field1"),
new ListGridField("field2"),
new ListGridField("field3")
});
grid.setHeaderSpans(new HeaderSpan[] {
new HeaderSpan("Field 1 and 2", new String[] {"field1", "field2"})
});
Header spans can be nested, allowing fields to be grouped by multiple levels of
granularity. See HeaderSpan.spans for further information
on nesting spans.
Header spans will automatically react to resizing of the headers they span, and will be hidden automatically when all of the spanned fields are hidden.
Header spans appear in the header area of the ListGrid,
sharing space
with the existing headers, so it's typical to set headerHeight to
approximately double its normal height when using headerSpans, or if using nested header
spans, the default header height multiplied by the number of levels of header spans to be
shown.
See HeaderSpan for many properties that allow the control of the appearance of
headerSpans.
Neither headerSpans themselves nor the fields within them may be drag reordered, but other unspanned headers may be.
A span can only span adjacent fields - if a span is defined and the spanned fields don't
sit next to each other in the specified fields array, the fields array will be automatically
reordered to match the order specified in the span's HeaderSpan.fields array.
Note that headerSpans primarily provide a visual cue for grouping multiple headers
together. If you have an OLAP, data "cube" or multi-dimensional data model, the
CubeGrid component is the right choice.
If this method is called after the component has been drawn/initialized:
Update the headerSpans configuration on the grid dynamically.
headerSpans - same configuration block as that passed to headerSpans.. Default value is nullpublic void setHeaderTitleStyle(java.lang.String headerTitleStyle)
throws java.lang.IllegalStateException
StretchImgButton.titleStyle to apply to the buttons
in the header, and the sorter, for this ListGrid. Note that this will typically only have an effect if headerButtonConstructor is set to StretchImgButton or a subclass thereof.headerTitleStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
Appearance overview and related methodspublic java.lang.String getHeaderTitleStyle()
StretchImgButton.titleStyle to apply to the buttons
in the header, and the sorter, for this ListGrid. Note that this will typically only have an effect if headerButtonConstructor is set to StretchImgButton or a subclass thereof.CSSStyleName,
Appearance overview and related methodspublic void setHideEmptySummaryRow(java.lang.Boolean hideEmptySummaryRow)
summaryRow component to be hidden if
it has no data after summaries have been recalculatedhideEmptySummaryRow - Default value is nullpublic java.lang.Boolean getHideEmptySummaryRow()
summaryRow component to be hidden if
it has no data after summaries have been recalculatedpublic void setHiliteCanReplaceValue(java.lang.Boolean hiliteCanReplaceValue)
throws java.lang.IllegalStateException
Hilite.replacementValue feature to cause values in hilited cells to
be replaced with a user-entered value. For example, a user could create a hilite rule that replaces numeric values
ranging from 0.5 to 1.0 with the text "LOW". Specifically, when the "Add Advanced Rule" button is pressed and
hiliteCanReplaceValue is true, the user will see a text entry field titled "Replace value with" (hiliteReplaceValueFieldTitle) and if they
enter a value, that value will appear in the grid cell in lieu of the cell's original value.
hiliteCanReplaceValue - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdHiliting overview and related methodspublic java.lang.Boolean getHiliteCanReplaceValue()
Hilite.replacementValue feature to cause values in hilited cells to
be replaced with a user-entered value. For example, a user could create a hilite rule that replaces numeric values
ranging from 0.5 to 1.0 with the text "LOW". Specifically, when the "Add Advanced Rule" button is pressed and
hiliteCanReplaceValue is true, the user will see a text entry field titled "Replace value with" (hiliteReplaceValueFieldTitle) and if they
enter a value, that value will appear in the grid cell in lieu of the cell's original value.
Hiliting overview and related methodspublic void setHiliteEditorSpanTitleSeparator(java.lang.String hiliteEditorSpanTitleSeparator)
headerSpans, and showHeaderSpanTitlesInHiliteEditor is
true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser
grid.hiliteEditorSpanTitleSeparator - Default value is " - "public java.lang.String getHiliteEditorSpanTitleSeparator()
headerSpans, and showHeaderSpanTitlesInHiliteEditor is
true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser
grid.public void setHiliteHTMLAfterFormat(boolean hiliteHTMLAfterFormat)
throws java.lang.IllegalStateException
formatting for each cell. If false, hilite HTML will be
applied before formatting. This applies to the following hilite properties:
May be overridden per field via ListGridField.hiliteHTMLAfterFormat
hiliteHTMLAfterFormat - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getHiliteHTMLAfterFormat()
formatting for each cell. If false, hilite HTML will be
applied before formatting. This applies to the following hilite properties:
May be overridden per field via ListGridField.hiliteHTMLAfterFormat
public void setHiliteIconHeight(java.lang.Integer hiliteIconHeight)
hiliteIconSize. Can be overridden at the field levelhiliteIconHeight - Default value is nullHiliting overview and related methodspublic java.lang.Integer getHiliteIconHeight()
hiliteIconSize. Can be overridden at the field levelHiliting overview and related methodspublic void setHiliteIconLeftPadding(int hiliteIconLeftPadding)
hilite
icons by default? Can be overridden at the field levelhiliteIconLeftPadding - Default value is 2Hiliting overview and related methodspublic int getHiliteIconLeftPadding()
hilite
icons by default? Can be overridden at the field levelHiliting overview and related methodspublic void setHiliteIconPosition(HiliteIconPosition hiliteIconPosition) throws java.lang.IllegalStateException
hiliteIcons are present, where the hilite icon
will be placed relative to the field value. See HiliteIconPosition. Can be
overridden at the field level.hiliteIconPosition - Default value is "before"java.lang.IllegalStateException - this property cannot be changed after the component has been createdHiliting overview and related methodspublic HiliteIconPosition getHiliteIconPosition()
hiliteIcons are present, where the hilite icon
will be placed relative to the field value. See HiliteIconPosition. Can be
overridden at the field level.Hiliting overview and related methodspublic void setHiliteIconRightPadding(int hiliteIconRightPadding)
hilite
icons by default? Can be overridden at the field levelhiliteIconRightPadding - Default value is 2Hiliting overview and related methodspublic int getHiliteIconRightPadding()
hilite
icons by default? Can be overridden at the field levelHiliting overview and related methodspublic void setHiliteIcons(java.lang.String... hiliteIcons)
throws java.lang.IllegalStateException
hilites. hiliteIcons should be specified as an Array of SCImgURL.
When present, the hilite editing interface shown when DataBoundComponent.editHilites() is called will offer the user a drop down for picking one of these icons when
defining either a simple or advanced hilite rule.
If the user picks an icon, the created hiliting rule will have
Hilite.icon set to the chosen icon. DataBoundComponent.hiliteIconPosition controls
where the icon will appear for that field -- the default is that it appears in front of the normal cell content. This
can also be overridden at the field level.
hiliteIcons - Default value is ["[SKINIMG]/Dialog/notify.png", "[SKINIMG]/Dialog/warn.png", "[SKINIMG]/actions/approve.png"]java.lang.IllegalStateException - this property cannot be changed after the component has been createdHiliting overview and related methodspublic java.lang.String[] getHiliteIcons()
hilites. hiliteIcons should be specified as an Array of SCImgURL.
When present, the hilite editing interface shown when DataBoundComponent.editHilites() is called will offer the user a drop down for picking one of these icons when
defining either a simple or advanced hilite rule.
If the user picks an icon, the created hiliting rule will have
Hilite.icon set to the chosen icon. DataBoundComponent.hiliteIconPosition controls
where the icon will appear for that field -- the default is that it appears in front of the normal cell content. This
can also be overridden at the field level.
Hiliting overview and related methodspublic void setHiliteIconSize(int hiliteIconSize)
hilite icons for this
component. Can be overridden at the component level via explicit hiliteIconWidth and hiliteIconHeight, or at the field level via hiliteIconSize, hiliteIconWidth and hiliteIconHeighthiliteIconSize - Default value is 12setHiliteIconWidth(java.lang.Integer),
setHiliteIconHeight(java.lang.Integer),
ListGridField.setHiliteIconSize(java.lang.Integer),
Hiliting overview and related methodspublic int getHiliteIconSize()
hilite icons for this
component. Can be overridden at the component level via explicit hiliteIconWidth and hiliteIconHeight, or at the field level via hiliteIconSize, hiliteIconWidth and hiliteIconHeightgetHiliteIconWidth(),
getHiliteIconHeight(),
ListGridField.getHiliteIconSize(),
Hiliting overview and related methodspublic void setHiliteIconWidth(java.lang.Integer hiliteIconWidth)
hiliteIconSize. Can be overridden at the field level.hiliteIconWidth - Default value is nullHiliting overview and related methodspublic java.lang.Integer getHiliteIconWidth()
hiliteIconSize. Can be overridden at the field level.Hiliting overview and related methodspublic void setHiliteReplaceValueFieldTitle(java.lang.String hiliteReplaceValueFieldTitle)
throws java.lang.IllegalStateException
hiliteCanReplaceValue is set.hiliteReplaceValueFieldTitle - Default value is "Replace value with"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getHiliteReplaceValueFieldTitle()
hiliteCanReplaceValue is set.public void setHiliteRowOnFocus(java.lang.Boolean hiliteRowOnFocus)
This property may be explicitly set to control this behavior independently of showRollOver. Otherwise (if this property is null), we will
show the roll-over styling for the keyboard focus row if showRollOver is true.
hiliteRowOnFocus - Default value is nullpublic java.lang.Boolean getHiliteRowOnFocus()
This property may be explicitly set to control this behavior independently of showRollOver. Otherwise (if this property is null), we will
show the roll-over styling for the keyboard focus row if showRollOver is true.
public void setHoverMode(HoverMode hoverMode)
showHoverComponents is true, the builtin
mode to use when automatically creating a hover component for rows in this grid. A number of builtin modes are
provided - see HoverMode. You can also override getCellHoverComponent() to provide a custom hover
widget - in that case, this attribute is ignored.
Note : This is an advanced setting
hoverMode - Default value is nullpublic HoverMode getHoverMode()
showHoverComponents is true, the builtin
mode to use when automatically creating a hover component for rows in this grid. A number of builtin modes are
provided - see HoverMode. You can also override getCellHoverComponent() to provide a custom hover
widget - in that case, this attribute is ignored.
public void setHoverStyle(java.lang.String hoverStyle)
Note : This is an advanced setting
setHoverStyle in class CanvashoverStyle - CSSStyleName . Default value is "gridHover",
setShowHover(java.lang.Boolean)public java.lang.String getHoverStyle()
getHoverStyle in class CanvasCSSStyleName,
getShowHover()public void setIconPadding(java.lang.Integer iconPadding)
throws java.lang.IllegalStateException
autoFitFieldWidths, padding in pixels
left on each side of fields that show images.iconPadding - Default value is 2java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getIconPadding()
autoFitFieldWidths, padding in pixels
left on each side of fields that show images.public void setImageSize(int imageSize)
ListGridField.imageSize or ListGridField.imageWidth/ListGridField.imageHeightimageSize - Default value is 16ImageColumns overview and related methodspublic int getImageSize()
ListGridField.imageSize or ListGridField.imageWidth/ListGridField.imageHeightImageColumns overview and related methodspublic void setIncludeHilitesInSummaryFields(boolean includeHilitesInSummaryFields)
summary field, if
a referenced field is hilited, should the hilite HTML be included in the summary field value? To control hilites
showing in group summaries, see showHilitesInGroupSummary.
Note : This is an advanced setting
includeHilitesInSummaryFields - Default value is trueshouldIncludeHiliteInSummaryField(java.lang.String, java.lang.String)public boolean getIncludeHilitesInSummaryFields()
summary field, if
a referenced field is hilited, should the hilite HTML be included in the summary field value? To control hilites
showing in group summaries, see showHilitesInGroupSummary.
shouldIncludeHiliteInSummaryField(java.lang.String, java.lang.String)public void setIncludeInSummaryProperty(java.lang.String includeInSummaryProperty)
grid summary.includeInSummaryProperty - Default value is "includeInSummary"public java.lang.String getIncludeInSummaryProperty()
grid summary.public void setInitialSort(SortSpecifier... initialSort) throws java.lang.IllegalStateException
SortSpecifier objects used to set up the initial sort configuration for
this grid. If specified, this will be used instead of any sortField specified.initialSort - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic SortSpecifier[] getInitialSort()
SortSpecifier objects used to set up the initial sort configuration for
this grid. If specified, this will be used instead of any sortField specified.public void setInstantScrollTrackRedraw(java.lang.Boolean instantScrollTrackRedraw)
scrollRedrawDelay
applies.instantScrollTrackRedraw - Default value is truepublic java.lang.Boolean getInstantScrollTrackRedraw()
scrollRedrawDelay
applies.public void setInvalidSummaryValue(java.lang.String invalidSummaryValue)
showGridSummary, showGroupSummary or listGridFieldType:"summary"), and the summary function returns
"null" (implying it was unable to calculate a valid summary value). This property will only be used in the
default formatting behavior. If an explicit formatter has been specified - via setCellFormatter() or formatGridSummary(), for example - this property
has no effect.
Note : This is an advanced setting
invalidSummaryValue - Default value is " "public java.lang.String getInvalidSummaryValue()
showGridSummary, showGroupSummary or listGridFieldType:"summary"), and the summary function returns
"null" (implying it was unable to calculate a valid summary value). This property will only be used in the
default formatting behavior. If an explicit formatter has been specified - via setCellFormatter() or formatGridSummary(), for example - this property
has no effect.public boolean getIsGrouped()
throws java.lang.IllegalStateException
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException - if this widget has not yet been rendered.groupBy(java.lang.String...)public void setIsSeparatorProperty(java.lang.String isSeparatorProperty)
record[this.isSeparatorProperty] is set for some record, the record will be displayed as a simple
separator row.isSeparatorProperty - Default value is "isSeparator"public java.lang.String getIsSeparatorProperty()
record[this.isSeparatorProperty] is set for some record, the record will be displayed as a simple
separator row.public void setLeaveHeaderMenuButtonSpace(java.lang.Boolean leaveHeaderMenuButtonSpace)
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? May be explicitly specified at the field level or at the grid level. If not explicitly specified space
will be left for fields with ListGridField.align set to
"left" or "right", but not for fields with align set to "center".
Note : This is an advanced setting
leaveHeaderMenuButtonSpace - Default value is nullpublic void setLeaveScrollbarGap(java.lang.Boolean leaveScrollbarGap)
Note that if leaveScrollbarGap is false and vertical scrolling is introduced, fields will be resized to fit the smaller body area if possible, in order to avoid horizontal scrolling also being required.
setLeaveScrollbarGap in class LayoutleaveScrollbarGap - Default value is trueAppearance overview and related methods,
Rows Examplepublic java.lang.Boolean getLeaveScrollbarGap()
Note that if leaveScrollbarGap is false and vertical scrolling is introduced, fields will be resized to fit the smaller body area if possible, in order to avoid horizontal scrolling also being required.
getLeaveScrollbarGap in class LayoutAppearance overview and related methods,
Rows Examplepublic void setLinkTextProperty(java.lang.String linkTextProperty)
This property is configurable to avoid possible collision with data values in the record.
Use ListGridField.linkTextProperty if you have more than
one link field and
linkTextProperty - Default value is "linkText"ListGridFieldType,
FieldType,
ListGridField.setLinkText(java.lang.String),
ListGridField.setLinkTextProperty(java.lang.String)public java.lang.String getLinkTextProperty()
This property is configurable to avoid possible collision with data values in the record.
Use ListGridField.linkTextProperty if you have more than
one link field and
ListGridFieldType,
FieldType,
ListGridField.getLinkText(),
ListGridField.getLinkTextProperty()public void setListEndEditAction(RowEndEditAction listEndEditAction)
See the Grid Editing overview and also
the Editing Unsaved Records overview for context about how newly added
records behave.
listEndEditAction - Default value is nullEditing overview and related methods,
Enter new rows Examplepublic RowEndEditAction getListEndEditAction()
See the Grid Editing overview and also
the Editing Unsaved Records overview for context about how newly added
records behave.
Editing overview and related methods,
Enter new rows Examplepublic void setLoadingDataMessage(java.lang.String loadingDataMessage)
"${loadingImage}" to
include a loading image.loadingDataMessage - HTMLString . Default value is "${loadingImage} Loading data...",
setLoadingDataMessageStyle(java.lang.String)public java.lang.String getLoadingDataMessage()
"${loadingImage}" to
include a loading image.HTMLString,
getLoadingDataMessageStyle()public void setLoadingDataMessageStyle(java.lang.String loadingDataMessageStyle)
loadingDataMessageStyle - CSSStyleName . Default value is "loadingDataMessage"public java.lang.String getLoadingDataMessageStyle()
CSSStyleNamepublic void setLoadingMessage(java.lang.String loadingMessage)
throws java.lang.IllegalStateException
loadingMessage - Default value is " "java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getLoadingMessage()
public void setLocateColumnsBy(java.lang.String locateColumnsBy)
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the column be identified? Valid options area:
"fieldName" Attempt to identify by fieldName."index" Attempt to
identify by colNum (index in the fields array).locateColumnsBy - Default value is nullLocatorStrategypublic java.lang.String getLocateColumnsBy()
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the column be identified? Valid options area:
"fieldName" Attempt to identify by fieldName."index" Attempt to
identify by colNum (index in the fields array).LocatorStrategypublic void setLocateRowsBy(java.lang.String locateRowsBy)
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the row be identified? Valid options area:
"primaryKey" Only applies to databound grids: If the cell in question has a primary key cell value,
use it to identify cells in autoTest locator strings."titleField" If the cell in question has a
value for the titleField, use it to identify cells in
autoTest locator strings"targetCellValue" Identify rows by storing the cell value for the target
row / field in autoTest locator strings"index"The rowNum will be used to identify the row.locateRowsBy - Default value is nullLocatorStrategypublic java.lang.String getLocateRowsBy()
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() for a cell in this grid, how
should the row be identified? Valid options area:
"primaryKey" Only applies to databound grids: If the cell in question has a primary key cell value,
use it to identify cells in autoTest locator strings."titleField" If the cell in question has a
value for the titleField, use it to identify cells in
autoTest locator strings"targetCellValue" Identify rows by storing the cell value for the target
row / field in autoTest locator strings"index"The rowNum will be used to identify the row.LocatorStrategypublic void setLongTextEditorThreshold(int longTextEditorThreshold)
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.longTextEditorThreshold - Default value is 255Editing overview and related methodspublic int getLongTextEditorThreshold()
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.Editing overview and related methodspublic void setLongTextEditorType(java.lang.String longTextEditorType)
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.longTextEditorType - Default value is "PopUpTextAreaItem"Editing overview and related methodspublic java.lang.String getLongTextEditorType()
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.Editing overview and related methodspublic void setMaxExpandedRecords(java.lang.Integer maxExpandedRecords)
canExpandRecords and canExpandMultipleRecords are both true, this
property dictates the number of records which can be expanded simultaneously. If the expanded record count hits the
value of this property, further attempts to expand records will result in a popup warning (see maxExpandedRecordsPrompt) and expansion will be
cancelled. The default value is null, meaning there is no limit on the number of expanded records.
Note : This is an advanced setting
maxExpandedRecords - Default value is nullpublic java.lang.Integer getMaxExpandedRecords()
canExpandRecords and canExpandMultipleRecords are both true, this
property dictates the number of records which can be expanded simultaneously. If the expanded record count hits the
value of this property, further attempts to expand records will result in a popup warning (see maxExpandedRecordsPrompt) and expansion will be
cancelled. The default value is null, meaning there is no limit on the number of expanded records.
public void setMaxExpandedRecordsPrompt(java.lang.String maxExpandedRecordsPrompt)
throws java.lang.IllegalStateException
${...} will be evaluated as JS code when the message is
displayed. Note that the local variable count will be available and set to this.maxExpandedRecords. The
string will be executed in the scope of the ListGrid so this may also be used to determine other
information about this grid. Default value returns
This grid is limited to [ simultaneously expanded
records. Please collapse some expanded records and retry. maxExpandedRecords]
maxExpandedRecordsPrompt - java.lang.IllegalStateException - this property cannot be changed after the component has been createdHTMLString . Default value is "This grid is limited to ${count} simultaneously expanded records. Please collapse some expanded records and retry."public java.lang.String getMaxExpandedRecordsPrompt()
${...} will be evaluated as JS code when the message is
displayed. Note that the local variable count will be available and set to this.maxExpandedRecords. The
string will be executed in the scope of the ListGrid so this may also be used to determine other
information about this grid. Default value returns
This grid is limited to [ simultaneously expanded
records. Please collapse some expanded records and retry. maxExpandedRecords]
HTMLStringpublic void setMinFieldWidth(int minFieldWidth)
minFieldWidth and redraws any columns as needed.minFieldWidth - Default value is 15public int getMinFieldWidth()
public void setMissingSummaryFieldValue(java.lang.String missingSummaryFieldValue)
missingSummaryFieldValue - Default value is "-"public java.lang.String getMissingSummaryFieldValue()
public void setModalEditing(java.lang.Boolean modalEditing)
Note : This is an advanced setting
modalEditing - Default value is nullEditing overview and related methods,
Modal editing Examplepublic java.lang.Boolean getModalEditing()
Editing overview and related methods,
Modal editing Examplepublic void setNavigateOnTab(boolean navigateOnTab)
canSelectCells is true, this property allows the
user to navigate through the cells of a grid using Tab and Shift+Tab keypresses. When a user tabs to the end of the row,
the rowEndEditAction is used to determine whether
to shift selection to the next row, return to the beginning of the same row, or simply move on through the page's tab
order.navigateOnTab - Default value is truepublic boolean getNavigateOnTab()
canSelectCells is true, this property allows the
user to navigate through the cells of a grid using Tab and Shift+Tab keypresses. When a user tabs to the end of the row,
the rowEndEditAction is used to determine whether
to shift selection to the next row, return to the beginning of the same row, or simply move on through the page's tab
order.public void setNeverValidate(java.lang.Boolean neverValidate)
Note : This is an advanced setting
neverValidate - Default value is nullGridValidation overview and related methodspublic java.lang.Boolean getNeverValidate()
GridValidation overview and related methodspublic void setNormalBaseStyle(java.lang.String normalBaseStyle)
throws java.lang.IllegalStateException
baseStyle is set to null. If baseStyle is unset, this property will be used as a base cell style if
the grid is showing fixed height rows, and the specified cellHeight matches normalCellHeight (and in Internet Explorer, fastCellUpdates is false). Otherwise tallBaseStyle will be used.
Having separate styles defined for fixed vs. variable height rows allows the developer to specify css which is designed to render at a specific height (typically using background images, which won't scale), without breaking support for styling rows of variable height.
See CellStyleSuffixes for details on how stateful suffixes are combined
with the base style to generate stateful cell styles.
normalBaseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is "cell",
getBaseStyle()public java.lang.String getNormalBaseStyle()
baseStyle is set to null. If baseStyle is unset, this property will be used as a base cell style if
the grid is showing fixed height rows, and the specified cellHeight matches normalCellHeight (and in Internet Explorer, fastCellUpdates is false). Otherwise tallBaseStyle will be used.
Having separate styles defined for fixed vs. variable height rows allows the developer to specify css which is designed to render at a specific height (typically using background images, which won't scale), without breaking support for styling rows of variable height.
See CellStyleSuffixes for details on how stateful suffixes are combined
with the base style to generate stateful cell styles.
CSSStyleName,
getBaseStyle()public void setNormalCellHeight(int normalCellHeight)
baseStyle is unset, base style will be derived from
normalBaseStyle if this grid has fixed row heights
and the specified cellHeight matches this value.
Otherwise tallBaseStyle will be used.
Note : This is an advanced setting
normalCellHeight - Default value is 20public int getNormalCellHeight()
baseStyle is unset, base style will be derived from
normalBaseStyle if this grid has fixed row heights
and the specified cellHeight matches this value.
Otherwise tallBaseStyle will be used.public void setNullGroupTitle(java.lang.String nullGroupTitle)
nullGroupTitle - Default value is '-none-'groupBy(java.lang.String...)public java.lang.String getNullGroupTitle()
groupBy(java.lang.String...)public void setOfflineMessageStyle(java.lang.String offlineMessageStyle)
offlineMessage if displayed.offlineMessageStyle - CSSStyleName . Default value is "offlineMessage"public java.lang.String getOfflineMessageStyle()
offlineMessage if displayed.CSSStyleNamepublic FormItemIcon getOperatorIcon()
Using AutoChildren
for details.
Inline icon shown inside filter editor fields when
allowFilterOperators is enabled.
public void setOriginBaseStyle(java.lang.String originBaseStyle)
baseStyle for a cell
that is currently a selection origin for shifted incremental cell selection. Only has an effect if canSelectCells is true. originBaseStyle - CSSStyleName . Default value is nullpublic java.lang.String getOriginBaseStyle()
baseStyle for a cell
that is currently a selection origin for shifted incremental cell selection. Only has an effect if canSelectCells is true. CSSStyleNamepublic void setOverflow(Overflow overflow) throws java.lang.IllegalStateException
body is configured with overflow: auto by default, no
overflow is expected for the ListGrid itself so by default it has overflow:
hidden.setOverflow in class Layoutoverflow - Default value is Canvas.HIDDENjava.lang.IllegalStateException - this property cannot be changed after the component has been createdLayout.setOverflow(com.smartgwt.client.types.Overflow)public Overflow getOverflow()
body is configured with overflow: auto by default, no
overflow is expected for the ListGrid itself so by default it has overflow:
hidden.getOverflow in class LayoutLayout.getOverflow()public void setPoolComponentsPerColumn(java.lang.Boolean poolComponentsPerColumn)
record components, be pooled
per column or per record. Only applies if showRecordComponentsByCell is true. When recordComponentPoolingMode is "recycle" and you
have components of different types in different columns, set this property to true to ensure that components intended
for one column are not recycled for use in another column that should have a different component.
If no components
applicable to a particular column are available in the pool, the system calls createRecordComponent.
poolComponentsPerColumn - Default value is truepublic java.lang.Boolean getPoolComponentsPerColumn()
record components, be pooled
per column or per record. Only applies if showRecordComponentsByCell is true. When recordComponentPoolingMode is "recycle" and you
have components of different types in different columns, set this property to true to ensure that components intended
for one column are not recycled for use in another column that should have a different component.
If no components
applicable to a particular column are available in the pool, the system calls createRecordComponent.
public void setPrintAutoFit(java.lang.Boolean printAutoFit)
Autofit, but
specific to printed output.printAutoFit - Default value is truePrinting overview and related methodspublic java.lang.Boolean getPrintAutoFit()
Autofit, but
specific to printed output.Printing overview and related methodspublic void setPrintBaseStyle(java.lang.String printBaseStyle)
baseStyle if null.printBaseStyle - CSSStyleName . Default value is null,
Printing overview and related methodspublic java.lang.String getPrintBaseStyle()
baseStyle if null.CSSStyleName,
Printing overview and related methodspublic void setPrintBooleanBaseStyle(java.lang.String printBooleanBaseStyle)
throws java.lang.IllegalStateException
printBooleanBaseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is null,
setBooleanBaseStyle(java.lang.String),
Printing overview and related methodspublic java.lang.String getPrintBooleanBaseStyle()
booleanBaseStyle to use when printing.CSSStyleName,
getBooleanBaseStyle(),
Printing overview and related methodspublic void setPrintBooleanFalseImage(java.lang.String printBooleanFalseImage)
booleanFalseImage to use when printing. If this, printBooleanTrueImage and printBooleanPartialImage are unset, this will be
set to the default CheckboxItem.printUncheckedImage.
Note : This is an advanced setting
printBooleanFalseImage - SCImgURL . Default value is null,
setBooleanFalseImage(java.lang.String),
Printing overview and related methodspublic java.lang.String getPrintBooleanFalseImage()
booleanFalseImage to use when printing. If this, printBooleanTrueImage and printBooleanPartialImage are unset, this will be
set to the default CheckboxItem.printUncheckedImage.
SCImgURL,
getBooleanFalseImage(),
Printing overview and related methodspublic void setPrintBooleanPartialImage(java.lang.String printBooleanPartialImage)
booleanPartialImage to use when
printing. If this, printBooleanTrueImage and printBooleanFalseImage are unset, this will be set
to the default CheckboxItem.printPartialSelectedImage.
Note : This is an advanced setting
printBooleanPartialImage - SCImgURL . Default value is null,
setBooleanPartialImage(java.lang.String),
Printing overview and related methodspublic java.lang.String getPrintBooleanPartialImage()
booleanPartialImage to use when
printing. If this, printBooleanTrueImage and printBooleanFalseImage are unset, this will be set
to the default CheckboxItem.printPartialSelectedImage.
SCImgURL,
getBooleanPartialImage(),
Printing overview and related methodspublic void setPrintBooleanTrueImage(java.lang.String printBooleanTrueImage)
booleanTrueImage to use when printing. If this, printBooleanFalseImage and printBooleanPartialImage are unset, this will be
set to the default CheckboxItem.printCheckedImage.
Note : This is an advanced setting
printBooleanTrueImage - SCImgURL . Default value is null,
setBooleanTrueImage(java.lang.String),
Printing overview and related methodspublic java.lang.String getPrintBooleanTrueImage()
booleanTrueImage to use when printing. If this, printBooleanFalseImage and printBooleanPartialImage are unset, this will be
set to the default CheckboxItem.printCheckedImage.
SCImgURL,
getBooleanTrueImage(),
Printing overview and related methodspublic void setPrintCheckboxFieldFalseImage(java.lang.String printCheckboxFieldFalseImage)
printCheckboxFieldFalseImage - SCImgURL . Default value is null,
setCheckboxFieldFalseImage(java.lang.String),
Printing overview and related methodspublic java.lang.String getPrintCheckboxFieldFalseImage()
checkboxFieldFalseImage to use
when printing.SCImgURL,
getCheckboxFieldFalseImage(),
Printing overview and related methodspublic void setPrintCheckboxFieldPartialImage(java.lang.String printCheckboxFieldPartialImage)
printCheckboxFieldPartialImage - SCImgURL . Default value is null,
setCheckboxFieldPartialImage(java.lang.String),
Printing overview and related methodspublic java.lang.String getPrintCheckboxFieldPartialImage()
checkboxFieldPartialImage to
use when printing.SCImgURL,
getCheckboxFieldPartialImage(),
Printing overview and related methodspublic void setPrintCheckboxFieldTrueImage(java.lang.String printCheckboxFieldTrueImage)
printCheckboxFieldTrueImage - SCImgURL . Default value is null,
setCheckboxFieldTrueImage(java.lang.String),
Printing overview and related methodspublic java.lang.String getPrintCheckboxFieldTrueImage()
checkboxFieldTrueImage to use
when printing.SCImgURL,
getCheckboxFieldTrueImage(),
Printing overview and related methodspublic void setPrintHeaderStyle(java.lang.String printHeaderStyle)
headerBaseStyle if null.printHeaderStyle - CSSStyleName . Default value is "printHeader",
Printing overview and related methodspublic java.lang.String getPrintHeaderStyle()
headerBaseStyle if null.CSSStyleName,
Printing overview and related methodspublic void setPrintMaxRows(int printMaxRows)
For grids with exceptional numbers of columns or complex formatting logic, this number might need to be adjusted downward.
Note : This is an advanced setting
printMaxRows - Default value is 100Printing overview and related methodspublic int getPrintMaxRows()
For grids with exceptional numbers of columns or complex formatting logic, this number might need to be adjusted downward.
Printing overview and related methodspublic void setPrintWrapCells(java.lang.Boolean printWrapCells)
wrapCells, but specific to printed output.printWrapCells - Default value is truePrinting overview and related methodspublic java.lang.Boolean getPrintWrapCells()
wrapCells, but specific to printed output.Printing overview and related methodspublic void setQuickDrawAheadRatio(float quickDrawAheadRatio)
drawAheadRatio, to be used when the
user is rapidly changing the grids viewport (for example drag scrolling through the grid). If unspecified drawAheadRatio will be used in all casesquickDrawAheadRatio - Default value is 2.0public float getQuickDrawAheadRatio()
drawAheadRatio, to be used when the
user is rapidly changing the grids viewport (for example drag scrolling through the grid). If unspecified drawAheadRatio will be used in all casespublic void setRecordBaseStyleProperty(java.lang.String recordBaseStyleProperty)
record[listGrid.recordBaseStyleProperty] to the desired base style name - for example if
recordBaseStyleProperty is "_baseStyle", set record._baseStyle to the custom base
style name.
Note : This is an advanced setting
recordBaseStyleProperty - Default value is "_baseStyle"setBaseStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getRecordBaseStyleProperty()
record[listGrid.recordBaseStyleProperty] to the desired base style name - for example if
recordBaseStyleProperty is "_baseStyle", set record._baseStyle to the custom base
style name.getBaseStyle(),
Appearance overview and related methodspublic void setRecordCanRemoveProperty(java.lang.String recordCanRemoveProperty)
throws java.lang.IllegalStateException
canRemoveRecords
is true, removal of that record is disallowed in the UI. The icon in the remove field is not shown.
Note : This is an advanced setting
recordCanRemoveProperty - Default value is "_canRemove"java.lang.IllegalStateException - this property cannot be changed after the component has been createdEditing overview and related methodspublic java.lang.String getRecordCanRemoveProperty()
canRemoveRecords
is true, removal of that record is disallowed in the UI. The icon in the remove field is not shown.Editing overview and related methodspublic void setRecordCanSelectProperty(java.lang.String recordCanSelectProperty)
throws java.lang.IllegalStateException
Note : This is an advanced setting
recordCanSelectProperty - Default value is "canSelect"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getRecordCanSelectProperty()
public void setRecordComponentHeight(java.lang.Integer recordComponentHeight)
showRecordComponents is true, this
attribute may be used to specify a standard height for record components. If specified every row in the grid will be
sized tall enough to accommodate a recordComponent of this size. Note that if this property is unset, the grid will
not be able to know row heights in advance, and frozen
fields are not currently supported in this case. If you are putting a recordComponent in every row, and they all have
a consistent height, set recordComponentHeight and you will then be able to use frozen fields and
avoid the whitespace side-effect of virtual scrolling by setting virtualScrolling:false.
Similarly, if your
recordComponents are never tall enough that they will expand the row beyond the cellHeight, set virtualScrolling:false to avoid the whitespace
side-effect of virtual scrolling and to allow
frozen fields to be used. In this mode, you can have
recordComponents on some rows but not others, and recordComponents of different heights, so long as no recordComponent
ever causes a row to grow beyond cellHeight (which would
happen if the recordComponents height + 2*cellPadding
is larger than cellHeight).
If this method is called after the component has been drawn/initialized:
Setter for the recordComponentHeight
Note : This is an advanced setting
recordComponentHeight - recordComponent height. Default value is nullsetVirtualScrolling(java.lang.Boolean)public java.lang.Integer getRecordComponentHeight()
showRecordComponents is true, this
attribute may be used to specify a standard height for record components. If specified every row in the grid will be
sized tall enough to accommodate a recordComponent of this size. Note that if this property is unset, the grid will
not be able to know row heights in advance, and frozen
fields are not currently supported in this case. If you are putting a recordComponent in every row, and they all have
a consistent height, set recordComponentHeight and you will then be able to use frozen fields and
avoid the whitespace side-effect of virtual scrolling by setting virtualScrolling:false.
Similarly, if your
recordComponents are never tall enough that they will expand the row beyond the cellHeight, set virtualScrolling:false to avoid the whitespace
side-effect of virtual scrolling and to allow
frozen fields to be used. In this mode, you can have
recordComponents on some rows but not others, and recordComponents of different heights, so long as no recordComponent
ever causes a row to grow beyond cellHeight (which would
happen if the recordComponents height + 2*cellPadding
is larger than cellHeight).
getVirtualScrolling()public void setRecordComponentPoolingMode(RecordComponentPoolingMode recordComponentPoolingMode)
component-pooling to employ for recordComponents. The default mode is "viewport", which means that recordComponents are destroyed as soon their record is no longer being rendered (scrolled out of the viewport, eliminated by search criteria, etc).
For a large or dynamic data set where the components shown on
different rows are similar, switch to "recycle" mode, which pools recordComponents by detaching them from records that
are not visible and re-using them in other records. In this mode, you should implement updateRecordComponent() to apply any changes to make
reused components applicable to the new record they appear in, if necessary. For example, if you have several controls
in your recordComponents, and not all of the controls apply to every record, your
updateRecordComponent() implementation could simply hide or disable inapplicable controls, and this would
be much faster than creating a whole new set of controls every time a given record is scrolled into view.
If you are
using per-cell recordComponents, and you
have components of different types in different columns and still want to take advantage of component recycling, you can
set poolComponentsPerColumn to ensure that
components intended for one column are not recycled for use in another column that should have a different component.
Note that, if different records have distinctly different components embedded in them, or multiple columns in each record embed different components, you should leave the recordComponentPoolingMode at "viewport" if your dataset is very large or use "data" otherwise.
Note : This is an advanced setting
recordComponentPoolingMode - Default value is "viewport"public RecordComponentPoolingMode getRecordComponentPoolingMode()
component-pooling to employ for recordComponents. The default mode is "viewport", which means that recordComponents are destroyed as soon their record is no longer being rendered (scrolled out of the viewport, eliminated by search criteria, etc).
For a large or dynamic data set where the components shown on
different rows are similar, switch to "recycle" mode, which pools recordComponents by detaching them from records that
are not visible and re-using them in other records. In this mode, you should implement updateRecordComponent() to apply any changes to make
reused components applicable to the new record they appear in, if necessary. For example, if you have several controls
in your recordComponents, and not all of the controls apply to every record, your
updateRecordComponent() implementation could simply hide or disable inapplicable controls, and this would
be much faster than creating a whole new set of controls every time a given record is scrolled into view.
If you are
using per-cell recordComponents, and you
have components of different types in different columns and still want to take advantage of component recycling, you can
set poolComponentsPerColumn to ensure that
components intended for one column are not recycled for use in another column that should have a different component.
Note that, if different records have distinctly different components embedded in them, or multiple columns in each record embed different components, you should leave the recordComponentPoolingMode at "viewport" if your dataset is very large or use "data" otherwise.
public void setRecordComponentPosition(EmbeddedPosition recordComponentPosition)
showRecordComponents is true, how should
the component appear within the cell. Valid options are "within": the component will be rendered
inside the record / cell. Canvas.snapTo may be set to specify
where the component should render within the row or cell, and Canvas.snapOffsetTop / Canvas.snapOffsetLeft may be set to indent recordComponents
within their parent cells. Note that if unset, the component will show up at the top/left edge for components embedded
within an entire row, or for per-cell components, cell align and valign will be respected. Note also that, when
rendering components "within" cells, specified component heights will be respected and will change the height of the
row. However, if you want components to completely fill a cell at it's default height, set height: "100%" or rows will
render at the default height of the component. "expand": the component will be written into the
cell below the normal cell content, causing the cell to expand vertically to accommodate it. null: If
this attribute is unset, we will default to showing recordComponents with position "within" if showRecordComponentsByCell is true, otherwise
using "expand" logic. recordComponentPosition - Default value is nullsetShowRecordComponents(java.lang.Boolean)public EmbeddedPosition getRecordComponentPosition()
showRecordComponents is true, how should
the component appear within the cell. Valid options are "within": the component will be rendered
inside the record / cell. Canvas.snapTo may be set to specify
where the component should render within the row or cell, and Canvas.snapOffsetTop / Canvas.snapOffsetLeft may be set to indent recordComponents
within their parent cells. Note that if unset, the component will show up at the top/left edge for components embedded
within an entire row, or for per-cell components, cell align and valign will be respected. Note also that, when
rendering components "within" cells, specified component heights will be respected and will change the height of the
row. However, if you want components to completely fill a cell at it's default height, set height: "100%" or rows will
render at the default height of the component. "expand": the component will be written into the
cell below the normal cell content, causing the cell to expand vertically to accommodate it. null: If
this attribute is unset, we will default to showing recordComponents with position "within" if showRecordComponentsByCell is true, otherwise
using "expand" logic. getShowRecordComponents()public void setRecordDetailDSProperty(java.lang.String recordDetailDSProperty)
listGrid.expansionMode is "related". The default is ListGridRecord.detailDS. Note that you can set the detailDS at the grid level instead if the same dataSource is to
be used for all records.
Note : This is an advanced setting
recordDetailDSProperty - Default value is "detailDS"public java.lang.String getRecordDetailDSProperty()
listGrid.expansionMode is "related". The default is ListGridRecord.detailDS. Note that you can set the detailDS at the grid level instead if the same dataSource is to
be used for all records.public void setRecordDropAppearance(RecordDropAppearance recordDropAppearance)
canAcceptDroppedRecords is true for this
listGrid, this property governs whether the user can drop between, or over records within the grid. This controls what
RecordDropPosition is passed to the recordDrop() event handler.recordDropAppearance - Default value is ListGrid.BETWEENpublic RecordDropAppearance getRecordDropAppearance()
canAcceptDroppedRecords is true for this
listGrid, this property governs whether the user can drop between, or over records within the grid. This controls what
RecordDropPosition is passed to the recordDrop() event handler.public void setRecordEditProperty(java.lang.String recordEditProperty)
Note : This is an advanced setting
recordEditProperty - Default value is "_canEdit"setCanEdit(java.lang.Boolean),
ListGridField.setCanEdit(java.lang.Boolean),
canEditCell(int, int),
Editing overview and related methodspublic java.lang.String getRecordEditProperty()
getCanEdit(),
ListGridField.getCanEdit(),
canEditCell(int, int),
Editing overview and related methodspublic void setRecordEnabledProperty(java.lang.String recordEnabledProperty)
throws java.lang.IllegalStateException
Setting this property on a
record will effect the visual style and interactivity of the record. If set to false the record (row in a
ListGrid or TreeGrid) will not
highlight when the mouse moves over it, nor will it respond to mouse clicks.
recordEnabledProperty - Default value is "enabled"java.lang.IllegalStateException - this property cannot be changed after the component has been createdListGridRecord.setEnabled(java.lang.Boolean),
Disabled rows Examplepublic java.lang.String getRecordEnabledProperty()
Setting this property on a
record will effect the visual style and interactivity of the record. If set to false the record (row in a
ListGrid or TreeGrid) will not
highlight when the mouse moves over it, nor will it respond to mouse clicks.
ListGridRecord.getEnabled(),
Disabled rows Examplepublic void setRecordSummaryBaseStyle(java.lang.String recordSummaryBaseStyle)
type:"summary"),
this attribute specifies a custom base style to apply to cells in the summary field
Note : This is an advanced setting
recordSummaryBaseStyle - CSSStyleName . Default value is "recordSummaryCell"public java.lang.String getRecordSummaryBaseStyle()
type:"summary"),
this attribute specifies a custom base style to apply to cells in the summary fieldCSSStyleNamepublic void setRemovedCSSText(java.lang.String removedCSSText)
marked for removal. This CSS text will be applied on top of standard disabled styling for the cell.
Note : This is an advanced setting
removedCSSText - Default value is "text-decoration:line-through;"Appearance overview and related methodspublic java.lang.String getRemovedCSSText()
marked for removal. This CSS text will be applied on top of standard disabled styling for the cell.
Appearance overview and related methodspublic void setRemoveFieldProperties(ListGridField removeFieldProperties) throws java.lang.IllegalStateException
canRemoveRecords is enabled.removeFieldProperties - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic ListGridField getRemoveFieldProperties()
canRemoveRecords is enabled.public void setRemoveFieldTitle(java.lang.String removeFieldTitle)
remove field. By
default this title is not displayed in the remove column header button as the removeFieldDefaults sets ListGridField.showTitle to false.
Note : This is an advanced setting
removeFieldTitle - Default value is " "public java.lang.String getRemoveFieldTitle()
remove field. By
default this title is not displayed in the remove column header button as the removeFieldDefaults sets ListGridField.showTitle to false.
public void setRemoveIcon(java.lang.String removeIcon)
throws java.lang.IllegalStateException
canRemoveRecords is enabled, default icon to
show in the auto-generated field that allows removing records.removeIcon - java.lang.IllegalStateException - this property cannot be changed after the component has been createdSCImgURL . Default value is "[SKIN]/actions/remove.png"public java.lang.String getRemoveIcon()
canRemoveRecords is enabled, default icon to
show in the auto-generated field that allows removing records.SCImgURLpublic void setRemoveIconSize(int removeIconSize)
remove icons for this
ListGrid.removeIconSize - Default value is 16public int getRemoveIconSize()
remove icons for this
ListGrid.public void setReselectOnUpdate(boolean reselectOnUpdate)
throws java.lang.IllegalStateException
databound listGrid, ensure the updated record is re-selected
when the operation completes. The reselectOnUpdateNotifications attributes governs whether ListGrid.selectionUpdated() and ListGrid.selectionChanged() will fire when this
occurs.
Note : This is an advanced setting
reselectOnUpdate - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getReselectOnUpdate()
databound listGrid, ensure the updated record is re-selected
when the operation completes. The reselectOnUpdateNotifications attributes governs whether ListGrid.selectionUpdated() and ListGrid.selectionChanged() will fire when this
occurs.public void setReselectOnUpdateNotifications(SelectionNotificationType reselectOnUpdateNotifications)
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.
Note : This is an advanced setting
reselectOnUpdateNotifications - Default value is "selectionChanged"public SelectionNotificationType getReselectOnUpdateNotifications()
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.public void setResizeFieldsInRealTime(boolean resizeFieldsInRealTime)
true, the grid contents are redrawn in real time as fields are resized. This can be slow with a large
grid and/or on some platforms. By default, this is enabled in modern desktop browsers. This is automatically switched
off in mobile browsers.
Note : This is an advanced setting
resizeFieldsInRealTime - Default value is see belowpublic boolean getResizeFieldsInRealTime()
true, the grid contents are redrawn in real time as fields are resized. This can be slow with a large
grid and/or on some platforms. By default, this is enabled in modern desktop browsers. This is automatically switched
off in mobile browsers.public void setReverseRTLAlign(java.lang.Boolean reverseRTLAlign)
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)? This is true by default to match user expectation that text flows from start-to end and is aligned with the start of text flow (left in LTR mode, right in RTL mode) by default. May be set to false to have the specified alignments be taken literally in RTL mode.
reverseRTLAlign - Default value is truepublic java.lang.Boolean getReverseRTLAlign()
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)? This is true by default to match user expectation that text flows from start-to end and is aligned with the start of text flow (left in LTR mode, right in RTL mode) by default. May be set to false to have the specified alignments be taken literally in RTL mode.
public void setRowEndEditAction(RowEndEditAction rowEndEditAction)
rowEndEditAction - Default value is nullEditing overview and related methodspublic RowEndEditAction getRowEndEditAction()
Editing overview and related methodspublic ListGridField getRowNumberField() throws java.lang.IllegalStateException
showRowNumbers is true.
This component is an AutoChild named "rowNumberField". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setRowNumberStart(int rowNumberStart)
Note : This is an advanced setting
rowNumberStart - Default value is 1public int getRowNumberStart()
public void setRowNumberStyle(java.lang.String rowNumberStyle)
rowNumberField.
Note : This is an advanced setting
rowNumberStyle - CSSStyleName . Default value is "specialCol"public java.lang.String getRowNumberStyle()
rowNumberField.CSSStyleNamepublic void setRowSpanEditMode(RowSpanEditMode rowSpanEditMode)
allowRowSpanning is enabled, this property may
be used to specify editing behavior for cells that span multiple rows.
Note : This is an advanced setting
rowSpanEditMode - Default value is "first"public RowSpanEditMode getRowSpanEditMode()
allowRowSpanning is enabled, this property may
be used to specify editing behavior for cells that span multiple rows.public void setRowSpanSelectionMode(RowSpanSelectionMode rowSpanSelectionMode) throws java.lang.IllegalStateException
useRowSpanStyling
is enabled. See RowSpanSelectionMode.rowSpanSelectionMode - Default value is "forward"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic RowSpanSelectionMode getRowSpanSelectionMode()
useRowSpanStyling
is enabled. See RowSpanSelectionMode.public void setSaveByCell(java.lang.Boolean saveByCell)
If unset, defaults to
this.editByCell.
To avoid automatic saving entirely,
set autoSaveEdits:false.
saveByCell - Default value is nullsetEditByCell(java.lang.Boolean),
Editing overview and related methodspublic java.lang.Boolean getSaveByCell()
If unset, defaults to
this.editByCell.
To avoid automatic saving entirely,
set autoSaveEdits:false.
getEditByCell(),
Editing overview and related methodspublic void setSaveLocally(java.lang.Boolean saveLocally)
throws java.lang.IllegalStateException
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. When using this mode, data must be provided to the grid via setData(), and must be provided as a RecordList. Setting
saveLocally is invalid if either fetchData() is
called or if a ResultSet is provided as the data model.
saveLocally
mode includes changes made via inline editing, record
removal via canRemoveRecords, as well as
programmatic calls to updateData(), addData() and removeData(). This also causes saves to be performed
synchronously (unlike normal DataSource operations).
Note that using this mode also disables the automatic cache synchronization provided by the DataSource system - changes made to this grid are saved only to this grid's data set.
See also filterLocalData to allow filtering,
such as filtering performed by the filterEditor, to
also work only with the local data set.
If saveLocally is unset, and filterLocalData is true, the saveLocally behavior is
enabled by default
Note : This is an advanced setting
saveLocally - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetUseRemoteValidators(java.lang.Boolean),
Databinding overview and related methodspublic java.lang.Boolean getSaveLocally()
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. When using this mode, data must be provided to the grid via setData(), and must be provided as a RecordList. Setting
saveLocally is invalid if either fetchData() is
called or if a ResultSet is provided as the data model.
saveLocally
mode includes changes made via inline editing, record
removal via canRemoveRecords, as well as
programmatic calls to updateData(), addData() and removeData(). This also causes saves to be performed
synchronously (unlike normal DataSource operations).
Note that using this mode also disables the automatic cache synchronization provided by the DataSource system - changes made to this grid are saved only to this grid's data set.
See also filterLocalData to allow filtering,
such as filtering performed by the filterEditor, to
also work only with the local data set.
If saveLocally is unset, and filterLocalData is true, the saveLocally behavior is
enabled by default
getUseRemoteValidators(),
Databinding overview and related methodspublic void setSaveRequestProperties(DSRequest saveRequestProperties)
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). An example usage would be to customize the prompt
displayed while saving is in progress if waitForSave is
true.
Note that for more advanced customization of save operations, DataBoundComponent.addOperation and DataBoundComponent.updateOperation are available to
developers, allowing specification of an explicit OperationBinding for the add / update
operation performed on save.
Note : This is an advanced setting
saveRequestProperties - Default value is nullEditing overview and related methodspublic DSRequest getSaveRequestProperties()
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). An example usage would be to customize the prompt
displayed while saving is in progress if waitForSave is
true.
Note that for more advanced customization of save operations, DataBoundComponent.addOperation and DataBoundComponent.updateOperation are available to
developers, allowing specification of an explicit OperationBinding for the add / update
operation performed on save.
Editing overview and related methodspublic void setScreenReaderCellSeparator(java.lang.String screenReaderCellSeparator)
throws java.lang.IllegalStateException
screen reader mode is enabled, this invisible separator
string is written out between each cell value. This string will be picked up by screen readers allowing them to more
obviously identify to the user the different cell values as the contents of a row are read aloud. The screenReaderRowSeparator string if any will be
written out after the last cell in a row to separate the last cell's value from the screen reader's announcement of the
row's number and total number of rows in the grid (such as "3 of 20"). This attribute may be set to null to disable the feature.
Note that screen readers vary widely on which punctuation symbols are read aloud, and sometimes it depends on the context of the punctuation. However, the widely-used JAWS, NVDA, and VoiceOver screen readers all read the forward slash '/' as "slash". See Why Don?t Screen Readers Always Read What?s on the Screen? Part 1: Punctuation and Typographic Symbols for a table of findings on which punctuation symbols are read aloud by JAWS, NVDA, and VoiceOver.
Note : This is an advanced setting
screenReaderCellSeparator - java.lang.IllegalStateException - this property cannot be changed after the component has been createdHTMLString . Default value is "/",
Accessibility overview and related methodspublic java.lang.String getScreenReaderCellSeparator()
screen reader mode is enabled, this invisible separator
string is written out between each cell value. This string will be picked up by screen readers allowing them to more
obviously identify to the user the different cell values as the contents of a row are read aloud. The screenReaderRowSeparator string if any will be
written out after the last cell in a row to separate the last cell's value from the screen reader's announcement of the
row's number and total number of rows in the grid (such as "3 of 20"). This attribute may be set to null to disable the feature.
Note that screen readers vary widely on which punctuation symbols are read aloud, and sometimes it depends on the context of the punctuation. However, the widely-used JAWS, NVDA, and VoiceOver screen readers all read the forward slash '/' as "slash". See Why Don?t Screen Readers Always Read What?s on the Screen? Part 1: Punctuation and Typographic Symbols for a table of findings on which punctuation symbols are read aloud by JAWS, NVDA, and VoiceOver.
HTMLString,
Accessibility overview and related methodspublic void setScreenReaderRowSeparator(java.lang.String screenReaderRowSeparator)
throws java.lang.IllegalStateException
screen reader mode is enabled, this invisible string will
be written out after the last cell in a row. This string will be picked up by screen readers allowing them to more
obviously identify to the user the end of the row's contents and the screen reader's announcement of the row's number
and total number of rows in the grid (such as "3 of 20"). This attribute may be set to null to disable writing out an invisible string at the end of each row.
Note that screen readers vary widely on which punctuation symbols are read aloud, and sometimes it depends on the context of the punctuation. However, the widely-used JAWS, NVDA, and VoiceOver screen readers all pause briefly for a comma ',' that is within text. See Why Don?t Screen Readers Always Read What?s on the Screen? Part 1: Punctuation and Typographic Symbols for a table of findings on which punctuation symbols are read aloud by JAWS, NVDA, and VoiceOver.
Note : This is an advanced setting
screenReaderRowSeparator - java.lang.IllegalStateException - this property cannot be changed after the component has been createdHTMLString . Default value is ",",
setScreenReaderCellSeparator(java.lang.String),
Accessibility overview and related methodspublic java.lang.String getScreenReaderRowSeparator()
screen reader mode is enabled, this invisible string will
be written out after the last cell in a row. This string will be picked up by screen readers allowing them to more
obviously identify to the user the end of the row's contents and the screen reader's announcement of the row's number
and total number of rows in the grid (such as "3 of 20"). This attribute may be set to null to disable writing out an invisible string at the end of each row.
Note that screen readers vary widely on which punctuation symbols are read aloud, and sometimes it depends on the context of the punctuation. However, the widely-used JAWS, NVDA, and VoiceOver screen readers all pause briefly for a comma ',' that is within text. See Why Don?t Screen Readers Always Read What?s on the Screen? Part 1: Punctuation and Typographic Symbols for a table of findings on which punctuation symbols are read aloud by JAWS, NVDA, and VoiceOver.
HTMLString,
getScreenReaderCellSeparator(),
Accessibility overview and related methodspublic void setScrollRedrawDelay(int scrollRedrawDelay)
scrollWheelRedrawDelay. See also GridRenderer.instantScrollTrackRedraw for
cases where this delay is skipped.
NOTE: In touch
browsers, touchScrollRedrawDelay is
used instead.
scrollRedrawDelay - Default value is 0public int getScrollRedrawDelay()
scrollWheelRedrawDelay. See also GridRenderer.instantScrollTrackRedraw for
cases where this delay is skipped.
NOTE: In touch
browsers, touchScrollRedrawDelay is
used instead.
public void setScrollToCellXPosition(Alignment scrollToCellXPosition)
scrollToCellXPosition - Default value is "center"public Alignment getScrollToCellXPosition()
public void setScrollToCellYPosition(VerticalAlignment scrollToCellYPosition)
scrollToCellYPosition - Default value is "center"public VerticalAlignment getScrollToCellYPosition()
public void setScrollWheelRedrawDelay(java.lang.Integer scrollWheelRedrawDelay)
scrollRedrawDelay will be used as a default for both
drag scrolling and mouseWheel scrolling. Note that if specified, this value will typically be larger than scrollRedrawDelay. From experimentation, the default
setting of 250 is typically enough time for a user to rapidly scroll through a grid (rotating the scroll
wheel with repeated flicks), without redrawing between rotations, but this will differ depending on how long the redraw
takes. A larger delay may be warranted for grids with large numbers of columns, heavy custom formatting, etc.
See
also GridRenderer.instantScrollTrackRedraw for cases where this delay is skipped.
scrollWheelRedrawDelay - Default value is 0public java.lang.Integer getScrollWheelRedrawDelay()
scrollRedrawDelay will be used as a default for both
drag scrolling and mouseWheel scrolling. Note that if specified, this value will typically be larger than scrollRedrawDelay. From experimentation, the default
setting of 250 is typically enough time for a user to rapidly scroll through a grid (rotating the scroll
wheel with repeated flicks), without redrawing between rotations, but this will differ depending on how long the redraw
takes. A larger delay may be warranted for grids with large numbers of columns, heavy custom formatting, etc.
See
also GridRenderer.instantScrollTrackRedraw for cases where this delay is skipped.
public void setSelectedState(java.lang.String selectedState)
ListGridSelectedState object.setSelectedState() to reset this grid's selection the
current state (assuming the same data is present in the grid).ListGridSelectedState object passed in.getSelectedState().selectedState - Object describing the desired selection state of the gridListGridSelectedState . Default value is nullpublic java.lang.String getSelectedState()
ListGridSelectedState object.setSelectedState() to reset this grid's selection the
current state (assuming the same data is present in the grid).ListGridSelectedState object.setSelectedState() to reset this grid's current selection
state (assuming the same data is present in the grid).ListGridSelectedStatepublic void setSelectHeaderOnSort(java.lang.Boolean selectHeaderOnSort)
multi-sort grid) in the selected state.selectHeaderOnSort - Default value is truepublic java.lang.Boolean getSelectHeaderOnSort()
multi-sort grid) in the selected state.public void setSelectionAppearance(SelectionAppearance selectionAppearance)
For selectionAppearance:"checkbox" with multiple
selection allowed, you would typically use selectionType:"simple" (the default). Because selectionType and selectionAppearance are
unrelated, the combination of selectionAppearance:"checkbox" and selectionType:"multiple"
results in a grid where multiple selection can only be achieved via shift-click or ctrl-click.
If using
"checkbox" for a ListGrid, see also checkboxField for customization APIs.
If using
"checkbox" for a TreeGrid, an extra icon, TreeGrid.getExtraIcon() is not supported. Additionally only
selectionType:"simple" and "single" are supported.
You can also toggle the display of a disabled checkbox on a treeGrid, displayed when the node can't be selected, via
TreeGrid.showDisabledSelectionCheckbox.
Note that the default behavior when you enable checkbox selection is to
continue to show the selected style. This can be changed by setting showSelectedStyle to false.
If this method is called after the component has been drawn/initialized:
Changes selectionAppearance on the fly.
selectionAppearance - new selection appearance. Default value is "rowStyle"Selection overview and related methodspublic SelectionAppearance getSelectionAppearance()
For selectionAppearance:"checkbox" with multiple
selection allowed, you would typically use selectionType:"simple" (the default). Because selectionType and selectionAppearance are
unrelated, the combination of selectionAppearance:"checkbox" and selectionType:"multiple"
results in a grid where multiple selection can only be achieved via shift-click or ctrl-click.
If using
"checkbox" for a ListGrid, see also checkboxField for customization APIs.
If using
"checkbox" for a TreeGrid, an extra icon, TreeGrid.getExtraIcon() is not supported. Additionally only
selectionType:"simple" and "single" are supported.
You can also toggle the display of a disabled checkbox on a treeGrid, displayed when the node can't be selected, via
TreeGrid.showDisabledSelectionCheckbox.
Note that the default behavior when you enable checkbox selection is to
continue to show the selected style. This can be changed by setting showSelectedStyle to false.
Selection overview and related methodspublic void setSelectionProperty(java.lang.String selectionProperty)
throws java.lang.IllegalStateException
"isSelected" any records in the listGrid data where "isSelected" is
true will show up as selected in the grid. Similarly if records are selected within the grid after the grid
has been created, this property will be set to true on the selected records.
Note : This is an advanced setting
selectionProperty - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdSelection overview and related methodspublic java.lang.String getSelectionProperty()
"isSelected" any records in the listGrid data where "isSelected" is
true will show up as selected in the grid. Similarly if records are selected within the grid after the grid
has been created, this property will be set to true on the selected records.Selection overview and related methodspublic void setSelectionType(SelectionStyle selectionType)
The default selection appearance is governed by selectionAppearance: if selectionAppearance is
"checkbox", this will be "simple", otherwise, this will be "multiple".
If this method is called after the component has been drawn/initialized:
Changes selectionType on the fly.
selectionType - New selection style.. Default value is nullSelectionStyle,
Selection overview and related methods,
Multiple select Examplepublic SelectionStyle getSelectionType()
The default selection appearance is governed by selectionAppearance: if selectionAppearance is
"checkbox", this will be "simple", otherwise, this will be "multiple".
SelectionStyle,
Selection overview and related methods,
Multiple select Examplepublic void setSelectOnEdit(java.lang.Boolean selectOnEdit)
Note that when this attribute is set to
true, other all other rows in the grid will be deselected when a record is selected due to editing.
Note : This is an advanced setting
selectOnEdit - Default value is trueEditing overview and related methodspublic java.lang.Boolean getSelectOnEdit()
Note that when this attribute is set to
true, other all other rows in the grid will be deselected when a record is selected due to editing.
Editing overview and related methodspublic void setSelectOnExpandRecord(boolean selectOnExpandRecord)
expansion
field will not add the record to the current selection.selectOnExpandRecord - Default value is truepublic boolean getSelectOnExpandRecord()
expansion
field will not add the record to the current selection.public void setShowAllColumns(java.lang.Boolean showAllColumns)
throws java.lang.IllegalStateException
Drawing all columns causes longer initial rendering time, but allows smoother horizontal scrolling. With a very large number of columns, showAllColumns will become too slow.
showAllColumns - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowAllColumns()
Drawing all columns causes longer initial rendering time, but allows smoother horizontal scrolling. With a very large number of columns, showAllColumns will become too slow.
public void setShowAllRecords(java.lang.Boolean showAllRecords)
Drawing all rows causes longer initial rendering time, but allows smoother vertical scrolling. With a very large number of rows, showAllRows will become too slow.
See also drawAheadRatio and
drawAllMaxCells.
showAllRecords - Default value is falsepublic java.lang.Boolean getShowAllRecords()
Drawing all rows causes longer initial rendering time, but allows smoother vertical scrolling. With a very large number of rows, showAllRows will become too slow.
See also drawAheadRatio and
drawAllMaxCells.
public void setShowAsynchGroupingPrompt(java.lang.Boolean showAsynchGroupingPrompt)
throws java.lang.IllegalStateException
asynchGroupingPrompt dialog during asynchronous grouping.showAsynchGroupingPrompt - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowAsynchGroupingPrompt()
asynchGroupingPrompt dialog during asynchronous grouping.public void setShowBackgroundComponents(java.lang.Boolean showBackgroundComponents)
true this grid will create and show per-row backgroundComponents as detailed here.showBackgroundComponents - Default value is falsepublic java.lang.Boolean getShowBackgroundComponents()
true this grid will create and show per-row backgroundComponents as detailed here.public void setShowCellContextMenus(java.lang.Boolean showCellContextMenus)
showCellContextMenus - Default value is falsepublic java.lang.Boolean getShowCellContextMenus()
public void setShowClippedHeaderTitlesOnHover(boolean showClippedHeaderTitlesOnHover)
throws java.lang.IllegalStateException
Note : This is an advanced setting
showClippedHeaderTitlesOnHover - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdheaderTitleClipped(int),
headerHoverHTML(int, java.lang.String)public boolean getShowClippedHeaderTitlesOnHover()
headerTitleClipped(int),
headerHoverHTML(int, java.lang.String)public void setShowClippedValuesOnHover(java.lang.Boolean showClippedValuesOnHover)
throws java.lang.IllegalStateException
Note that standard
cell hovers override clipped value hovers. Thus, to enable clipped value hovers, canHover must be unset or null and the corresponding field must
have showHover unset or null as well.
Note : This is an advanced setting
showClippedValuesOnHover - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetCanHover(java.lang.Boolean),
cellValueHoverHTML(com.smartgwt.client.widgets.grid.ListGridRecord, int, int, java.lang.String)public java.lang.Boolean getShowClippedValuesOnHover()
Note that standard
cell hovers override clipped value hovers. Thus, to enable clipped value hovers, canHover must be unset or null and the corresponding field must
have showHover unset or null as well.
getCanHover(),
cellValueHoverHTML(com.smartgwt.client.widgets.grid.ListGridRecord, int, int, java.lang.String)public void setShowCollapsedGroupSummary(java.lang.Boolean showCollapsedGroupSummary)
This property only applies to grouped grids showing group summary rows. When set to true, the group summary
row(s) for each group will show up under the group header nodes when the group is collapsed, or at then end of the
grouped set of data if the group is expanded.
This property has no effect if showGroupSummaryInHeader is true.
If this method is called after the component has been drawn/initialized:
Setter for showCollapsedGroupSummary
showCollapsedGroupSummary - new showCollapsedGroupSummary value. Default value is falsegroupBy(java.lang.String...)public java.lang.Boolean getShowCollapsedGroupSummary()
This property only applies to grouped grids showing group summary rows. When set to true, the group summary
row(s) for each group will show up under the group header nodes when the group is collapsed, or at then end of the
grouped set of data if the group is expanded.
This property has no effect if showGroupSummaryInHeader is true.
groupBy(java.lang.String...)public void setShowDetailFields(java.lang.Boolean showDetailFields)
throws java.lang.IllegalStateException
detail:true from this component's DataSource. When this
property is true, the ListGrid will include all detail fields unless fields have been
specifically declared using the fields array.
Any field
which has been included directly in the fields array will be included regardless of the fields
detail attribute.
Detail fields included will initially be hidden but the user may show these fields
via the default header context menu (showHeaderContextMenu).
The field's visibility can also be overridden programatically using the standard showField(), hideField() and ListGridField.showIf() APIs, for example, set showIf:"true" to
show a detail field initially.
Setting this property to false will completely exclude all detail fields from the list grid's fields array, such that they cannot be shown by the user or programmatically.
setShowDetailFields in interface DataBoundComponentshowDetailFields - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdDatabinding overview and related methodspublic java.lang.Boolean getShowDetailFields()
detail:true from this component's DataSource. When this
property is true, the ListGrid will include all detail fields unless fields have been
specifically declared using the fields array.
Any field
which has been included directly in the fields array will be included regardless of the fields
detail attribute.
Detail fields included will initially be hidden but the user may show these fields
via the default header context menu (showHeaderContextMenu).
The field's visibility can also be overridden programatically using the standard showField(), hideField() and ListGridField.showIf() APIs, for example, set showIf:"true" to
show a detail field initially.
Setting this property to false will completely exclude all detail fields from the list grid's fields array, such that they cannot be shown by the user or programmatically.
getShowDetailFields in interface DataBoundComponentDatabinding overview and related methodspublic void setShowEmptyMessage(java.lang.Boolean showEmptyMessage)
showEmptyMessage - Default value is truesetEmptyMessage(java.lang.String),
Empty grid Examplepublic java.lang.Boolean getShowEmptyMessage()
getEmptyMessage(),
Empty grid Examplepublic void setShowErrorIcons(boolean showErrorIcons)
showErrorIcons - Default value is truepublic boolean getShowErrorIcons()
public java.lang.Boolean getShowExpansionEditorSaveButton()
throws java.lang.IllegalStateException
ExpansionMode is editor, should a Save button be shown below the the
expanded editor? Note that if an expanded-row containing an editor is collapsed while changes are outstanding,
changes will be either be automatically updated to the grid, or will first show a confirmation dialog, according to the
value of expansionEditorShowSaveDialog.
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setShowFilterEditor(boolean showFilterEditor)
Values entered into this row are used as filter criteria to filter this List's data on
enter-keypress or filter button click. autoFetchTextMatchStyle determines
the textMatchStyle for the request passed to fetchData().
The default search operator for an item in the
filterEditor can
be set via ListGridField.filterOperator. When
field.filterOperator
has been set calls to retrieve the criteria from the grid return AdvancedCriteria.
See also allowFilterOperators for a UI that
allows end users to change the search
operator on the fly
Note that if filterData() or fetchData() is called
directly while the filter editor is showing, the filter editor values will be updated to
reflect the new set of criteria. If you wish to retain the user entered filter criteria
and modify a subset of field values programmatically, this can be achieved by
copying the existing set of criteria and adding other changes - something
like this:
Criteria newCriteria = myListGrid.getFilterEditorCriteria();
newCriteria = DataSource.combineCriteria(newCriteria,
new Criteria("field1", "new value1")
);
myListGrid.setCriteria(newCriteria);
In this example code we're using getFilterEditorCriteria() rather than
getCriteria() - this ensures that if the user has typed a
new value into
the filter editor, but not yet clicked the filter button, we pick up the value the user
entered. This sample code uses DataSource.combineCriteria()
to combine the
existing filterEditorCriteria with some new custom criteria. This technique is
applicable to both simple and advanced criteria.
If you call filterData() and pass in criteria for dataSource
fields that are not present in the ListGrid, these criteria will continue to be applied
along with the user-visible criteria.
filterEditor and advanced criteria: If a developer calls filterData()
on a ListGrid and passes in AdvancedCriteria, expected behavior of the filter
editor becomes ambiguous, since AdvancedCriteria has far more complex filter
expression support than the ordinary filterEditor can represent.
Default behavior for AdvancedCriteria will combine the AdvancedCriteria with the values in the filter editor as follows:
autoFetchTextMatchStyle).showFilterEditor property. Allows the filter editor to be shown or hidden at runtime.showFilterEditor - true if the filter editor should be shown, false if it should be hidden. Default value is falsepublic boolean getShowFilterEditor()
Values entered into this row are used as filter criteria to filter this List's data on
enter-keypress or filter button click. autoFetchTextMatchStyle determines
the textMatchStyle for the request passed to fetchData().
The default search operator for an item in the
filterEditor can
be set via ListGridField.filterOperator. When
field.filterOperator
has been set calls to retrieve the criteria from the grid return AdvancedCriteria.
See also allowFilterOperators for a UI that
allows end users to change the search
operator on the fly
Note that if filterData() or fetchData() is called
directly while the filter editor is showing, the filter editor values will be updated to
reflect the new set of criteria. If you wish to retain the user entered filter criteria
and modify a subset of field values programmatically, this can be achieved by
copying the existing set of criteria and adding other changes - something
like this:
Criteria newCriteria = myListGrid.getFilterEditorCriteria();
newCriteria = DataSource.combineCriteria(newCriteria,
new Criteria("field1", "new value1")
);
myListGrid.setCriteria(newCriteria);
In this example code we're using getFilterEditorCriteria() rather than
getCriteria() - this ensures that if the user has typed a
new value into
the filter editor, but not yet clicked the filter button, we pick up the value the user
entered. This sample code uses DataSource.combineCriteria()
to combine the
existing filterEditorCriteria with some new custom criteria. This technique is
applicable to both simple and advanced criteria.
If you call filterData() and pass in criteria for dataSource
fields that are not present in the ListGrid, these criteria will continue to be applied
along with the user-visible criteria.
filterEditor and advanced criteria: If a developer calls filterData()
on a ListGrid and passes in AdvancedCriteria, expected behavior of the filter
editor becomes ambiguous, since AdvancedCriteria has far more complex filter
expression support than the ordinary filterEditor can represent.
Default behavior for AdvancedCriteria will combine the AdvancedCriteria with the values in the filter editor as follows:
autoFetchTextMatchStyle).public void setShowGridSummary(java.lang.Boolean showGridSummary)
ListGridField.showGridSummary and getGridSummaryFunction() for details on how the summary value to be displayed for each column will be calculated.
Note that the summaryRow autoChild will be created to
actually display the summary row.
If this method is called after the component has been drawn/initialized:
Setter for the showGridSummary attribute
showGridSummary - new value for this.showGridSummary. Default value is falsepublic java.lang.Boolean getShowGridSummary()
ListGridField.showGridSummary and getGridSummaryFunction() for details on how the summary value to be displayed for each column will be calculated.
Note that the summaryRow autoChild will be created to
actually display the summary row.
public void setShowGroupSummary(java.lang.Boolean showGroupSummary)
grouping, setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields. Summary information will be calculated by the ListGridField.getGroupSummary() method if specified,
otherwise via the specified ListGridField.summaryFunction.
showGroupSummary attributeshowGroupSummary - new value for this.showGroupSummary. Default value is falsesetGroupByFieldSummaries(java.lang.String...)public java.lang.Boolean getShowGroupSummary()
grouping, setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields. Summary information will be calculated by the ListGridField.getGroupSummary() method if specified,
otherwise via the specified ListGridField.summaryFunction.getGroupByFieldSummaries()public void setShowGroupSummaryInHeader(java.lang.Boolean showGroupSummaryInHeader)
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. Note that this means the group header node will be showing multiple field values
rather than the default display of a single cell spanning all columns containing the group title. Developers may specify
an explicit groupTitleField, or rely on the
automatically generated groupTitleColumn to
have group titles be visible as well as the summary values.
Also note that multi-line group summaries are not
supported when showing the group summary in the group header. If multiple field summary functions are defined for some field
only the first will be displayed when this property is set to true.
If this method is called after the component has been drawn/initialized:
Setter for showGroupSummaryInHeader
showGroupSummaryInHeader - new showGroupSummaryInHeader state. Default value is falsegroupBy(java.lang.String...)public java.lang.Boolean getShowGroupSummaryInHeader()
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. Note that this means the group header node will be showing multiple field values
rather than the default display of a single cell spanning all columns containing the group title. Developers may specify
an explicit groupTitleField, or rely on the
automatically generated groupTitleColumn to
have group titles be visible as well as the summary values.
Also note that multi-line group summaries are not
supported when showing the group summary in the group header. If multiple field summary functions are defined for some field
only the first will be displayed when this property is set to true.
groupBy(java.lang.String...)public void setShowGroupTitleColumn(java.lang.Boolean showGroupTitleColumn)
throws java.lang.IllegalStateException
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. In this case there are 2 options for where the group title
will show up. Developers may specify an existing field to put the title values into via groupTitleField. If no groupTitleField is specified, this
property may be set to true which causes a groupTitleColumn to be automatically generated.
Each group header will show the group title in this column (records within the group will not show a value for this
column). The column appears in the leftmost position within the grid (unless showRowNumbers is true, in which case this column shows up
in the second-leftmost position), and by default will auto-fit to its data.
To customize this field, developers may
modify groupTitleColumnProperties
showGroupTitleColumn - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowGroupTitleColumn()
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. In this case there are 2 options for where the group title
will show up. Developers may specify an existing field to put the title values into via groupTitleField. If no groupTitleField is specified, this
property may be set to true which causes a groupTitleColumn to be automatically generated.
Each group header will show the group title in this column (records within the group will not show a value for this
column). The column appears in the leftmost position within the grid (unless showRowNumbers is true, in which case this column shows up
in the second-leftmost position), and by default will auto-fit to its data.
To customize this field, developers may
modify groupTitleColumnProperties
public void setShowHeader(java.lang.Boolean showHeader)
showHeader - true to show the header, false to hide it.. Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowHeader()
Appearance overview and related methodspublic void setShowHeaderContextMenu(java.lang.Boolean showHeaderContextMenu)
throws java.lang.IllegalStateException
CubeGrid.showHeaderContextMenu - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createddisplayHeaderContextMenu(com.smartgwt.client.widgets.Canvas, int[]),
getHeaderContextMenuItems(java.lang.Integer),
GridHeader overview and related methodspublic java.lang.Boolean getShowHeaderContextMenu()
CubeGrid.public void setShowHeaderMenuButton(java.lang.Boolean showHeaderMenuButton)
throws java.lang.IllegalStateException
showHeaderContextMenu is
true, the headerMenuButton will be displayed when
the user rolls over the header buttons in this grid. Not supported for CubeGrid.showHeaderMenuButton - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowHeaderMenuButton()
showHeaderContextMenu is
true, the headerMenuButton will be displayed when
the user rolls over the header buttons in this grid. Not supported for CubeGrid.public void setShowHeaderSpanTitlesInFormulaBuilder(java.lang.Boolean showHeaderSpanTitlesInFormulaBuilder)
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or
SummaryBuilder.showHeaderSpanTitlesInFormulaBuilder - Default value is truesetFormulaBuilderSpanTitleSeparator(java.lang.String)public java.lang.Boolean getShowHeaderSpanTitlesInFormulaBuilder()
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or
SummaryBuilder.getFormulaBuilderSpanTitleSeparator()public void setShowHeaderSpanTitlesInHiliteEditor(java.lang.Boolean showHeaderSpanTitlesInHiliteEditor)
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the hilite editor.showHeaderSpanTitlesInHiliteEditor - Default value is truesetHiliteEditorSpanTitleSeparator(java.lang.String)public java.lang.Boolean getShowHeaderSpanTitlesInHiliteEditor()
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the hilite editor.getHiliteEditorSpanTitleSeparator()public void setShowHeaderSpanTitlesInSortEditor(java.lang.Boolean showHeaderSpanTitlesInSortEditor)
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor.showHeaderSpanTitlesInSortEditor - Default value is truesetSortEditorSpanTitleSeparator(java.lang.String)public java.lang.Boolean getShowHeaderSpanTitlesInSortEditor()
headerSpans, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor.getSortEditorSpanTitleSeparator()public void setShowHilitesInGroupSummary(boolean showHilitesInGroupSummary)
To suppress hilites for a specific field see ListGridField.showHilitesInGroupSummary.
Hiliting in summary fields (columns) can be enabled by setting includeHiliteInSummaryField to true.
showHilitesInGroupSummary - Default value is truepublic boolean getShowHilitesInGroupSummary()
To suppress hilites for a specific field see ListGridField.showHilitesInGroupSummary.
Hiliting in summary fields (columns) can be enabled by setting includeHiliteInSummaryField to true.
public void setShowHover(java.lang.Boolean showHover)
cellHoverHTML().setShowHover in class CanvasshowHover - Default value is truesetCanHover(java.lang.Boolean),
com.smartgwt.client.widgets.grid.ListGrid#cellHoverHTMLpublic java.lang.Boolean getShowHover()
cellHoverHTML().getShowHover in class CanvasgetCanHover(),
com.smartgwt.client.widgets.grid.ListGrid#cellHoverHTMLpublic void setShowHoverComponents(java.lang.Boolean showHoverComponents)
A number of builtin modes
are provided - see HoverMode.
Also supported at the field-level.
Note : This is an advanced setting
setShowHoverComponents in class CanvasshowHoverComponents - Default value is falsepublic java.lang.Boolean getShowHoverComponents()
A number of builtin modes
are provided - see HoverMode.
Also supported at the field-level.
getShowHoverComponents in class Canvaspublic void setShowPartialSelection(java.lang.Boolean showPartialSelection)
canSelectGroups is true. The partial icon
will show up for the group header node when a group is partially selected.showPartialSelection - Default value is falsepublic java.lang.Boolean getShowPartialSelection()
canSelectGroups is true. The partial icon
will show up for the group header node when a group is partially selected.public void setShowRecordComponents(java.lang.Boolean showRecordComponents)
createRecordComponent() will be
called when saved rows are being rendered, and any returned component will be displayed embedded within the row or cell.
recordComponents are not created for newly added rows which have not yet been saved. See the Handling Unsaved Records overview for more information.
Depending on the
showRecordComponentsByCell setting,
createRecordComponent() will be called either once per row, or once for every cell.
Depending on recordComponentPosition, components can either be
placed underneath normal record or cell content ("expand" setting) or placed so that they overlap normal cell content
("within" setting). For the "within" setting, the default is to fill the row or cell, but the component can specify
percent size or even use snapTo-positioning to place itself within
the row or cell.
The "expand" setting is incompatible with frozen columns unless all
recordComponents are the same height and they are present in every row, in which case the fixed height of
all recordComponents can be set via recordComponentHeight to re-enable frozen fields.
Using recordComponents potentially means creating one component for every visible grid row or cell and
so can impact performance. Before using this subsystem:
ListGridField.valueIcons (possibly with a specified
ListGridField.valueIconClick() handler)
for icons based on field values which may be displayed alone in the cell or alongside standard content (see
ListGridField.showValueIconOnly); a field of type "icon", or multiple such fields rollOver controls ListGridField.editorType, and FormItem.icons are a common way to add clickable
buttons. You can also provide different controls
per record. These options are usually better that using recordComponents as custom editors, since
you won't have to manage issues like making the recordComponent appear only when editing, having
changes affect editValues, triggering saves and handling validation
errors, etc. See RecordComponentPoolingMode for an overview of how best to
optimize use of recordComponents for different data sets.
Regardless of the pooling mode, you can
explicitly refresh record components via invalidateRecordComponents() and refreshRecordComponent().
Interaction with column auto-fit: per-cell record components are not
taken into account when determining the size for column auto fit. The default getDefaultFieldWidth() implementation looks at cell
content only. We typically recommend that, for fields showing record-components, ListGridField.autoFitWidth and ListGridField.canAutoFitWidth be disabled, or if the
record components are of a predictable size, a ListGridField.defaultWidth be specified.
This is particularly pertinent where recordComponentPosition is set to "within", in
which case cells' content is often empty or completely covered by record-components.
If this method is called after the component has been drawn/initialized:
Setter for the showRecordComponents attribute
Note : This is an advanced setting
showRecordComponents - new value for this.showRecordComponents. Default value is nullsetRecordComponentPosition(com.smartgwt.client.types.EmbeddedPosition),
setShowRecordComponentsByCell(java.lang.Boolean),
RecordComponentPoolingMode,
showRecordComponent(com.smartgwt.client.widgets.grid.ListGridRecord, java.lang.Integer),
createRecordComponent(com.smartgwt.client.widgets.grid.ListGridRecord, java.lang.Integer),
updateRecordComponent(com.smartgwt.client.widgets.grid.ListGridRecord, java.lang.Integer, com.smartgwt.client.widgets.Canvas, boolean)public java.lang.Boolean getShowRecordComponents()
createRecordComponent() will be
called when saved rows are being rendered, and any returned component will be displayed embedded within the row or cell.
recordComponents are not created for newly added rows which have not yet been saved. See the Handling Unsaved Records overview for more information.
Depending on the
showRecordComponentsByCell setting,
createRecordComponent() will be called either once per row, or once for every cell.
Depending on recordComponentPosition, components can either be
placed underneath normal record or cell content ("expand" setting) or placed so that they overlap normal cell content
("within" setting). For the "within" setting, the default is to fill the row or cell, but the component can specify
percent size or even use snapTo-positioning to place itself within
the row or cell.
The "expand" setting is incompatible with frozen columns unless all
recordComponents are the same height and they are present in every row, in which case the fixed height of
all recordComponents can be set via recordComponentHeight to re-enable frozen fields.
Using recordComponents potentially means creating one component for every visible grid row or cell and
so can impact performance. Before using this subsystem:
ListGridField.valueIcons (possibly with a specified
ListGridField.valueIconClick() handler)
for icons based on field values which may be displayed alone in the cell or alongside standard content (see
ListGridField.showValueIconOnly); a field of type "icon", or multiple such fields rollOver controls ListGridField.editorType, and FormItem.icons are a common way to add clickable
buttons. You can also provide different controls
per record. These options are usually better that using recordComponents as custom editors, since
you won't have to manage issues like making the recordComponent appear only when editing, having
changes affect editValues, triggering saves and handling validation
errors, etc. See RecordComponentPoolingMode for an overview of how best to
optimize use of recordComponents for different data sets.
Regardless of the pooling mode, you can
explicitly refresh record components via invalidateRecordComponents() and refreshRecordComponent().
Interaction with column auto-fit: per-cell record components are not
taken into account when determining the size for column auto fit. The default getDefaultFieldWidth() implementation looks at cell
content only. We typically recommend that, for fields showing record-components, ListGridField.autoFitWidth and ListGridField.canAutoFitWidth be disabled, or if the
record components are of a predictable size, a ListGridField.defaultWidth be specified.
This is particularly pertinent where recordComponentPosition is set to "within", in
which case cells' content is often empty or completely covered by record-components.
getRecordComponentPosition(),
getShowRecordComponentsByCell(),
RecordComponentPoolingMode,
showRecordComponent(com.smartgwt.client.widgets.grid.ListGridRecord, java.lang.Integer),
createRecordComponent(com.smartgwt.client.widgets.grid.ListGridRecord, java.lang.Integer),
updateRecordComponent(com.smartgwt.client.widgets.grid.ListGridRecord, java.lang.Integer, com.smartgwt.client.widgets.Canvas, boolean)public void setShowRecordComponentsByCell(java.lang.Boolean showRecordComponentsByCell)
recordComponents in cells,
rather than just in records.
Note : This is an advanced setting
showRecordComponentsByCell - Default value is nullpublic java.lang.Boolean getShowRecordComponentsByCell()
recordComponents in cells,
rather than just in records.public void setShowRollOver(java.lang.Boolean showRollOver)
If true, the cell style will have the suffix "Over" appended.
Can be overridden on a per-record basis via ListGridRecord.showRollOver.
showRollOver - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowRollOver()
If true, the cell style will have the suffix "Over" appended.
Can be overridden on a per-record basis via ListGridRecord.showRollOver.
Appearance overview and related methodspublic void setShowRollOverCanvas(java.lang.Boolean showRollOverCanvas)
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. This can be used to dynamically show controls or informational displays only on rollover. For example, controls to delete a row might appear only on rollover so they do not clutter the static display, or a "rollunder" Canvas could be used to display additional information that can appear behind normal cell values (like displaying percent complete via as a bar of color that appears behind text values).
snapTo positioning can be
used to place the rollOver/rollUnderCanvas. With useCellRollOvers, positioning is relative to the cell,
for row-level rollOver, position is relative to the portion of the row that is scrolled into view (this implies a
row-level rollOver/UnderCanvas can never be placed horizontally scrolled out of view, but this is possible for a
cell-level rollOver).
snapTo positioning makes it easy to do something like place a button at the
right edge of the grid, next to the scrollbar: just set snapTo:"R" on the rollOverCanvas.
The
rollOver/rollUnder Canvas can be a single static component (the same for all cells/rows) configured via the com.smartgwt.client.types.AutoChild system, or can instead be provided dynamically by implementing getRollOverCanvas() and/or getRollUnderCanvas().
With row-level rollOvers with
frozen fields, the rollOverCanvas and
rollUnderCanvas appear only for non-frozen fields. This is usually not an issue for something like
rollOver controls for row deletion, but will prevent certain scenarios of using rollOverCanvas/rollUnderCanvas for
visual styling.
showRollOverCanvas has no effect if showRollOver is false.
Note : This is an advanced setting
showRollOverCanvas - Default value is nullsetShowRollUnderCanvas(java.lang.Boolean),
RollOver Controls Examplepublic java.lang.Boolean getShowRollOverCanvas()
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. This can be used to dynamically show controls or informational displays only on rollover. For example, controls to delete a row might appear only on rollover so they do not clutter the static display, or a "rollunder" Canvas could be used to display additional information that can appear behind normal cell values (like displaying percent complete via as a bar of color that appears behind text values).
snapTo positioning can be
used to place the rollOver/rollUnderCanvas. With useCellRollOvers, positioning is relative to the cell,
for row-level rollOver, position is relative to the portion of the row that is scrolled into view (this implies a
row-level rollOver/UnderCanvas can never be placed horizontally scrolled out of view, but this is possible for a
cell-level rollOver).
snapTo positioning makes it easy to do something like place a button at the
right edge of the grid, next to the scrollbar: just set snapTo:"R" on the rollOverCanvas.
The
rollOver/rollUnder Canvas can be a single static component (the same for all cells/rows) configured via the com.smartgwt.client.types.AutoChild system, or can instead be provided dynamically by implementing getRollOverCanvas() and/or getRollUnderCanvas().
With row-level rollOvers with
frozen fields, the rollOverCanvas and
rollUnderCanvas appear only for non-frozen fields. This is usually not an issue for something like
rollOver controls for row deletion, but will prevent certain scenarios of using rollOverCanvas/rollUnderCanvas for
visual styling.
showRollOverCanvas has no effect if showRollOver is false.
getShowRollUnderCanvas(),
RollOver Controls Examplepublic void setShowRollUnderCanvas(java.lang.Boolean showRollUnderCanvas)
rollUnderCanvas be displayed? Use of the showRollUnderCanvas is enabled if showRollOver is true, and either showRollOverCanvas is true and
showRollUnderCanvas is unset, or showRollUnderCanvas is explicitly set to true.
Note : This is an advanced setting
showRollUnderCanvas - Default value is nullsetShowRollOverCanvas(java.lang.Boolean),
Animated Selection Examplepublic java.lang.Boolean getShowRollUnderCanvas()
rollUnderCanvas be displayed? Use of the showRollUnderCanvas is enabled if showRollOver is true, and either showRollOverCanvas is true and
showRollUnderCanvas is unset, or showRollUnderCanvas is explicitly set to true.
getShowRollOverCanvas(),
Animated Selection Examplepublic void setShowRowNumbers(java.lang.Boolean showRowNumbers)
Note : This is an advanced setting
showRowNumbers - Default value is nullpublic java.lang.Boolean getShowRowNumbers()
public void setShowSelectedStyle(java.lang.Boolean showSelectedStyle)
showSelectedStyle - Default value is truepublic java.lang.Boolean getShowSelectedStyle()
public void setShowSelectionCanvas(java.lang.Boolean showSelectionCanvas)
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. If showSelectionCanvas is set to true, then the
selectionUnderCanvas will automatically be enabled unless showSelectionUnderCanvas is set to
false.
NOTE: It is recommended to use the selectionUnderCanvas rather than the
selectionCanvas if possible because the selectionCanvas is stacked on top of the selected
record and this may interfere with event handling in rare cases. If no interactive components are shown in the
selectionCanvas and it simply provides custom styling, then the selectionUnderCanvas should be
used instead.
With frozen fields, the
selectionCanvas is displayed only over the non-frozen fields of the selected row.
Note : This is an advanced setting
showSelectionCanvas - Default value is nullsetShowSelectionUnderCanvas(java.lang.Boolean)public java.lang.Boolean getShowSelectionCanvas()
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. If showSelectionCanvas is set to true, then the
selectionUnderCanvas will automatically be enabled unless showSelectionUnderCanvas is set to
false.
NOTE: It is recommended to use the selectionUnderCanvas rather than the
selectionCanvas if possible because the selectionCanvas is stacked on top of the selected
record and this may interfere with event handling in rare cases. If no interactive components are shown in the
selectionCanvas and it simply provides custom styling, then the selectionUnderCanvas should be
used instead.
With frozen fields, the
selectionCanvas is displayed only over the non-frozen fields of the selected row.
getShowSelectionUnderCanvas()public void setShowSelectionUnderCanvas(java.lang.Boolean showSelectionUnderCanvas)
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.
Setting showSelectionUnderCanvas to false will disable the use of the
selectionUnderCanvas. With frozen
fields, the selectionUnderCanvas is displayed only behind the non-frozen fields of the selected row.
Note : This is an advanced setting
showSelectionUnderCanvas - Default value is nullsetShowSelectionCanvas(java.lang.Boolean)public java.lang.Boolean getShowSelectionUnderCanvas()
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.
Setting showSelectionUnderCanvas to false will disable the use of the
selectionUnderCanvas. With frozen
fields, the selectionUnderCanvas is displayed only behind the non-frozen fields of the selected row.
getShowSelectionCanvas()public void setShowSortArrow(SortArrow showSortArrow)
SortArrow for details. Clicking the sort arrow reverses the direction of sorting for the current sort column (if any), or sorts the listGrid by its first sortable column. The arrow image on the button indicates the current direction of sorting. If undefined, the sort arrow will show up in the sorted field, and the corner sort button will be displayed if a vertical scrollbar is being displayed
showSortArrow - Default value is nullAppearance overview and related methodspublic SortArrow getShowSortArrow()
SortArrow for details. Clicking the sort arrow reverses the direction of sorting for the current sort column (if any), or sorts the listGrid by its first sortable column. The arrow image on the button indicates the current direction of sorting. If undefined, the sort arrow will show up in the sorted field, and the corner sort button will be displayed if a vertical scrollbar is being displayed
Appearance overview and related methodspublic void setShowSortNumerals(java.lang.Boolean showSortNumerals)
Note : This is an advanced setting
showSortNumerals - Default value is nullpublic java.lang.Boolean getShowSortNumerals()
public void setShowTreeColumnPicker(java.lang.Boolean showTreeColumnPicker)
throws java.lang.IllegalStateException
headerSpans are in use, whether to show a
hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under
headerSpans similarly to how a TreeGrid displays a Tree. If
showTreeColumnPicker is false, no column picker will be shown on the headerSpan itself, and the column
picker for a clicked on a normal field header will include only normal fields.
showTreeColumnPicker - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowTreeColumnPicker()
headerSpans are in use, whether to show a
hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under
headerSpans similarly to how a TreeGrid displays a Tree. If
showTreeColumnPicker is false, no column picker will be shown on the headerSpan itself, and the column
picker for a clicked on a normal field header will include only normal fields.
public void setShrinkForFreeze(java.lang.Boolean shrinkForFreeze)
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?true any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s).
Note : This is an advanced setting
shrinkForFreeze - Default value is falseFrozenFields overview and related methodspublic java.lang.Boolean getShrinkForFreeze()
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?true any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s).FrozenFields overview and related methodspublic void setSingleCellValueProperty(java.lang.String singleCellValueProperty)
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].singleCellValueProperty - Default value is "singleCellValue"public java.lang.String getSingleCellValueProperty()
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].public void setSkinImgDir(java.lang.String skinImgDir)
Note : This is an advanced setting
setSkinImgDir in class CanvasskinImgDir - Default value is "images/ListGrid/"Images overview and related methodspublic java.lang.String getSkinImgDir()
getSkinImgDir in class CanvasImages overview and related methodspublic void setSortAscendingImage(ImgProperties sortAscendingImage)
ImgProperties for format.
Note : This is an advanced setting
sortAscendingImage - Default value is {...}Appearance overview and related methodspublic ImgProperties getSortAscendingImage()
ImgProperties for format.Appearance overview and related methodspublic void setSortBinaryByFileName(boolean sortBinaryByFileName)
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. If set to false, binary
fields will be sorted against the record value for the field in question. Client-side sorting does not support this, so
developers who actually want to support a sort against the binary itself would typically set ResultSet.useClientSorting to false on the dataProperties block for this grid.
Note that this
setting will have no effect if DataSourceField.sortByField is specified
sortBinaryByFileName - Default value is truepublic boolean getSortBinaryByFileName()
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. If set to false, binary
fields will be sorted against the record value for the field in question. Client-side sorting does not support this, so
developers who actually want to support a sort against the binary itself would typically set ResultSet.useClientSorting to false on the dataProperties block for this grid.
Note that this
setting will have no effect if DataSourceField.sortByField is specified
public void setSortByGroupFirst(java.lang.Boolean sortByGroupFirst)
groupBy(), data is implicitly sorted by all of the grouped columns,
in the order they were passed to groupBy. Any user-configured sorting is applied after sorting by grouped columns.
Sorting by grouped fields will be in ascending or descending order according to whether the grid is currently sorted
(by any field) in ascending or descending order, defaulting to ascending if the grid is not sorted. Implicit sorting by
group can be forced to be always ascending or always descending by setting groupSortDirection.
The sorting is "implicit" in
the sense that the sorting is not shown in the ListGrid headers, and not shown in the MultiSortDialog if enabled. An end user cannot currently remove the implicit sorting
themselves (except by removing the grouping), though it is possible to override it by providing an explicit sort on the
group's column. Clicking on the grouped field's header reveals the usual sort indicators with all the same semantics.
The correct way to remove implicit sorting programmatically is to call setSortByGroupFirst(false).
Programmatic calls to
getSort() will not include the implicit sort in the list of
return sort specifiers, and calls to setSort() will implicitly
add the sorting by grouped columns before the specified sort.
Note that directly calling ResultSet.getSort() will include the implicit sort information.
sortByGroupFirst - Default value is nullpublic java.lang.Boolean getSortByGroupFirst()
groupBy(), data is implicitly sorted by all of the grouped columns,
in the order they were passed to groupBy. Any user-configured sorting is applied after sorting by grouped columns.
Sorting by grouped fields will be in ascending or descending order according to whether the grid is currently sorted
(by any field) in ascending or descending order, defaulting to ascending if the grid is not sorted. Implicit sorting by
group can be forced to be always ascending or always descending by setting groupSortDirection.
The sorting is "implicit" in
the sense that the sorting is not shown in the ListGrid headers, and not shown in the MultiSortDialog if enabled. An end user cannot currently remove the implicit sorting
themselves (except by removing the grouping), though it is possible to override it by providing an explicit sort on the
group's column. Clicking on the grouped field's header reveals the usual sort indicators with all the same semantics.
The correct way to remove implicit sorting programmatically is to call setSortByGroupFirst(false).
Programmatic calls to
getSort() will not include the implicit sort in the list of
return sort specifiers, and calls to setSort() will implicitly
add the sorting by grouped columns before the specified sort.
Note that directly calling ResultSet.getSort() will include the implicit sort information.
public void setSortDescendingImage(ImgProperties sortDescendingImage)
ImgProperties for format.
Note : This is an advanced setting
sortDescendingImage - Default value is {...}Appearance overview and related methodspublic ImgProperties getSortDescendingImage()
ImgProperties for format.Appearance overview and related methodspublic void setSortDirection(SortDirection sortDirection)
sortField. May be overridden by
specifying ListGridField.sortDirection.
After initialization, this property will be updated on sort() or
setSort() to reflect the current sort direction of the grid.
When this grid is sorted by multiple fields, the grid's sortDirection reflects the sort direction of the primary sort
field.
If this method is called after the component has been drawn/initialized:
Sort this grid's data, with the option to explicitly specify a single field to sort by and sort direction.
If sortField is not provided and listGrid.sortField is undefined, the data will be sorted by the first sortable column according to ListGridField.sortDirection if specified, or sortDirection.
ListGrids also support multiple-field sorting. See setSort() for details.
Note that for editable grids, sorting is performed by underlying data values, not for unsaved pending edit values.
sortDirection - the field name or column number to sort by. Default value is "ascending"SortDirection,
Sort Examplepublic SortDirection getSortDirection()
sortField. May be overridden by
specifying ListGridField.sortDirection.
After initialization, this property will be updated on sort() or
setSort() to reflect the current sort direction of the grid.
When this grid is sorted by multiple fields, the grid's sortDirection reflects the sort direction of the primary sort
field.
SortDirection,
Sort Examplepublic void setSortEditorSpanTitleSeparator(java.lang.String sortEditorSpanTitleSeparator)
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 editorsortEditorSpanTitleSeparator - Default value is " - "public java.lang.String getSortEditorSpanTitleSeparator()
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 editorpublic void setSorterButtonTitle(java.lang.String sorterButtonTitle)
throws java.lang.IllegalStateException
sorterButtonTitle - Default value is "corner menu"java.lang.IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methodspublic java.lang.String getSorterButtonTitle()
Appearance overview and related methodspublic void setSortField(java.lang.String sortField)
throws java.lang.IllegalStateException
field name or the index of the field in the fields Array.
ListGrids also support being initialized with multiple-field sort via initialSort. If initialSort is specified, it will be used in
preference to this property.
To sort the grid after it has been initialized, use sort() or setSort(). Details about the current sort of a live grid can be retrieved by calling getSortField() or getSort()
sortField - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getSortField()
field name or the index of the field in the fields Array.
ListGrids also support being initialized with multiple-field sort via initialSort. If initialSort is specified, it will be used in
preference to this property.
To sort the grid after it has been initialized, use sort() or setSort(). Details about the current sort of a live grid can be retrieved by calling getSortField() or getSort()
setSort() has been used to sort by multiple fields, you can call getSort() to retrieve details about the complete sort applied to the
grid.public void setSortField(java.lang.Integer sortField)
throws java.lang.IllegalStateException
field name or the index of the field in the fields Array.
ListGrids also support being initialized with multiple-field sort via initialSort. If initialSort is specified, it will be used in
preference to this property.
To sort the grid after it has been initialized, use sort() or setSort(). Details about the current sort of a live grid can be retrieved by calling getSortField() or getSort()
sortField - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic void setSortFieldAscendingText(java.lang.String sortFieldAscendingText)
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in ascending order.sortFieldAscendingText - Default value is "Sort Ascending"public java.lang.String getSortFieldAscendingText()
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in ascending order.public void setSortFieldDescendingText(java.lang.String sortFieldDescendingText)
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in descending order.sortFieldDescendingText - Default value is "Sort Descending"public java.lang.String getSortFieldDescendingText()
headerContextMenu for this
grid, this attribute will be shown as the menu item title to sort a field in descending order.public void setSortNumeralStyle(java.lang.String sortNumeralStyle)
Note : This is an advanced setting
sortNumeralStyle - CSSStyleName . Default value is "sortNumeral"public java.lang.String getSortNumeralStyle()
CSSStyleNamepublic void setSortState(java.lang.String sortState)
viewState can be
used to initialize all view properties of the grid. When doing so, sortState is not needed because
viewState includes it as well. If both are provided, sortState has priority for sort state.
If this method is called after the component has been drawn/initialized:
Reset this grid's sort state (sort field and direction or list of SortSpecifiers) to match the ListGridSortState object passed in.
Used to restore previous state retrieved from the grid by a call to getSortState().
sortState - Object describing the desired sort state for the grid.ListGridSortState . Default value is nullpublic java.lang.String getSortState()
viewState can be
used to initialize all view properties of the grid. When doing so, sortState is not needed because
viewState includes it as well. If both are provided, sortState has priority for sort state.
ListGridSortState object.setSortState() to reset this grid's sort to the current state
(assuming the same fields are present in the grid).ListGridSortStatepublic Layout getSpanContextMenu() throws java.lang.IllegalStateException
This component is an AutoChild named "spanContextMenu". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.GridHeader overview and related methodspublic void setStopOnErrors(java.lang.Boolean stopOnErrors)
If this property is true, when validation errors occur the errors will be displayed to the user in an alert, and focus will be returned to the first cell to fail validation.
If false, the cells that failed validation will be silently styled with the editFailedBaseStyle.
Note: stopOnErrors being set to true implies that 'waitForSave' is also true. We will not dismiss the editor until save has completed if stopOnErrors is true.
Note : This is an advanced setting
stopOnErrors - Default value is falsesetWaitForSave(java.lang.Boolean),
Editing overview and related methodspublic java.lang.Boolean getStopOnErrors()
If this property is true, when validation errors occur the errors will be displayed to the user in an alert, and focus will be returned to the first cell to fail validation.
If false, the cells that failed validation will be silently styled with the editFailedBaseStyle.
Note: stopOnErrors being set to true implies that 'waitForSave' is also true. We will not dismiss the editor until save has completed if stopOnErrors is true.
getWaitForSave(),
Editing overview and related methodspublic void setStyleName(java.lang.String styleName)
setStyleName in class CanvasstyleName - CSSStyleName . Default value is "listGrid",
Appearance overview and related methodspublic java.lang.String getStyleName()
getStyleName in class CanvasCSSStyleName,
Appearance overview and related methodspublic ListGrid getSummaryRow() throws java.lang.IllegalStateException
showGridSummary). This component is an com.smartgwt.client.types.AutoChild and as such may be customized via listGrid.summaryRowProperties and
listGrid.summaryRowDefaults
This component is an AutoChild named "summaryRow". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setSummaryRowCriteria(Criteria summaryRowCriteria)
showGridSummary is true, and a summaryRowDataSource is specified this property may
be used to specify fetch criteria to apply when retrieving summary data to show in the summary row. If unset, and any
filter criteria have been specified for the grid, they will be used.
Note : This is an advanced setting
summaryRowCriteria - Default value is nullpublic Criteria getSummaryRowCriteria()
showGridSummary is true, and a summaryRowDataSource is specified this property may
be used to specify fetch criteria to apply when retrieving summary data to show in the summary row. If unset, and any
filter criteria have been specified for the grid, they will be used.public void setSummaryRowDataSource(DataSource summaryRowDataSource) throws java.lang.IllegalStateException
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()). In some cases however it may make sense to calculate summary values on the server and retrieve them via a dataSource fetch. If set, this property specifies a dataSource to fetch against for the summary row. The dataSource should return a single record with summary data for each field for which summary data should be shown. Note that specifying this property completely bypasses the standard client-side grid summary calculation logic.
The fetch may be further customized via summaryRowCriteria and summaryRowFetchRequestProperties
Note : This is an advanced setting
summaryRowDataSource - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic DataSource getSummaryRowDataSource()
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()). In some cases however it may make sense to calculate summary values on the server and retrieve them via a dataSource fetch. If set, this property specifies a dataSource to fetch against for the summary row. The dataSource should return a single record with summary data for each field for which summary data should be shown. Note that specifying this property completely bypasses the standard client-side grid summary calculation logic.
The fetch may be further customized via summaryRowCriteria and summaryRowFetchRequestProperties
public void setSummaryRowFetchRequestProperties(DSRequest summaryRowFetchRequestProperties)
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. An example use case
might be specifying a DSRequest.operationId to perform a
custom fetch operation which retrieved only summary values based on criteria.
Note : This is an advanced setting
summaryRowFetchRequestProperties - Default value is nullpublic DSRequest getSummaryRowFetchRequestProperties()
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. An example use case
might be specifying a DSRequest.operationId to perform a
custom fetch operation which retrieved only summary values based on criteria.public void setSummaryRowHeight(int summaryRowHeight)
throws java.lang.IllegalStateException
summary row autoChild. Note that
this height is a minimum - the summary row has autoFitData set to "vertical" so if multiple rows are visible in the grid summary, the summaryRow component will expand
to accommodate them.summaryRowHeight - Default value is 20java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int getSummaryRowHeight()
summary row autoChild. Note that
this height is a minimum - the summary row has autoFitData set to "vertical" so if multiple rows are visible in the grid summary, the summaryRow component will expand
to accommodate them.public void setSummaryRowStyle(java.lang.String summaryRowStyle)
summaryRowStyle - CSSStyleName . Default value is "gridSummaryCell"public java.lang.String getSummaryRowStyle()
baseStyle for the summaryRowCSSStyleNamepublic void setTallBaseStyle(java.lang.String tallBaseStyle)
throws java.lang.IllegalStateException
baseStyle is set to null. If baseStyle is unset, this property will be used as a base cell style
unless the grid is showing fixed height rows with a specified cellHeight that matches normalCellHeight, in which case normalBaseStyle will be used. Note that in Internet
Explorer if fastCellUpdates is true,
tallBaseStyle will also be used even if the cellHeight matches the specified normalCellHeight
for the grid.
See CellStyleSuffixes for details on how stateful suffixes are
combined with the base style to generate stateful cell styles.
tallBaseStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is "cell",
getBaseStyle()public java.lang.String getTallBaseStyle()
baseStyle is set to null. If baseStyle is unset, this property will be used as a base cell style
unless the grid is showing fixed height rows with a specified cellHeight that matches normalCellHeight, in which case normalBaseStyle will be used. Note that in Internet
Explorer if fastCellUpdates is true,
tallBaseStyle will also be used even if the cellHeight matches the specified normalCellHeight
for the grid.
See CellStyleSuffixes for details on how stateful suffixes are
combined with the base style to generate stateful cell styles.
CSSStyleName,
getBaseStyle()public void setTouchScrollRedrawDelay(java.lang.Integer touchScrollRedrawDelay)
scrollRedrawDelay will be used as a default for both
drag scrolling and touch scrolling. Note that if specified, this value will typically be larger than scrollRedrawDelay.
See also GridRenderer.instantScrollTrackRedraw for
cases where this delay is skipped.
touchScrollRedrawDelay - Default value is 0public java.lang.Integer getTouchScrollRedrawDelay()
scrollRedrawDelay will be used as a default for both
drag scrolling and touch scrolling. Note that if specified, this value will typically be larger than scrollRedrawDelay.
See also GridRenderer.instantScrollTrackRedraw for
cases where this delay is skipped.
public void setTrackerImage(ImgProperties trackerImage)
ImgProperties for format.
Note : This is an advanced setting
trackerImage - Default value is {...}setDragTrackerMode(com.smartgwt.client.types.DragTrackerMode),
com.smartgwt.client.widgets.grid.ListGrid#getDragTrackerIconpublic ImgProperties getTrackerImage()
ImgProperties for format.getDragTrackerMode(),
com.smartgwt.client.widgets.grid.ListGrid#getDragTrackerIconpublic void setUnfreezeFieldText(java.lang.String unfreezeFieldText)
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to unfreeze a currently frozen field. This is a dynamic string - text
within ${...} will be evaluated as JS code when the message is displayed, with title
available as a variable containing the field title.
Default value returns "Unfreeze " + the field's summary title.
Note : This is an advanced setting
unfreezeFieldText - HTMLString . Default value is "Unfreeze ${title}"public java.lang.String getUnfreezeFieldText()
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to unfreeze a currently frozen field. This is a dynamic string - text
within ${...} will be evaluated as JS code when the message is displayed, with title
available as a variable containing the field title.
Default value returns "Unfreeze " + the field's summary title.
HTMLStringpublic void setUngroupText(java.lang.String ungroupText)
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.ungroupText - Default value is "Ungroup"public java.lang.String getUngroupText()
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.public void setUnremoveIcon(java.lang.String unremoveIcon)
throws java.lang.IllegalStateException
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(). At this point, clicking on the icon
will unmark the record as removed.unremoveIcon - java.lang.IllegalStateException - this property cannot be changed after the component has been createdSCImgURL . Default value is "[SKIN]/actions/undo.png"public java.lang.String getUnremoveIcon()
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(). At this point, clicking on the icon
will unmark the record as removed.SCImgURLpublic void setUseAdvancedFieldPicker(java.lang.Boolean useAdvancedFieldPicker)
throws java.lang.IllegalStateException
FieldPicker will be shown
instead of the column picker submenu if there are more fields in the grid than advancedFieldPickerThreshold. When there are large numbers of available fields, the FieldPicker-based interface is more usable for both defining visible fields and defining field order.
useAdvancedFieldPicker - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseAdvancedFieldPicker()
FieldPicker will be shown
instead of the column picker submenu if there are more fields in the grid than advancedFieldPickerThreshold. When there are large numbers of available fields, the FieldPicker-based interface is more usable for both defining visible fields and defining field order.
public void setUseCellRollOvers(java.lang.Boolean useCellRollOvers)
useCellRollOvers - Default value is nullpublic java.lang.Boolean getUseCellRollOvers()
public void setUseCopyPasteShortcuts(java.lang.Boolean useCopyPasteShortcuts)
canSelectCells is true The default setting of true means that the value of canSelectCells determines whether copy/paste shortcuts are
enabled. Setting this property to false disables said shortcuts unconditionally.
Copying is done via copying to a
Smart GWT-wide "clipboard" - not the OS-level clipboard, which is inaccessible on some browsers - via the methods
getSelectedCellData() and applyCellData(). To copy data to and from applications outside
of the browser, use the technique shown in the @see Grid to Excel and @see Excel to Grid samples.
The following shortcuts are available:
CTRL + D: copy cell values from top row of selected cells down to all rows
CTRL + R: copy cell values from left column of selected cells right to all columns
CTRL + C: copy selected cell values into shared clipboard
CTRL + V: paste from shared clipboard into current selection
useCopyPasteShortcuts - Default value is truepublic java.lang.Boolean getUseCopyPasteShortcuts()
canSelectCells is true The default setting of true means that the value of canSelectCells determines whether copy/paste shortcuts are
enabled. Setting this property to false disables said shortcuts unconditionally.
Copying is done via copying to a
Smart GWT-wide "clipboard" - not the OS-level clipboard, which is inaccessible on some browsers - via the methods
getSelectedCellData() and applyCellData(). To copy data to and from applications outside
of the browser, use the technique shown in the @see Grid to Excel and @see Excel to Grid samples.
The following shortcuts are available:
CTRL + D: copy cell values from top row of selected cells down to all rows
CTRL + R: copy cell values from left column of selected cells right to all columns
CTRL + C: copy selected cell values into shared clipboard
CTRL + V: paste from shared clipboard into current selection
public void setUseRemoteValidators(java.lang.Boolean useRemoteValidators)
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.true to ensure these remote validators are called when
saving edits in saveLocally mode. Note that since these remote validators need to run on the server, saving with this
property set is asynchronous, even though the data that ultimately gets updated is already present on the client.
Note : This is an advanced setting
useRemoteValidators - Default value is nullDatabinding overview and related methodspublic java.lang.Boolean getUseRemoteValidators()
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.true to ensure these remote validators are called when
saving edits in saveLocally mode. Note that since these remote validators need to run on the server, saving with this
property set is asynchronous, even though the data that ultimately gets updated is already present on the client.Databinding overview and related methodspublic void setUseRowSpanStyling(java.lang.Boolean useRowSpanStyling)
throws java.lang.IllegalStateException
getRowSpan() has been overridden to introduce spanning cells, and
spanning is largest on the left and smaller as cells go to the right. Specifically: banded styling based on the span of the cell in
the left-most column cell-level
selection, including cell-level rollover
styling RowSpanSelectionMode
for available behaviors Because this setting enables canSelectCells, it is incompatible with any APIs that
expect a record-oriented data model.
Because this setting only makes sense when row spanning decreases from the
first column to the last, it has unspecified behavior with canReorderFields.
useRowSpanStyling - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseRowSpanStyling()
getRowSpan() has been overridden to introduce spanning cells, and
spanning is largest on the left and smaller as cells go to the right. Specifically: banded styling based on the span of the cell in
the left-most column cell-level
selection, including cell-level rollover
styling RowSpanSelectionMode
for available behaviors Because this setting enables canSelectCells, it is incompatible with any APIs that
expect a record-oriented data model.
Because this setting only makes sense when row spanning decreases from the
first column to the last, it has unspecified behavior with canReorderFields.
public void setValidateByCell(java.lang.Boolean validateByCell)
editByCell. Note that validation
always occurs when a row is to be saved, so setting saveByCell:true forces validation on cell transitions. To completely disable automatic validation, set neverValidate:true.
validateByCell - Default value is nullGridValidation overview and related methodspublic java.lang.Boolean getValidateByCell()
editByCell. Note that validation
always occurs when a row is to be saved, so setting saveByCell:true forces validation on cell transitions. To completely disable automatic validation, set neverValidate:true.
GridValidation overview and related methodspublic void setValidateOnChange(java.lang.Boolean validateOnChange)
validateOnChange - Default value is nullListGridField.setValidateOnChange(java.lang.Boolean),
GridValidation overview and related methodspublic java.lang.Boolean getValidateOnChange()
ListGridField.getValidateOnChange(),
GridValidation overview and related methodspublic void setValueIconHeight(java.lang.Integer valueIconHeight)
valueIconSize. Can be overridden at the field levelvalueIconHeight - Default value is nullImageColumns overview and related methodspublic java.lang.Integer getValueIconHeight()
valueIconSize. Can be overridden at the field levelImageColumns overview and related methodspublic void setValueIconLeftPadding(int valueIconLeftPadding)
valueIconLeftPadding - Default value is 2ListGridField.setValueIcons(java.util.Map<java.lang.String, java.lang.String>),
ImageColumns overview and related methodspublic int getValueIconLeftPadding()
com.smartgwt.client.widgets.grid.ListGridField#getValueIcons,
ImageColumns overview and related methodspublic void setValueIconRightPadding(int valueIconRightPadding)
valueIconRightPadding - Default value is 2ListGridField.setValueIcons(java.util.Map<java.lang.String, java.lang.String>),
ImageColumns overview and related methodspublic int getValueIconRightPadding()
com.smartgwt.client.widgets.grid.ListGridField#getValueIcons,
ImageColumns overview and related methodspublic void setValueIconSize(int valueIconSize)
valueIconWidth and valueIconHeight, or at the field level via ListGridField.valueIconSize, ListGridField.valueIconWidth and
{ListGridField.valueIconHeight}valueIconSize - Default value is 16setValueIconWidth(java.lang.Integer),
setValueIconHeight(java.lang.Integer),
ListGridField.setValueIconSize(java.lang.Integer),
ImageColumns overview and related methodspublic int getValueIconSize()
valueIconWidth and valueIconHeight, or at the field level via ListGridField.valueIconSize, ListGridField.valueIconWidth and
{ListGridField.valueIconHeight}getValueIconWidth(),
getValueIconHeight(),
ListGridField.getValueIconSize(),
ImageColumns overview and related methodspublic void setValueIconWidth(java.lang.Integer valueIconWidth)
valueIconSize. Can be overridden at the field levelvalueIconWidth - Default value is nullImageColumns overview and related methodspublic java.lang.Integer getValueIconWidth()
valueIconSize. Can be overridden at the field levelImageColumns overview and related methodspublic void setViewState(java.lang.String viewState)
view state for the grid. Since view state contains field
state it is not necessary to set fieldState when also
setting viewState. If both are provided, fieldState has priority for field state.
If this method is called after the component has been drawn/initialized:
Reset this grid's view state to match the ListGridViewState object passed in.
Used to restore previous state retrieved from the grid by a call to getViewState().
viewState - Object describing the desired view state for the grid. Default value is nullpublic java.lang.String getViewState()
view state for the grid. Since view state contains field
state it is not necessary to set fieldState when also
setting viewState. If both are provided, fieldState has priority for field state.
ListGridViewState
object.setViewState()
to reset this grid's view state to the current state (assuming the same data / fields are present in the grid).public void setVirtualScrolling(java.lang.Boolean virtualScrolling)
throws java.lang.IllegalStateException
When the virtualScrolling system is active, the last scroll position scrolls
the last record to the top of the viewport, leaving blank space underneath. This is a necessary and unavoidable
consequence of mapping the position of the scrollbar thumb to an unknown amount of remaining space without being able to
know the total scrollable area in advance (since record heights vary).
virtualScrolling is switched on automatically
when fixedRecordHeights is false and also when
using the recordComponents subsystem, as
recordComponents expand the rows that contain them. This flag should be manually enabled when calling addEmbeddedComponent() if embedded components can cause
record sizes to expand beyond specified cellHeight.
virtualScrolling is also automatically enabled when canExpandRecords is true to handle the fact that expanded
rows may render at variable heights.
Note : This is an advanced setting
virtualScrolling - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetRecordComponentHeight(java.lang.Integer)public java.lang.Boolean getVirtualScrolling()
When the virtualScrolling system is active, the last scroll position scrolls
the last record to the top of the viewport, leaving blank space underneath. This is a necessary and unavoidable
consequence of mapping the position of the scrollbar thumb to an unknown amount of remaining space without being able to
know the total scrollable area in advance (since record heights vary).
virtualScrolling is switched on automatically
when fixedRecordHeights is false and also when
using the recordComponents subsystem, as
recordComponents expand the rows that contain them. This flag should be manually enabled when calling addEmbeddedComponent() if embedded components can cause
record sizes to expand beyond specified cellHeight.
virtualScrolling is also automatically enabled when canExpandRecords is true to handle the fact that expanded
rows may render at variable heights.
getRecordComponentHeight()public void setWaitForSave(java.lang.Boolean waitForSave)
Note : This is an advanced setting
waitForSave - Default value is falseEditing overview and related methodspublic java.lang.Boolean getWaitForSave()
Editing overview and related methodspublic void setWarnOnRemoval(java.lang.Boolean warnOnRemoval)
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?warnOnRemoval - Default value is falsepublic java.lang.Boolean getWarnOnRemoval()
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?public void setWarnOnRemovalMessage(java.lang.String warnOnRemovalMessage)
canRemoveRecords is true and warnOnRemoval is true.warnOnRemovalMessage - Default value is "Are you sure you want to delete this record?"public java.lang.String getWarnOnRemovalMessage()
canRemoveRecords is true and warnOnRemoval is true.public void setWarnOnUnmappedValueFieldChange(java.lang.Boolean warnOnUnmappedValueFieldChange)
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). If such a field is editable, changing the edit value for the field on some record,
without updating the edit value for the associated display field on the same record would mean the user would continue
to see the unchanged display field value. Developers can resolve this situation by programmatically setting an edit
value for the display field as well as the data field, or avoid it by specifying an optionDataSource and ensuring autoFetchDisplayMap is true, or setting an explicit
valueMap for the field.
By default, when the edit value on a field with a specified displayField and no
optionDataSource is set, we log a warning to notify the developer. This warning may be disabled by setting
warnOnUnmappedValueFieldChange to false.
Note: There are actually a couple of cases in which the system will automatically derive a new display-field value and apply it to the record:
Note : This is an advanced setting
warnOnUnmappedValueFieldChange - Default value is truepublic java.lang.Boolean getWarnOnUnmappedValueFieldChange()
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). If such a field is editable, changing the edit value for the field on some record,
without updating the edit value for the associated display field on the same record would mean the user would continue
to see the unchanged display field value. Developers can resolve this situation by programmatically setting an edit
value for the display field as well as the data field, or avoid it by specifying an optionDataSource and ensuring autoFetchDisplayMap is true, or setting an explicit
valueMap for the field.
By default, when the edit value on a field with a specified displayField and no
optionDataSource is set, we log a warning to notify the developer. This warning may be disabled by setting
warnOnUnmappedValueFieldChange to false.
Note: There are actually a couple of cases in which the system will automatically derive a new display-field value and apply it to the record:
public void setWrapCells(java.lang.Boolean wrapCells)
Even if content is allowed to wrap, if fixedRecordHeights is set, the content will be clipped
off at the cell boundary. Either set a larger, fixed cellHeight to reveal more content, or set fixedRecordHeights to false to allow auto-sizing.
Note : This is an advanced setting
wrapCells - Default value is falsepublic java.lang.Boolean getWrapCells()
Even if content is allowed to wrap, if fixedRecordHeights is set, the content will be clipped
off at the cell boundary. Either set a larger, fixed cellHeight to reveal more content, or set fixedRecordHeights to false to allow auto-sizing.
public void setWrapHeaderSpanTitles(java.lang.Boolean wrapHeaderSpanTitles)
throws java.lang.IllegalStateException
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.wrapHeaderSpanTitles - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetMinFieldWidth(int)public java.lang.Boolean getWrapHeaderSpanTitles()
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.getMinFieldWidth()public void setWrapHeaderTitles(java.lang.Boolean wrapHeaderTitles)
throws java.lang.IllegalStateException
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.wrapHeaderTitles - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetMinFieldWidth(int)public java.lang.Boolean getWrapHeaderTitles()
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.getMinFieldWidth()public void addData(Record newRecord)
newRecord - new recordDataBoundComponentMethods overview and related methods,
Databound add Examplepublic void addData(Record newRecord, DSCallback callback)
addData(com.smartgwt.client.data.Record)public void addData(Record newRecord, DSCallback callback, DSRequest requestProperties)
newRecord - new recordcallback - method to call on operation completionrequestProperties - additional properties to set on the DSRequest that will be issuedDataBoundComponentMethods overview and related methods,
Databound add Examplepublic void addEmbeddedComponent(Canvas component, ListGridRecord record)
position is specified as "within" Canvas.snapTo and Canvas.snapOffsetLeft, Canvas.snapOffsetTop may be set to specify where the component will
render within the cell or record. If unset, for components embedded within a record we will default to embedding at the
top/left coordinate, and for components embedded within a cell, we will respect the align / valign properties for the
cell in question. Any percentage sizing will be interpreted as percentage of row size. Otherwise it will appear to be embedded within the record, underneath the field values.
Embedded components become children of the grid and will stay attached to a record through scrolling, sorting and other operations that cause records to shift position.
If
position is set to "expand", embedded components may offer a resize interface, eg, by setting
canDragResize:true, and the grid will react
accordingly, growing or shrinking the record to match the embedded component's new extents.
Embedded components can
be explicitly removed with removeEmbeddedComponent().
If a record is removed from the dataset or is replaced in the dataset, for example, it is eliminated through filtering (removes record) or is successfully edited in a databound grid (replaces record), the component is cleared but not logically removed from the grid. It is the responsibility of code that sets up the embedded component to remove it if the record is removed from the dataSet.
When embedding components will result in variable
height records, you should switch on virtualScrolling.
component - component to embedrecord - record to attach the component topublic void addEmbeddedComponent(Canvas component, ListGridRecord record, java.lang.Integer rowNum)
public void addEmbeddedComponent(Canvas component, ListGridRecord record, java.lang.Integer rowNum, java.lang.Integer colNum)
public void addEmbeddedComponent(Canvas component, ListGridRecord record, java.lang.Integer rowNum, java.lang.Integer colNum, EmbeddedPosition position)
position is specified as "within" Canvas.snapTo and Canvas.snapOffsetLeft, Canvas.snapOffsetTop may be set to specify where the component will
render within the cell or record. If unset, for components embedded within a record we will default to embedding at the
top/left coordinate, and for components embedded within a cell, we will respect the align / valign properties for the
cell in question. Any percentage sizing will be interpreted as percentage of row size. Otherwise it will appear to be embedded within the record, underneath the field values.
Embedded components become children of the grid and will stay attached to a record through scrolling, sorting and other operations that cause records to shift position.
If
position is set to "expand", embedded components may offer a resize interface, eg, by setting
canDragResize:true, and the grid will react
accordingly, growing or shrinking the record to match the embedded component's new extents.
Embedded components can
be explicitly removed with removeEmbeddedComponent().
If a record is removed from the dataset or is replaced in the dataset, for example, it is eliminated through filtering (removes record) or is successfully edited in a databound grid (replaces record), the component is cleared but not logically removed from the grid. It is the responsibility of code that sets up the embedded component to remove it if the record is removed from the dataSet.
When embedding components will result in variable
height records, you should switch on virtualScrolling.
component - component to embedrecord - record to attach the component torowNum - rowNum of the record to attach the component tocolNum - colNum in which to embed the componentposition - positioning with respect to the record or cell (Defaults to "expand").public void addSort(SortSpecifier sortSpecifier)
SortSpecifier to this grid's sort configuration and resorts.sortSpecifier - A SortSpecifier object indicating an additional field and direction to sort bypublic void applyCellData(RecordList cellData)
getSelectedCellData() and applies the data at the current
selection. For consistency with Excel, given a record in the cellData, after the data value with the most negative column index is found, the rest of the values in the record are applied contiguously to the right of it, using the positional data for ordering only.
Will only modify cells in the grid which are editable, and changes will be
applied as editValues, exactly as though the user had typed the values in (see Grid Editing Overview).
See also applyRecordData().
cellData - list of Records as described abovepublic void applyRecordData(RecordList recordData)
Values found in each of the passed records will be applied to the same-named fields in the Records starting from the top-left of the current selection, in order.
Will
only modify cells in the grid which are editable, and changes will be applied as editValues, exactly as though the user
had typed the values in (see Grid Editing Overview).
See also applyCellData().
recordData - list of Records as described abovepublic void applySortToData(SortSpecifier... sortSpecifiers)
NOTE: This method is primarily used by setSort(); it is not intended to be called by user code, unless you
are implementing a custom setSortHandler). For the
normal use case, calling this method directly will fail to execute vital pre-steps. If you are not implementing a
custom handler as described above, do not call this method directly - call setSort() instead.
sortSpecifiers - Array of SortSpecifier objectspublic void askForSort()
MultiSortDialog.askForSort(), passing this component as the
fieldSource and the current sort-specification if there
is one. The generated multiSortDialog can be customized via multiSortDialogDefaults, multiSortDialogProperties.
public int autoFitField(java.lang.String fieldName)
Does not establish permanent
auto-fitting - use setAutoFitWidth() or setAutoFitFieldWidths() to do so.
Note that unlike
the ongoing autoFit set up by autoFitFieldWidths
or ListGridField.autoFitWidth, any specified
ListGridField.width will not be taken as a minimum width
- the field may shrink below the current specified width when this method is run. However, ListGridField.minWidth will be respected.
As with autoFitFieldWidths, the auto-fit sizing is determined
via the autoFitWidthApproach.
fieldName - public void autoFitFields()
autoFitWidthApproach) Does not
establish permanent auto-fitting - use setAutoFitWidth() to do so. Note that unlike the ongoing autoFit set up by autoFitFieldWidths or ListGridField.autoFitWidth, any specified ListGridField.width will not be taken as a minimum width - the
field(s) may shrink below the current specified width when this method is run. However, ListGridField.minWidth will be respected.
public void autoFitFields(ListGridField... fields)
autoFitWidthApproach) Does not
establish permanent auto-fitting - use setAutoFitWidth() to do so. Note that unlike the ongoing autoFit set up by autoFitFieldWidths or ListGridField.autoFitWidth, any specified ListGridField.width will not be taken as a minimum width - the
field(s) may shrink below the current specified width when this method is run. However, ListGridField.minWidth will be respected.
fields - Array of fields to auto fit. If this parameter is not passed, autoFitting will occur on all visible fields.public void cancelEditing()
Editing overview and related methodspublic boolean canEditCell(int rowNum,
int colNum)
The default implementation of canEditCell() respects the various property
settings affecting editability:
field.canEdit can be set to disable editing
for a fieldcanEditFieldAttribute value on the
dataSource field may enable / disable editingrecordEditProperty set to
false is not editablecanEditCell() as follows:
public boolean canEditCell(int rowNum, int colNum) {
Record record = this.getRecord(rowNum);
String fieldName = this.getFieldName(colNum);
if (fieldName.equals("shipDate") && record.getAttribute("orderStatus").equals("complete") {
return false;
}
// use default rules for all other fields
return super.canEditCell(rowNum, colNum);
};
Notes on providing custom implementations:
canEditCell() is called
very frequently. If you see delays on row to row navigation, check that your implementation
is efficient
ListGrid.editorExit() on another cell, call
refreshCell() to show or hide the editor
canEditCell() may be
called when there is no record available, in which case getRecord() will return null. The
values input so far by the user are available via getEditValues().
Note: This is an override point.
rowNum - row number for the cellcolNum - column number of the cellEditing overview and related methodspublic boolean canExpandRecord(ListGridRecord record, int rowNum)
canExpandRecords and record[canExpandRecordProperty]. Override this method for more specific control over individual record expansion.
Note: Rows with no underlying record in the data array - for example newly added edit rows that have not yet been saved - cannot be expanded.
record - record to work withrowNum - rowNum of the record to work withpublic boolean canSelectCell(int rowNum,
int colNum)
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.
If it returns false, the cell will not be selected.rowNum - rowNum being selectedcolNum - colNum being selectedpublic com.google.gwt.event.shared.HandlerRegistration addCellSavedHandler(CellSavedHandler handler)
Fires after user edits have been successfully saved to the server, only for cells where the value was actually modified.
If you want immediate notification of a changes before changes has been saved to the server, implement field.change() or field.changed() instead.
You can alternatively use
ListGridField.cellChanged() to get notification only
of saved changes for a specific field. If both a listGridField and the containing listGrid have a handler for this
event, only the handler defined on the field is called.
addCellSavedHandler in interface HasCellSavedHandlershandler - the cellSaved handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellClickHandler(CellClickHandler handler)
Called when a cell receives a click event.
Note that returning false from this method will not prevent any specified
ListGrid.rowClick() handler from firing.
addCellClickHandler in interface HasCellClickHandlershandler - the cellClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellContextClickHandler(CellContextClickHandler handler)
Called when a cell receives a contextclick event.
addCellContextClickHandler in interface HasCellContextClickHandlershandler - the cellContextClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellDoubleClickHandler(CellDoubleClickHandler handler)
Called when a cell receives a double click event.
addCellDoubleClickHandler in interface HasCellDoubleClickHandlershandler - the cellDoubleClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellErrorIconHoverHandler(CellErrorIconHoverHandler handler)
Optional stringMethod to fire when the user hovers over the error icon of a cell with validation errors. The default
behavior is to show a hover canvas containing the validation error message text. Call CellErrorIconHoverEvent.cancel() from within CellErrorIconHoverHandler.onCellErrorIconHover(com.smartgwt.client.widgets.grid.events.CellErrorIconHoverEvent) to suppress this default
behavior.
addCellErrorIconHoverHandler in interface HasCellErrorIconHoverHandlershandler - the cellErrorIconHover handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellErrorIconOutHandler(CellErrorIconOutHandler handler)
Optional stringMethod to fire when the mouse moves off the error icon of a cell with validation errors.
addCellErrorIconOutHandler in interface HasCellErrorIconOutHandlershandler - the cellErrorIconOut handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellErrorIconOverHandler(CellErrorIconOverHandler handler)
Optional stringMethod to fire when the mouse moves over the error icon of a cell with validation errors.
addCellErrorIconOverHandler in interface HasCellErrorIconOverHandlershandler - the cellErrorIconOver handlerHandlerRegistration used to remove this handlerpublic java.lang.Boolean cellHasChanges(int rowNum,
int colNum)
rowNum - index of row to check for changescolNum - index of the col to check for changesEditing overview and related methodspublic java.lang.Boolean cellHasErrors(int rowNum,
java.lang.String fieldID)
rowNum - index of row to check for validation errorsfieldID - name of field, or index of column to check for validation errorshasErrors(),
rowHasErrors(int),
GridValidation overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addCellHoverHandler(CellHoverHandler handler)
Called when the mouse hovers over a cell if this.canHover is true. Returning false will suppress the hover text from being shown if this.showHover is true.
addCellHoverHandler in interface HasCellHoverHandlershandler - the cellHover handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellMouseDownHandler(CellMouseDownHandler handler)
Called when a cell receives a mousedown event.
addCellMouseDownHandler in interface HasCellMouseDownHandlershandler - the cellMouseDown handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellMouseUpHandler(CellMouseUpHandler handler)
Called when a cell receives a mouseup event.
addCellMouseUpHandler in interface HasCellMouseUpHandlershandler - the cellMouseUp handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellOutHandler(CellOutHandler handler)
Called when the mouse pointer leaves a cell
addCellOutHandler in interface HasCellOutHandlershandler - the cellOut handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellOverHandler(CellOverHandler handler)
Called when the mouse pointer enters a cell
addCellOverHandler in interface HasCellOverHandlershandler - the cellOver handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellSelectionChangedHandler(CellSelectionChangedHandler handler)
Called when (cell-based) selection changes within this grid.
addCellSelectionChangedHandler in interface HasCellSelectionChangedHandlershandler - the cellSelectionChanged handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addCellValueHoverHandler(CellValueHoverHandler handler)
Optional stringMethod to fire when the user hovers over a cell and the value is clipped. If
this.showClippedValuesOnHover is true, the default behavior is to show a hover canvas containing the HTML returned by
cellValueHoverHTML(). Call CellValueHoverEvent.cancel() from within
CellValueHoverHandler.onCellValueHover(com.smartgwt.client.widgets.grid.events.CellValueHoverEvent) to suppress this default
behavior.
addCellValueHoverHandler in interface HasCellValueHoverHandlershandler - the cellValueHover handlerHandlerRegistration used to remove this handlerpublic java.lang.String cellValueHoverHTML(ListGridRecord record, int rowNum, int colNum, java.lang.String defaultHTML)
Use setCellValueHoverFormatter() to provide a custom implementation.
record - cell record as returned by getCellRecord()rowNum - row number for the cellcolNum - column number of the celldefaultHTML - the HTML that would have been displayed by default. See HTMLStringCellValueHoverEventpublic java.lang.Boolean cellValueIsClipped(int rowNum,
int colNum)
rowNum - row number of the cellcolNum - column number of the cellCellValueHoverEventpublic FacetChart chartData(java.lang.String labelField)
Each row provides a series of data. Each series of data is
labeled by a value from one column, called the labelField.
For example, cell values are sales figures,
and fields are "Product", "August", "September", "October". In this case each row gives a series: sales figures for
each of 3 months. The labelField in this case is the "Product" field, meaning each row represents sales
figures for each of 3 months for a particular product. This dataset can be charted via any multi-series chart: stacked
or clustered bar or column chart, line chart with multiple lines, or area chart (stacked lines).
By default, all
visible fields other than the label field are assumed to be labels for series values, but an explicit list of fields can
be provided as dataFields.
By default, all data is charted if all data is loaded, otherwise, data
visible in the viewport is charted. An explicit set of rows can be provided via dataRows.
labelField - name of the fieldpublic FacetChart chartData(java.lang.String labelField, java.lang.String[] dataFields)
chartData(java.lang.String)public FacetChart chartData(java.lang.String labelField, java.lang.String[] dataFields, ListGridRecord... dataRows)
chartData(java.lang.String)public FacetChart chartData(java.lang.String labelField, java.lang.String[] dataFields, ListGridRecord[] dataRows, FacetChart chartProperties)
chartData(java.lang.String)public FacetChart chartData(java.lang.String labelField, java.lang.String[] dataFields, ListGridRecord[] dataRows, FacetChart chartProperties, boolean labelFieldFirst)
Each row provides a series of data. Each series of data is
labeled by a value from one column, called the labelField.
For example, cell values are sales figures,
and fields are "Product", "August", "September", "October". In this case each row gives a series: sales figures for
each of 3 months. The labelField in this case is the "Product" field, meaning each row represents sales
figures for each of 3 months for a particular product. This dataset can be charted via any multi-series chart: stacked
or clustered bar or column chart, line chart with multiple lines, or area chart (stacked lines).
By default, all
visible fields other than the label field are assumed to be labels for series values, but an explicit list of fields can
be provided as dataFields.
By default, all data is charted if all data is loaded, otherwise, data
visible in the viewport is charted. An explicit set of rows can be provided via dataRows.
labelField - name of the fielddataFields - optional list of fields to use as labels. By default, all fields are used.dataRows - set of records to chart. Can be obtained by eg grid.data.getRange().chartProperties - properties to pass to the created chartlabelFieldFirst - if true, use the labelField as the "first" set of labels, for example, as the bar labels in a stacked bar chart,
whereas the second set of labels would appear as the legend.public void clearCriteria()
public void clearCriteria(DSCallback callback)
clearCriteria()public void clearCriteria(DSCallback callback, DSRequest requestProperties)
callback - callback to invoke on completionrequestProperties - additional properties to set on the DSRequest that will be issuedfetchData(),
DataBoundComponentMethods overview and related methods,
Databound filter Examplepublic void clearFieldError(int rowNum,
int fieldName)
rowNum - row index of cell to add validation error forfieldName - col index or field name of cell to add validation error forsetFieldError(int, java.lang.String, java.lang.String),
GridValidation overview and related methodspublic void clearRowErrors(int rowNum)
rowNum - index of row to clear validation error forsetRowErrors(int, java.lang.Object),
Validation overview and related methodspublic void clearSort()
setSort() with a null parameter. The internal list of SortSpecifiers is removed and
the grid is unsorted.public boolean closeGroup(Record record)
grouped ListGrids.record - node to closepublic void collapseRecord(ListGridRecord record)
record which has been previously expanded
using expandRecord(). Depending on the pooling mode, this method may automatically
destroy expansionComponents. By default, components created automatically by the ListGrid will be auto-destroyed. This
behavior can be changed by setting a different pooling mode.
Note that components created via an override to getExpansionComponent() will *not* be auto-destroyed -
developers should override collapseRecord to take care of clean-up for such components.
record - record to collapsepublic void collapseRecords(ListGridRecord... records)
records. Calls collapseRecord for each passed record, but only marks the grid
for redraw once, after all records have been collapsed.records - records to collapsepublic void configureGrouping()
protected Canvas createRecordComponent(ListGridRecord record, java.lang.Integer colNum)
showRecordComponents is true, this method
is called to create per-row or per-cell embedded components to display in the grid. The colNum parameter is
applicable only when showRecordComponentsByCell is true.
If this row should not have a recordComponent, return null.
This method should create and return a new component for the record passed in every time it is called and never return
the same Canvas instance twice. To re-use components with different rows, set RecordComponentPoolingMode to "recycle". In this mode, in addition to implementing this
method, developers should also implement updateRecordComponent() which allows already created components to be altered for re-use in new records. See the showRecordComponents overview for more information.
record - record to create a component forcolNum - cell to which the component appliespublic com.google.gwt.event.shared.HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)
Notification method fired when new data arrives from the server to be displayed in this ListGrid, (for example in
response to the user scrolling a new set of rows into view). Only applies to databound listGrids where the data attribute is a ResultSet. This
ResultSet may have been created manually and applied to the grid via a call to ListGrid.setData() or may have been created and automatically
assigned if ListGrid.fetchData() was used to populate the
grid. This method is fired directly in response to dataArrived() firing on the data object.
Note that dataArrived(), unlike ListGrid.dataChanged(), only fires in limited
circumstances - when data for a ResultSet arrives from the server due to a fetch or
cache invalidation, or as a result of filtering. If you want to catch all data changes, you should instead react to
ListGrid.dataChanged().
addDataArrivedHandler in interface HasDataArrivedHandlershandler - the dataArrived handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDataChangedHandler(DataChangedHandler handler)
Notification method fired when the ListGrid's data changes, for any reason.
Examples of why data changed might be:
ListGrid.addData(), ListGrid.updateData(), or ListGrid.removeData() DataSource updates from the server for ResultSet data
(triggered by record editing, etc.) ResultSet data ListGrid.setData() doesn't call this notification directly, but it
may fire if one of the above listed events is triggered (e.g. a server fetch for ResultSet data). Note that the operationType parameter is optional and will
be passed and contain the operation (e.g. "update") if this notification was triggered by a fetch, an ListGrid.addData(), ListGrid.updateData(), or ListGrid.removeData(), or a DataSource update for ResultSet data (the first three reasons
listed above) but otherwise will be null.
addDataChangedHandler in interface HasDataChangedHandlershandler - the dataChanged handlerHandlerRegistration used to remove this handlerpublic void deselectRange(int startRow,
int endRow)
This is a synonym for selectRange(startRow, endRow,
false);
startRow - start of selection rangeendRow - end of selection range (non-inclusive)Selection overview and related methodspublic void discardAllEdits()
If
no rows are passed in, all outstanding edit values will be dropped. This will not automatically end editing;
call endEditing() before calling discardAllEdits()
if you also want to end editing.
Note that this also clears the removed state of any records that have been marked as
removed.
Editing overview and related methodspublic void discardAllEdits(int[] rows)
discardAllEdits()public void discardAllEdits(int[] rows,
boolean dontHideEditor)
If
no rows are passed in, all outstanding edit values will be dropped. This will not automatically end editing;
call endEditing() before calling discardAllEdits()
if you also want to end editing.
Note that this also clears the removed state of any records that have been marked as
removed.
rows - allows you to specify which row(s) to drop edits fordontHideEditor - By default this method will hide the editor if it is currently showing for any row in the
grid. Passing in this parameter will leave the editor visible (and just reset
the edit values underneath the editor).Editing overview and related methodspublic void discardEdits(int rowNum,
int colNum)
Note
that if this method is called on a new edit row (created via startEditingNew() for example), which has not yet been saved,
this method will remove the row entirely.
Also note that this method will clear the removed state of records that have been marked as removed.
rowNum - Row to cancelcolNum - Column to cancel. Note that this parameter is ignored in ListGrids but may be required in
subclasses of ListGrid where each cell represents one record in the data set (EG CubeGrid)Editing overview and related methodspublic void discardEdits(int rowNum,
int colNum,
java.lang.Boolean dontHideEditor)
Note
that if this method is called on a new edit row (created via startEditingNew() for example), which has not yet been saved,
this method will remove the row entirely.
Also note that this method will clear the removed state of records that have been marked as removed.
rowNum - Row to cancelcolNum - Column to cancel. Note that this parameter is ignored in ListGrids but may be required in
subclasses of ListGrid where each cell represents one record in the data set (EG CubeGrid)dontHideEditor - By default this method will hide the editor if it is currently showing for the row in
question. Passing in this parameter will leave the editor visible (and just reset
the edit values underneath the editor).Editing overview and related methodspublic void displaySort(SortSpecifier... sortSpecifiers)
If multiple fields are sorted, those that are
visible show a directional icon and a small sort-numeral indicating that field's index in the sort configuration.
See addSort() and toggleSort() APIs for information on making changes to the current
sort configuration.
NOTE: This method is primarily used by setSort(); it is not intended to be called by user code, unless you
are implementing a custom setSortHandler). For the
normal use case, calling this method directly will fail to execute vital pre-steps. If you are not implementing a
custom handler as described above, do not call this method directly - call setSort() instead.
sortSpecifiers - Array of SortSpecifier objectspublic com.google.gwt.event.shared.HandlerRegistration addDrawAreaChangedHandler(DrawAreaChangedHandler handler)
Notification method that fires when the drawArea changes due to scrolling. Receives the previous drawArea co-ordinates
as parameters. Call ListGrid.getDrawArea() to get the new
drawArea co-ordinates.
Note that if this grid is showing any frozen fields, they will not be included in the
oldStartCol, oldEndCol range reported by this method. Frozen fields are assumed never to be
scrolled out of view.
addDrawAreaChangedHandler in interface HasDrawAreaChangedHandlershandler - the drawAreaChanged handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEditCompleteHandler(EditCompleteHandler handler)
Callback fired when inline edits have been successfully saved.
No default implementation.
addEditCompleteHandler in interface HasEditCompleteHandlershandler - the editComplete handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEditFailedHandler(EditFailedHandler handler)
Called when an attempt to save inline edits fails, due to a validation error or other server error.
The default
implementation of editFailed does nothing for normal validation errors, which are displayed before editFailed() is
called. For any other errors, the default implementation will call HandleErrorCallback.handleError(), which by default will result
in a warning dialog.
addEditFailedHandler in interface HasEditFailedHandlershandler - the editFailed handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEditorEnterHandler(EditorEnterHandler handler)
Callback fired when the user starts editing a new cell.
This callback is typically used to establish dynamic default
values via ListGrid.setEditValue() or ListGrid.setEditValues().
Can also be overridden on a
per-field basis via field.editorEnter.
addEditorEnterHandler in interface HasEditorEnterHandlershandler - the editorEnter handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEditorExitHandler(EditorExitHandler handler)
Callback fired when the user attempts to navigate away from the current edit cell, or complete the current edit.
Call EditorExitEvent.cancel() from within EditorExitHandler.onEditorExit(com.smartgwt.client.widgets.grid.events.EditorExitEvent) from this method to cancel the default behavior
(Saving / cancelling the current edit / moving to the next edit cell).
This callback is typically used to
dynamically update values or value maps for related fields (via ListGrid.setEditValue() and ListGrid.setEditorValueMap() respectively, or to implement
custom navigation (via startEditing(rowNum,colNum).
Can be overridden at the field level as field.editorExit.
addEditorExitHandler in interface HasEditorExitHandlershandler - the editorExit handlerHandlerRegistration used to remove this handlerpublic void endEditing()
autoSaveEdits is true, the value will be saved to the
server.public void expandRecord(ListGridRecord record)
record by creating a subcomponent and inserting
it in to the record's grid-row. A number of built-in expansionModes are
supported by the default implementation of getExpansionComponent() and you can override that method to provide your own expansion behavior. Once a record has
been expanded, the currently visible expansion component may be retrieved via getCurrentExpansionComponent().
record - record to expandpublic void expandRecords(ListGridRecord... records)
records by creating a subcomponent
for each record and inserting them it in to the record's grid-row. Calls expandRecord for each passed record, but only marks the grid for
redraw once, after all expansions are complete.records - records to expandpublic void exportClientData()
Ordinarily, calls to this method go through the static classMethod DataSource.exportClientData(). In this case, no server-side
DataSources are required. However, if this component is databound and you specify a valid operationId in the properties passed to this method, the call will go
through the instance method DataSource.exportClientData()
instead. As the documentation for that method explains, this allows you more control on the server side. This
approach requires both the Smart GWT server and server-side DataSource definitions.
If your ListGrid has custom formatters, formatted values will be exported by default, with HTML normalized to text where possible. Since some levels of HTML normalizing aren't possible, this may result in missing or incorrect export values. In this case, you have two options:
exportRawValues
on the field. This will export the raw underlying value of the field; your formatter will not be calledisExportingClientData() and perform whatever alternative formatting you require if that method returns true To export data from this component's dataSource, see exportData, which does not include client-side formatters,
but does include formatters declared in the .ds.xml file. exportData() relies on both
the Smart GWT server and server-side DataSources.
public void exportClientData(DSRequest requestProperties)
exportClientData()public void exportClientData(DSRequest requestProperties, RPCCallback callback)
Ordinarily, calls to this method go through the static classMethod DataSource.exportClientData(). In this case, no server-side
DataSources are required. However, if this component is databound and you specify a valid operationId in the properties passed to this method, the call will go
through the instance method DataSource.exportClientData()
instead. As the documentation for that method explains, this allows you more control on the server side. This
approach requires both the Smart GWT server and server-side DataSource definitions.
If your ListGrid has custom formatters, formatted values will be exported by default, with HTML normalized to text where possible. Since some levels of HTML normalizing aren't possible, this may result in missing or incorrect export values. In this case, you have two options:
exportRawValues
on the field. This will export the raw underlying value of the field; your formatter will not be calledisExportingClientData() and perform whatever alternative formatting you require if that method returns true To export data from this component's dataSource, see exportData, which does not include client-side formatters,
but does include formatters declared in the .ds.xml file. exportData() relies on both
the Smart GWT server and server-side DataSources.
requestProperties - Request properties for the export. Note that specifying exportData on the request properties allows the developer to pass in an explicit data set to export.callback - Optional callback. If you specify exportToClient: false
in the request properties, this callback will fire after export completes. Otherwise the callback will fire right
before the download request is made to the server.DataSource.exportClientData(java.lang.Object[], com.smartgwt.client.data.DSRequest)public void fetchRelatedData(ListGridRecord record, Canvas schema)
Relationships
between DataSources are declared via DataSourceField.foreignKey.
For example, given two related DataSources "orders" and "orderItems", where we want to
fetch the "orderItems" that belong to a given "order". "orderItems" should declare a field that is a foreignKey to the "orders" table (for example, it might be named
"orderId" with foreignKey="orders.id"). Then, to load the records related to a given "order", call fetchRelatedData()
on the component bound to "orderItems", pass the "orders" DataSource as the "schema" and pass a record from the "orders"
DataSource as the "record" argument.
Note that multiple foreign keys into the schema are supported by this method.
record - DataSource recordschema - schema of the DataSource record, or DataBoundComponent already bound to that schemaDataBoundComponentMethods overview and related methodspublic void fetchRelatedData(ListGridRecord record, Canvas schema, DSCallback callback)
public void fetchRelatedData(ListGridRecord record, Canvas schema, DSCallback callback, DSRequest requestProperties)
Relationships
between DataSources are declared via DataSourceField.foreignKey.
For example, given two related DataSources "orders" and "orderItems", where we want to
fetch the "orderItems" that belong to a given "order". "orderItems" should declare a field that is a foreignKey to the "orders" table (for example, it might be named
"orderId" with foreignKey="orders.id"). Then, to load the records related to a given "order", call fetchRelatedData()
on the component bound to "orderItems", pass the "orders" DataSource as the "schema" and pass a record from the "orders"
DataSource as the "record" argument.
Note that multiple foreign keys into the schema are supported by this method.
record - DataSource recordschema - schema of the DataSource record, or DataBoundComponent already bound to that schemacallback - callback to invoke on completionrequestProperties - additional properties to set on the DSRequest that will be issuedDataBoundComponentMethods overview and related methodspublic boolean fieldIsEditable(ListGridField field)
canEdit for
the grid as well as the ListGridField.canEdit value,
to determine whether editing is actually allowed. For a detailed discussion, see the documentation at canEdit.field - field object or identifierEditing overview and related methodspublic boolean fieldIsEditable(int field)
canEdit for
the grid as well as the ListGridField.canEdit value,
to determine whether editing is actually allowed. For a detailed discussion, see the documentation at canEdit.field - field object or identifierEditing overview and related methodspublic boolean fieldIsEditable(java.lang.String field)
canEdit for
the grid as well as the ListGridField.canEdit value,
to determine whether editing is actually allowed. For a detailed discussion, see the documentation at canEdit.field - field object or identifierEditing overview and related methodspublic boolean fieldIsVisible(java.lang.String field)
field - field to be checkedpublic com.google.gwt.event.shared.HandlerRegistration addFieldStateChangedHandler(FieldStateChangedHandler handler)
Notification method executed when columns are resized or reordered, or fields are shown or hidden. frozen or unfrozen. Has no default implementation.
addFieldStateChangedHandler in interface HasFieldStateChangedHandlershandler - the fieldStateChanged handlerHandlerRegistration used to remove this handlerpublic void filterByEditor()
showFilterEditor) is visible
for this grid, this method will perform a filter based on the current values in the editor.public com.google.gwt.event.shared.HandlerRegistration addFilterEditorSubmitHandler(FilterEditorSubmitHandler handler)
Optional notification fired when the user performs a filter using the
Filter Editor. May fire as criteria values are
being edited if
ListGrid.filterOnKeypress is true, otherwise will
fire when the user clicks the filter
button or presses the Enter key while focus is in the Filter Editor.
Use event.cancel()
to cancel the default behavior - you must cancel the default behavior if your
code is going to call ListGrid.filterData(), ListGrid.setCriteria() or any other API that
affects the criteria applied to the grid.
The criteria parameter contains the current criteria applied to the
grid including edits the user has just made using the Filter Editor. This matches
what is returned if you call ListGrid.getFilterEditorCriteria().
If you wish to access the criteria applied to the grid without picking
up any edits to the Filter Editor, use ListGrid.getCriteria() instead.
Developers may wish to perform a filter using the Filter Editor values from code running outside the standard filterEditorSubmit flow. For example, if you wanted a confirmation dialog to be shown before filtering was performed, you would cancel the default behavior as described above, but then need to replicate the default behavior once the user confirms that they want to proceed. To replicate the default behavior, just call:
grid.filterData(grid.getFilterEditorCriteria());or, to ensure the specified
ListGrid.autoFetchTextMatchStyle is picked up
DSRequest request = new DSRequest();
request.setTextMatchStyle(grid.getAutoFetchTextMatchStyle());
grid.filterData(grid.getFilterEditorCriteria(), null,
request);
addFilterEditorSubmitHandler in interface HasFilterEditorSubmitHandlershandler - the filterEditorSubmit handlerHandlerRegistration used to remove this handlerpublic void focusInCell(java.lang.Integer row,
java.lang.Integer col)
Only applies where canSelectCells is true.
row - Index of target rowcol - Index of target colfocusInRow(java.lang.Integer)public void focusInFilterEditor()
showFilterEditor) is visible
for this grid, this method will explicitly put focus into the specified field in the filter editor.public void focusInFilterEditor(java.lang.String fieldName)
showFilterEditor) is visible
for this grid, this method will explicitly put focus into the specified field in the filter editor.fieldName - Name of the field to put focus into. If unspecified focus will go to the first field in the
editorpublic void focusInRow(java.lang.Integer row)
Only applies where canSelectCells is false.
row - Index of target rowfocusInCell(java.lang.Integer, java.lang.Integer)public com.google.gwt.event.shared.HandlerRegistration addFormulaUpdatedHandler(FormulaUpdatedHandler handler)
Notification fired when a user either creates a new formula field or edits an existing formula field.
addFormulaUpdatedHandler in interface HasFormulaUpdatedHandlershandler - the formulaUpdated handlerHandlerRegistration used to remove this handlerpublic void freezeField(ListGridField field)
field - field or fields to freeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic void freezeField(java.lang.Integer field)
field - field or fields to freeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic void freezeField(java.lang.String field)
field - field or fields to freeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic void freezeField(java.lang.String[] field)
field - field or fields to freeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic int[] getAllEditRows()
markRecordRemoved() as well
as records with unsaved changes to field values.Editing overview and related methodspublic ListGridField[] getAllFields()
dataSource. This list of fields is
only valid once the ListGrid has been drawn or once setFields() has been called explicitly. If called earlier, only
the list of directly specified fields will be returned (the Array passed to create()).
This Array should be treated
as read-only. To modify the set of visible fields, use showField(), hideField() and related APIs. To update properties of individual
fields, use setFieldProperties() or more specific
APIs such as setFieldTitle().
protected java.lang.String getBaseStyle(ListGridRecord record, int rowNum, int colNum)
this.editFailedBaseStyle is defined, and the cell
is displaying a validation error return this value.this.editFailedPendingStyle is defined, and the
cell is displaying an edit value that has not yet been saved (see autoSaveEdits) return this value.record[listGrid.recordBaseStyleProperty],
if defined, otherwise field.baseStyle.baseStyle is specified this will be used. Otherwise for grids
showing fixed height rows which match normalCellHeight normalBaseStyle will be used. For
grids with variable, or modified cell heights, tallBaseStyle will be used. Note also that enabling fastCellUpdates will cause the tallBaseStyle
to be used rather than normalBaseStyle.
As
noted under enforceVClipping, cell content which
renders taller than the available space within a cell may cause rows to expand even if fixedRecordHeights is true. This can lead to
misaligned rows when frozen columns are used. Developers should be aware that changing cell styling such that there is
increased borders or padding will reduce the available space for content within the specified cell height, making this
scenario more common. To fix this, specify a larger cellHeight, or set enforceVClipping to true.
Note: This is an override point.
record - Record associated with this cell. May be null for a new edit row at the
end of this grid's data set.rowNum - row number for the cellcolNum - column number of the cellgetCellStyle(com.smartgwt.client.widgets.grid.ListGridRecord, int, int),
Hilite cells (replace style) Exampleprotected java.lang.String getCellCSSText(ListGridRecord record, int rowNum, int colNum)
"CSS text" means semicolon-separated style settings, suitable for inclusion in a CSS stylesheet or in a STYLE attribute of an HTML element.
Note: This is an override point.
record - cell record as returned by getCellRecordrowNum - row number for the cellcolNum - column number of the cellgetCellStyle(com.smartgwt.client.widgets.grid.ListGridRecord, int, int),
Hilite cells (add style) Examplepublic java.lang.String[] getCellErrors(int rowNum,
java.lang.String fieldName)
rowNum - index of row to check for validation errors.fieldName - field to check for validation errors - can be fieldName or index of the column.GridValidation overview and related methodsprotected Canvas getCellHoverComponent(Record record, java.lang.Integer rowNum, java.lang.Integer colNum)
showHoverComponents is set, this method is
called to get the component to show as a hover for the current cell. By default, this method returns one of a set of
builtin components, according to the value of listGrid.hoverMode. You can
override this method to return any component you wish to provide as a hoverComponent, or invoke the superclass method to
have the default hover component generated, then further customize it.
By default, components returned by
getCellHoverComponent() will be automatically destroyed when the hover is hidden. To prevent this, set
Canvas.hoverAutoDestroy to false on the returned
component.
If you return a component that fetches data or loads content dynamically:
Canvas.destroyed before taking action in an asynchronous callback
Canvas.adjustForContent() will be required. See that API
for details. record - record to get the hoverComponent forrowNum - row number for the cellcolNum - column number of the cellpublic java.lang.Integer[] getCellPageRect(int rowNum,
int colNum)
rowNum - row index of the cellcolNum - column index of the cellPositioning overview and related methodspublic int getCellRowSpan(int rowNum,
int colNum)
row spanning, returns the number of cells
spanned by the cell at the given coordinates. If the passed coordinates are in the middle of a series of spanned
cells, the row span of the spanning cell is returned. For example, if row 2 col 0 spans 3 cells, calls to
getCellRowSpan() for row 2 col 0, row 3 col 0, row 4 col 0 will all return 3.
This method returns row
span information for the current rendered cells. In contrast, if the grid is about to be redrawn, a call to
getRowSpan() may return row span values for how the grid is about to be drawn. Also, user-provided
getRowSpan() functions are not required to operate properly when called outside of the grid rendering loop.
Note: This method is a utility method for developers - it is not called directly by the grid rendering path and
therefore is not intended for override. To set up custom row-spanning behavior, override getRowSpan() instead.
rowNum - row number of cell to return the row span forcolNum - column number of cell to return the row span forpublic CellSelection getCellSelection()
canSelectCells is active, returns the CellSelection object that tracks and manages the current selection. Returns null if
canSelectCells is false.public int getCellStartRow(int rowNum,
int colNum)
row spanning, returns the row number where a
row-spanning cell starts. For example, if row 2 col 0 spans 3 cells, getCellStartRow() for row 2 col 0,
row 3 col 0, row 4 col 0 will all return 2, because that's the row when spanning starts.
rowNum - row number of cell for which the start row should be returnedcolNum - column number of cell for which the start row should be returnedprotected java.lang.String getCellStyle(ListGridRecord record, int rowNum, int colNum)
GridRenderer.recordCustomStyleProperty) if defined.GridRenderer.getBaseStyle() and the state of the record
using the rules described in CellStyleSuffixes. Cell Styles are customizable by:
record[this.recordCustomStyleProperty] to some
valid CSS style name. In addition to this, getCellCSSText() may be overriden to provide custom
cssText to apply on top of the styling attributes derived from the named style.
Note: This is an override point.
record - record object for this row and columnrowNum - number of the rowcolNum - number of the columngetBaseStyle(),
Appearance overview and related methodspublic java.lang.Integer getColumnLeft(java.lang.Integer colNum)
colNum - number of the columnPositioning overview and related methodspublic java.lang.Integer getColumnPageLeft(java.lang.Integer colNum)
colNum - number of the columnPositioning overview and related methodspublic java.lang.Integer getColumnWidth(int colNum)
colNum - number of the columnnull if undrawn or no such column.Positioning overview and related methodspublic Canvas getCurrentExpansionComponent(java.lang.Integer record)
getExpansionComponent() currently visible in some record, or null if the specified record is not showing an expansion
component.record - rowNum or record to get the expansionComponent forpublic Canvas getCurrentExpansionComponent(ListGridRecord record)
getExpansionComponent() currently visible in some record, or null if the specified record is not showing an expansion
component.record - rowNum or record to get the expansionComponent forpublic java.lang.Integer[] getCurrentFieldWidths()
ListGrid, in px. This method is implemented by
calling getFieldWidth() for each field. If field widths
cannot be determined, the returned array will contain nulls.public void setDefaultFieldWidthCustomizer(DefaultFieldWidthCustomizer customizer)
field auto fit behavior.
Note that this method returns a size for content, so will not be consulted if autoFitWidthApproach is set to
"title". If ListGridField.defaultWidth is specified, this will be returned.
Otherwise, the default implementation varies by
field type. For fields of type "icon", or fields which
show only a valueIcon as a value, and for boolean
fields which show a checkbox value, the width will be calculated based on the icon size and iconPadding. For other fields the getFieldContentWidth() method will be used to calculate
a width based on the rendered width of content. Note that for "image" type fields, this method will rely on
the ListGridField.imageWidth being specified.
Note that this width is the default width of "content" - it does not take into account the rendered size of the field title.
DefaultFieldWidthCustomizer - customizerpublic java.lang.String getDefaultFormattedFieldValue(Record record, ListGridField field)
This method differs from getDefaultFormattedValue() in a couple of ways.
Firstly, this method does not rely on the rowNum and colNum parameters to find the record and field in the grid.
Secondly, unlike getDefaultFormattedValue()
this method will call any explicit cell formatter specified on the field passed in (though it will not call a
component level formatter if one exists).
This is useful for cases where a developer wishes to display a formatted value for some record and field combination which does not necessarily map to a cell displayed in the ListGrid.
If rowNum and colNum parameters
are passed through to the field level cell formatter if one exists. If not explicitly provided these are defaulted to
-1.
record - the record objectfield - the field objectListGridField.setCellFormatter(com.smartgwt.client.widgets.grid.CellFormatter)public java.lang.String getDefaultFormattedFieldValue(Record record, ListGridField field, int rowNum)
public java.lang.String getDefaultFormattedFieldValue(Record record, ListGridField field, int rowNum, int colNum)
This method differs from getDefaultFormattedValue() in a couple of ways.
Firstly, this method does not rely on the rowNum and colNum parameters to find the record and field in the grid.
Secondly, unlike getDefaultFormattedValue()
this method will call any explicit cell formatter specified on the field passed in (though it will not call a
component level formatter if one exists).
This is useful for cases where a developer wishes to display a formatted value for some record and field combination which does not necessarily map to a cell displayed in the ListGrid.
If rowNum and colNum parameters
are passed through to the field level cell formatter if one exists. If not explicitly provided these are defaulted to
-1.
record - the record objectfield - the field objectrowNum - rowNum (passed to any field level cell formatter)colNum - colNum (passed to any field level cell formatter)ListGridField.setCellFormatter(com.smartgwt.client.widgets.grid.CellFormatter)public java.lang.String getDefaultFormattedValue(Record record, int rowNum, int colNum)
This method is useful for cases where a developer wishes to conditionally customize a cell's formatting, but needs to see what the default formatted value would be.
For example - a developer might wish to apply a custom formatter to some link type field, and be
able to return the default active link HTML in some cases. In this case a formatter could check for the conditions in
which custom formatting should be applied and run appropriate custom logic to generate a value for display - otherwise
return the result of this method to leave the standard formatted-value intact.
record - the cell's record objectrowNum - rowNum for the cellcolNum - colNum for the cellListGridField.setCellFormatter(com.smartgwt.client.widgets.grid.CellFormatter)public java.lang.Integer[] getDrawArea()
Note: if there are any frozen fields, they are not included in the draw area range
returned by this method. Frozen fields are assumed to never be scrolled out of view. The column coordinates returned by
this method will only include unfrozen columns.
public int getDrawnRowHeight(int rowNum)
rowNum - Positioning overview and related methodspublic int getEditCol()
Editing overview and related methodspublic java.lang.Object getEditedCell(int record,
int field)
record - rowNum of the record being edited, or an Object containing values for all the
record's primary keysfield - colNum or fieldName of the cellEditing overview and related methodspublic int getEditRow()
Editing overview and related methodspublic java.lang.Object getEditValue(int rowNum,
int colNum)
rowNum - index of the row for which the editValue should be returnedcolNum - index of the field, or fieldName, for which value should be returnedEditing overview and related methodspublic int getEventColumn()
public int getEventColumn(java.lang.Integer x)
x - optional x-coordinate to obtain column number for, in lieu of the x coordinate of the last mouse
eventpublic int getEventRow()
public int getEventRow(java.lang.Integer y)
y - optional y-coordinate to obtain row number, in lieu of the y coordinate of the last mouse eventpublic ListGridRecord[] getExpandedRecords()
protected Canvas getExpansionComponent(ListGridRecord record)
a VLayout and embedded into a record's row. By
default, this method returns one of a set of built-in components, according to the value of listGrid.expansionMode. You can override this method to return any component
you wish to provide as an expansionComponent.
As long as the record is expanded, this component may be retrieved via
a call to getCurrentExpansionComponent().
When an expanded record is collapsed, the component is disassociated from the record and may or may not be
automatically destroyed. By default, built-in components will be destroyed on unembed. Custom expansion components,
created via an override of getExpansionComponents(), may not be auto-destroyed, according to the pooling mode being used.
record - record to get the expansionComponent forpublic java.lang.String getExportBGColor(int rowNum,
int colNum,
Record record)
exportData() or exportClientData(), background color
to use for the cell at the given rowNum and colNum. See ExportBGColor for an
overview.
rowNum - row number of cellcolNum - column number of cellrecord - the record object behind the row being exportedpublic java.lang.String getExportColumnBGColor(int colNum)
exportData() or exportClientData(), background color
to use for the given colNum. See ExportBGColor for an overview.
colNum - column numberpublic java.lang.String getExportRowBGColor(int rowNum,
Record record)
exportData() or exportClientData(), background color
to use for the given rowNum. See ExportBGColor for an overview.
rowNum - row numberrecord - the record object behind the row being exportedpublic ListGridField getField(int colNum)
getFieldByName(). When using DataBinding, the field definition may be a mix of information
derived from fields and dataSource.
colNum - number or id of the field.public ListGridField getFieldByName(java.lang.String fieldName)
getField(), this method will return the field definition even if
it's not visible in the grid.fieldName - name of the field to retrievepublic java.lang.Integer getFieldContentWidth(ListGridField field)
field - field to testpublic java.lang.String getFieldName(int colNum)
colNum - number or id of the field.public int getFieldNum(java.lang.String fieldID)
fieldID - field number or field.namepublic int getFieldNum(int fieldID)
fieldID - field number or field.namepublic java.lang.String getFieldTitle(java.lang.String fieldId)
fieldId - name or index of the fieldpublic java.lang.String getFieldTitle(int fieldId)
fieldId - name or index of the fieldpublic java.lang.Integer getFieldWidth(int fieldNum)
ListGrid.fieldNum - Index or name of the field for which the width is to be determined.null if the width can't be determined.public Criteria getFilterEditorCriteria()
showFilterEditor is true, this method will
return the criteria currently displayed in the filterEditor. Note that these values may differ from the
criteria returned by getCriteria() if the filter editor
values have been modified without performing an actual filter.public Criteria getFilterEditorCriteria(java.lang.Boolean omitHiddenFields)
showFilterEditor is true, this method will
return the criteria currently displayed in the filterEditor. Note that these values may differ from the
criteria returned by getCriteria() if the filter editor
values have been modified without performing an actual filter.omitHiddenFields - By default this method will include criteria applied to fields, including criteria that are not actually
visible/editable in the filterEditor for the grid. Pass in this parameter to get only values for visible fields
returned.public java.lang.Integer getFocusRow()
public java.lang.Object getGridSummary(ListGridField field)
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. The default implementation is as follows:
ListGridField.getGridSummary() is defined, calls that
method passing in the current data set for the gridListGridField.getGridSummary() is undefined, makes use of
the standard summary function for the
field to calculate the summary based on the current data setThis method may be overridden to completely customize the summary value displayed for columns in this grid. An example use case would be when summary information is available on the client and does not need to be calculated directly from the data.
Note: this method will not
be called if summaryRowDataSource is
specified.
field - field for which the summary value should be returnedpublic ListGridRecord[] getGridSummaryData()
summaryRow when showGridSummary is true. By
default this will call getGridSummary() for each field
and generate an array of records containing the resulting values.
This method may return multiple records if more than one summary row is desired.
public ListGridRecord[] getGroupSummaryData(Record[] records, Record groupNode)
grouped, and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. This method may return multiple records if more than one summary row per group is desired.
records - the records in the group, for which the summary values are being calculatedgroupNode - object with specified groupValue and groupName for this grouppublic ListGridRecord[] getGroupSummaryData(Record[] records, Record groupNode, java.lang.Boolean recalculate)
grouped, and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. This method may return multiple records if more than one summary row per group is desired.
records - the records in the group, for which the summary values are being calculatedgroupNode - object with specified groupValue and groupName for this grouprecalculate - if set to false and the node has existing summary data, returns the stored summary data,
rather than recalculatingpublic ListGridRecord[] getGroupTreeSelection()
is grouped, this method will return the
current selection. Unlike the standard getSelection
method, this method will return group nodes in addition
to standard ListGridRecords within the grid's data.listGrid selection will be returned.public ListGridRecord[] getGroupTreeSelection(boolean excludePartialSelection)
getGroupTreeSelection()public ListGridRecord[] getGroupTreeSelection(boolean excludePartialSelection, boolean groupNodesOnly)
is grouped, this method will return the
current selection. Unlike the standard getSelection
method, this method will return group nodes in addition
to standard ListGridRecords within the grid's data.excludePartialSelection - By default a group header node is considered selected if any members of the group are selected. If this flag is passed
in, only header nodes where all members of the group are selected will be included in the returned results.groupNodesOnly - If this parameter is passed as true, this method will return just the group header nodes from the group
tree. If omitted or false, both header nodes and data records will be returned.listGrid selection will be returned.protected MenuItem[] getHeaderContextMenuItems(java.lang.Integer fieldNum)
showHeaderContextMenu is true
this method returns the menu items to be displayed in the default header context menu. This method is called at various times, including during redraws, as the mouse moves over a ListGrid header button and each time the menu is actually displayed - this allows for dynamic content depending on the current state of the grid and its fields.
Consequently, this method should not instantiate any classes, because they'll be re-created on each call, resulting in a leak - your implementation should return an array of menuItem config-blocks only, so you shouldn't instantiate actual Menu instances to apply as the +link{menuItem.subMenu, submenu) of items - instead, set submenu to a simple array of menuItems. If your use-case necessitates that class instances are created, because specific submenus have a different Menu class, for example, you should keep a reference to them and either, if their content is dynamic, destroy and recreate them with the new items, or just return the existing instances otherwise.
The default set of menu items includes items for built-in ListGrid features like showing and hiding fields, freezing fields or grouping by them, and other functions.
fieldNum - Index of the field the user clicked in the fields array.
Note: if the user right-clicked the sorter button this parameter will be null.GridHeader overview and related methodsprotected MenuItem[] getHeaderSpanContextMenuItems(HeaderSpan headerSpan)
headerSpan.headerSpan - the component representing the headerSpan. This component will have all the properties
specified via headerSpans.public ListGridRecord getRecord(int recordNum)
getCellRecord().recordNum - row index of record to return.com.smartgwt.client.widgets.grid.ListGrid#getCellRecord,
getEditedRecord(int)public Canvas getRecordComponent(int rowNum)
recordComponent currently being
shown at the given coordinates. recordComponents are dynamically assigned to row/cell coordinates and,
depending on the recordComponentPoolingMode, any kind of redraw of the containing ListGrid (due to sort change, scrolling, editing etc)
may cause a recordComponent to be assigned to another row, clear()ed or permanently destroy()ed.
Hence you should always
call getRecordComponent() right before taking action on the recordComponent - don't cache the
component associated with row/cell coordinate. Similarly, it's invalid to call getRecordComponent() during
a redraw (for example, from formatting code).
It's always invalid to try to use a recordComponent outside of a ListGrid (by eg adding it to some
other layout).
If showRecordComponentsByCell is true and the colNum parameter is not passed, the call will return the first component in
the passed rowNum.
Returns null if there is no component at the specified coordinates.
rowNum - row number to get record component forpublic Canvas getRecordComponent(int rowNum, java.lang.Integer colNum)
recordComponent currently being
shown at the given coordinates. recordComponents are dynamically assigned to row/cell coordinates and,
depending on the recordComponentPoolingMode, any kind of redraw of the containing ListGrid (due to sort change, scrolling, editing etc)
may cause a recordComponent to be assigned to another row, clear()ed or permanently destroy()ed.
Hence you should always
call getRecordComponent() right before taking action on the recordComponent - don't cache the
component associated with row/cell coordinate. Similarly, it's invalid to call getRecordComponent() during
a redraw (for example, from formatting code).
It's always invalid to try to use a recordComponent outside of a ListGrid (by eg adding it to some
other layout).
If showRecordComponentsByCell is true and the colNum parameter is not passed, the call will return the first component in
the passed rowNum.
Returns null if there is no component at the specified coordinates.
rowNum - row number to get record component forcolNum - optional column number to get the record component forpublic RecordDropPosition getRecordDropPosition()
RecordDropPosition for some record drop operation. This value is passed to
the recordDrop() event notification method. Default
implementation determines the position to return based on the specified recordDropAppearance for the grid and the y-coordinate of the drop event.
public int getRecordIndex(ListGridRecord record)
This is essentially the same as calling listGrid.data.indexOf(record), except that the currently visible range of records is checked first. This is important for responsiveness in functions that respond to user actions when the user is working near the end of a very large dataset (eg 500k records).
record - the record whose index is to be retrievedpublic DataSource getRelatedDataSource(ListGridRecord record)
DataSource containing data related to the passed record. Used when canExpandRecords is true and ExpansionMode is "related". The default implementation returns the DataSource specified in
ListGridRecord.detailDS if set, otherwise detailDS.record - The record to get the Related dataSource for.protected Canvas getRollOverCanvas(java.lang.Integer rowNum, java.lang.Integer colNum)
rollOverCanvas is enabled, this method will
be called to create the canvas to display over the current row or cell when a user moves their mouse over the row. Note that for efficiency this should not typically create a new Canvas every time that it is called. Instead typically a single rollOver canvas should be created and updated to reflect the current rollOver row if necessary.
Return null
to avoid showing a rollOverCanvas for this row.
Note: This is an override point.
rowNum - index of the current rollOver row.colNum - index of the current rollOver column. This parameter will be null unless useCellRollOvers is true for the grid.protected Canvas getRollUnderCanvas(java.lang.Integer rowNum, java.lang.Integer colNum)
rollUnderCanvas is enabled, this method will
be called to create the canvas to display under the current row or cell when a user moves their mouse over the row. Note that for efficiency this should not typically create a new Canvas every time that it is called. Instead typically a single rollUnder canvas should be created and updated to reflect the current rollOver row if necessary.
Return null
to avoid showing a rollUnderCanvas for this row.
Note: This is an override point.
rowNum - index of the current rollOver row.colNum - index of the current rollOver column. This parameter will be null unless useCellRollOvers is true for the grid.public java.util.Map getRowErrors(int rowNum)
{fieldName:[array of error messages], ...}rowNum - index of row to check for validation errors.getCellErrors(int, java.lang.String),
GridValidation overview and related methodspublic int getRowHeight(ListGridRecord record, int rowNum)
fixedRecordHeights is false, the row may be rendered
taller than this specified size. If records will be variable height, you should switch on virtualScrolling.
Note if row spanning is enabled, this method should return the
height of a single row (with rowSpan set to 1).
record - cell record as returned by getCellRecordrowNum - row numberpublic int getRowNum(ListGridRecord record)
getRecordIndex().record - the record whose index is to be retrievedpublic int getRowPageTop(int rowNum)
getRowTop().rowNum - Positioning overview and related methodspublic int getRowTop(int rowNum)
getRowPageTop() for a page-relative coordinate. This method
is reliable only for rows that are currently drawn, which is generally only rows that are visible in the viewport. If
row heights vary (see fixedRowHeights), coordinates for rows that are not currently shown are rough
approximations.
rowNum - Positioning overview and related methodspublic ListGridRecord getSelectedRecord()
This method is appropriate if the selectionType is SelectionStyle.SINGLE, or if you only care about the first selected record in a
multiple-record selection. To access all selected records, use getSelection() instead.
NOTE: If a record is returned, it should be treated as read-only and not modified.
Selection overview and related methods,
Databound remove Examplepublic ListGridRecord[] getSelectedRecords()
NOTE: Records in the returned array should be treated as read-only and not modified.
Selection overview and related methodspublic ListGridRecord[] getSelectedRecords(boolean excludePartialSelections)
NOTE: Records in the returned array should be treated as read-only and not modified.
excludePartialSelections - When true, partially selected records will not be returned. Otherwise, both fully and
partially selected records are returned.Selection overview and related methodspublic SortSpecifier[] getSort()
SortSpecifiers for this ListGrid. Will return null if
this grid has never been sorted (and has no specified initialSort or sortField). Note that if sorting was
applied via sort() [rather than setSort()] the sortSpecifiers returned will have been created based
on the specified sort field / direction passed into sort().
public int getSortFieldCount()
public java.lang.String getSortNumeralHTML(java.lang.String fieldName,
int sortIndex)
showSortNumerals to false. Note that the sortIndex passed in is zero based. The default implementation of this
method returns an HTML element with the sortNumeralStyle applied to it, containing the specified sortIndex incremented by 1 (therefore showing the more
user-friendly 1-based numbering system).
fieldName - The name of a sort-field to get the sortNumeral
HTML for.sortIndex - The sort index for the field.public SortSpecifier getSortSpecifier(java.lang.String fieldName)
SortSpecifier for the passed fieldName, or null if the field is not sorted.fieldName - The name of a field, visible, hidden or existing only in the dataSourcepublic java.lang.String getSummaryFieldValue(ListGridField field, Record record)
summary field.field - field that has a summary formatrecord - record to use to compute formula valuepublic java.lang.String getToggleFreezeText(ListGridField field)
headerContextMenu for this
grid and this.canFreezeFields is true, this string
will be shown as the title for the menu item to toggle whether a field is frozen or unfrozen. Default implementation
evaluates and returns freezeFieldText or unfreezeFieldText depending on whether the field is
currently frozen.
field - field to get the menu item title forpublic com.google.gwt.event.shared.HandlerRegistration addGroupByCompleteHandler(GroupByCompleteHandler handler)
Callback fired when the listGrid is grouped or ungrouped.
Unlike ListGrid.groupBy(), this notification will fire when
grouping is complete, and the ListGrid.data object has been
updated. On successful grouping the fields argument will list the new grouping and the ListGrid.groupTree will have been updated to reflect the grouped
data.
Note that the fields argument may be an empty array if the data is not grouped. This implies that
a user or developer explicitly ungrouped the grid, or that a groupBy attempt failed due to the data length exceeding
ListGrid.groupByMaxRecords.
addGroupByCompleteHandler in interface HasGroupByCompleteHandlershandler - the groupByComplete handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addGroupStateChangedHandler(GroupStateChangedHandler handler)
Notification method executed whenever the groupState of this grid changes. Group state is accessible via ListGrid.getGroupState(), and contains group state information.
addGroupStateChangedHandler in interface HasGroupStateChangedHandlershandler - the groupStateChanged handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addGroupByHandler(GroupByHandler handler)
Callback fired when the user attempts to group or ungroup the listGrid, or when ListGrid.groupBy() is called programmatically. This event may be
cancelled.
This notification is fired before the data
is updated to reflect the grouping. See also ListGrid.groupByComplete().
addGroupByHandler in interface HasGroupByHandlershandler - the groupBy handlerHandlerRegistration used to remove this handlerpublic java.lang.Boolean hasChanges()
marked as removed in addition to any rows that have
pending unsaved edits.Editing overview and related methodspublic java.lang.Boolean hasErrors()
rowHasErrors(int),
cellHasErrors(int, java.lang.String),
GridValidation overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addHeaderDoubleClickHandler(HeaderDoubleClickHandler handler)
Handle a double click in the list header.
By default, calls ListGrid.autoFitField() if ListGrid.canAutoFitFields is true and ListGrid.headerAutoFitEvent is
"doubleClick".
addHeaderDoubleClickHandler in interface HasHeaderDoubleClickHandlershandler - the headerDoubleClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addHeaderHoverHandler(HeaderHoverHandler handler)
Handle a hover over a button in the header.
addHeaderHoverHandler in interface HasHeaderHoverHandlershandler - the headerHover handlerHandlerRegistration used to remove this handlerpublic java.lang.String headerHoverHTML(int fieldNum,
java.lang.String defaultHTML)
headerHover handler. Return null or an empty string to cancel the hover. Use setHeaderHoverFormatter()
to provide a custom implementation.
fieldNum - field number for the header that was hovereddefaultHTML - the HTML that would have been displayed by default. See HTMLStringgetShowClippedHeaderTitlesOnHover(),
getClipHeaderTitles(),
GridHeader overview and related methodspublic boolean headerTitleClipped(int fieldNum)
fieldNum - field number for the header button title to testgetClipHeaderTitles(),
GridHeader overview and related methodspublic void hideField(java.lang.String field)
Note also that
if multiple fields are to be hidden it is more efficient to call hideFields() passing in the array of fields to hide rather than to
call this method repeatedly.
field - field to hidepublic void hideField(java.lang.String field,
boolean suppressRelayout)
Note also that
if multiple fields are to be hidden it is more efficient to call hideFields() passing in the array of fields to hide rather than to
call this method repeatedly.
field - field to hidesuppressRelayout - if passed, don't relayout non-explicit sized fields to fit the available spacepublic void hideFields(java.lang.String... fields)
NOTE: If a field.showIf expression exists, it will be destroyed.
When
hiding multiple fields, this method should be called rather than calling hideField() repeatedly for each field to hide.
fields - fields to hidepublic void hideFields(ListGridField... fields)
NOTE: If a field.showIf expression exists, it will be destroyed.
When
hiding multiple fields, this method should be called rather than calling hideField() repeatedly for each field to hide.
fields - fields to hidepublic void hideFields(java.lang.String[] fields,
boolean suppressRelayout)
NOTE: If a field.showIf expression exists, it will be destroyed.
When
hiding multiple fields, this method should be called rather than calling hideField() repeatedly for each field to hide.
fields - fields to hidesuppressRelayout - if passed, don't relayout non-explicit sized fields to fit the available spacepublic com.google.gwt.event.shared.HandlerRegistration addHilitesChangedHandler(HilitesChangedHandler handler)
Notification method executed whenever the end user uses the HiliteEditor to change the set of hilites applied to this
grid. This method will not be called after a purely programmatic change to the hilites made with a call to setHilites(). The array of currently applied hilite objects
is accessible via getHilites().
addHilitesChangedHandler in interface HasHilitesChangedHandlershandler - the hilitesChanged handlerHandlerRegistration used to remove this handlerpublic void invalidateRecordComponents()
recordComponents and gets fresh ones for the visible rows in the grid according to the recordComponentPoolingMode See also refreshRecordComponent() which allows you to refresh a
specific recordComponent
public java.lang.Boolean isCheckboxField(ListGridField field)
checkboxField used when SelectionAppearance is "checkbox". Use this method in your custom event handlers to avoid
inappropriately performing actions when the checkboxField is clicked on.field - field to testpublic java.lang.Boolean isExpanded(ListGridRecord record)
record is expanded or collapsed.record - record in questionpublic java.lang.Boolean isExpansionField(ListGridField field)
expansionField used when canExpandRecords is true. Use this method in your custom
event handlers to avoid inappropriately performing actions when the expansionField is clicked on.field - field to testpublic boolean isExportingClientData()
exporting
client data. This method can be called from custom cell formatters if you need to return a different formatted value
for an export than for a live ListGridexportClientData()public boolean isGroupNode(ListGridRecord record)
grouped, is the record passed in a group
header node.record - record to testpublic java.lang.Boolean isPartiallySelected(ListGridRecord record)
TreeGrid.cascadeSelection, returns true if the record is considered partially selected because only some of it's
children are selected.record - record to checkSelection overview and related methodspublic java.lang.Boolean isRowNumberField(ListGridField field)
rowNumberField used when showRowNumbers is true. Use this method in your custom
event handlers to avoid inappropriately performing actions when the rowNumberField is clicked on.field - field to testpublic java.lang.Boolean isSelected(ListGridRecord record)
record - record to checkSelection overview and related methodspublic java.lang.Boolean isSortField(java.lang.String fieldName)
fieldName - The name of a field, visible, hidden or existing only in the dataSourcepublic void markForRedraw()
markForRedraw() instead of calling Canvas.redraw() directly. Since this method queues the redraw, multiple calls to markForRedraw() within a single thread
of execution will only lead to a single DOM manipulation which greatly improves application performance.markForRedraw in class CanvasDrawing overview and related methodspublic void markForRedraw(java.lang.String reason)
markForRedraw() instead of calling Canvas.redraw() directly. Since this method queues the redraw, multiple calls to markForRedraw() within a single thread
of execution will only lead to a single DOM manipulation which greatly improves application performance.markForRedraw in class Canvasreason - reason for performing the redrawDrawing overview and related methodspublic void markRecordRemoved(int rowNum)
saveEdits()
or saveAllEdits() will cause a "remove" DSRequest to be submitted. A removed record is disabled and non-editable, and uses removedCSSText for its CSS style, which by default will
show strikethrough text.
Contrast this method with removeSelectedData(), which immediately submits a DSRequest to remove the selected records from the dataset.
Records that have been marked for removal using this method may be
'unmarked' via a call to unmarkRecordRemoved(), or
by discarding edit values (discardEdits()).
rowNum - row number for the record to markEditing overview and related methodspublic void markRecordsRemoved(ListGridRecord... records)
saveEdits() or saveAllEdits() will cause a "remove"
DSRequest to be submitted. This method is similar to markRecordRemoved() but should be more efficient in
avoiding unneeded duplicate refreshes due to the multiple records getting marked.
records - records or indices to mark removedmarkRecordRemoved(int),
Editing overview and related methodspublic void markRecordsRemoved(int records)
saveEdits() or saveAllEdits() will cause a "remove"
DSRequest to be submitted. This method is similar to markRecordRemoved() but should be more efficient in
avoiding unneeded duplicate refreshes due to the multiple records getting marked.
records - records or indices to mark removedmarkRecordRemoved(int),
Editing overview and related methodspublic void markRecordsRemoved(RecordList records)
saveEdits() or saveAllEdits() will cause a "remove"
DSRequest to be submitted. This method is similar to markRecordRemoved() but should be more efficient in
avoiding unneeded duplicate refreshes due to the multiple records getting marked.
records - records or indices to mark removedmarkRecordRemoved(int),
Editing overview and related methodspublic void markSelectionRemoved()
markRecordRemoved() had been called.Editing overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addBodyKeyPressHandler(BodyKeyPressHandler handler)
Handle a keyPress event on the body.
Default implementation handles navigating between records with arrow keys, and activating records with space and enter.
addBodyKeyPressHandler in interface HasBodyKeyPressHandlershandler - the bodyKeyPress handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRecordCollapseHandler(RecordCollapseHandler handler)
Handler fired when a record is collapsed in a grid with canExpandRecords set to true. Allows the collapse
to be cancelled.
addRecordCollapseHandler in interface HasRecordCollapseHandlershandler - the recordCollapse handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRecordExpandHandler(RecordExpandHandler handler)
Handler fired when a record is expanded in a grid with canExpandRecords set to true. Allows the expansion
to be cancelled.
addRecordExpandHandler in interface HasRecordExpandHandlershandler - the recordExpand handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addHeaderClickHandler(HeaderClickHandler handler)
Handler fired when the user clicks a header in this listGrid before any other processing occurs. Call HeaderClickEvent.cancel() from within HeaderClickHandler.onHeaderClick(com.smartgwt.client.widgets.grid.events.HeaderClickEvent) to suppress the default header click handling
addHeaderClickHandler in interface HasHeaderClickHandlershandler - the headerClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRecordClickHandler(RecordClickHandler handler)
Executed when the listGrid receives a 'click' event on an enabled, non-separator record. The default implementation does
nothing -- override to perform some action when any record or field is clicked.
A record event handler can be
specified either as a function to execute, or as a string of script to evaluate. If the handler is defined as a string
of script, all the parameters below will be available as variables for use in the script.
To do something specific
if a particular field is clicked, add a recordClick method or string of script to that field (same parameters) when
you're setting up the list.
Notes:
ListGrid.rowClick(), so if that method is overridden this method may
not be fired.addRecordClickHandler in interface HasRecordClickHandlershandler - the recordClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRecordDropHandler(RecordDropHandler handler)
Process a drop of one or more records on a ListGrid record.
This method can be overridden to provide custom drop
behaviors, and is a more appropriate override point than the lower level Canvas.drop() handler.
If this is a self-drop, records are simply reordered.
For a drop from another widget,
ListGrid.transferDragData() is called, which
depending on the dragDataAction specified on the
source widget, may either remove the source records from the original list (dragDataAction:"move") or just
provide a copy to this list (dragDataAction:"copy").
If this grid is databound, the new records will be
added to the dataset by calling DataSource.addData(). Further, if
the new records were dragged from another databound component, and addDropValues is true, getDropValues will be called for every item being dropped.
For multi-record drops, Queuing is automatically used to combine all DSRequests into a single HTTP Request (see QuickStart Guide, Server Framework chapter). This allows the server to persist all changes caused by the drop in a single transaction (and this is automatically done when using the built-in server DataSources with Power Edition and above).
Note that reordering records has no effect on a databound grid.
The newly dropped data is then selected automatically.
If these default persistence behaviors are undesirable, Call RecordDropEvent.cancel() from within RecordDropHandler.onRecordDrop(com.smartgwt.client.widgets.grid.events.RecordDropEvent) to cancel them, then and implement your own
behavior, typically by using grid.updateData() or addData() to add new records.
NOTE: the records you receive
in this event are the actual Records from the source component. Use DataSource.copyRecords() to create a copy before modifying the records
or using them with updateData() or addData().
NOTE: for a drop beyond the last visible record of a ListGrid,
targetRecord will be null and the index will be one higher than the last record. This
includes a drop into an empty ListGrid, where index will be 0.
addRecordDropHandler in interface HasRecordDropHandlershandler - the recordDrop handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRemoveRecordClickHandler(RemoveRecordClickHandler handler)
Handler fired when the user clicks the "remove" icon if ListGrid.canRemoveRecords is true. Default behavior will
remove the record from the data set, or if we're deferring removal mark the record as removed [or for records already marked as removed, clear this removed marker].
If ListGrid.warnOnRemoval is set, this method will
also show a warning dialog to users allowing them to cancel the removal.
This event may be cancelled to suppress the default behavior.
addRemoveRecordClickHandler in interface HasRemoveRecordClickHandlershandler - the removeRecordClick handlerHandlerRegistration used to remove this handlerpublic boolean openGroup(Record record)
grouped ListGrids.record - node to openpublic void recalculateGridSummary()
grid summary, by either re-calculating
from already-loaded data or doing a new fetch from the summaryRowDataSource. Note unlike recalculateSummaries(), this method will not force a
refresh of field-level summaries (see ListGridField.recordSummaryFunction) or group level summaries (see showGroupSummary).
public void recalculateSummaries()
summary-functions or user formulae defined and
for values displayed in the grid summary and group summary rows.public void recalculateSummaries(Record... records)
recalculateSummaries()public void recalculateSummaries(Record[] records, ListGridField... fields)
summary-functions or user formulae defined and
for values displayed in the grid summary and group summary rows.records - Optional array of records to recalculate summaries for, or null for all recordsfields - Optional array of fields to recalculate summaries for, or null for all fields Note that the records
should be from data; thus, if the grid is grouped, the
records should be from the grouped data rather than originalData.
public boolean recordClick(ListGrid viewer, ListGridRecord record, int recordNum, ListGridField field, int fieldNum, java.lang.Object value, java.lang.Object rawValue)
rowClick(), so if that method is overridden this method may not be
fired.viewer - the listGrid that contains the click eventrecord - the record that was clicked onrecordNum - number of the record clicked on in the current set of displayed records (starts with 0)field - the field that was clicked on (field definition)fieldNum - number of the field clicked on in the listGrid.fields arrayvalue - value of the cell (after valueMap, etc. applied)rawValue - raw value of the cell (before valueMap, etc applied)rowClick(com.smartgwt.client.widgets.grid.ListGridRecord, int, int)public com.google.gwt.event.shared.HandlerRegistration addRecordDoubleClickHandler(RecordDoubleClickHandler handler)
Executed when the listGrid receives a 'doubleClick' event on an enabled, non-separator record. The default
implementation does nothing -- override to perform some action when any record or field is double clicked.
A record
event handler can be specified either as a function to execute, or as a string of script to evaluate. If the handler is
defined as a string of script, all the parameters below will be available as variables for use in the script.
To do
something specific if a particular field is double clicked, add a recordDoubleClick method or string of script to that
field (same parameters) when you're setting up the list.
Notes:
ListGrid.rowDoubleClick(), so if that method is overridden
this method may not be fired.addRecordDoubleClickHandler in interface HasRecordDoubleClickHandlershandler - the recordDoubleClick handlerHandlerRegistration used to remove this handlerpublic java.lang.Boolean recordMarkedAsRemoved(int rowNum)
markRecordRemoved()rowNum - index of row to verifyEditing overview and related methodspublic void redrawHeader(boolean rightNow)
grid headerrightNow - If true, redraw the grid header with a direct inline call to its redraw() method. Otherwise, mark the header for redrawpublic void refreshCell(int rowNum,
int colNum)
The cell's value, CSS class, and CSS text will be refreshed, to the current values returned by getCellValue(), getCellStyle() and getCellCSSText() respectively.
rowNum - row number of cell to refreshcolNum - column number of cell to refreshrefreshCellStyle(int, int),
Appearance overview and related methods,
Calculated Examplepublic void refreshCellStyle(int rowNum,
int colNum)
The cell's CSS class and CSS text will be refreshed, to the current values returned by getCellStyle() and getCellCSSText() respectively.
The cell's contents (as returned by getCellValue()) will not be refreshed. To refresh both styling and contents, call refreshCell() instead.
rowNum - row number of cell to refreshcolNum - column number of cell to refreshrefreshCell(int, int),
Appearance overview and related methodspublic void refreshData()
invalidateCache this will perform an
asynchronous (background) refresh of this components data and then call the provided callback method on completion.
If refreshData is called while the grid is waiting for a response from fetchData() the refreshData call will be aborted. This is because
the fetch has higher priority.
If fetchData() is called
while the grid is waiting for a response from refreshData and the fetchData call has altered the criteria or sort
specifiers, the refreshData call will be aborted.
If data is being edited or has been edited without being saved
when refreshData is called, the data will be retained so you can save it after the refresh is complete. If you however
want to throw away your edited but unsaved data when calling refreshData you first need to call discardAllEdits() which will discard any unsaved edited data.
In order to use refreshData() this grid needs to have a DataSource associated with
it.
public void refreshData(DSCallback callback)
invalidateCache this will perform an
asynchronous (background) refresh of this components data and then call the provided callback method on completion.
If refreshData is called while the grid is waiting for a response from fetchData() the refreshData call will be aborted. This is because
the fetch has higher priority.
If fetchData() is called
while the grid is waiting for a response from refreshData and the fetchData call has altered the criteria or sort
specifiers, the refreshData call will be aborted.
If data is being edited or has been edited without being saved
when refreshData is called, the data will be retained so you can save it after the refresh is complete. If you however
want to throw away your edited but unsaved data when calling refreshData you first need to call discardAllEdits() which will discard any unsaved edited data.
In order to use refreshData() this grid needs to have a DataSource associated with
it.
callback - callback method to run once the refresh completes.fetchData(),
invalidateCache(),
DataBoundComponentMethods overview and related methodspublic void refreshFields()
ListGridField.showIf() for each field,
dynamically showing and hiding the appropriate set of fieldspublic void refreshRecordComponent(int rowNum)
recordComponent currently
assigned to the specified record (or cell) and gets a fresh one, according to the recordComponentPoolingMode See also invalidateRecordComponents() which allows you to
refresh all record components that are currently visible in the grid.
rowNum - Row to refreshpublic void refreshRecordComponent(int rowNum,
java.lang.Integer colNum)
recordComponent currently
assigned to the specified record (or cell) and gets a fresh one, according to the recordComponentPoolingMode See also invalidateRecordComponents() which allows you to
refresh all record components that are currently visible in the grid.
rowNum - Row to refreshcolNum - Column to refresh. This parameter should be passed if showRecordComponentsByCell is true.public void refreshRow(int rowNum)
The cells' values, CSS classes, and CSS text will be refreshed, to the current values returned by getCellValue(), getCellStyle() and getCellCSSText() respectively.
rowNum - row number of cell to refreshrefreshCellStyle(int, int),
refreshCell(int, int),
Appearance overview and related methodspublic void regroup()
groupBy(java.lang.String...)public void removeData(Record data)
If this grid is bound to a DataSource, it will perform a DataSource "remove" operation to remove records from this component's DataSource.
Otherwise the data will be removed from the grid's
data object.
To make changes to the local data object even
when a DataSource is present, use saveLocally.
data - listGrid record, or primary key values of record to delete.DataBoundComponentMethods overview and related methodspublic void removeData(Record data, DSCallback callback)
public void removeData(Record data, DSCallback callback, DSRequest requestProperties)
If this grid is bound to a DataSource, it will perform a DataSource "remove" operation to remove records from this component's DataSource.
Otherwise the data will be removed from the grid's
data object.
To make changes to the local data object even
when a DataSource is present, use saveLocally.
data - listGrid record, or primary key values of record to delete.callback - method to call on operation completion. Note that if this is method does not trigger a dataSource remove operation,
the callback will still be fired when the data has been removed, but the dsResponse parameter will be
null.requestProperties - additional properties to set on any DSRequest that will be issuedDataBoundComponentMethods overview and related methodspublic void removeEmbeddedComponent(ListGridRecord record)
record parameter, it is assumed to be a component and the record is detected automatically from it. If
destroyOnUnEmbed is true for the component, it will also be destroyed.record - record that the component was previously attached to or the component itselfpublic void removeEmbeddedComponent(ListGridRecord record, java.lang.Integer component)
record parameter, it is assumed to be a component and the record is detected automatically from it. If
destroyOnUnEmbed is true for the component, it will also be destroyed.record - record that the component was previously attached to or the component itselfcomponent - component to unembed, or the colNum in which it appearspublic void removeRecordClick(int rowNum)
canRemoveRecords is true. Default behavior will remove
the record from the data set, or if we're deferring
removal mark record as removed [or for records already marked as removed, clear this removed marker]. If warnOnRemoval is set, this method will also show a warning
dialog to users allowing them to cancel the removal.
This method may be called directly to cause a record to be removed or marked for removal as if the user had hit the "remove" icon.
To be notified when a "remove" click occurs,
developers should add a *
RemoveRecordClickHandler.
rowNum - Row on which the icon was clickedpublic void removeSelectedData()
If no records are selected, no action is taken. The grid will automatically be updated if the record deletion succeeds.
public void removeSelectedData(DSCallback callback)
removeSelectedData()public void removeSelectedData(DSCallback callback, DSRequest requestProperties)
If no records are selected, no action is taken. The grid will automatically be updated if the record deletion succeeds.
callback - callback to fire when the data has been removedrequestProperties - additional properties to set on the DSRequest that will be issuedDataBoundComponentMethods overview and related methods,
Remove Examplepublic void reorderField(int fieldNum,
int moveToPosition)
fieldNum - Number of the field to reordermoveToPosition - New position for that fieldpublic void reorderFields(int start,
int end,
int moveDelta)
start - Start of the range of fields to move, inclusiveend - End of the range of fields to move, non-inclusivemoveDelta - Distance to move bypublic void resizeField(int fieldNum,
int newWidth)
ListGridField.autoFitWidth to false if it was previously
true.fieldNum - Number of the field to resizenewWidth - New width of the fieldpublic void resort()
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.public void rowClick(ListGridRecord record, int recordNum, int fieldNum)
startEditing() if appropriate, and fires ListGridField.recordClick() and/or recordClick() if set. Developers should typically implement
recordClick rather than overriding this method. Note that this method fires in addition to any specified ListGrid.cellClick() handler (even if that method cancels
the event as a whole by returning false).
record - record object returned from getCellRecord()recordNum - index of the row where the click occurredfieldNum - index of the col where the click occurredrecordClick(com.smartgwt.client.widgets.grid.ListGrid, com.smartgwt.client.widgets.grid.ListGridRecord, int, com.smartgwt.client.widgets.grid.ListGridField, int, java.lang.Object, java.lang.Object)public void rowClick(ListGridRecord record, int recordNum, int fieldNum, boolean keyboardGenerated)
startEditing() if appropriate, and fires ListGridField.recordClick() and/or recordClick() if set. Developers should typically implement
recordClick rather than overriding this method. Note that this method fires in addition to any specified ListGrid.cellClick() handler (even if that method cancels
the event as a whole by returning false).
record - record object returned from getCellRecord()recordNum - index of the row where the click occurredfieldNum - index of the col where the click occurredkeyboardGenerated - indicates whether this was a synthesized record click in response to a
keyboard eventrecordClick(com.smartgwt.client.widgets.grid.ListGrid, com.smartgwt.client.widgets.grid.ListGridRecord, int, com.smartgwt.client.widgets.grid.ListGridField, int, java.lang.Object, java.lang.Object)public com.google.gwt.event.shared.HandlerRegistration addRowContextClickHandler(RowContextClickHandler handler)
Called when a row receives a contextclick event.
addRowContextClickHandler in interface HasRowContextClickHandlershandler - the rowContextClick handlerHandlerRegistration used to remove this handlerpublic void rowDoubleClick(ListGridRecord record, int recordNum, int fieldNum)
Default implementation fires 'editCell' if appropriate, and handles firing 'recordDoubleClick' stringMethod if defined at the field or LG level (That method has a different signature from this one)
record - record object returned from getCellRecord()recordNum - index of the row where the click occurredfieldNum - index of the col where the click occurredRecordDoubleClickEventpublic void rowDoubleClick(ListGridRecord record, int recordNum, int fieldNum, boolean keyboardGenerated)
Default implementation fires 'editCell' if appropriate, and handles firing 'recordDoubleClick' stringMethod if defined at the field or LG level (That method has a different signature from this one)
record - record object returned from getCellRecord()recordNum - index of the row where the click occurredfieldNum - index of the col where the click occurredkeyboardGenerated - indicates whether this was a synthesized record doubleclick in response to
a keyboard eventRecordDoubleClickEventpublic com.google.gwt.event.shared.HandlerRegistration addRowEditorEnterHandler(RowEditorEnterHandler handler)
Callback fired when the user starts editing a new row.
addRowEditorEnterHandler in interface HasRowEditorEnterHandlershandler - the rowEditorEnter handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRowEditorExitHandler(RowEditorExitHandler handler)
Callback fired when the user attempts to navigate away from the current edit row, or complete the current edit.
Call
RowEditorExitEvent.cancel() from within RowEditorExitHandler.onRowEditorExit(com.smartgwt.client.widgets.grid.events.RowEditorExitEvent) from this method to cancel the default
behavior (Saving / cancelling the current edit / moving to the next edit cell).
addRowEditorExitHandler in interface HasRowEditorExitHandlershandler - the rowEditorExit handlerHandlerRegistration used to remove this handlerpublic java.lang.Boolean rowHasChanges(int rowNum)
Note this method will not return true if a record has been marked
as removed, but has no other changes. Developers can
use recordMarkedAsRemoved() to check for this
case.
rowNum - index of row to check for changesEditing overview and related methodspublic java.lang.Boolean rowHasErrors(int rowNum)
rowNum - rowNum to check for errorshasErrors(),
cellHasErrors(int, java.lang.String),
GridValidation overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addRowHoverHandler(RowHoverHandler handler)
Called when the mouse hovers over a row if this.canHover is true. Returning false will suppress the hover text from being shown if this.showHover is true.
addRowHoverHandler in interface HasRowHoverHandlershandler - the rowHover handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRowMouseDownHandler(RowMouseDownHandler handler)
Called when a row receives a mousedown event.
addRowMouseDownHandler in interface HasRowMouseDownHandlershandler - the rowMouseDown handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRowMouseUpHandler(RowMouseUpHandler handler)
Called when a row receives a mouseup event.
addRowMouseUpHandler in interface HasRowMouseUpHandlershandler - the rowMouseUp handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRowOutHandler(RowOutHandler handler)
Called when the mouse pointer leaves a row
addRowOutHandler in interface HasRowOutHandlershandler - the rowOut handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRowOverHandler(RowOverHandler handler)
Called when the mouse pointer enters a row
addRowOverHandler in interface HasRowOverHandlershandler - the rowOver handlerHandlerRegistration used to remove this handlerpublic void saveEdits()
This method can be called to manually trigger saves if the default mechanisms of cell by cell or row by row saving are not suitable.
The 'callback' parameter provides a notification when the save attempt completes, which is likely to be asynchronous for databound grids. Cases under which the callback will fire are:
Other, standard callbacks such as ListGrid.editComplete(), ListGrid.editFailed() and ListGrid.cellSaved() will fire normally.
Note this method does not hide the inline editors if they are showing - to explicitly save and end editing, use the method 'endEditing()'
If this method is called for a row which has been marked for deletion (see markRecordRemoved()) it will cause the record to be removed
from the data-set.
endEditing(),
Editing overview and related methodspublic void saveEdits(EditCompletionEvent editCompletionEvent)
saveEdits()public void saveEdits(EditCompletionEvent editCompletionEvent, java.lang.String callback)
saveEdits()public void saveEdits(EditCompletionEvent editCompletionEvent, java.lang.String callback, int rowNum)
This method can be called to manually trigger saves if the default mechanisms of cell by cell or row by row saving are not suitable.
The 'callback' parameter provides a notification when the save attempt completes, which is likely to be asynchronous for databound grids. Cases under which the callback will fire are:
Other, standard callbacks such as ListGrid.editComplete(), ListGrid.editFailed() and ListGrid.cellSaved() will fire normally.
Note this method does not hide the inline editors if they are showing - to explicitly save and end editing, use the method 'endEditing()'
If this method is called for a row which has been marked for deletion (see markRecordRemoved()) it will cause the record to be removed
from the data-set.
editCompletionEvent - Event used to complete cell editing. Optional, and defaults to "programmatic". Can be used by the
callback method to perform custom actions such as navigation when the save completes.callback - Callback to fire on completion of the saving process. If no edits were made or
client-side validation fails the callback will be fired synchronously at the end of
this method."programmatic") CallbackrowNum - Which row should be saved. If unspecified the current edit row is saved by default. Note that
if there is no current edit row this method will no op.endEditing(),
Editing overview and related methodspublic void scrollToCell(int rowNum,
int colNum)
This method has no effect if the cell is already visible in the viewport.
When scrolling vertically, this will cause data
to be automatically loaded if paging is active and
you scroll into an area of the data that isn't loaded. Only rows around the target row will be loaded, not all
intervening rows. See also ResultSet.
Scrolling into an undrawn area will cause
the body area of the grid to redraw, but this won't happen synchronously unless you explicitly call redraw(). Scrolling
into an area of the data that is not yet loaded will never synchronously draw new rows, even if you call redraw() - wait
for ListGrid.dataArrived() to be notified when
new rows have been loaded.
Calling this method with a row index larger than the current dataset will clamp to the end of the dataset (similarly horizontal scrolling will clamp to the last column).
If a call to this method is made
while data is still loading, such that the last row of the dataset is not yet known the grid will attempt to compensate
by scrolling the record into view when data arrives, if it is valid. For better control over scrolling, developers
should consider calling scrollToRow() or scrollToCell from ListGrid.dataArrived() if data is still loading.
With mixed-height rows it will only reliably work if virtualScrolling is enabled.
rowNum - Row index of the cell to scroll into viewcolNum - Column index of the cell to scroll into viewScrolling overview and related methodspublic void scrollToCell(int rowNum,
int colNum,
Alignment xPosition)
scrollToCell(int, int)public void scrollToCell(int rowNum,
int colNum,
Alignment xPosition,
VerticalAlignment yPosition)
This method has no effect if the cell is already visible in the viewport.
When scrolling vertically, this will cause data
to be automatically loaded if paging is active and
you scroll into an area of the data that isn't loaded. Only rows around the target row will be loaded, not all
intervening rows. See also ResultSet.
Scrolling into an undrawn area will cause
the body area of the grid to redraw, but this won't happen synchronously unless you explicitly call redraw(). Scrolling
into an area of the data that is not yet loaded will never synchronously draw new rows, even if you call redraw() - wait
for ListGrid.dataArrived() to be notified when
new rows have been loaded.
Calling this method with a row index larger than the current dataset will clamp to the end of the dataset (similarly horizontal scrolling will clamp to the last column).
If a call to this method is made
while data is still loading, such that the last row of the dataset is not yet known the grid will attempt to compensate
by scrolling the record into view when data arrives, if it is valid. For better control over scrolling, developers
should consider calling scrollToRow() or scrollToCell from ListGrid.dataArrived() if data is still loading.
With mixed-height rows it will only reliably work if virtualScrolling is enabled.
rowNum - Row index of the cell to scroll into viewcolNum - Column index of the cell to scroll into viewxPosition - Horizontal position of scrolled cell (optional)yPosition - Vertical position of scrolled cell (optional)Scrolling overview and related methodspublic void scrollToColumn(int colNum)
See scrollToCell() for a full description of how this method
interacts with incremental loading and rendering of data.
colNum - Index of the column to scroll into viewScrolling overview and related methodspublic void scrollToColumn(int colNum,
Alignment xPosition)
See scrollToCell() for a full description of how this method
interacts with incremental loading and rendering of data.
colNum - Index of the column to scroll into viewxPosition - Horizontal position of scrolled column (optional)Scrolling overview and related methodspublic void scrollToRow(int rowNum)
See scrollToCell() for a full description of how this
method interacts with incremental loading and rendering of data.
rowNum - Row index of the cell to scroll into viewScrolling overview and related methodspublic void scrollToRow(int rowNum,
VerticalAlignment yPosition)
See scrollToCell() for a full description of how this
method interacts with incremental loading and rendering of data.
rowNum - Row index of the cell to scroll into viewyPosition - Vertical position of scrolled row (optional)Scrolling overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addSelectionChangedHandler(SelectionChangedHandler handler)
Called when (row-based) selection changes within this grid. Note this method fires for each record for which selection is modified - so when a user clicks inside a grid this method will typically fire twice (once for the old record being deselected, and once for the new record being selected).
NOTE: For updating other components based on selections or
triggering selection-oriented events within an application, see the selectionUpdated() event which is likely more suitable.
Calls to getSelection() from within this event may not
return a valid set of selected records if the event has been triggered by a call to selectAllRecords() or deselectAllRecords() - in this case use the selectionUpdated() event instead.
addSelectionChangedHandler in interface HasSelectionChangedHandlershandler - the selectionChanged handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addSelectionUpdatedHandler(SelectionUpdatedHandler handler)
Called when the selection changes. Note that this method fires exactly once for any given change to the selection unlike
the selectionChanged event.
This event is fired once after selection/deselection has completed. The result is one event per mouse-down event. For a drag selection there will be two events fired: one when the first record is selected and one when the range is completed.
This event is also fired when selection is updated by a direct call to one of the DataBoundComponent
select/deselect methods. Calls on the Selection object do not trigger this event.
addSelectionUpdatedHandler in interface HasSelectionUpdatedHandlershandler - the selectionUpdated handlerHandlerRegistration used to remove this handlerpublic void selectRange(int startRow,
int endRow)
startRow - start of selection rangeendRow - end of selection range (non-inclusive)Selection overview and related methodspublic void selectRange(int startRow,
int endRow,
boolean newState)
startRow - start of selection rangeendRow - end of selection range (non-inclusive)newState - new selection state (if null, defaults to true)Selection overview and related methodspublic void setAutoFitWidth(java.lang.String fieldName,
boolean autoFit)
ListGridField.autoFitWidth. Enables or
disables dynamic autoFitWidth behavior on the specified field. Note if the field is currently autoFitWidth:true, and
this method is disabling autoFit, the field will not be resized by default - if you wish to resize to an explicit width,
use resizeField().fieldName - field to auto-fitautoFit - Should autoFitWidth be enabled or disabled?public void setDontAutoDestroyComponent(Canvas component, boolean dontAutoDestroy)
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). This method may be used to suppress this behavior for some component. Typical usage might call this method
as part of createRecordComponent() to suppress
this behavior.component - component in question.dontAutoDestroy - If true, the component will not be destroyed automatically when the grid is destroyedpublic void setEditValues(int rowNum,
java.util.Map values)
rowNum - Row number for the record being editedvalues - New values for the rowpublic void setFieldButtonProperties(java.lang.String name,
Canvas properties)
name - Field to updateproperties - new properties to apply to the header buttonpublic void setFieldCellIcon(java.lang.String fieldName,
java.lang.String cellIcon)
ListGridField.cellIcon for a field after
the grid is createdfieldName - field to updatecellIcon - new cellIcon for the field. See SCImgURLpublic void setFieldError(int rowNum,
java.lang.String fieldName,
java.lang.String errorMessage)
rowNum - row index of cell to add validation error forfieldName - col index or field name of cell to add validation error forerrorMessage - validation error/errors for the cell.getCellErrors(int, java.lang.String),
setRowErrors(int, java.lang.Object),
GridValidation overview and related methodspublic void setFieldHeaderBaseStyle(java.lang.String name,
java.lang.String newStyle)
ListGridField.headerBaseStyle for a
field within the grid at runtime.name - name of the field.newStyle - new baseStyle for the field header. See CSSClasspublic void setFieldHeaderTitleStyle(java.lang.String name,
java.lang.String newStyle)
ListGridField.headerTitleStyle for
a field within the grid at runtime.name - name of the field.newStyle - new titleTyle for the field header. See CSSClasspublic void setFieldIcon(java.lang.String fieldName,
java.lang.String icon)
ListGridField.icon for a field after the grid
is createdfieldName - field to updateicon - icon for the field. See SCImgURLpublic void setFieldProperties(int fieldNum,
ListGridField properties)
ListGridField should
contain just the minimal properties you want to change; do not take the original ListGridField, modify it, and just pass
that to this function. NOTE: Where explicit setters exist for field properties (such as resizeField(), setFieldTitle(), setFieldIcon(), etc.) these should be used instead.
fieldNum - name of the field, or index.properties - properties to apply to the headerpublic void setFieldProperties(java.lang.String fieldNum,
ListGridField properties)
ListGridField should
contain just the minimal properties you want to change; do not take the original ListGridField, modify it, and just pass
that to this function. NOTE: Where explicit setters exist for field properties (such as resizeField(), setFieldTitle(), setFieldIcon(), etc.) these should be used instead.
fieldNum - name of the field, or index.properties - properties to apply to the headerpublic void setFieldTitle(int fieldNum,
java.lang.String title)
fieldNum - name of the field, or index.title - new titlepublic void setFieldTitle(java.lang.String fieldNum,
java.lang.String title)
fieldNum - name of the field, or index.title - new titlepublic void setFilterEditorCriteria(Criteria criteria)
showFilterEditor is true, this method will
update the criteria shown in the filterEditor without performing a filter.criteria - New criteria to showpublic void setHeaderSpanBaseStyle(java.lang.String name,
java.lang.String newStyle)
HeaderSpan.headerBaseStyle for a span
within the grid at runtime.name - name of the headerSpan, as specified via HeaderSpan.name.newStyle - new baseStyle for the headerSpan. See CSSClasspublic void setHeaderSpanButtonProperties(java.lang.String name,
Canvas properties)
name - name of span to updateproperties - new properties to apply to the header buttonpublic void setHeaderSpanHeaderTitle(java.lang.String name,
java.lang.String newTitle)
headerSpan dynamically.name - name of the headerSpan, as specified via HeaderSpan.name.newTitle - new headerTitle for the headerSpanpublic void setHeaderSpanTitle(java.lang.String name,
java.lang.String newTitle)
headerSpan dynamically.name - name of the headerSpan, as specified via HeaderSpan.name.newTitle - new title for the headerSpanpublic void setHeaderSpanTitleStyle(java.lang.String name,
java.lang.String newTitle)
HeaderSpan.headerTitleStyle for a
span within the grid at runtime.name - name of the headerSpan, as specified via HeaderSpan.name.newTitle - new titleStyle for the headerSpan. See CSSClasspublic void setRowErrors(int rowNum,
java.lang.Object errors)
Note that in the case of a
grouped listGrid, or a TreeGrid, some records may be hidden form view (part of a collapsed group or parent
folder). In this case there is no meaningful row number associated with a record. This method cannot be called on such
rows - developers should make the row visible first. This is by design - users should always be able to see errors.
rowNum - row to add validation error forerrors - validation errors for the row in the format {fieldName:errorMessage, ...} {fieldName:[errorMessage1, errorMessage2], ...}getRowErrors(int),
setFieldError(int, java.lang.String, java.lang.String),
GridValidation overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addSetSortHandler(SetSortHandler handler)
Optional notification fired when either user or framework code calls
setSort(). This notification fires before the default
behavior;
use event.cancel() to cancel the default behavior. Note,
the notification is fired before the default functionality, but after prechecks
have completed; your method will only be called if the default behavior would have been
called. For example, if there are pending edits and the user does not confirm that these
should be saved, normal sorting would not have gone ahead, so equally your handler will
not be called.
The default setSort() method does two things to reflect the set of
sortSpecifiers passed to it:
setSortHandler() is to inhibit or
replace one of those behaviors, you should cancel the default behavior and directly invoke
just that part of it you require. The following implementation will replicate the default
behavior:
grid.addSetSortHander(new SetSortHandler() {
public void onSetSort(SetSortEvent event) {
displaySort(event.getSortSpecifiers());
applySortToData(event.getSortSpecifiers());
event.cancel(); // Prevent the framework from running its own default impl
}
});addSetSortHandler in interface HasSetSortHandlershandler - the setSort handlerHandlerRegistration used to remove this handlerpublic void setUserFormula(ListGridField field)
Known component dependencies are:
field - field owning the userFormulaListGridField.getUserFormula()public void setUserFormula(java.lang.String field)
Known component dependencies are:
field - field owning the userFormulaListGridField.getUserFormula()public void setUserFormula(ListGridField field, UserFormula userFormula)
Known component dependencies are:
field - field owning the userFormulauserFormula - optional formula to installListGridField.getUserFormula()public void setUserFormulaText(ListGridField field)
Known component dependencies are:
field - field owning the userFormulaListGridField.getUserFormula()public void setUserFormulaText(java.lang.String field)
Known component dependencies are:
field - field owning the userFormulaListGridField.getUserFormula()public void setUserFormulaText(ListGridField field, java.lang.String text)
Known component dependencies are:
field - field owning the userFormulatext - optional formula text to installListGridField.getUserFormula()public void setUserSummary(ListGridField field)
Known component dependencies are:
field - field owning the userSummaryListGridField.getUserSummary()public void setUserSummary(java.lang.String field)
Known component dependencies are:
field - field owning the userSummaryListGridField.getUserSummary()public void setUserSummary(ListGridField field, UserSummary userSummary)
Known component dependencies are:
field - field owning the userSummaryuserSummary - optional summary to installListGridField.getUserSummary()public void setUserSummaryText(ListGridField field)
Known component dependencies are:
field - field owning the userSummaryListGridField.getUserSummary()public void setUserSummaryText(java.lang.String field)
Known component dependencies are:
field - field owning the userSummaryListGridField.getUserSummary()public void setUserSummaryText(ListGridField field, java.lang.String text)
Known component dependencies are:
field - field owning the userSummarytext - optional summary text to installListGridField.getUserSummary()public boolean shouldIncludeHiliteInSummaryField(java.lang.String summaryFieldName,
java.lang.String usedFieldName)
summary field, if
a referenced field is hilited, should the hilite HTML be included in the summary field value? Example use case: Consider a grid containing a numeric field, and a summary field which contains some string value, plus the contents of the numeric field. If a hilite is defined for the grid which turns the numeric field text red when the value is negative, this property will govern whether the number will also be rendered in red within the summary field cells. Any other text in the summary field cells would not be effected by this hilite.
Default implementation returns includeHilitesInSummaryFields.
To
control hilites showing in group summaries, see showHilitesInGroupSummary.
summaryFieldName - name of the summary fieldusedFieldName - name of the field referenced by this summarypublic void showField(java.lang.String field)
Note: for showing multiple fields it is more efficient to call
showFields() than to call this method repeatedly.
field - field to showpublic void showField(java.lang.String field,
boolean suppressRelayout)
Note: for showing multiple fields it is more efficient to call
showFields() than to call this method repeatedly.
field - field to showsuppressRelayout - If passed, don't resize non-explicitly sized columns to fill the available space.public void showFields(java.lang.String... field)
Note: for showing multiple fields it is more
efficient to call this method than to call showField()
repeatedly.
field - Fields to show.public void showFields(ListGridField... field)
Note: for showing multiple fields it is more
efficient to call this method than to call showField()
repeatedly.
field - Fields to show.public void showFields(java.lang.String[] field,
boolean suppressRelayout)
Note: for showing multiple fields it is more
efficient to call this method than to call showField()
repeatedly.
field - Fields to show.suppressRelayout - If passed, don't resize non-explicitly sized columns to fill the available space.public java.lang.Boolean sort()
If
sortField is not provided and listGrid.sortField is undefined, the data will be sorted by the first sortable column
according to ListGridField.sortDirection if
specified, or sortDirection.
ListGrids also
support multiple-field sorting. See setSort() for details.
Note that for editable grids, sorting is performed by underlying data values, not for unsaved pending edit values.
SortDirectionpublic java.lang.Boolean sort(java.lang.String sortField)
sort()public java.lang.Boolean sort(java.lang.String sortField,
SortDirection sortDirection)
If
sortField is not provided and listGrid.sortField is undefined, the data will be sorted by the first sortable column
according to ListGridField.sortDirection if
specified, or sortDirection.
ListGrids also
support multiple-field sorting. See setSort() for details.
Note that for editable grids, sorting is performed by underlying data values, not for unsaved pending edit values.
sortField - the field name or column number to sort bysortDirection - the direction to sort inSortDirectionpublic com.google.gwt.event.shared.HandlerRegistration addSortChangedHandler(SortChangedHandler handler)
Notification method executed when the sort specifiers change
for this grid.
addSortChangedHandler in interface HasSortChangedHandlershandler - the sortChanged handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addSorterClickHandler(SorterClickHandler handler)
Notification method fired when the user clicks on the corner sort button. Call SorterClickEvent.cancel() from within SorterClickHandler.onSorterClick(com.smartgwt.client.widgets.grid.events.SorterClickEvent) to suppress the sort.
addSorterClickHandler in interface HasSorterClickHandlershandler - the sorterClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addSorterContextClickHandler(SorterContextClickHandler handler)
Notification method fired when the user right-clicks on the corner sort button. Call SorterContextClickEvent.cancel() from within SorterContextClickHandler.onSorterContextClick(com.smartgwt.client.widgets.grid.events.SorterContextClickEvent) to suppress the default behavior
of showing the sorter's context menu.
addSorterContextClickHandler in interface HasSorterContextClickHandlershandler - the sorterContextClick handlerHandlerRegistration used to remove this handlerpublic java.lang.Boolean startEditing()
Invoked when a cell is editable and the editEvent
occurs on that cell. Can also be invoked explicitly.
If this method is called while editing is already in progress,
the value from the current editCell will either be stored locally as a temporary edit value, or saved via 'saveEdits()'
depending on this.saveByCell, and the position of the new edit cell.
Will update the UI to show the
editor for the new cell, and put focus in it unless explicitly suppressed by the optional suppressFocus
parameter.
canEditCell(int, int),
getEditEvent(),
Editing overview and related methodspublic java.lang.Boolean startEditing(java.lang.Integer rowNum)
startEditing()public java.lang.Boolean startEditing(java.lang.Integer rowNum,
java.lang.Integer colNum)
startEditing()public java.lang.Boolean startEditing(java.lang.Integer rowNum,
java.lang.Integer colNum,
java.lang.Boolean suppressFocus)
Invoked when a cell is editable and the editEvent
occurs on that cell. Can also be invoked explicitly.
If this method is called while editing is already in progress,
the value from the current editCell will either be stored locally as a temporary edit value, or saved via 'saveEdits()'
depending on this.saveByCell, and the position of the new edit cell.
Will update the UI to show the
editor for the new cell, and put focus in it unless explicitly suppressed by the optional suppressFocus
parameter.
rowNum - Row number of the cell to edit. Defaults to first editable rowcolNum - Column number of the cell to edit. Defaults to first editable columnsuppressFocus - If passed this parameter suppresses the default behavior of focusing in the edit form
item when the editor is shown.canEditCell(int, int),
getEditEvent(),
Editing overview and related methodspublic void startEditingNew()
This new row will be saved
via the "add" DataSource\n operation.
See the Grid Editing overview and also the Editing Unsaved Records overview for context about how unsaved records behave.
You can optionally pass
newValues which are the initial values for the newly added record. See also ListGridField.defaultValue as a means of setting default
values every time the user begins editing a new record, for instance, by pressing downArrow on the last normal record in
the grid when listEndEditAction is "next".
If
editing is already underway elsewhere in the grid, startEditingNew() behaves just like startEditing().
public void startEditingNew(java.util.Map newValues)
startEditingNew()public void startEditingNew(java.util.Map newValues,
java.lang.Boolean suppressFocus)
This new row will be saved
via the "add" DataSource\n operation.
See the Grid Editing overview and also the Editing Unsaved Records overview for context about how unsaved records behave.
You can optionally pass
newValues which are the initial values for the newly added record. See also ListGridField.defaultValue as a means of setting default
values every time the user begins editing a new record, for instance, by pressing downArrow on the last normal record in
the grid when listEndEditAction is "next".
If
editing is already underway elsewhere in the grid, startEditingNew() behaves just like startEditing().
newValues - Optional initial set of properties for the new recordsuppressFocus - Whether to suppress the default behavior of moving focus to the newly shown editor.startEditing(),
Editing overview and related methodspublic void stopHover()
public void summaryUpdated(ListGridField field, UserSummary summary)
field - the summary fieldsummary - the new or updated summary definitionpublic void toggleSort(java.lang.String fieldName)
fieldName - The name of a field, visible, hidden or existing only in the dataSourcepublic void unfreezeField(ListGridField field)
field - field or fields to unfreeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic void unfreezeField(java.lang.Integer field)
field - field or fields to unfreeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic void unfreezeField(java.lang.String field)
field - field or fields to unfreeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic void unfreezeField(java.lang.String[] field)
field - field or fields to unfreeze. fields may be specified as ListGridField objects, field names or colNum.FrozenFields overview and related methodspublic void ungroup()
public void unmarkRecordRemoved(int rowNum)
markRecordRemoved().
Note that a record that is marked for removal and then un-marked retains any uncommitted edits from before it was marked
for removal. These can be discarded with discardEdits().
rowNum - index of record to clear the 'removed'Editing overview and related methodspublic void unsort()
Calling unsort() disables
visual indication of which columns are sorted, and calls unsort() on the underlying dataset.
Note that
a grid viewing a paged dataset may not be able to support unsort() because the sort order is what
establishes the row numbering that allows data to be fetched in batches.
unsort() is automatically
called when records are dropped or the sort-configuration is
altered.
public void updateData(Record updatedRecord)
updatedRecord - updated recordDataBoundComponentMethods overview and related methods,
Databound update Examplepublic void updateData(Record updatedRecord, DSCallback callback)
public void updateData(Record updatedRecord, DSCallback callback, DSRequest requestProperties)
updatedRecord - updated recordcallback - method to call on operation completionrequestProperties - additional properties to set on the DSRequest that will be issuedDataBoundComponentMethods overview and related methods,
Databound update Examplepublic Canvas updateRecordComponent(ListGridRecord record, java.lang.Integer colNum, Canvas component, boolean recordChanged)
showRecordComponents is true, this method
is called to update components created by createRecordComponent() when they are to be applied to a different record in the grid. See the record components overview for more information on
recordComponents. The colNum parameter is applicable only when showRecordComponentsByCell is true. Note that
if poolComponentsPerColumn is set to false,
the component may have been generated by a createRecordComponent() call applied to a different field.
Return null to avoid re-adding the component to the row or cell.
record - record to which the passed component appliescolNum - cell to which the passed component appliescomponent - the component to updaterecordChanged - was the passed component previously embedded in a different record?public void userSelectAllRecords()
selectAllRecords(), if a record is unselectable, this method will not attempt to select it.public java.lang.Boolean validateCell(int rowNum,
java.lang.String fieldName)
validateByCell is true.rowNum - index of row to be validated.fieldName - field name (or column index) of field to be validatedGridValidation overview and related methodspublic java.lang.Boolean validateRow(int rowNum)
Called when the user moves to a new edit row, or when an edited record is to be saved if client side validation is enabled for this grid.
This method may also be called directly to perform row level validation at any time.
rowNum - index of row to be validated.GridValidation overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addViewStateChangedHandler(ViewStateChangedHandler handler)
Notification method executed whenever the viewState of this grid changes. View state is accessible via ListGrid.getViewState(), and contains field state information,
sort information, selection information, hiliting information and grouping information.
addViewStateChangedHandler in interface HasViewStateChangedHandlershandler - the viewStateChanged handlerHandlerRegistration used to remove this handlerpublic java.lang.Boolean willFetchData(Criteria newCriteria)
This is equivalent to calling this.data.willFetchData(...). Always returns true if this
component is not showing a set of data from the dataSource.
Note that to predict correctly the decision that will be
made by filter/fetch, you'll need to pass the same TextMatchStyle that will be used by
the future filter/fetch. Fetching manually (e.g. fetchData()) will by default use "exact" while filtering (e.g. filterData()) will by default use "substring". If the component
is configured for autofetch (i.e. autoFetchData:
true), that will use autoFetchTextMatchStyle, which defaults to "substring". If nothing/null is passed for the style, this method assumes
you want the style from the last filter/fetch.
To determine what TextMatchStyle is
being used, check the RPC Tab of the Smart GWT Developer Console and check
the relevant DSRequest.
newCriteria - new criteria to test.DataBoundComponentMethods overview and related methodspublic java.lang.Boolean willFetchData(Criteria newCriteria, TextMatchStyle textMatchStyle)
This is equivalent to calling this.data.willFetchData(...). Always returns true if this
component is not showing a set of data from the dataSource.
Note that to predict correctly the decision that will be
made by filter/fetch, you'll need to pass the same TextMatchStyle that will be used by
the future filter/fetch. Fetching manually (e.g. fetchData()) will by default use "exact" while filtering (e.g. filterData()) will by default use "substring". If the component
is configured for autofetch (i.e. autoFetchData:
true), that will use autoFetchTextMatchStyle, which defaults to "substring". If nothing/null is passed for the style, this method assumes
you want the style from the last filter/fetch.
To determine what TextMatchStyle is
being used, check the RPC Tab of the Smart GWT Developer Console and check
the relevant DSRequest.
newCriteria - new criteria to test.textMatchStyle - New text match style. If not passed assumes textMatchStyle will not be modified.DataBoundComponentMethods overview and related methodspublic static void setDefaultProperties(ListGrid listGridProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
listGridProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiesprotected void onInit_ListGrid()
protected java.lang.Boolean displayHeaderContextMenu(Canvas target, int[] position)
showHeaderContextMenu is true
this method is fired when the user right-clicks on the header for this grid.ListGrid.getHeaderContextMenuItems for the appropriate column.target - which button in the header received the right-click event (may be the sorter button)position - Optional 2-element array specifying position at which the menu should be shown.
If this is not passed in the menu will be shown at the mouseEvent position (default context menu behavior).getShowHeaderContextMenu(),
GridHeader overview and related methodspublic int getTotalRows()
Note that, when creating new rows via inline editing, this can be more than the total number of rows in the dataset (that is, grid.data.getLength())
Note : this is an override point.
public java.lang.String getValueIcon(ListGridField field, java.lang.Object value, ListGridRecord record)
suppressValueIcon is true
otherwise looks at valueIcons.field - field associated with the cellvalue - data value for the cell's record in this field.record - record associated with this cell
Note : This is an override pointpublic int getRowSpan(ListGridRecord record, int rowNum, int colNum)
When using row spanning, consider setting useRowSpanStyling to enable row-span-sensitive styling
behaviors.
When using row spanning:
ListGrid.getCellStyle or CellFormatter.format(java.lang.Object, com.smartgwt.client.widgets.grid.ListGridRecord, int, int)) will be called only once
per row-spanning cell cell-based
selection, only the spanning cell is considered selected, and not any of the cells spanned through. For example, if
the cell at row 2 column 0 spans 2 cells, isSelected will be true for 2,0 but false for 3,0. getRowSpan() may be called for a rowNum in the middle of a spanning cell, and should return the
remaining span from that rowNum onward. More generally, the ListGrid has a data model of one Record per row, and spanning cells doesn't fit well with this model, meaning that many
ListGrid features are incompatible with rowSpanning.
Note : This is an override point
record - cell record as returned by getCellRecordrowNum - row number for the cellcolNum - column number of the cellpublic com.google.gwt.core.client.JavaScriptObject getRemoveFieldDefaults()
ListGridField
attributes of remove fields.public void removeEmbeddedComponent(Canvas component)
destroyOnUnEmbed is true for the component, it will also be destroyed.component - the embedded componentprotected boolean showRecordComponent(ListGridRecord record, java.lang.Integer colNum)
showRecordComponents is true, return
false from this method to prevent showRecordComponent behavior for the passed record. The second parameter is only
applicable if showRecordComponentsByCell
is true.
record - record being processedcolNum - column index of the cell in which the record component may be shown. Will be null unless showRecordComponentsByCell is
true.protected boolean canSelectRecord(ListGridRecord record)
selectionType is not set to "none",
this method will be called for each record the user attempts to select. If it returns false, the
record will not be selected.
Note this method will not be called at all if canSelectCells is true.
record - the record being selected
Note : this is an override point.public void setHeaderHoverFormatter(HeaderHoverFormatter formatter)
headerHoverHTML(int,java.lang.String).
The HeaderHoverFormatter should return the HTML to display in the hover canvas
that is displayed by default if a registered HeaderHoverHandler
does not cancel a HeaderHoverEvent.
The formatter can return null or an empty string to cancel the hover.
formatter - the header hover formatterpublic void setRowNumberFieldProperties(ListGridField rowNumberFieldProperties)
showRowNumbers is true.
For example you can change the default width of the row number column if you have data that exceeds 4 digits to accommodate the width of, say, 10000.rowNumberFieldProperties - the row number field propertiespublic void setDataProperties(ResultSet resultSetProperties)
ResultSet object created for this grid when data is
fetched.
Note : This is an advanced setting
Class overrides forResultSet cannot be applied to the
grid using this API. Instead, consider setting the
resultSetClass property in
the file defining your DataSource. Your class must be
registered for reflection.dataProperties - Default value is nullDatabinding overview and related methodspublic void setData(Record[] data)
setData(ListGridRecord...)public void setData(RecordList data)
setData(ListGridRecord...)public RecordList getDataAsRecordList()
RecordList. If the component is bound to a DataSource,
the actual type of the RecordList instance will be a ResultSet.public void setRecords(ListGridRecord[] records)
setData(ListGridRecord[])records - the recordspublic ListGridRecord[] getRecords()
getGroupTree()
to get the underlying Tree data representation. You can call isGrouped() to test whether the ListGrid is
grouped on a field.
If this is a DataBound grid this method will return an empty array unless
the entire set of data for the current criteria has been loaded into the
client, in which case all matching rows will be returned.
For DataBound grids, you can call getResultSet() to retrieve
the current data set as a ResultSet object.
public boolean isGrouped()
public void setSortField(int fieldIndex)
fieldIndex - the field indexpublic java.lang.String[] getGroupByFields()
This method returns an array containing the names of the field(s) by which this
grid is grouped (either from setGroupByField(String... field) or
or from a call to groupBy(String...)).
If this grid is not currently grouped, this method will return null.
public void setGroupStartOpen(GroupStartOpen group)
group - the grouppublic void setGroupStartOpen(java.lang.Object... groupValues)
groupValues - Array of values that should be openedpublic void setSelectionCanvasProperties(Canvas selectionCanvasProperties) throws java.lang.IllegalStateException
selectionCanvas AutoChild when
its use is enabled.selectionCanvasProperties - the selectionCanvas propertiesjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetShowSelectionCanvas(Boolean)public void setSelectionUnderCanvasProperties(Canvas selectionUnderCanvasProperties) throws java.lang.IllegalStateException
selectionUnderCanvas AutoChild when
its use is enabled.selectionUnderCanvasProperties - the selectionUnderCanvas propertiesjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetShowSelectionUnderCanvas(Boolean)public void setRollOverCanvasProperties(Canvas rollOverCanvasProperties) throws java.lang.IllegalStateException
rollOverCanvas
AutoChild when its use is enabled.rollOverCanvasProperties - the rollOverCanvas propertiesjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetShowRollOverCanvas(Boolean)public void setRollUnderCanvasProperties(Canvas rollUnderCanvasProperties) throws java.lang.IllegalStateException
rollUnderCanvas
AutoChild when its use is enabled.rollUnderCanvasProperties - the rollUnderCanvas propertiesjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetShowRollUnderCanvas(Boolean)public void setDataSource(DataSource dataSource, ListGridField... fields)
Binding to a DataSource means that the component will use the DataSource to provide default data for its fields.
When binding to a new DataSource, if the component has any existing "fields" or has a dataset, these will be discarded by default, since it is assumed the new DataSource may represent a completely unrelated set of objects. If the old "fields" are still relevant, pass them to setDataSource().
dataSource - fields - public void setDetailDS(DataSource detailDS)
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. This property may also be
specified on a per-record basis - see recordDetailDSProperty
detailDS - detail datasourcepublic void setCheckboxFieldProperties(ListGridField checkboxField)
selectionAppearance is set to "checkbox".
Any properties applied to the ListGridField passed in will be overlaid onto the automatically
generated checkbox field, allowing the developer to customize this field - for example
modifying the appearance for skinning purposes, or setting shouldPrint to
include the field in the print-view of the grid.
checkboxField - properties to apply to the checkbox fieldpublic void scrollBodyTo(java.lang.Integer left,
java.lang.Integer top)
left - the left positiontop - the top positionpublic java.lang.Integer getBodyScrollLeft()
public java.lang.Integer getBodyScrollTop()
public void startEditingNew(Record defaultRecordValue)
startEditing().defaultRecordValue - the default field values for the new recordpublic ListGridField getField(java.lang.String fieldName)
When using fields, the field definition may be a mix of information
derived from fields and dataSource.
fieldName - the field name.public ListGridRecord[] getSelection()
getSelectedRecords() insteadpublic ListGridRecord[] getSelection(boolean excludePartialSelections)
getSelectedRecords(boolean) insteadexcludePartialSelections - when true, partially selected records will not be returned. Otherwise, both fully and partially selected records are returned.public FormItem getEditFormItem(java.lang.Integer field)
editable
ListGrid. This is the automatically generated editor displayed in a cell while editing the grid. Note that this is an advanced method and developers should be aware of the following issues:
incremental rendering columns which are not currently
scrolled into view may be unrendered, in which case they may have no associated edit item until the user scrolls them
into view.ListGrid.setEditValue and the grid will handle updating the value in the live item if necessary. You should not need to
call setValue(); directly on the item and doing so will not always update the edit value for the grid.
field - fieldName or colNum to get the edit item for.public FormItem getEditFormItem(java.lang.String field)
editable
ListGrid. This is the automatically generated editor displayed in a cell while editing the grid. Note that this is an advanced method and developers should be aware of the following issues:
incremental rendering columns which are not currently
scrolled into view may be unrendered, in which case they may have no associated edit item until the user scrolls them
into view.ListGrid.setEditValue and the grid will handle updating the value in the live item if necessary. You should not need to
call setValue(); directly on the item and doing so will not always update the edit value for the grid.
field - fieldName or colNum to get the edit item for.public void openRecordDetailGrid(ListGridRecord record, DataSource detailDataSource)
setCanExpandRecords(Boolean) with setExpansionMode(com.smartgwt.client.types.ExpansionMode), or override getExpansionComponent(ListGridRecord)record - the recorddetailDataSource - the detail data sourcepublic void closeRecord(ListGridRecord record)
setCanExpandRecords(Boolean) with setExpansionMode(com.smartgwt.client.types.ExpansionMode), or override getExpansionComponent(ListGridRecord)record - the recordpublic void openRecordEditor(ListGridRecord record)
setCanExpandRecords(Boolean) with setExpansionMode(com.smartgwt.client.types.ExpansionMode), or override getExpansionComponent(ListGridRecord)record - the recordpublic void groupBy(java.lang.String... fields)
Grouping transforms the current dataset into a Tree on the fly, then provides a familiar tree interface for exploring the grouped data.
Grouping works automatically with any dataset,
providing simple default grouping based on each field's declared type. However, you can use the com.smartgwt.client.widgets.grid.ListGridField#getGroupValue API to control how records are grouped, and the
com.smartgwt.client.widgets.grid.ListGridField#getGroupTitle API to control how groups are titled.
Grouping can be performed programmatically via this API, or you can set canGroupBy to enable menus that allow the user to
performing grouping. To group a grid automatically, instantiate the grid with a groupByField setting.
While grouped, the
automatically created Tree is available as groupTree and the original dataset is available as originalData.
public java.lang.Boolean sort(int sortCol,
SortDirection sortDirection)
sortCol - the column number to sort bysortDirection - the direction to sort insort()public boolean saveAllEdits()
public boolean saveAllEdits(Function callback)
callback - this callback will be fired on a successful save. Note that if there are no pending edits to be saved this
callback will not fire - you can check for this condition using hasChanges() or #rowHasChanges().
Use addEditFailedHandler(EditFailedHandler) to find out about failures encountered during saving (on a per-row basis).public boolean saveAllEdits(Function callback, int[] rows)
callback - this callback will be fired on a successful save of the specified rows. Note that if there are no pending edits to be saved this
callback will not fire - you can check for this condition using hasChanges() or #rowHasChanges().
Use addEditFailedHandler(EditFailedHandler) to find out about failures encountered during saving (on a per-row basis).rows - specify which rows to savepublic void freezeFields(int[] colNums)
#freezeField(int)public void freezeFields(java.lang.String[] fieldNames)
freezeField(String)public void unfreezeFields(int[] colNums)
#unfreezeField(int)public void unfreezeFields(java.lang.String[] fieldNames)
unfreezeField(String)public void refreshCell(int rowNum,
int colNum,
boolean refreshingRow,
boolean allowEditCellRefresh)
The cell's value, CSS class, and CSS text will be refreshed, to the current values returned by getCellValue(), getCellStyle() and getCellCSSText() respectively.
rowNum - row number of cell to refreshcolNum - column number of cell to refreshpublic java.lang.Integer[] getVisibleRows()
public java.lang.Integer[] getDrawnRows()
The drawn rows differ from the getVisibleRows() because of drawAheadRatio. The drawn rows are the apppropriate range to consider if you need to, eg, using refreshCell(int, int) to update all the cells in a column.
If the grid is undrawn or the emptyMessage is currently shown, returns [null,null];
public void fetchRelatedData(Record record, DataSource dataSource)
record - the DataSource recorddataSource - the schema of the DataSource recordfetchRelatedData(ListGridRecord,Canvas)public void fetchRelatedData(Record record, DataSource dataSource, DSCallback callback, DSRequest requestProperties)
record - the DataSource recorddataSource - the schema of the DataSource recordcallback - callback to invoke on completionrequestProperties - additional properties to set on the DSRequest that will be issuedfetchRelatedData(ListGridRecord,Canvas)public GridRenderer getBody()
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.public GridRenderer getGridRenderer()
getBody().public java.lang.Object getEditedCell(int rowNum,
java.lang.String fieldName)
getEditedCell(int, int)public java.lang.Object getEditedCell(Record record, java.lang.String fieldName)
getEditedCell(int, int)public java.lang.Object getEditedCell(Record record, int colNum)
getEditedCell(int, int)public Record getEditedRecord(int rowNum)
The returned value is never null, and can be freely modified.
rowNum - the row numpublic void setEditValue(int rowNum,
int colNum,
java.lang.Object value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
java.lang.String value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
java.util.Date value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
double value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
boolean value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
java.lang.Boolean value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
float value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
int value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
java.lang.Integer value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
Record value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
Record[] value)
rowNum - row numbercolNum - column number of cellvalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
int colNum,
com.google.gwt.core.client.JavaScriptObject value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.String value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
java.util.Date value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
double value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
boolean value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.Boolean value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
float value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
int value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.Integer value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
Record value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
Record[] value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
com.google.gwt.core.client.JavaScriptObject value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic void setEditValue(int rowNum,
java.lang.String fieldName,
java.lang.Object value)
rowNum - row numberfieldName - the field namevalue - new value for the appropriate fieldpublic java.lang.Object getEditValue(int rowNum,
java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic java.lang.String getEditValueAsString(int rowNum,
java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic java.lang.Integer getEditValueAsInt(int rowNum,
java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic java.lang.Float getEditValueAsFloat(int rowNum,
java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic java.util.Date getEditValueAsDate(int rowNum,
java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic java.lang.Boolean getEditValueAsBoolean(int rowNum,
java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic Record getEditValueAsRecord(int rowNum, java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic Record[] getEditValueAsRecordArray(int rowNum, java.lang.String fieldName)
rowNum - index of the row for which the editValue should be returnedfieldName - field name for which value should be returnedpublic java.util.Map getEditValues(int rowNum)
rowNum - rowNum of the record being editedpublic java.util.Map getEditValues(Record record)
record - an Object containing values for all the record's primary keyspublic void setSort(SortSpecifier... sortSpecifiers)
Pass in an array of SortSpecifiers to have the grid's data sorted by the fields in
each specifier.property and
in the directions specified. The grid can be sorted by any combination of fields,
including fields specified in the fields array, whether visible or hidden, and unused fields from the underlying
dataSource, if there is one.
If multiple fields are sorted, those that are visible show a directional icon and a
small sort-numeral
indicating that field's index in the sort configuration.
If setSort() is called on a ListGrid which doesn't yet have a SmartClient widget, the
widget will not be created; instead, the initial sort for the ListGrid will be set as
if by setInitialSort(com.smartgwt.client.data.SortSpecifier...).
See addSort() and toggleSort() APIs for information
on making changes to the current sort configuration.
sortSpecifiers - Array of SortSpecifier objectspublic void setRowErrors(int rowNum,
java.util.Map errors)
rowNum - row to add validation error forerrors - validation errors for the row. The key of the map must be the field name, and the value can either be a String error message
or an array of Strings for multiple errorspublic void setFieldError(int rowNum,
java.lang.String fieldName,
java.lang.String[] errorMessages)
rowNum - row index of cell to add validation error forfieldName - field name of cell to add validation error forerrorMessages - validation error messages#setFieldError(int, int, String)public void selectSingleRecord(Record record)
Record passed in explicitly, or by index, and deselect everything else. When programmatic selection of records is a requirement and selectionType is "single", use this method rather than selectRecord(com.smartgwt.client.data.Record) to enforce mutually-exclusive record-selection.record - record to selectpublic void selectSingleRecord(int rowNum)
Record passed in explicitly, or by index, and deselect everything else. When programmatic selection of records is a requirement and selectionType is "single", use this method rather than selectRecord(com.smartgwt.client.data.Record) to enforce mutually-exclusive record-selection.rowNum - rowNum (or row number) to selectpublic java.lang.Double getFormulaFieldValue(ListGridField field, Record record)
canAddFormulaFields.
Returns null for a bad formula or where the result is not a valid number.field - field that has a formularecord - record to use to compute formula valuepublic void setCriteria(Criteria criteria)
criteria - new criteria to showpublic java.lang.Boolean validateCell(int rowNum,
int colIndex)
validateByCell is true.rowNum - index of row to be validated.colIndex - column index of field to be validatedpublic java.lang.Boolean cellHasErrors(int rowNum,
int colIndex)
rowNum - index of row to check for validation errorscolIndex - index of column to check for validation errorspublic void clearFieldError(int rowNum,
java.lang.String fieldName)
rowNum - row index of cell to add validation error forfieldName - field name of cell to add validation error forclearFieldError(int, int)public void setValueMap(java.lang.String fieldName,
java.util.LinkedHashMap valueMap)
setEditorValueMap(java.lang.String, java.util.LinkedHashMap)
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap methods which allow further
customization of the valueMap displayed while the field is in edit mode.
fieldName - Name of field to updatevalueMap - ValueMap for the fieldpublic void setValueMap(java.lang.String fieldName,
java.lang.String... valueMap)
setEditorValueMap(java.lang.String, java.util.LinkedHashMap)
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap methods which allow further
customization of the valueMap displayed while the field is in edit mode.
fieldName - Name of field to updatevalueMap - ValueMap for the fieldpublic void setEditorValueMap(java.lang.String fieldName,
java.util.LinkedHashMap valueMap)
fieldName - Name of field to updatevalueMap - ValueMap for the fieldpublic void setEditorValueMap(java.lang.String fieldName,
java.lang.String... valueMap)
fieldName - Name of field to updatevalueMap - ValueMap for the fieldpublic java.lang.Object getDisplayValue(java.lang.String fieldName,
int value)
valueMap
or displayField,
this method will return the display value for any underlying data value.fieldName - Name of the field for which the displayValue is requiredvalue - data value for the fieldpublic java.lang.Object getDisplayValue(java.lang.String fieldName,
float value)
valueMap
or displayField,
this method will return the display value for any underlying data value.fieldName - Name of the field for which the displayValue is requiredvalue - data value for the fieldpublic java.lang.Object getDisplayValue(java.lang.String fieldName,
java.lang.String value)
valueMap
or displayField,
this method will return the display value for any underlying data value.fieldName - Name of the field for which the displayValue is requiredvalue - data value for the fieldpublic java.lang.Object getDisplayValue(java.lang.String fieldName,
boolean value)
valueMap
or displayField,
this method will return the display value for any underlying data value.fieldName - Name of the field for which the displayValue is requiredvalue - data value for the fieldpublic java.lang.Object getDisplayValue(java.lang.String fieldName,
java.util.Date value)
valueMap
or displayField,
this method will return the display value for any underlying data value.fieldName - Name of the field for which the displayValue is requiredvalue - data value for the fieldpublic ListGridRecord[] getGroupSummaryData(Record[] records, GroupNode groupNode)
grouped, and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. This method may return multiple records if more than one summary row per group is desired.
records - the records in the group, for which the summary values are being calculatedgroupNode - object with specified groupValue and groupName for this grouppublic ListGridRecord[] getGroupSummaryData(Record[] records, GroupNode groupNode, java.lang.Boolean recalculate)
grouped, and showGroupSummary is true, this method will return the
group summary data displayed at the end of the group. This method may return multiple records if more than one summary row per group is desired.
records - the records in the group, for which the summary values are being calculatedgroupNode - object with specified groupValue and groupName for this grouprecalculate - if set to false and the node has existing summary data, returns the stored summary data,
rather than recalculatingpublic void clearEditValue(int rowNum,
java.lang.String fieldName)
The saved record value will be displayed in the the appropriate cell instead. Will also discard any validation errors for the specified field / row.
rowNum - the row numberfieldName - name of field for which the value is to be clearedpublic java.lang.Boolean willAcceptDrop()
Canvas.willAcceptDrop() and works as follows:Canvas.willAcceptDrop() (the superclass definition) returns false, this method
always returns false. This allows dragType and dropTypes to be used to configure eligibility for drop. By default,
a ListGrid has no dropTypes configured and so this check will not prevent a drop.canReorderRecords is false, this method returns
false.EventHandler.getDragTarget() is another widget, if canAcceptDroppedRecords is false this method
returns false.getDragData() on the
dragTarget fails to return an record object or an array of records, this method returns false.canAcceptDrop set to false, return false.willAcceptDrop in class Canvaspublic static void preloadImages()
public java.lang.Integer getFieldWidth(java.lang.String fieldName)
ListGrid.fieldName - Name of the field for which the width is to be determined.null if the width can't be determined.public ResultSet getOriginalResultSet()
ResultSet.
Use this method to access the data when the grid is grouped.
Note that this method should only be called after initial data has been fetched by this DataBoundComponent.
fetchData()public RecordList getOriginalRecordList()
RecordList.
If this grid is grouped,
DataBoundComponent.getRecordList() will return the
grouped data as a Tree.
Use this method to return the underlying Array of Records or
ResultSet, as if
the grid was ungrouped:
isGrouped() ? getOriginalRecordList() : getRecordList()
public void setCellFormatter(CellFormatter formatter)
ListGridField.setCellFormatter(com.smartgwt.client.widgets.grid.CellFormatter).formatter - formatter to apply to the cell valuesCellFormatterpublic void setCellValueHoverFormatter(CellValueHoverFormatter formatter)
cellValueHoverHTML(ListGridRecord, int, int, String).
The CellValueHoverFormatter should return the HTML to display in the hover canvas
that is displayed by default if a registered CellValueHoverHandler
does not cancel a CellValueHoverEvent.
The formatter can return null or an empty string to cancel the hover.
formatter - the cell value hover formatterpublic void setDragTrackerIconCustomizer(DragTrackerIconCustomizer dragTrackerIconCustomizer)
dragTrackerIconCustomizer - the dragTrackerIcon customizerpublic void setSortNumeralHTMLCustomizer(SortNumeralHTMLCustomizer customizer)
customizer - the sortNumeralHTML customizerpublic void setDragTrackerTitleCustomizer(DragTrackerTitleCustomizer dragTrackerTitleCustomizer)
Note: Only called if +link{listGrid.dragTrackerMode} is set to "title".
dragTrackerIconCustomizer - the dragTrackerIcon customizerpublic void setHoverCustomizer(HoverCustomizer hoverCustomizer)
hoverCustomizer - the hover customizerListGridField.setHoverCustomizer(HoverCustomizer)public void setEditorCustomizer(ListGridEditorCustomizer customizer)
ListGridField#setEditorType() allows a simpler static customization of FormItem properties
for a specific field.customizer - public void hideFields(ListGridField[] fields, boolean suppressRelayout)
fields - fields to hidesuppressRelayout - if passed, don't relayout non-explicit sized fields to fit the available spacehideFields(String[], boolean)public void showFields(ListGridField[] fields, boolean suppressRelayout)
field - Fields to show.suppressRelayout - If passed, don't resize non-explicitly sized columns to fill the available space.showFields(String[],boolean),
Column order Examplepublic RecordList getSelectedCellData()
If canSelectCells is not enabled, this API always returns null.
public void setFilterEditorProperties(ListGrid filterEditorProperties) throws java.lang.IllegalStateException
setFilterEditorProperties(RecordEditor)filterEditor if showFilterEditor is true.filterEditorProperties - filterEditorProperties Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int[] findNextEditCell(int rowNum,
int colNum,
boolean searchForward,
boolean stepThroughFields,
boolean checkStartingCell)
Note, this is potentially an expensive method. For example, consider a listGrid where
the user can add rows but not edit any existing rows; in this case, canEditCell() would inspect and reject every row
in the dataSet before returning true for the last row. Consider this before making use of this method on grids with large dataSets
rowNum - Index of starting rowcolNum - Index of starting columnsearchForward - true if searching forward for the next edit cell, false if searching backwardsstepThroughFields - true if we should check every field in each row; false if we should check the same field in each rowcheckStartingCell - Should we check whether the starting cell is editable? Pass false to skip the starting cell[rowNum,colNum] for the next editable cell, or null if no editable
cell is found.public void setMultiSortDialogDefaults(MultiSortDialog multiSortDialogDefaults) throws java.lang.IllegalStateException
MultiSortDialog which gets automatically
generated when askForSort.() is called. See also showHeaderSpanTitlesInSortEditor and
sortEditorSpanTitleSeparator
multiSortDialogDefaults - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdSGWTPropertiespublic void setMultiSortDialogProperties(MultiSortDialog multiSortDialogProperties) throws java.lang.IllegalStateException
MultiSortDialog which gets automatically generated when
askForSort.() is called. See also showHeaderSpanTitlesInSortEditor and
sortEditorSpanTitleSeparator
multiSortDialogProperties - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdSGWTPropertiespublic Criteria getCriteria()
Note: if showFilterEditor is true, the criteria returned by this
method may not match the values currently displayed in the filter editor, since the user may have entered values which
have not yet been applied to our data. getFilterEditorCriteria() may be used to retrieve the current criteria displayed in the filterEditor.
DataBoundComponentMethods overview and related methodspublic AdvancedCriteria getFilterEditorCriteriaAsAdvancedCriteria()
getFilterEditorCriteria() but returns an
AdvancedCriteria.public void setDataPageSize(int dataPageSize)
DataBoundComponentdata
paging, how many records to fetch at a time. If set to a positive integer,
dataPageSize will override the default resultSize for ResultSets
automatically created when you call fetchData() (and similarly for
the resultSize of
ResultTrees). The default of 0 means to just use the default page size of the data
container. Note that regardless of the dataPageSize setting,
a component will always fetch all of data that it needs to draw. Settings such as showAllRecords:true, drawAllMaxCells and drawAheadRatio can cause
more rows than the configured dataPageSize to be fetched.
setDataPageSize in interface DataBoundComponentdataPageSize - dataPageSize Default value is 0Databinding overview and related methodspublic int getDataPageSize()
DataBoundComponentdata
paging, how many records to fetch at a time. If set to a positive integer,
dataPageSize will override the default resultSize for ResultSets
automatically created when you call fetchData() (and similarly for
the resultSize of
ResultTrees). The default of 0 means to just use the default page size of the data
container. Note that regardless of the dataPageSize setting,
a component will always fetch all of data that it needs to draw. Settings such as showAllRecords:true, drawAllMaxCells and drawAheadRatio can cause
more rows than the configured dataPageSize to be fetched.
getDataPageSize in interface DataBoundComponentDatabinding overview and related methodspublic void setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
DataBoundComponentfields) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
If component.fields contains fields that are not found in the DataSource,
they will be shown after the most recently referred to DataSource field. If the new
fields appear first, they will be shown first.
setUseAllDataSourceFields in interface DataBoundComponentuseAllDataSourceFields - useAllDataSourceFields Default value is falsepublic java.lang.Boolean getUseAllDataSourceFields()
DataBoundComponentfields) is used, with any fields specified in
component.fields acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
If component.fields contains fields that are not found in the DataSource,
they will be shown after the most recently referred to DataSource field. If the new
fields appear first, they will be shown first.
getUseAllDataSourceFields in interface DataBoundComponentpublic void setShowHiddenFields(java.lang.Boolean showHiddenFields)
DataBoundComponenthidden:true when a DataBoundComponent is given a
DataSource but no component.fields.
The hidden property is used on DataSource fields to mark fields that are
never of meaning to an end user.
setShowHiddenFields in interface DataBoundComponentshowHiddenFields - showHiddenFields Default value is falsepublic java.lang.Boolean getShowHiddenFields()
DataBoundComponenthidden:true when a DataBoundComponent is given a
DataSource but no component.fields.
The hidden property is used on DataSource fields to mark fields that are
never of meaning to an end user.
getShowHiddenFields in interface DataBoundComponentpublic void setShowComplexFields(java.lang.Boolean showComplexFields)
DataBoundComponentcomponent.fields.
If true, the component will show fields that declare a complex type, for example, a field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a DataSource that declares the fields of a shipping address (city, street name, etc).
Such fields may need custom formatters or editors in order to create a usable interface, for example, an Address field in a ListGrid might use a custom formatter to combine the relevant fields of an address into one column, and might use a pop-up dialog for editing.
Note : This is an advanced setting
setShowComplexFields in interface DataBoundComponentshowComplexFields - showComplexFields Default value is truepublic java.lang.Boolean getShowComplexFields()
DataBoundComponentcomponent.fields.
If true, the component will show fields that declare a complex type, for example, a field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a DataSource that declares the fields of a shipping address (city, street name, etc).
Such fields may need custom formatters or editors in order to create a usable interface, for example, an Address field in a ListGrid might use a custom formatter to combine the relevant fields of an address into one column, and might use a pop-up dialog for editing.
getShowComplexFields in interface DataBoundComponentpublic void setFetchOperation(java.lang.String fetchOperation)
DataBoundComponentsetFetchOperation in interface DataBoundComponentfetchOperation - fetchOperation Default value is nullpublic java.lang.String getFetchOperation()
DataBoundComponentgetFetchOperation in interface DataBoundComponentpublic void setUpdateOperation(java.lang.String updateOperation)
DataBoundComponentoperationId this component
should use when performing update operations.setUpdateOperation in interface DataBoundComponentupdateOperation - Default value is nullOperations overview and related methodspublic java.lang.String getUpdateOperation()
DataBoundComponentoperationId this component
should use when performing update operations.getUpdateOperation in interface DataBoundComponentOperations overview and related methodspublic void setAddOperation(java.lang.String addOperation)
DataBoundComponentoperationId this component
should use when performing add operations.setAddOperation in interface DataBoundComponentaddOperation - Default value is nullOperations overview and related methodspublic java.lang.String getAddOperation()
DataBoundComponentoperationId this component
should use when performing add operations.getAddOperation in interface DataBoundComponentOperations overview and related methodspublic void setRemoveOperation(java.lang.String removeOperation)
DataBoundComponentoperationId this component
should use when performing remove operations.setRemoveOperation in interface DataBoundComponentremoveOperation - Default value is nullOperations overview and related methodspublic java.lang.String getRemoveOperation()
DataBoundComponentoperationId this component
should use when performing remove operations.getRemoveOperation in interface DataBoundComponentOperations overview and related methodspublic void setExportFields(java.lang.String[] exportFields)
DataBoundComponentIf exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.
setExportFields in interface DataBoundComponentexportFields - exportFields Default value is nullpublic java.lang.String[] getExportFields()
DataBoundComponentIf exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.
getExportFields in interface DataBoundComponentpublic void setExportAll(java.lang.Boolean exportAll)
DataBoundComponentfields.
If exportAll is false, an export operation will first consider
exportFields, if it's set, and fall back on all visible fields from
fields otherwise.
setExportAll in interface DataBoundComponentexportAll - exportAll Default value is falsepublic java.lang.Boolean getExportAll()
DataBoundComponentfields.
If exportAll is false, an export operation will first consider
exportFields, if it's set, and fall back on all visible fields from
fields otherwise.
getExportAll in interface DataBoundComponentpublic void setPreventDuplicates(java.lang.Boolean preventDuplicates)
throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
When a duplicate transfer is detected,
a dialog will appear showing the duplicateDragMessage.
If the component either does not have a DataSource or has a DataSource with no
primaryKey
declared, duplicate checking is off by
default. If duplicate checking is enabled, it looks for an existing record in the dataset
that has all of the
properties of the dragged record, and considers that a duplicate.
For DragDataAction:"copy" where the target DataSource is related to the source
DataSource by foreignKey, a duplicate means that
the target list, as filtered by the current
criteria, already has a record whose value for the foreignKey field matches the
primaryKey of the record being
transferred.
For example, consider dragging "employees" to "teams", where "teams" has a field "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target grid has search criteria causing it to show all the members of one team. A duplicate - adding an employee to the same team twice - is when the target grid's dataset contains an record with "employeeId" matching the "id" field of the dropped employee.
setPreventDuplicates in interface DataBoundComponentpreventDuplicates - preventDuplicates Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getPreventDuplicates()
DataBoundComponentDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
When a duplicate transfer is detected,
a dialog will appear showing the duplicateDragMessage.
If the component either does not have a DataSource or has a DataSource with no
primaryKey
declared, duplicate checking is off by
default. If duplicate checking is enabled, it looks for an existing record in the dataset
that has all of the
properties of the dragged record, and considers that a duplicate.
For DragDataAction:"copy" where the target DataSource is related to the source
DataSource by foreignKey, a duplicate means that
the target list, as filtered by the current
criteria, already has a record whose value for the foreignKey field matches the
primaryKey of the record being
transferred.
For example, consider dragging "employees" to "teams", where "teams" has a field "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target grid has search criteria causing it to show all the members of one team. A duplicate - adding an employee to the same team twice - is when the target grid's dataset contains an record with "employeeId" matching the "id" field of the dropped employee.
getPreventDuplicates in interface DataBoundComponentpublic void setDuplicateDragMessage(java.lang.String duplicateDragMessage)
throws java.lang.IllegalStateException
DataBoundComponentpreventDuplicates
is enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.setDuplicateDragMessage in interface DataBoundComponentduplicateDragMessage - duplicateDragMessage Default value is "Duplicates not allowed"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getDuplicateDragMessage()
DataBoundComponentpreventDuplicates
is enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.getDuplicateDragMessage in interface DataBoundComponentpublic void setAddDropValues(java.lang.Boolean addDropValues)
DataBoundComponent
If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item
dropped on this grid, and an update performed on the item
setAddDropValues in interface DataBoundComponentaddDropValues - addDropValues Default value is truepublic java.lang.Boolean getAddDropValues()
DataBoundComponent
If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item
dropped on this grid, and an update performed on the item
getAddDropValues in interface DataBoundComponentpublic void setDropValues(java.util.Map dropValues)
DataBoundComponentaddDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
setDropValues in interface DataBoundComponentdropValues - dropValues Default value is nullpublic java.util.Map getDropValues()
DataBoundComponentaddDropValues is true and both the source and
target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that
Smart GWT will apply to the dropped object before updating it.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
getDropValues in interface DataBoundComponentdropValues for more details. If multiple records
are being dropped, this method is called for each of them in turn.
This method returns the following:
addDropValues is falseYou can override this method if you need more complex setting of drop values than can be provided by simply supplying a dropValues object.
public void setProgressiveLoading(java.lang.Boolean progressiveLoading)
progressivelyprogressiveLoading - ProgressiveLoading,
DataSource.setProgressiveLoading(java.lang.Boolean)public java.lang.Boolean getProgressiveLoading()
progressivelyProgressiveLoading,
DataSource.getProgressiveLoading()public void setUseFlatFields(java.lang.Boolean useFlatFields)
throws java.lang.IllegalStateException
DataBoundComponentuseFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
useFlatFields is typically used with imported metadata, such as
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback) from a
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
nesting that aren't meaningful in a user interface, without the cumbersome and fragile
process of mapping form fields to XML structures.
For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message
schema for a web service operation whose input message looks like this:
<FindServices>
<searchFor>search text</searchFor>
<Options>
<caseSensitive>false</caseSensitive>
</Options>
<IncludeInSearch>
<serviceName>true</serviceName>
<documentation>true</documentation>
<keywords>true</keywords>
</IncludeInSearch>
</FindServices>
Setting useFlatFields on a DynamicForm that is bound to this input
message schema would result in 5 FormItem reflecting the 5 simple type
fields in the message.
For this form, the result of DynamicForm.getValues() might look
like:
{
searchFor: "search text",
caseSensitive: false,
serviceName: true,
documentation : true,
keywords : true
}
When contacting a WebService, these values can be automatically
mapped to the structure of the input message for a web service operation by setting
useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields (for use with a DataSource that is
'bound to a WSDL web service' via
wsOperation).
Using these two facilities in conjunction (component.useFlatFields and request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user presentation and when providing the data for XML messages.
You can also set useFlatFields to automatically enable
"flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
particular operationType.
Note that useFlatFields is not generally recommended for use with structures
where multiple simple type fields exist with the same name, however if used with such a
structure, the first field to use a given name wins. "first" means the first field
encountered in a depth first search. "wins" means only the first field will be present as a
field when data binding.
setUseFlatFields in interface DataBoundComponentuseFlatFields - useFlatFields Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseFlatFields()
DataBoundComponentuseFlatFields flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
useFlatFields is typically used with imported metadata, such as
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback) from a
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
nesting that aren't meaningful in a user interface, without the cumbersome and fragile
process of mapping form fields to XML structures.
For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message
schema for a web service operation whose input message looks like this:
<FindServices>
<searchFor>search text</searchFor>
<Options>
<caseSensitive>false</caseSensitive>
</Options>
<IncludeInSearch>
<serviceName>true</serviceName>
<documentation>true</documentation>
<keywords>true</keywords>
</IncludeInSearch>
</FindServices>
Setting useFlatFields on a DynamicForm that is bound to this input
message schema would result in 5 FormItem reflecting the 5 simple type
fields in the message.
For this form, the result of DynamicForm.getValues() might look
like:
{
searchFor: "search text",
caseSensitive: false,
serviceName: true,
documentation : true,
keywords : true
}
When contacting a WebService, these values can be automatically
mapped to the structure of the input message for a web service operation by setting
useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields (for use with a DataSource that is
'bound to a WSDL web service' via
wsOperation).
Using these two facilities in conjunction (component.useFlatFields and request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user presentation and when providing the data for XML messages.
You can also set useFlatFields to automatically enable
"flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
particular operationType.
Note that useFlatFields is not generally recommended for use with structures
where multiple simple type fields exist with the same name, however if used with such a
structure, the first field to use a given name wins. "first" means the first field
encountered in a depth first search. "wins" means only the first field will be present as a
field when data binding.
getUseFlatFields in interface DataBoundComponentpublic void setHiliteProperty(java.lang.String hiliteProperty)
DataBoundComponentid for a hilite defined on this component.setHiliteProperty in interface DataBoundComponenthiliteProperty - hiliteProperty Default value is "_hilite"public java.lang.String getHiliteProperty()
DataBoundComponentid for a hilite defined on this component.getHiliteProperty in interface DataBoundComponentpublic void editFields()
public void editHilites()
editHilites in interface DataBoundComponentpublic java.lang.String getHiliteState()
getHiliteState in interface DataBoundComponentpublic void setHiliteState(java.lang.String hiliteState)
setHiliteState in interface DataBoundComponenthiliteState - hilites state encoded as a Stringpublic void setHilites(Hilite[] hilites)
getHilites for a method of
retrieving the hilite array for storage, including hilites manually added by the user.setHilites in interface DataBoundComponenthilites - array of hilite objectspublic Hilite[] getHilites()
getHilites in interface DataBoundComponentpublic void setDragDataAction(DragDataAction dragDataAction)
DataBoundComponentsetDragDataAction in interface DataBoundComponentdragDataAction - dragDataAction Default value is Canvas.MOVEpublic DragDataAction getDragDataAction()
DataBoundComponentgetDragDataAction in interface DataBoundComponentpublic void setDragTrackerStyle(java.lang.String dragTrackerStyle)
DataBoundComponentsetDragTrackerStyle in interface DataBoundComponentdragTrackerStyle - dragTrackerStyle Default value is "gridDragTracker"public java.lang.String getDragTrackerStyle()
DataBoundComponentgetDragTrackerStyle in interface DataBoundComponentpublic void setCanAddFormulaFields(java.lang.Boolean canAddFormulaFields)
DataBoundComponentcom.smartgwt.client..FormulaBuilder.
User-added formula fields can be persisted via getFieldState() and
setFieldState(java.lang.String).
setCanAddFormulaFields in interface DataBoundComponentcanAddFormulaFields - canAddFormulaFields Default value is falsepublic void addSummaryField()
DataBoundComponentcom.smartgwt.client..SummaryBuilder to create a new Summary Field. This
is equivalent to calling DataBoundComponentGen#editSummaryField with
no parameter.
addSummaryField in interface DataBoundComponentpublic void addFormulaField()
DataBoundComponentcom.smartgwt.client..FormulaBuilder to create a new Formula Field. This
is equivalent to calling DataBoundComponentGen#editFormulaField with
no parameter.
addFormulaField in interface DataBoundComponentpublic java.lang.Boolean getCanAddFormulaFields()
DataBoundComponentcom.smartgwt.client..FormulaBuilder.
User-added formula fields can be persisted via getFieldState() and
setFieldState(java.lang.String).
getCanAddFormulaFields in interface DataBoundComponentpublic void setAddFormulaFieldText(java.lang.String addFormulaFieldText)
DataBoundComponentsetAddFormulaFieldText in interface DataBoundComponentaddFormulaFieldText - addFormulaFieldText Default value is "Add formula column..."public java.lang.String getAddFormulaFieldText()
DataBoundComponentgetAddFormulaFieldText in interface DataBoundComponentpublic void setEditFormulaFieldText(java.lang.String editFormulaFieldText)
DataBoundComponentsetEditFormulaFieldText in interface DataBoundComponenteditFormulaFieldText - editFormulaFieldText Default value is "Edit formula..."public java.lang.String getEditFormulaFieldText()
DataBoundComponentgetEditFormulaFieldText in interface DataBoundComponentpublic void setCanAddSummaryFields(java.lang.Boolean canAddSummaryFields)
DataBoundComponentcom.smartgwt.client..SummaryBuilder.
User-added summary fields can be persisted via getFieldState() and
setFieldState(java.lang.String).
setCanAddSummaryFields in interface DataBoundComponentcanAddSummaryFields - canAddSummaryFields Default value is falsepublic java.lang.Boolean getCanAddSummaryFields()
DataBoundComponentcom.smartgwt.client..SummaryBuilder.
User-added summary fields can be persisted via getFieldState() and
setFieldState(java.lang.String).
getCanAddSummaryFields in interface DataBoundComponentpublic void setAddSummaryFieldText(java.lang.String addSummaryFieldText)
DataBoundComponentsetAddSummaryFieldText in interface DataBoundComponentaddSummaryFieldText - addSummaryFieldText Default value is "Add summary column..."public java.lang.String getAddSummaryFieldText()
DataBoundComponentgetAddSummaryFieldText in interface DataBoundComponentpublic void setEditSummaryFieldText(java.lang.String editSummaryFieldText)
DataBoundComponentsetEditSummaryFieldText in interface DataBoundComponenteditSummaryFieldText - editSummaryFieldText Default value is "Edit summary format..."public java.lang.String getEditSummaryFieldText()
DataBoundComponentgetEditSummaryFieldText in interface DataBoundComponentpublic Record[] findAll(AdvancedCriteria adCriteria)
adCriteria - AdvancedCriteria to use to filter resultspublic Record find(AdvancedCriteria adCriteria)
adCriteria - AdvancedCriteria to use to filter resultspublic int findIndex(AdvancedCriteria adCriteria)
adCriteria - AdvancedCriteria to use to filter resultspublic int findNextIndex(int startIndex,
AdvancedCriteria adCriteria,
int endIndex)
RecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters.startIndex - first index to consideradCriteria - AdvancedCriteria to use to filter resultsendIndex - last index to considerpublic int findNextIndex(int startIndex,
AdvancedCriteria adCriteria)
RecordList.findIndex(java.util.Map), but considering the startIndex parameter.startIndex - first index to consideradCriteria - AdvancedCriteria to use to filter resultspublic void selectRecord(Record record)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectpublic void selectRecord(int record)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectpublic void selectRecord(int record,
boolean newState)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectnewState - new selection state (if null, defaults to true)public void selectRecord(Record record, boolean newState)
DataBoundComponentRecord passed in explicitly, or by index.selectRecord in interface DataBoundComponentrecord - record (or row number) to selectnewState - new selection state (if null, defaults to true)public void selectRecords(int[] records)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectpublic void selectRecords(int[] records,
boolean newState)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectnewState - new selection statepublic void selectRecords(Record[] records)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectpublic void selectRecords(Record[] records, boolean newState)
DataBoundComponentRecords passed in explicitly, or by index.selectRecords in interface DataBoundComponentrecords - records (or row numbers) to selectnewState - new selection state (if null, defaults to true)public void deselectRecord(Record record)
DataBoundComponentRecord passed in explicitly, or by index. Synonym for
selectRecord(record, false)
deselectRecord in interface DataBoundComponentrecord - record (or row number) to deselectpublic void deselectRecord(int record)
DataBoundComponentRecord passed in explicitly, or by index. Synonym for
selectRecord(record, false)
deselectRecord in interface DataBoundComponentrecord - record (or row number) to deselectpublic void deselectRecords(int[] records)
DataBoundComponentRecords passed in explicitly, or by index. Synonym
for selectRecords(records, false)
deselectRecords in interface DataBoundComponentrecords - records (or row numbers) to deselectpublic void deselectRecords(Record[] records)
DataBoundComponentRecords passed in explicitly, or by index. Synonym
for selectRecords(records, false)
deselectRecords in interface DataBoundComponentrecords - records (or row numbers) to deselectpublic void selectAllRecords()
DataBoundComponentselectAllRecords in interface DataBoundComponentpublic void deselectAllRecords()
DataBoundComponentdeselectAllRecords in interface DataBoundComponentpublic java.lang.Boolean anySelected()
DataBoundComponentanySelected in interface DataBoundComponentpublic void enableHilite(java.lang.String hiliteID)
DataBoundComponenthilites
enableHilite in interface DataBoundComponenthiliteID - ID of hilite to enablepublic void enableHilite(java.lang.String hiliteID,
boolean enable)
DataBoundComponenthilites
enableHilite in interface DataBoundComponenthiliteID - ID of hilite to enableenable - new enabled state to apply - if null, defaults to truepublic void disableHilite(java.lang.String hiliteID)
DataBoundComponentdisableHilite in interface DataBoundComponenthiliteID - ID of hilite to disablepublic void enableHiliting()
DataBoundComponentenableHiliting in interface DataBoundComponentpublic void enableHiliting(boolean enable)
DataBoundComponentenableHiliting in interface DataBoundComponentenable - new enabled state to apply - if null, defaults to truepublic void disableHiliting()
DataBoundComponentdisableHiliting in interface DataBoundComponentpublic Record[] getDragData()
DataBoundComponent
This method is consulted by
willAcceptDrop().
getDragData in interface DataBoundComponentRecords that are currently selected.public void transferSelectedData(DataBoundComponent source)
DataBoundComponentDataBoundComponent.getDropValues() for each dropped record.
To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.
Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether
dropped records already exist in the target component. Therefore, it is possible to issue a call to transferSelectedData() and/or the drop()
method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs
them one after the other. If you want to be notified when a transfer process has actually completed, use addDropCompleteHandler.
See the Dragging documentation for an overview of list grid drag/drop data transfer.
transferSelectedData in interface DataBoundComponentsource - source component from which the records will be tranferredpublic void transferSelectedData(DataBoundComponent source, int index)
DataBoundComponentDataBoundComponent.getDropValues() for each dropped record.
To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.
Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether
dropped records already exist in the target component. Therefore, it is possible to issue a call to transferSelectedData() and/or the drop()
method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs
them one after the other. If you want to be notified when a transfer process has actually completed, use addDropCompleteHandler.
See the Dragging documentation for an overview of list grid drag/drop data transfer.
transferSelectedData in interface DataBoundComponentsource - source component from which the records will be transferredindex - target index (drop position) of the rows within this grid.public int getRecordIndex(Record record)
DataBoundComponentOverride in subclasses to provide more specific behaviour, for instance, when data holds a large number of records
getRecordIndex in interface DataBoundComponentrecord - the record whose index is to be retrievedpublic java.lang.String getTitleFieldValue(Record record)
DataBoundComponentOverride in subclasses
getTitleFieldValue in interface DataBoundComponentrecord - the record whose index is to be retrievedpublic void setTitleField(java.lang.String titleField)
DataBoundComponentsetTitleField in interface DataBoundComponentpublic java.lang.String getTitleField()
DataBoundComponenttitleField for databound
components."title",
"name", or "id". If we dont find any field-names that match these
titles, the first field in the component will be used instead.
getTitleField in interface DataBoundComponentpublic DataSource getDataSource()
DataBoundComponentDataSource requests.getDataSource in interface DataBoundComponentpublic void setAutoFetchData(java.lang.Boolean autoFetchData)
throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria
and textMatchStyle may be specified via DataBoundComponent.getAutoFetchTextMatchStyle().
NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be
issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteria and not any other criteria or settings from the first request. Generally, turn off
autoFetchData if you are going to manually call fetchData() at any time.
setAutoFetchData in interface DataBoundComponentautoFetchData - autoFetchDatajava.lang.IllegalStateExceptionpublic java.lang.Boolean getAutoFetchData()
DataBoundComponentDataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on
DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria
and textMatchStyle may be specified via DataBoundComponent.getAutoFetchTextMatchStyle().
NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be
issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteria and not any other criteria or settings from the first request. Generally, turn off
autoFetchData if you are going to manually call fetchData() at any time.
getAutoFetchData in interface DataBoundComponentpublic void setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle) throws java.lang.IllegalStateException
DataBoundComponentautoFetchData is true, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call.setAutoFetchTextMatchStyle in interface DataBoundComponentjava.lang.IllegalStateExceptionpublic TextMatchStyle getAutoFetchTextMatchStyle()
DataBoundComponentautoFetchData is true, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call.getAutoFetchTextMatchStyle in interface DataBoundComponentpublic void setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter)
throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()setAutoFetchAsFilter in interface DataBoundComponentautoFetchAsFilter - autoFetchAsFilterjava.lang.IllegalStateExceptionpublic java.lang.Boolean getAutoFetchAsFilter()
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()getAutoFetchAsFilter in interface DataBoundComponentpublic void setInitialCriteria(Criteria initialCriteria) throws java.lang.IllegalStateException
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is used.setInitialCriteria in interface DataBoundComponentinitialCriteria - the initial criteriajava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic Criteria getInitialCriteria()
DataBoundComponentDataBoundComponent.setAutoFetchData(Boolean) is used.getInitialCriteria in interface DataBoundComponentpublic void fetchData()
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentpublic void fetchData(Criteria criteria)
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object, will be
derived by calling DynamicForm.getValuesAsCriteria()public void fetchData(Criteria criteria, DSCallback callback)
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object, will be
derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires only
if server contact was requiredpublic void fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
DataBoundComponent
When fetchData() is first called, if data has not already been provided via
setData(), this method will create a ResultSet, which will be
configured based on component settings such as fetchOperation and dataPageSize, as well
as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest
to retrieve data from the dataSource, and from then on will
automatically manage paging through large datasets, as well as performing filtering and
sorting operations inside the browser when possible - see the ResultSet docs for
details.
NOTE: do not use both autoFetchData and a
call to fetchData() - this may result in two DSRequests to fetch data. Use
either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData()
passing criteria.
Whether a ResultSet was automatically created or provided via setData(), subsequent
calls to fetchData() will simply call resultSet.setCriteria().
Changes to criteria may or may not result in a DSRequest to the server due to
client-side filtering. You can call
willFetchData(criteria) to determine if new criteria will
result in a server fetch.
If you need to force data to be re-fetched, you can call
invalidateCache() and new data will
automatically be fetched from the server using the current criteria and sort direction. NOTE:
when using invalidateCache() there is no need to also call fetchData()
and in fact this could produce unexpected results.
This method takes an optional callback parameter (set to a DSCallback)
to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed.
In this case the data is updated synchronously, so as soon as this method completes you
can interact with the new data. If necessary, you can use
resultSet.willFetchData() to determine whether or not a server
fetch will occur when fetchData() is called with new criteria.
In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandler to be notified every time data is loaded.
fetchData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object,
will be derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires
only if server contact was requiredrequestProperties - additional properties to set on the DSRequest
that will be issuedpublic void filterData()
DataBoundComponent This
method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentpublic void filterData(Criteria criteria)
DataBoundComponent This
method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object, will be
derived by calling DynamicForm.getValuesAsCriteria()public void filterData(Criteria criteria, DSCallback callback)
DataBoundComponent This
method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object,
will be derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires
only if server contact was required; see
DataBoundComponent.fetchData() for detailspublic void filterData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
DataBoundComponent This
method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData in interface DataBoundComponentcriteria - Search criteria. If a DynamicForm
is passed in as this argument instead of a raw criteria object,
will be derived by calling DynamicForm.getValuesAsCriteria()callback - callback to invoke when a fetch is complete. Fires
only if server contact was required; see
DataBoundComponent.fetchData() for detailsrequestProperties - for databound components only - optional additional
properties to set on the DSRequest that will be issuedpublic void invalidateCache()
DataBoundComponentinvalidateCache() method, for example,
ResultSet.invalidateCache().
NOTE: there is no need to call invalidateCache() when a save operation
is performed on a DataSource. Automatic cache synchronization features will automatically
update caches - see ResultSet for details. If automatic
cache synchronization isn't working, troubleshoot the problem using the steps suggested
in the FAQ rather than just calling invalidateCache(). Calling
invalidateCache() unnecessarily causes extra server load and added code
complexity.
Calling invalidateCache() will automatically cause a new
fetch to be performed with the current set of criteria if data had been previously
fetched and the component is currently drawn with data visible - there is no need to
manually call fetchData() after invalidateCache() and this could result in duplicate
fetches.
While data is being re-loaded after a call to invalidateCache(), the widget
is in a state similar to initial data load - it doesn't know the total length of the
dataset and any APIs that act on records or row indices will necessarily fail and should
not be called. To detect that the widget is in this state, call
ResultSet.lengthIsKnown().
invalidateCache() only has an effect if this component's dataset is a data
manager class that manages a cache (eg ResultSet or ResultTree). If data was provided as
a simple Array or List, invalidateCache() does nothing.
invalidateCache in interface DataBoundComponentrefreshData(),
DataBoundComponentMethods
overview and related methodspublic ResultSet getResultSet()
DataBoundComponentResultSet.
Note that this method should only be called after initial data has been fetched by this DataBoundComponent.
getResultSet in interface DataBoundComponentDataBoundComponent.fetchData()public RecordList getRecordList()
DataBoundComponentRecordList.
Depending on the component configuration, the actual JavaScript instance of the returned RecordList may be one of several types:
DataSource,
the instance is generally an Array of Record.ResultSet.Tree.
To access the ungrouped record list regardless of grouping status, use
isGrouped() ? getOriginalRecordList() : getRecordList()
TreeGrid,
the instance is a ResultTree.getRecordList in interface DataBoundComponentpublic com.google.gwt.core.client.JavaScriptObject getDataAsJSList()
getDataAsJSList in interface DataBoundComponentpublic void exportData()
DataBoundComponentDataSource
to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data
to a file or window in the requested format. A variety of DSRequest settings, such as exportAs and exportFilename, affect the exporting process: see exportResults for further detail.
Note that data exported via this method does not include any client-side
formatting and relies on both the Smart GWT server and server-side DataSources. To export client-data with formatters
applied, see exportClientData, which still
requires the Smart GWT server but does not rely on server-side DataSources.
For more information on exporting data,
see DataSource.exportData.
exportData in interface DataBoundComponentDataBoundComponentMethods overview and related methodspublic void exportData(DSRequest requestProperties)
DataBoundComponentDataSource
to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data
to a file or window in the requested format. A variety of DSRequest settings, such as exportAs and exportFilename, affect the exporting process: see exportResults for further detail.
Note that data exported via this method does not include any client-side
formatting and relies on both the Smart GWT server and server-side DataSources. To export client-data with formatters
applied, see exportClientData, which still
requires the Smart GWT server but does not rely on server-side DataSources.
For more information on exporting data,
see DataSource.exportData.
exportData in interface DataBoundComponentrequestProperties - additional properties to set on the DSRequest that will be issuedDataBoundComponentMethods overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addFetchDataHandler(FetchDataHandler handler)
Notification function fired on fetchData() or filterData()
addFetchDataHandler in interface HasFetchDataHandlershandler - the filterData handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDropCompleteHandler(DropCompleteHandler handler)
com.smartgwt.client.widgets.DropCompleteHandler. See that class's documentation for a definition of "drop complete",
and how it differs from "drag complete" (com.smartgwt.client.widgets.DragCompleteHandler).addDropCompleteHandler in interface HasDropCompleteHandlershandler - the DropCompleteHandlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDragCompleteHandler(DragCompleteHandler handler)
com.smartgwt.client.widgets.DragCompleteHandler. See that class's documentation for a definition of "drag complete",
and how it differs from "drop complete" (com.smartgwt.client.widgets.DropCompleteHandler).addDragCompleteHandler in interface HasDragCompleteHandlershandler - the DropCompleteHandlerHandlerRegistration used to remove this handlerpublic Alignment[] getFieldAlignments()
DataBoundComponentgetFieldAlignments in interface DataBoundComponentpublic java.lang.Boolean getDeepCloneOnEdit()
DataBoundComponentDataSource.getDeepCloneOnEdit() for details of what this means.
If this value is not explicitly set, it defaults to the DataSource deepCloneOnEdit value.
This value can also be overridden per-field with DataSourceField.setDeepCloneOnEdit(java.lang.Boolean).
Like the other deepCloneOnEdit settings, this flag only has an effect if you are
editing a values object that contains nested objects or arrays, using Canvas.setDataPath(java.lang.String)
getDeepCloneOnEdit in interface DataBoundComponentpublic void setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
DataBoundComponentDataSource.getDeepCloneOnEdit() for details of what this means.
If this value is not explicitly set, it defaults to the DataSource deepCloneOnEdit value.
This value can also be overridden per-field with DataSourceField.setDeepCloneOnEdit(java.lang.Boolean).
Like the other deepCloneOnEdit settings, this flag only has an effect if you are
editing a values object that contains nested objects or arrays, using Canvas.setDataPath(java.lang.String)
setDeepCloneOnEdit in interface DataBoundComponentpublic void setFields(com.google.gwt.core.client.JavaScriptObject... fields)
DataBoundComponentsetFields(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.
FormItem,
ListGridField, etc.)
This is an advanced method and only for cases where you have the JavaScriptObject for
each field but want to avoid having to create each associated SmartGWT Java wrapper.
Note: use toArray() to create a Java
array of JavaScriptObject if you only have the array itself as a single JavaScriptObject.
setFields in interface DataBoundComponentfields - the component fieldspublic com.google.gwt.core.client.JavaScriptObject[] getFieldsAsJavaScriptObjects()
DataBoundComponentFormItem,
ListGridField, etc.)
This avoids building the SmartGWT Java wrappers for the fields in situations where they
aren't needed - and for FormItems in particular - where there may not be enough
information to determine the correct subclass, such as before the SmartClient instance
underlying the DynamicForm has been
created.getFieldsAsJavaScriptObjects in interface DataBoundComponentpublic int getFieldCount()
DataBoundComponentgetFieldCount in interface DataBoundComponentpublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.grid.ListGridLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class VLayout