public class CubeGrid extends ListGrid implements HasFacetAddedHandlers, HasFacetContextClickHandlers, HasFacetLabelClickHandlers, HasFacetMovedHandlers, HasFacetRemovedHandlers, HasFacetValueContextClickHandlers, HasFacetValueSelectionChangedHandlers, HasFixedFacetValueChangedHandlers, HasSortByFacetIdHandlers, HasSortByFacetValuesHandlers
CubeGrids are often called crosstabs, for their cross-tabular display of data dimensions in stacked/nested rows and columns, or pivot tables, for their ability to "pivot" dimensions between rows and columns to view a data cube from different perspectives. They are typically used in the querying and reporting front-ends of data warehousing, decision support, OLAP, and business intelligence systems.
For example, CubeGrids can be connected to Pentaho Mondrian, Jasper Reports, Microsoft Analysis Services and any other OLAP technology that supports the XMLA standard - the Isomorphic public wiki has examples. of such integration.
NOTE: you must load the Analytics Optional Module
before you can use CubeGrid.
Multi-Dimensional Data Terminology
The CubeGrid refers to
the dimensions of a data cube as facets, to the possible values in each facet as facet values, and to the values within
the data cube as data values or cell values. Equivalent terms that are commonly used in data warehousing or business
intelligence systems include:
facet: dimension, attribute, feature
facet value: dimension member,
attribute value, feature value
cell value: data value, metric value, measure
Visual Structure
Like the ListGrid and TreeGrid components, the CubeGrid displays data values in a tabular "body" with adjacent "headers". While the ListGrid and TreeGrid display rows of records with field values, the CubeGrid displays a body of individual cell values, each associated with a combination of facet values. The facet values for a cell are displayed in the column headers above the cell and row headers to the left of the cell. CubeGrids can display an arbitrary number of facets, by stacking multiple levels of row and/or column headers.
Except for the innermost column facet, each facet in a CubeGrid has a facet label adjacent to its row or column headers. The facet labels serve two main purposes: they display the titles of the facets, and they provide drag-and-drop reordering or pivoting of facets within the CubeGrid. The row facet labels also provide interactive selection, resizing, and other operations on the columns of row facet values.
The innermost column headers provide special behaviors and controls for manipulating the columns of data in a CubeGrid. End users may select, resize, reorder, minimize, maximize, or auto-fit the columns of data via mouse interactions with these headers. Customizable indicators and controls may be included at the top of each innermost column header.
If a CubeGrid is not large enough to display all of its cell values, horizontal and/or vertical scrollbars will appear below and to the right of the body. The body of the CubeGrid may be scrolled on either axis. The headers are "frozen" from scrolling on one axis - row headers only scroll vertically, while column headers only scroll horizontally - so the facet values for the visible cells are always displayed.
Data Loading
Data can be
provided to the Cube via data
as an Array of CellRecords
, each representing the data for one cell.
For large
datasets, provide a DataSource
with one field per
facetId, and the CubeGrid will load data on demand to fill the visible area, including lazily loading data for
expanding/collapsing tree facets and when facetValues are made visible programmatically or via menus.
Picking Facets
By "facet" we mean an aspect of the data which is orthogonal to other aspects of the data, that is, combining values from any two "facets" should make sense.
For example, in sales data, two facets might be "quarter" and "region" - it makes sense to combine any quarter and region, although for some combinations, there may not be data available.
An example of two aspects that would not be independent facets are "state" and "city" - it's
senseless to combine arbitrary states with arbitrary cities - most combinations are invalid. Consider instead a tree facet
that combines "city" and "state" values.
Note that if
"city" and "state" are represented as facets, they may look correct if they are both on the same axis of the grid and
hideEmptyFacetValues
is used to trim nonsense
combinations, but if the data is pivoted
such that
"state" and "city" are on opposing axes, there will be a roughly diagonal "stripe" of data for combinations of "state"
and "city" that make sense, and all other space will be blank. This is a strong indication that two facets should be
represented as a single tree facet instead.
Facet
,
FacetValue
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
CubeGrid() |
CubeGrid(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
void |
addColumnFacet(java.lang.String facetId)
Add a column facet to the view at index "index".
|
void |
addColumnFacet(java.lang.String facetId,
java.lang.Integer index)
Add a column facet to the view at index "index".
|
void |
addFacet(java.lang.String facetId)
Add a facet to the view, into the row or column facets (intoRows true or false), at index "index".
|
void |
addFacet(java.lang.String facetId,
java.lang.Boolean intoRows) |
void |
addFacet(java.lang.String facetId,
java.lang.Boolean intoRows,
java.lang.Integer index)
Add a facet to the view, into the row or column facets (intoRows true or false), at index "index".
|
com.google.gwt.event.shared.HandlerRegistration |
addFacetAddedHandler(FacetAddedHandler handler)
Add a facetAdded handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFacetContextClickHandler(FacetContextClickHandler handler)
Add a facetContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFacetLabelClickHandler(FacetLabelClickHandler handler)
Add a facetLabelClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFacetMovedHandler(FacetMovedHandler handler)
Add a facetMoved handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFacetRemovedHandler(FacetRemovedHandler handler)
Add a facetRemoved handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFacetValueContextClickHandler(FacetValueContextClickHandler handler)
Add a facetValueContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFacetValueSelectionChangedHandler(FacetValueSelectionChangedHandler handler)
Add a facetValueSelectionChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFixedFacetValueChangedHandler(FixedFacetValueChangedHandler handler)
Add a fixedFacetValueChanged handler.
|
void |
addRowFacet(java.lang.String facetId)
Add a row facet to the view at index "index".
|
void |
addRowFacet(java.lang.String facetId,
java.lang.Integer index)
Add a row facet to the view at index "index".
|
com.google.gwt.event.shared.HandlerRegistration |
addSortByFacetIdHandler(SortByFacetIdHandler handler)
Add a sortByFacetId handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addSortByFacetValuesHandler(SortByFacetValuesHandler handler)
Add a sortByFacetValues handler.
|
static boolean |
analyticsLoaded()
Static method indicating whether the optional Analytics module is loaded for the page.
|
java.lang.Boolean |
anyCellSelected()
Determine whether any cells are selected in this cubeGrid.
|
void |
autoSizeFacet(java.lang.String facetId)
auto-size the header facet horizontally
|
java.lang.Boolean |
cellIsSelected(CellRecord cell)
Determine whether the cell passed in is selected in this cubeGrid.
|
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 . |
void |
closeFacet(java.lang.String facetId)
Handler fired when facet is closed
methodType handler |
java.lang.Boolean |
collapseField(FacetValueMap facetValueMap)
Collapses the specified field.
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
dataArrived()
Notification method fired when new data arrives from the server to be displayed in this CubeGrid.
|
void |
deselectAll()
Deselect all cells and facetValues.
|
void |
deselectAllCells()
Deselect all cells.
|
void |
deselectAllFacetValues()
Deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
|
void |
deselectAllFacetValues(java.lang.String facetId)
Deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
|
void |
deselectCell(CellRecord cell)
Deselect a single cell - accepts cellRecord.
|
void |
deselectCell(java.lang.String cell)
Deselect a single cell - accepts cell ID.
|
void |
deselectCells(CellRecord[] cellList)
Deselect cells that match a
FacetValueMap . |
void |
deselectCells(FacetValueMap cellList)
Deselect cells that match a
FacetValueMap . |
void |
deselectCells(java.lang.String... cellList)
Deselect cells that match a
FacetValueMap . |
void |
deselectFacetValue(java.lang.String facetId,
java.lang.String facetValueId)
Deselect the header for a given facet value.
|
java.lang.Boolean |
expandField(FacetValueMap facetValueMap)
Expands the specified field.
|
void |
exportClientData(java.util.Map settings)
Exports this component's data with client-side formatters applied, so is suitable for direct display to users.
|
void |
exportClientData(java.util.Map settings,
DSRequest requestProperties) |
void |
exportClientData(java.util.Map settings,
DSRequest requestProperties,
RPCCallback callback)
Exports this component's data with client-side formatters applied, so is suitable for direct display to users.
|
java.lang.Boolean |
facetHasSelection(java.lang.String facetId)
Return whether any facet value for this facet is selected in headers.
|
java.lang.Boolean |
getAlternateRecordStyles()
Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
|
TextMatchStyle |
getAutoFetchTextMatchStyle()
If
autoFetchData is true , this attribute
allows the developer to specify a textMatchStyle for the initial fetchData() call. |
java.lang.String |
getAutoFitColumnTitle()
Title for the auto-fit column menu item.
|
java.lang.Boolean |
getAutoFitFieldWidths()
This property is not supported for
CubeGrid . |
java.lang.Boolean |
getAutoSelectHeaders()
If true, when multiple facets appear on one side in a nested headers presentation, the selection state of parent/child
headers are automatically kept in sync.
|
AutoSelectionModel |
getAutoSelectValues()
Whether to select cells in the body when row or column headers are selected.
|
java.lang.Boolean |
getAutoSizeHeaders()
Automatically size row headers to fit wrapped text.
|
java.lang.String |
getBaseStyle()
base cell style for this listGrid. |
java.lang.Integer |
getBodyMinHeight()
Minimum height for the body of this cubeGrid.
|
java.lang.Integer |
getBodyMinWidth()
Minimum width for the body of this cubeGrid.
|
java.lang.String |
getBodyStyleName()
CSS class for the CubeGrid body
|
java.lang.Boolean |
getCanCollapseFacets()
If true, hierarchical facets will show expand/collapse controls to allow the user to expand and collapse the tree of
facetValues for that facet.
|
java.lang.Boolean |
getCanDragSelect()
For
touch browsers , canDragSelect defaults to false so
that touch scrolling can be used to navigate scrollable CubeGrids. |
java.lang.Boolean |
getCanEdit()
Whether cells can be edited in this grid.
|
java.lang.Boolean |
getCanMinimizeColumns()
If true, allow columns in the grid body to be minimized (reduced to the width of the minimize control) by clicking on a
minimize control in the innermost column headers.
|
java.lang.Boolean |
getCanMinimizeFacets()
If true, when multiple facets are shown on a side, all facetValues in the second level of headers or higher will show
controls to "minimize" the values of the next facet.
|
java.lang.Boolean |
getCanMoveFacets()
Whether row and column facets can be rearranged by the user, by dragging and dropping the facet labels.
|
java.lang.Boolean |
getCanReorderColumns()
If true, body columns can be reordered via the innermost column headers.
|
java.lang.Boolean |
getCanResizeColumns()
If true, body columns can be resized via the innermost column headers.
|
java.lang.Boolean |
getCanSelectHeaders()
Determines whether row or column facetValue headers can be selected.
|
java.lang.Boolean |
getCanSelectValues()
Determines whether cell values in the body can be selected.
|
java.lang.Boolean |
getCanSortData()
If true, sort controls will be shown on facet values.
|
java.lang.Boolean |
getCanSortFacets()
If true, sort controls will be shown on FacetHeaders.
|
Alignment |
getCellAlign()
Default align for cell values (in body).
|
int |
getCellColumn(CellRecord cellRecord)
Given a record in this grid, this method returns the colNum in which the record is displayed.
|
int[] |
getCellCoordinates(CellRecord cellRecord)
Given a record in this grid, this method returns the coordinates of the cell in which the record is displayed as a 2
element array.
|
FacetValueMap |
getCellFacetValues(int rowNum,
int colNum)
Given a cell coordinate within this CubeGrid return a
FacetValueMap indicating
the facet values for the cell. |
java.lang.String |
getCellIdProperty()
Name of the property in a cell record that holds it's unique ID.
|
ListGridRecord |
getCellRecord(int rowNum,
int colNum)
Return the pointer to a particular record by record and column number.
|
int |
getCellRow(CellRecord cellRecord)
Given a record in this grid, this method returns the rowNum on which the record is displayed.
|
int |
getChartConfirmThreshold()
If
makeChart() is called with a chart specification that
will show more than chartConfirmThreshold data elements, the user will be presented with a confirmation dialog . |
java.lang.String |
getChartConstructor()
Name of the Smart GWT Class to be used when creating charts.
|
java.lang.String |
getChartDialogTitle()
Title for the Chart dialog.
|
java.lang.String |
getChartItemTitle()
Title for the Chart menu item.
|
java.lang.String |
getChartStackedTitle()
Title for the stacked chart item.
|
ChartType |
getChartType()
Default type of chart to plot.
|
java.lang.String |
getChartTypeTitle()
Title for the chart-type control.
|
java.lang.String |
getColHeaderBaseStyle()
baseStyle for the buttons in this grid's column headers. |
java.lang.String |
getColHeaderLabelBaseStyle()
baseStyle for the facet-label buttons above this grid's column
headers. |
java.lang.String[] |
getColumnFacets()
The list of
ids for facets that will appear on top of the body. |
FacetValueMap |
getColumnFacetValues(int colNum)
Return a
FacetValueMap indicating the facet values for a specific column in
the grid. |
FacetValueMap |
getColumnHeaderFacetValues(int colNum,
int level)
Return a
FacetValueMap of the facet values for the column field at the
specified level containing the requested column number. |
java.lang.String |
getControlCloseTitle()
Title for the close control.
|
java.lang.String |
getControlMaximizeTitle()
Title for the maximize control.
|
java.lang.String |
getControlMinimizeTitle()
Title for the minimize control.
|
java.lang.String |
getControlReorderHandleTitle()
Title for the resizeHandle control.
|
java.lang.String |
getControlSortDownTitle()
Title for the sort-down control.
|
java.lang.String |
getControlSortUpTitle()
Title for the sort-up control.
|
MenuItem[] |
getDefaultFacetValueContextItems(FacetValueMap facetValues)
Returns a default set of items, which can be updated/modified, and then assigned to
facetValueContextItems to be used in the context
menu of the appropriate header button. |
int |
getDefaultFacetWidth()
Default width of inner column headers.
|
java.lang.Boolean |
getEditByCell()
CubeGrids only support editing by cell.
|
java.lang.Object |
getEditedCell(int rowNum,
int colNum)
Returns the current value of a cell.
|
java.lang.Object |
getEditedCell(Record record)
Returns the current value of a cell.
|
CellRecord |
getEditedRecord(int rowNum,
int colNum)
Returns the combination of unsaved edits (if any) and original values (if any) for a given cell being edited.
|
CellRecord |
getEditedRecord(Record baseRecord)
Returns the combination of unsaved edits (if any) and original values (if any) for a given cell being edited.
|
java.lang.Object |
getEditValue(int rowNum,
int colNum)
Returns the current temporary locally stored edit value for a cell being edited.
|
java.lang.Boolean |
getEnableCharting()
If set to true, context menu items will be included on the cells and headers providing the user with an option to create
a chart of the cubeGrid's data set.
|
int |
getEventColumn()
Returns the column number of the provided X-coordinate, or the most recent mouse event if an X-coordinate is not
provided.
|
int |
getEventColumn(java.lang.Integer x)
Returns the column number of the provided X-coordinate, or the most recent mouse event if an X-coordinate is not
provided.
|
int |
getEventRow()
Returns the row number of the provided Y-coordinate, or the most recent mouse event if a Y-coordinate is not provided.
|
int |
getEventRow(java.lang.Integer y)
Returns the row number of the provided Y-coordinate, or the most recent mouse event if a Y-coordinate is not provided.
|
java.lang.String |
getExportColumnFacetBGColor()
Sets the background color for the column headers of the cube.
|
java.lang.String |
getExportColumnFacetTextColor()
Sets the text color for the column headers of the cube.
|
java.lang.String |
getExportFacetBGColor()
Sets the background color for the row and column headers of the cube, if not otherwise set by a more specific property.
|
java.lang.String |
getExportFacetSeparatorString()
Default separator string used by
exportClientData()
to separate column and row facet value titles. |
java.lang.String |
getExportFacetTextColor()
Sets the text color for the row and column headers of the cube, if not otherwise set by a more specific property.
|
java.lang.String |
getExportRowFacetBGColor()
Sets the background color for the row headers of the cube.
|
java.lang.String |
getExportRowFacetTextColor()
Sets the text color for the row headers of the cube.
|
Facet |
getFacet(java.lang.String facetId)
Get a facet definition by facetId.
|
Alignment |
getFacetLabelHoverAlign()
Allows the developer to override the horizontal text alignment of hover tips shown for facetLabels.
|
java.lang.Integer |
getFacetLabelHoverHeight()
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetLabels. |
java.lang.String |
getFacetLabelHoverHeightAsString()
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetLabels. |
java.lang.String |
getFacetLabelHoverStyle()
Allows the developer to override the css class applied to hover tips shown for facet labels.
|
VerticalAlignment |
getFacetLabelHoverVAlign()
Allows the developer to override the vertical text alignment of hover tips shown for facetLabels.
|
java.lang.Integer |
getFacetLabelHoverWidth()
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetLabels. |
java.lang.String |
getFacetLabelHoverWidthAsString()
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetLabels. |
java.lang.String[] |
getFacetsHavingSelection()
Return the list of facets that have any selection in their headers.
|
Alignment |
getFacetTitleAlign()
Default alignment for facet labels.
|
FacetValue |
getFacetValue(java.lang.String facetId,
java.lang.String facetValueId)
Get a facet value definition by facetId and facetValueId.
|
Alignment |
getFacetValueAlign()
Default alignment for facet values (in headers).
|
MenuItem[] |
getFacetValueContextItems()
Array of MenuItem to replace the default menu.
|
Alignment |
getFacetValueHoverAlign()
Allows the developer to override the horizontal text alignment of hover tips shown for facet values.
|
java.lang.Integer |
getFacetValueHoverHeight()
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetValues. |
java.lang.String |
getFacetValueHoverHeightAsString()
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetValues. |
java.lang.String |
getFacetValueHoverStyle()
Allows the developer to override the css class applied to hover tips shown for facet values.
|
VerticalAlignment |
getFacetValueHoverVAlign()
Allows the developer to override the vertical text alignment of hover tips shown for facet values.
|
java.lang.Integer |
getFacetValueHoverWidth()
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetValues. |
java.lang.String |
getFacetValueHoverWidthAsString()
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetValues. |
int |
getFacetValuesColumn(FacetValueMap facetValues)
Get the index of the first column in the grid that matches the specified FacetValueMap.
|
int |
getFacetValuesRow(FacetValueMap facetValues)
Get the index of the first row in the grid that matches the specified FacetValueMap.
|
DSRequest |
getFetchRequestProperties()
If
autoFetchData is true , this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. |
java.lang.String |
getFieldVisibilitySubmenuTitle()
Title for the Field-visibility submenu item.
|
FacetValueMap |
getFixedFacetValues()
A
FacetValueMap describing the set of facet values that should be regarded as
"fixed" in this cubeGrid. |
java.lang.String |
getHideAllHighlightsTitle()
Title for the hide all highlights menu item.
|
Axis |
getHideEmptyAxis()
With
hideEmptyFacetValues , controls on which
axis hiding of empty values is applied, "row" (only empty rows are hidden), "column" (only empty columns are hidden) or
both (the default). |
java.lang.Boolean |
getHideEmptyFacetValues()
This causes the headers for any combination of facetValues for which there are no cellRecords to be suppressed.
|
java.lang.String |
getHighlightCellTitle()
Title for the cell highlight menu item.
|
java.lang.String |
getHighlightSelectionTitle()
Title for the selection highlight menu item.
|
java.lang.String |
getHighlightTitle()
Title for the highlight menu item.
|
Hilite[] |
getHilites()
Hilites to be applied to the data for this component.
|
boolean |
getIndentVTreeFacets()
Turns on indenting of any
hierarchical column facets. |
java.lang.String |
getInnerHeaderBaseStyle()
baseStyle for the buttons in the innermost column header for
this cubeGrid. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
java.lang.String |
getMaximizeColumnTitle()
Title for the maximize-column menu item.
|
java.lang.String |
getMetricFacetId()
In a CubeGrid that displays values of different types (eg "Revenue" and "Income"), the different types of values on
display are enumerated as the facet values of the "metric facet".
|
java.lang.String |
getMinimizeColumnTitle()
Title for the minimize-column menu item.
|
java.lang.String |
getNoHighlightsTitle()
Title for the menu item that clears highlights.
|
static CubeGrid |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getPadTitles()
Whether to pad titles so they aren't flush with header borders.
|
java.lang.String |
getRenameFacetValueMessage()
Message displayed when renaming a facet value.
|
java.lang.String |
getRenameFacetValueTitle()
Title for the Rename menu item.
|
java.lang.String |
getRollupValue()
facetValueId of the default rollupValue for each facet.
|
java.lang.Boolean |
getRotateHeaderTitles()
This property is not supported for
CubeGrid . |
java.lang.String[] |
getRowFacets()
The list of
ids for facets that will appear to the left of the
body. |
FacetValueMap |
getRowFacetValues(int rowNum)
Return a
FacetValueMap indicating the facet values for a specific row in the
grid. |
java.lang.String |
getRowHeaderBaseStyle()
baseStyle for the buttons in this grid's row headers. |
FacetValueMap |
getRowHeaderFacetValues(int rowNum,
int level)
Return a
FacetValueMap of the facet values for the row field at the specified
level containing the requested row number. |
java.lang.Boolean |
getRowHeaderGridMode()
If enabled row headers for this cubeGrid will be rendered using a
GridRenderer
component. |
java.lang.String |
getRowHeaderLabelBaseStyle()
baseStyle for the facet-label buttons above the grid's row
headers. |
java.lang.Boolean |
getSaveByCell()
CubeGrids only support editing by cell.
|
java.lang.String[] |
getSelectedCellIds()
Returns an array of the IDs of all selected cell records.
|
CellRecord[] |
getSelectedCells()
Returns an array of the selected cell records.
|
FacetValueMap[] |
getSelectedFacetValues()
Returns an array of facetValues objects indicating the headers that are selected in the headerBar for this facet.
|
FacetValueMap[] |
getSelectedFacetValues(java.lang.String facetId)
Returns an array of facetValues objects indicating the headers that are selected in the headerBar for this facet.
|
java.lang.String |
getShowAllHighlightsTitle()
Title for the show all highlights menu item.
|
boolean |
getShowFacetContextMenus()
If true, show facet label context menus with some built-in operations.
|
boolean |
getShowFacetValueContextMenus()
If true, show facet value context menus with some built-in operations.
|
java.lang.String |
getShowHighlightsTitle()
Title for the show highlights menu item.
|
java.lang.String |
getShowHoverTipsTitle()
Title for the show hover tips menu item.
|
java.lang.Boolean |
getSimpleDeselect()
If true, clicking on the existing selection causes it to be entirely deselected.
|
java.lang.String |
getSkinImgDir()
Default directory for skin images (those defined by the class), relative to the Page-wide
skinDir . |
SortDirection |
getSortDirection()
Direction of sorting if sortedFacet or sortedFacetValues is specified.
|
FacetValueMap |
getSortedFacetValues()
FacetValueMap of facet values representing a set of facetValues by which the
cubeGrid data is sorted. |
java.lang.String |
getStyleName()
CSS class for the CubeGrid as a whole
|
protected CubeGrid |
getTestInstance() |
java.lang.String |
getValueExportFormat()
FormatString used during exports for numeric or date formatting. |
java.lang.String |
getValueFormat()
FormatString for numeric or date formatting. |
java.lang.String |
getValueProperty()
Name of the property in a cell record that holds the cell value.
|
java.lang.String |
getValueTitle()
A label for the data values shown in cells, such as "Sales in Thousands", typically used
when the CubeGrid must generate a description for a cell value or set of cell values.
|
java.lang.String |
getViewState()
Note: This is a ListGrid feature which is inapplicable on this class.
|
int |
getVTreeFacetIndent()
Determines how many pixels to move for each level when
hierarchical column facets are being indented . |
FacetIndentDirection |
getVTreeFacetIndentDirection()
Determines layout of facet value titles in each column facet being
indented . |
java.lang.Boolean |
getWrapFacetTitles()
Whether to allow text wrapping on facet titles.
|
java.lang.Boolean |
getWrapFacetValueTitles()
Whether to allow text wrapping on facet value titles.
|
java.lang.Boolean |
hasChanges()
Determines whether any cells in this cubeGrid have been edited but not yet saved to the underlying data set.
|
java.lang.Boolean |
hasChanges(java.lang.Boolean ignorePendingValues)
Determines whether any cells in this cubeGrid have been edited but not yet saved to the underlying data set.
|
boolean |
hideFacetValues(FacetValueMap facetValueMap)
Hides the specified field if it is currently visible.
|
java.lang.Boolean |
hiliteCell(int rowNum,
int colNum,
java.lang.String hiliteID)
Apply a hilite to a specific cell.
|
java.lang.Boolean |
hiliteFacetValue(java.lang.String facetID,
java.lang.String facetValueID,
java.lang.String hiliteID)
Apply a hilite to all cells corresponding to a facetValue.
|
java.lang.Boolean |
isFieldOpen(FacetValueMap facetValueMap)
Return whether the specified CubeGrid field is open, taking into account both
collapsing and minimizing . |
java.lang.Boolean |
loadAllRecords()
This method is not currently supported for this grid-type.
|
java.lang.Boolean |
loadAllRecords(java.lang.Integer maxRecords) |
java.lang.Boolean |
loadAllRecords(java.lang.Integer maxRecords,
DSCallback callback)
This method is not currently supported for this grid-type.
|
FacetChart |
makeChart(FacetValueMap fixedFacetValues,
java.lang.String[] variableFacets,
FacetChart chartProperties)
Chart the portion of the dataset indicated by
fixedFacetValues , for all
values of the variableFacets . |
java.lang.Boolean |
recordHasChanges(int rowNum,
int colNum)
If this cubeGrid can be edited, this method will return true if the record passed in has been edited, but the edits have
not yet been saved to the CubeGrid's data object.
|
java.lang.Boolean |
recordHasChanges(int rowNum,
int colNum,
java.lang.Boolean ignorePendingValues)
If this cubeGrid can be edited, this method will return true if the record passed in has been edited, but the edits have
not yet been saved to the CubeGrid's data object.
|
void |
removeFacet(java.lang.String facetId)
Remove a facet from the current view, using a fixed value from that facet.
|
void |
removeFacet(java.lang.String facetId,
java.lang.String fixedFacetValueId)
Remove a facet from the current view, using a fixed value from that facet.
|
void |
resizeFacetValue(java.lang.String facetValueId,
int newWidth)
Resizes all columns for the provided facetValueId, which must be a facetValueId from the innermost column facet.
|
void |
selectAllCells()
Select all cells.
|
void |
selectAllFacetValues()
Select/deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
|
void |
selectAllFacetValues(java.lang.String facetId) |
void |
selectAllFacetValues(java.lang.String facetId,
java.lang.Boolean newState)
Select/deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
|
void |
selectCell(Record cell)
Select a single cell - accepts cell ID or cell record.
|
void |
selectCell(java.lang.String ID)
Select a single cell - accepts cell ID or cell record.
|
void |
selectCells(CellRecord[] cellList)
Select/deselect cells that match a
FacetValueMap . |
void |
selectCells(CellRecord[] cellList,
boolean newState)
Select/deselect cells that match a
FacetValueMap . |
void |
selectCells(FacetValueMap cellList)
Select/deselect cells that match a
FacetValueMap . |
void |
selectCells(java.lang.String... cellList)
Select/deselect cells that match a
FacetValueMap . |
void |
selectFacetValue(java.lang.String facetId,
java.lang.String facetValueId)
Select/deselect the header for a given facet value.
|
void |
selectFacetValue(java.lang.String facetId,
java.lang.String facetValueId,
java.lang.Boolean newState)
Select/deselect the header for a given facet value.
|
CubeGrid |
setAlternateRecordStyles(java.lang.Boolean alternateRecordStyles)
Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
|
CubeGrid |
setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
If
autoFetchData is true , this attribute
allows the developer to specify a textMatchStyle for the initial fetchData() call. |
CubeGrid |
setAutoFitColumnTitle(java.lang.String autoFitColumnTitle)
Title for the auto-fit column menu item.
|
CubeGrid |
setAutoFitFieldWidths(java.lang.Boolean autoFitFieldWidths)
This property is not supported for
CubeGrid . |
CubeGrid |
setAutoSelectHeaders(java.lang.Boolean autoSelectHeaders)
If true, when multiple facets appear on one side in a nested headers presentation, the selection state of parent/child
headers are automatically kept in sync.
|
CubeGrid |
setAutoSelectValues(AutoSelectionModel autoSelectValues)
Whether to select cells in the body when row or column headers are selected.
|
CubeGrid |
setAutoSizeHeaders(java.lang.Boolean autoSizeHeaders)
Automatically size row headers to fit wrapped text.
|
CubeGrid |
setBaseStyle(java.lang.String baseStyle)
base cell style for this listGrid. |
CubeGrid |
setBodyMinHeight(java.lang.Integer bodyMinHeight)
Minimum height for the body of this cubeGrid.
|
CubeGrid |
setBodyMinWidth(java.lang.Integer bodyMinWidth)
Minimum width for the body of this cubeGrid.
|
CubeGrid |
setBodyStyleName(java.lang.String bodyStyleName)
CSS class for the CubeGrid body
|
CubeGrid |
setCanCollapseFacets(java.lang.Boolean canCollapseFacets)
If true, hierarchical facets will show expand/collapse controls to allow the user to expand and collapse the tree of
facetValues for that facet.
|
CubeGrid |
setCanDragSelect(java.lang.Boolean canDragSelect)
For
touch browsers , canDragSelect defaults to false so
that touch scrolling can be used to navigate scrollable CubeGrids. |
CubeGrid |
setCanEdit(java.lang.Boolean canEdit)
Whether cells can be edited in this grid.
|
CubeGrid |
setCanMinimizeColumns(java.lang.Boolean canMinimizeColumns)
If true, allow columns in the grid body to be minimized (reduced to the width of the minimize control) by clicking on a
minimize control in the innermost column headers.
|
CubeGrid |
setCanMinimizeFacets(java.lang.Boolean canMinimizeFacets)
If true, when multiple facets are shown on a side, all facetValues in the second level of headers or higher will show
controls to "minimize" the values of the next facet.
|
CubeGrid |
setCanMoveFacets(java.lang.Boolean canMoveFacets)
Whether row and column facets can be rearranged by the user, by dragging and dropping the facet labels.
|
CubeGrid |
setCanReorderColumns(java.lang.Boolean canReorderColumns)
If true, body columns can be reordered via the innermost column headers.
|
CubeGrid |
setCanResizeColumns(java.lang.Boolean canResizeColumns)
If true, body columns can be resized via the innermost column headers.
|
CubeGrid |
setCanSelectHeaders(java.lang.Boolean canSelectHeaders)
Determines whether row or column facetValue headers can be selected.
|
CubeGrid |
setCanSelectValues(java.lang.Boolean canSelectValues)
Determines whether cell values in the body can be selected.
|
CubeGrid |
setCanSortData(java.lang.Boolean canSortData)
If true, sort controls will be shown on facet values.
|
CubeGrid |
setCanSortFacets(java.lang.Boolean canSortFacets)
If true, sort controls will be shown on FacetHeaders.
|
CubeGrid |
setCellAlign(Alignment cellAlign)
Default align for cell values (in body).
|
CubeGrid |
setCellIdProperty(java.lang.String cellIdProperty)
Name of the property in a cell record that holds it's unique ID.
|
CubeGrid |
setChartConfirmThreshold(int chartConfirmThreshold)
If
makeChart() is called with a chart specification that
will show more than chartConfirmThreshold data elements, the user will be presented with a confirmation dialog . |
CubeGrid |
setChartConstructor(java.lang.String chartConstructor)
Name of the Smart GWT Class to be used when creating charts.
|
CubeGrid |
setChartDialogTitle(java.lang.String chartDialogTitle)
Title for the Chart dialog.
|
CubeGrid |
setChartItemTitle(java.lang.String chartItemTitle)
Title for the Chart menu item.
|
CubeGrid |
setChartStackedTitle(java.lang.String chartStackedTitle)
Title for the stacked chart item.
|
CubeGrid |
setChartType(ChartType chartType)
Default type of chart to plot.
|
CubeGrid |
setChartTypeTitle(java.lang.String chartTypeTitle)
Title for the chart-type control.
|
CubeGrid |
setColHeaderBaseStyle(java.lang.String colHeaderBaseStyle)
baseStyle for the buttons in this grid's column headers. |
CubeGrid |
setColHeaderLabelBaseStyle(java.lang.String colHeaderLabelBaseStyle)
baseStyle for the facet-label buttons above this grid's column
headers. |
CubeGrid |
setColumnFacets(java.lang.String... columnFacets)
The list of
ids for facets that will appear on top of the body. |
CubeGrid |
setControlCloseTitle(java.lang.String controlCloseTitle)
Title for the close control.
|
CubeGrid |
setControlMaximizeTitle(java.lang.String controlMaximizeTitle)
Title for the maximize control.
|
CubeGrid |
setControlMinimizeTitle(java.lang.String controlMinimizeTitle)
Title for the minimize control.
|
CubeGrid |
setControlReorderHandleTitle(java.lang.String controlReorderHandleTitle)
Title for the resizeHandle control.
|
CubeGrid |
setControlSortDownTitle(java.lang.String controlSortDownTitle)
Title for the sort-down control.
|
CubeGrid |
setControlSortUpTitle(java.lang.String controlSortUpTitle)
Title for the sort-up control.
|
CubeGrid |
setDefaultFacetWidth(int defaultFacetWidth)
Default width of inner column headers.
|
static void |
setDefaultProperties(CubeGrid cubeGridProperties)
Class level method to set the default properties of this class.
|
void |
setEditValue(int rowNum,
int colNum,
java.lang.Object value)
Set the edit value for some cell in the cube grid.
|
void |
setEnableCharting(java.lang.Boolean enableCharting)
If set to true, context menu items will be included on the cells and headers providing the user with an option to create
a chart of the cubeGrid's data set.
|
CubeGrid |
setExportColumnFacetBGColor(java.lang.String exportColumnFacetBGColor)
Sets the background color for the column headers of the cube.
|
CubeGrid |
setExportColumnFacetTextColor(java.lang.String exportColumnFacetTextColor)
Sets the text color for the column headers of the cube.
|
CubeGrid |
setExportFacetBGColor(java.lang.String exportFacetBGColor)
Sets the background color for the row and column headers of the cube, if not otherwise set by a more specific property.
|
CubeGrid |
setExportFacetSeparatorString(java.lang.String exportFacetSeparatorString)
Default separator string used by
exportClientData()
to separate column and row facet value titles. |
CubeGrid |
setExportFacetTextColor(java.lang.String exportFacetTextColor)
Sets the text color for the row and column headers of the cube, if not otherwise set by a more specific property.
|
CubeGrid |
setExportRowFacetBGColor(java.lang.String exportRowFacetBGColor)
Sets the background color for the row headers of the cube.
|
CubeGrid |
setExportRowFacetTextColor(java.lang.String exportRowFacetTextColor)
Sets the text color for the row headers of the cube.
|
CubeGrid |
setFacetLabelHoverAlign(Alignment facetLabelHoverAlign)
Allows the developer to override the horizontal text alignment of hover tips shown for facetLabels.
|
CubeGrid |
setFacetLabelHoverHeight(java.lang.Integer facetLabelHoverHeight)
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetLabels. |
CubeGrid |
setFacetLabelHoverHeight(java.lang.String facetLabelHoverHeight)
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetLabels. |
CubeGrid |
setFacetLabelHoverStyle(java.lang.String facetLabelHoverStyle)
Allows the developer to override the css class applied to hover tips shown for facet labels.
|
CubeGrid |
setFacetLabelHoverVAlign(VerticalAlignment facetLabelHoverVAlign)
Allows the developer to override the vertical text alignment of hover tips shown for facetLabels.
|
CubeGrid |
setFacetLabelHoverWidth(java.lang.Integer facetLabelHoverWidth)
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetLabels. |
CubeGrid |
setFacetLabelHoverWidth(java.lang.String facetLabelHoverWidth)
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetLabels. |
CubeGrid |
setFacets(Facet... facets)
Facet definitions for this CubeGrid.
|
void |
setFacetTitle(java.lang.String facetId,
java.lang.String newTitle)
Set the title of a facet (appears in facet label).
|
CubeGrid |
setFacetTitleAlign(Alignment facetTitleAlign)
Default alignment for facet labels.
|
CubeGrid |
setFacetValueAlign(Alignment facetValueAlign)
Default alignment for facet values (in headers).
|
CubeGrid |
setFacetValueContextItems(MenuItem... facetValueContextItems)
Array of MenuItem to replace the default menu.
|
CubeGrid |
setFacetValueHoverAlign(Alignment facetValueHoverAlign)
Allows the developer to override the horizontal text alignment of hover tips shown for facet values.
|
void |
setFacetValueHoverCustomizer(FacetValueHoverCustomizer hoverCustomizer)
Set the customizer for the HTML to be shown in hovers over facet values.
|
CubeGrid |
setFacetValueHoverHeight(java.lang.Integer facetValueHoverHeight)
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetValues. |
CubeGrid |
setFacetValueHoverHeight(java.lang.String facetValueHoverHeight)
If specified and
this.showHover is true, this is the default height to apply to hover tips shown for
facetValues. |
CubeGrid |
setFacetValueHoverStyle(java.lang.String facetValueHoverStyle)
Allows the developer to override the css class applied to hover tips shown for facet values.
|
CubeGrid |
setFacetValueHoverVAlign(VerticalAlignment facetValueHoverVAlign)
Allows the developer to override the vertical text alignment of hover tips shown for facet values.
|
CubeGrid |
setFacetValueHoverWidth(java.lang.Integer facetValueHoverWidth)
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetValues. |
CubeGrid |
setFacetValueHoverWidth(java.lang.String facetValueHoverWidth)
If specified and
this.showHover is true, this is the default width to apply to hover tips shown for
facetValues. |
void |
setFacetValueTitle(java.lang.String facetId,
java.lang.String facetValueId,
java.lang.String newTitle)
Set the title for a facet value.
|
void |
setFacetValueTitleAlign(java.lang.String facetId,
java.lang.String facetValueId,
Alignment align)
Set the align for the title for a facet value.
|
CubeGrid |
setFetchRequestProperties(DSRequest fetchRequestProperties)
If
autoFetchData is true , this attribute
allows the developer to declaratively specify DSRequest properties for the initial
fetchData() call. |
CubeGrid |
setFieldVisibilitySubmenuTitle(java.lang.String fieldVisibilitySubmenuTitle)
Title for the Field-visibility submenu item.
|
void |
setFixedFacetValue(java.lang.String facetId,
java.lang.String fixedFacetValueId)
Modify fixedFacetValues for this cubeGrid.
|
CubeGrid |
setFixedFacetValues(FacetValueMap fixedFacetValues)
A
FacetValueMap describing the set of facet values that should be regarded as
"fixed" in this cubeGrid. |
CubeGrid |
setHideAllHighlightsTitle(java.lang.String hideAllHighlightsTitle)
Title for the hide all highlights menu item.
|
CubeGrid |
setHideEmptyAxis(Axis hideEmptyAxis)
With
hideEmptyFacetValues , controls on which
axis hiding of empty values is applied, "row" (only empty rows are hidden), "column" (only empty columns are hidden) or
both (the default). |
CubeGrid |
setHideEmptyFacetValues(java.lang.Boolean hideEmptyFacetValues)
This causes the headers for any combination of facetValues for which there are no cellRecords to be suppressed.
|
CubeGrid |
setHighlightCellTitle(java.lang.String highlightCellTitle)
Title for the cell highlight menu item.
|
CubeGrid |
setHighlightSelectionTitle(java.lang.String highlightSelectionTitle)
Title for the selection highlight menu item.
|
CubeGrid |
setHighlightTitle(java.lang.String highlightTitle)
Title for the highlight menu item.
|
CubeGrid |
setHilites(Hilite... hilites)
Hilites to be applied to the data for this component.
|
CubeGrid |
setIndentVTreeFacets(boolean indentVTreeFacets)
Turns on indenting of any
hierarchical column facets. |
CubeGrid |
setInnerHeaderBaseStyle(java.lang.String innerHeaderBaseStyle)
baseStyle for the buttons in the innermost column header for
this cubeGrid. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.cube.CubeGridLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
CubeGrid |
setMaximizeColumnTitle(java.lang.String maximizeColumnTitle)
Title for the maximize-column menu item.
|
CubeGrid |
setMetricFacetId(java.lang.String metricFacetId)
In a CubeGrid that displays values of different types (eg "Revenue" and "Income"), the different types of values on
display are enumerated as the facet values of the "metric facet".
|
CubeGrid |
setMinimizeColumnTitle(java.lang.String minimizeColumnTitle)
Title for the minimize-column menu item.
|
CubeGrid |
setNoHighlightsTitle(java.lang.String noHighlightsTitle)
Title for the menu item that clears highlights.
|
CubeGrid |
setPadTitles(java.lang.Boolean padTitles)
Whether to pad titles so they aren't flush with header borders.
|
CubeGrid |
setRenameFacetValueMessage(java.lang.String renameFacetValueMessage)
Message displayed when renaming a facet value.
|
CubeGrid |
setRenameFacetValueTitle(java.lang.String renameFacetValueTitle)
Title for the Rename menu item.
|
CubeGrid |
setRollupValue(java.lang.String rollupValue)
facetValueId of the default rollupValue for each facet.
|
CubeGrid |
setRotateHeaderTitles(java.lang.Boolean rotateHeaderTitles)
This property is not supported for
CubeGrid . |
CubeGrid |
setRowFacets(java.lang.String... rowFacets)
The list of
ids for facets that will appear to the left of the
body. |
CubeGrid |
setRowHeaderBaseStyle(java.lang.String rowHeaderBaseStyle)
baseStyle for the buttons in this grid's row headers. |
CubeGrid |
setRowHeaderGridMode(java.lang.Boolean rowHeaderGridMode)
If enabled row headers for this cubeGrid will be rendered using a
GridRenderer
component. |
CubeGrid |
setRowHeaderLabelBaseStyle(java.lang.String rowHeaderLabelBaseStyle)
baseStyle for the facet-label buttons above the grid's row
headers. |
CubeGrid |
setShowAllHighlightsTitle(java.lang.String showAllHighlightsTitle)
Title for the show all highlights menu item.
|
CubeGrid |
setShowFacetContextMenus(boolean showFacetContextMenus)
If true, show facet label context menus with some built-in operations.
|
CubeGrid |
setShowFacetValueContextMenus(boolean showFacetValueContextMenus)
If true, show facet value context menus with some built-in operations.
|
CubeGrid |
setShowHighlightsTitle(java.lang.String showHighlightsTitle)
Title for the show highlights menu item.
|
CubeGrid |
setShowHoverTipsTitle(java.lang.String showHoverTipsTitle)
Title for the show hover tips menu item.
|
CubeGrid |
setSimpleDeselect(java.lang.Boolean simpleDeselect)
If true, clicking on the existing selection causes it to be entirely deselected.
|
CubeGrid |
setSkinImgDir(java.lang.String skinImgDir)
Default directory for skin images (those defined by the class), relative to the Page-wide
skinDir . |
CubeGrid |
setSortDirection(SortDirection sortDirection)
Direction of sorting if sortedFacet or sortedFacetValues is specified.
|
CubeGrid |
setSortedFacetValues(FacetValueMap sortedFacetValues)
FacetValueMap of facet values representing a set of facetValues by which the
cubeGrid data is sorted. |
void |
setStyleName(java.lang.String styleName)
CSS class for the CubeGrid as a whole
|
CubeGrid |
setValueExportFormat(java.lang.String valueExportFormat)
FormatString used during exports for numeric or date formatting. |
CubeGrid |
setValueFormat(java.lang.String valueFormat)
FormatString for numeric or date formatting. |
CubeGrid |
setValueProperty(java.lang.String valueProperty)
Name of the property in a cell record that holds the cell value.
|
CubeGrid |
setValueTitle(java.lang.String valueTitle)
A label for the data values shown in cells, such as "Sales in Thousands", typically used
when the CubeGrid must generate a description for a cell value or set of cell values.
|
CubeGrid |
setViewState(java.lang.String viewState)
Note: This is a ListGrid feature which is inapplicable on this class.
|
CubeGrid |
setVTreeFacetIndent(int vTreeFacetIndent)
Determines how many pixels to move for each level when
hierarchical column facets are being indented . |
CubeGrid |
setVTreeFacetIndentDirection(FacetIndentDirection vTreeFacetIndentDirection)
Determines layout of facet value titles in each column facet being
indented . |
CubeGrid |
setWrapFacetTitles(java.lang.Boolean wrapFacetTitles)
Whether to allow text wrapping on facet titles.
|
CubeGrid |
setWrapFacetValueTitles(java.lang.Boolean wrapFacetValueTitles)
Whether to allow text wrapping on facet value titles.
|
boolean |
showFacetValues(FacetValueMap facetValueMap)
Shows the specified field if it was previsouly hidden.
|
java.lang.Boolean |
toggleFieldOpenState(FacetValueMap facetValueMap)
Toggles the open state of the specified field.
|
addBodyKeyPressHandler, addCellClickHandler, addCellContextClickHandler, addCellDoubleClickHandler, addCellErrorIconHoverHandler, addCellErrorIconOutHandler, addCellErrorIconOverHandler, addCellHoverHandler, addCellMouseDownHandler, addCellMouseUpHandler, addCellOutHandler, addCellOverHandler, addCellSavedHandler, addCellSelectionChangedHandler, addCellValueHoverHandler, addCriteriaChangedHandler, addData, addData, addData, addDataArrivedHandler, addDataChangedHandler, addDragCompleteHandler, addDrawAreaChangedHandler, addDropCompleteHandler, addEditCompleteHandler, addEditFailedHandler, addEditorEnterHandler, addEditorExitHandler, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addFetchDataHandler, addFieldStateChangedHandler, addFilterEditorSubmitHandler, addFormulaField, addFormulaUpdatedHandler, addGroupByCompleteHandler, addGroupByHandler, addGroupStateChangedHandler, addGroupTreeChangedHandler, addHeaderClickHandler, addHeaderDoubleClickHandler, addHeaderHoverHandler, addHilitesChangedHandler, addRecordClickHandler, addRecordCollapseHandler, addRecordDoubleClickHandler, addRecordDropHandler, addRecordExpandHandler, addRegroupHandler, addRemoveRecordClickHandler, addRowContextClickHandler, addRowEditorEnterHandler, addRowEditorExitHandler, addRowHoverHandler, addRowMouseDownHandler, addRowMouseUpHandler, addRowOutHandler, addRowOverHandler, addSelectionChangedHandler, addSelectionUpdatedHandler, addSetSortHandler, addSort, addSortChangedHandler, addSorterClickHandler, addSorterContextClickHandler, addSummaryField, addViewStateChangedHandler, anySelected, applyCellData, applyRecordData, applySortToData, askForSort, autoFitField, autoFitFields, autoFitFields, cancelEditing, canEditCell, canExpandRecord, canSelectCell, canSelectRecord, cellHasChanges, cellHasErrors, cellHasErrors, cellValueHoverHTML, cellValueIsClipped, chartData, chartData, chartData, chartData, chartData, clearAllCriteria, clearCriteria, clearCriteria, clearCriteria, clearEditValue, clearFieldError, clearFieldError, clearFieldSearchOperator, clearFilterWindowCriteria, clearRowErrors, clearSavedViewState, clearSort, closeGroup, closeRecord, collapseRecord, collapseRecords, configureGrouping, createRecordComponent, dataChangedComplete, dataChangedComplete, deselectAllRecords, deselectRange, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, discardAllEdits, discardAllEdits, discardAllEdits, discardEdits, discardEdits, displayHeaderContextMenu, displaySort, drop, editExistingRecord, editExistingRecord, editFields, editHilites, enableHilite, enableHilite, enableHiliting, enableHiliting, endEditing, expandRecord, expandRecords, exportClientData, exportClientData, exportClientData, exportData, exportData, exportData, fetchData, fetchData, fetchData, fetchData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRowCount, fetchRowCount, fetchRowCount, fieldIsEditable, fieldIsEditable, fieldIsEditable, fieldIsVisible, filterByEditor, filterData, filterData, filterData, filterData, find, findAll, findIndex, findNextEditCell, findNextIndex, findNextIndex, focusInCell, focusInFilterEditor, focusInFilterEditor, focusInRow, freezeField, freezeField, freezeField, freezeField, freezeFields, freezeFields, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAdvancedFieldPickerThreshold, getAdvancedFilteringText, getAiFilterWindow, getAiFilterWindowHint, getAiFilterWindowInstructions, getAiFilterWindowTitle, getAiHiliteWindow, getAiHoverContentsPrefix, getAiHoverRetryDelay, getAiSortFieldMaxRecordsMessage, getAiSortProgressDialog, getAllEditRows, getAllFields, getAllowFilterExpressions, getAllowFilterOperators, getAllowFilterWindow, getAllowRowSpanning, getAlternateBodyStyleName, getAlternateFieldFrequency, getAlternateFieldStyles, getAlternateFieldSuffix, getAlternateRecordFrequency, getAlternateRecordSuffix, getAlwaysShowEditors, getAlwaysShowOperatorIcon, getAnimateFolderEffect, getAnimateFolderMaxRows, getAnimateFolders, getAnimateFolderSpeed, getAnimateFolderTime, getAnimateRemoveRecord, getAnimateRemoveSpeed, getAnimateRemoveTime, getAnimateRollOver, getAnimateRollUnder, getAnimateSelection, getAnimateSelectionUnder, getApplyFormulaAfterSummary, getApplyRowCountToLength, getApplyRowNumberStyle, getApproximateRowCountFormat, getAriaRole, getAriaState, getAriaStateDefaults, getArrowKeyAction, getArrowKeyEditAction, getAsyncErrorCellValue, getAsynchGroupingPrompt, getAsyncMissingCellValue, getAutoComplete, getAutoConfirmSaveEdits, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchDisplayMap, getAutoFetchRowCount, getAutoFitAllText, getAutoFitClipFields, getAutoFitData, getAutoFitDateFields, getAutoFitExpandField, getAutoFitExtraRecords, getAutoFitFieldsFillViewport, getAutoFitFieldText, getAutoFitHeaderHeights, getAutoFitIconFields, getAutoFitMaxColumns, getAutoFitMaxHeight, getAutoFitMaxRecords, getAutoFitMaxWidth, getAutoFitMaxWidthAsString, getAutoFitTimeFields, getAutoFitWidthApproach, getAutoPersistViewState, getAutoSaveEdits, getAutoSizeHeaderSpans, getBackgroundComponent, getBadFormulaResultValue, getBaseStyle, getBlockingRowCountFetch, getBody, getBodyBackgroundColor, getBodyOverflow, getBodyScrollLeft, getBodyScrollTop, getBooleanBaseStyle, getBooleanFalseImage, getBooleanImageHeight, getBooleanImageWidth, getBooleanPartialImage, getBooleanTrueImage, getBriefRowRangeDisplayValue, getCanAcceptDroppedRecords, getCanAddAISortFields, getCanAddFormulaFields, getCanAddSummaryFields, getCanAutoFitFields, getCancelEditingConfirmationMessage, getCanCollapseGroup, getCanDragRecordsOut, getCanDragSelectText, getCanDropInEmptyArea, getCanEditFieldAttribute, getCanEditHilites, getCanEditTitles, getCanExpandMultipleRecords, getCanExpandRecordProperty, getCanExpandRecords, getCanFocusInEmptyGrid, getCanFreezeFields, getCanGroupBy, getCanHiliteViaAI, getCanHover, getCanMultiGroup, getCanMultiSort, getCanPickFields, getCanPickOmittedFields, getCanRemoveRecords, getCanReorderFields, getCanReorderRecords, getCanRequestRowCount, getCanResizeFields, getCanSaveSearches, getCanSelectAll, getCanSelectCells, getCanSelectGroups, getCanSelectSummaryRows, getCanShowFilterEditor, getCanSort, getCanTabToHeader, getCanTabToSorter, getCellAriaState, getCellContextMenu, getCellContextMenuItems, getCellCSSText, getCellErrors, getCellHeight, getCellHoverComponent, getCellPadding, getCellPageRect, getCellRole, getCellRowSpan, getCellSelection, getCellStartRow, getCellStyle, getCheckboxFieldFalseImage, getCheckboxFieldImageHeight, getCheckboxFieldImageWidth, getCheckboxFieldPartialImage, getCheckboxFieldTrueImage, getChildExpansionMode, getClearAllSortingText, getClearCriteriaOnFilterEditorHide, getClearFilterText, getClearFilterViaAIText, getClearSortFieldText, getClipHeaderTitles, getCollapseGroupOnRowClick, getColumnLeft, getColumnPageLeft, getColumnWidth, getConfigureGroupingText, getConfigureSortText, getConfirmCancelEditing, getConfirmDiscardEdits, getConfirmDiscardEditsMessage, getCriteria, getCriteriaIndicatorColor, getCriteriaIndicatorHeaderColor, getCurrentExpansionComponent, getCurrentExpansionComponent, getCurrentFieldWidths, getDataArity, getDataAsJSList, getDataAsRecordList, getDataFetchDelay, getDataFetchMode, getDataPageSize, getDataSource, getDateFormatter, getDatetimeFormatter, getDeepCloneOnEdit, getDefaultDateFieldWidth, getDefaultDateTimeFieldWidth, getDefaultEditableDateFieldWidth, getDefaultEditableDateTimeFieldWidth, getDefaultFields, getDefaultFilterOperator, getDefaultFilterOperatorSuffix, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedValue, getDefaultTimeFieldWidth, getDeferRemoval, getDeselectOnPartialCheckboxClick, getDetailDS, getDetailField, getDisabledGroupByPrompt, getDiscardEditsOnHideField, getDiscardEditsSaveButtonTitle, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDragData, getDragDataAction, getDragHandleField, getDragHandleFieldTitle, getDragHandleIcon, getDragHandleIconSize, getDragScrollRedrawDelay, getDragTrackerMode, getDragTrackerStyle, getDrawAheadRatio, getDrawAllMaxCells, getDrawArea, getDrawnRowHeight, getDrawnRows, getDropValues, getDuplicateDragMessage, getEditCol, getEditedCell, getEditedCell, getEditedCell, getEditedRecord, getEditEvent, getEditFailedBaseStyle, getEditFailedCSSText, getEditFormItem, getEditFormItem, getEditFormulaFieldText, getEditOnF2Keypress, getEditOnFocus, getEditPendingBaseStyle, getEditPendingCSSText, getEditPendingMarkerStyle, getEditProxyConstructor, getEditRow, getEditSelectionType, getEditSummaryFieldText, getEditValue, getEditValueAsBoolean, getEditValueAsDate, getEditValueAsFloat, getEditValueAsInt, getEditValueAsRecord, getEditValueAsRecordArray, getEditValueAsString, getEditValues, getEditValues, getEmbeddedComponentIndent, getEmbeddedComponentMargin, getEmptyAIHoverContents, getEmptyCellValue, getEmptyMessage, getEmptyMessageStyle, getEmptyRowRangeDisplayValue, getEnforceVClipping, getEnterKeyEditAction, getEnumCriteriaAsInitialValues, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getEscapeKeyEditAction, getExactRowCountFormat, getExpandedRecords, getExpansionCanEdit, getExpansionComponent, getExpansionComponentPoolingMode, getExpansionDetailField, getExpansionDetailRelated, getExpansionDetails, getExpansionEditor, getExpansionEditorCollapseOnSave, getExpansionEditorSaveButton, getExpansionEditorSaveButtonTitle, getExpansionEditorSaveDialogPrompt, getExpansionEditorShowSaveDialog, getExpansionField, getExpansionFieldFalseImage, getExpansionFieldImageHeight, getExpansionFieldImageShowRTL, getExpansionFieldImageShowSelected, getExpansionFieldImageStyle, getExpansionFieldImageWidth, getExpansionFieldTrueImage, getExpansionIndent, getExpansionLayout, getExpansionMode, getExpansionRelated, getExpansionScreen, getExplicitFetchDelay, getExportAll, getExportAlternateRowBGColor, getExportBGColor, getExportColumnBGColor, getExportDefaultBGColor, getExportFieldAlignments, getExportFields, getExportFieldWidths, getExportHeaderHeights, getExportHiddenFieldWidth, getExportIncludeSummaries, getExportRawNumbers, getExportRawValues, getExportRowBGColor, getExportTextColor, getExportWidthScale, getExportWrapHeaderTitles, getFetchDelay, getFetchFields, getFetchFieldsAsString, getFetchOperation, getField, getField, getFieldAlignments, getFieldByName, getFieldContentWidth, getFieldCount, getFieldCriteriaText, getFieldName, getFieldNum, getFieldNum, getFieldPickerFieldProperties, getFieldPickerShowSampleValues, getFieldPickerWindow, getFields, getFieldsAsJavaScriptObjects, getFieldSearchOperator, getFieldState, getFieldTitle, getFieldTitle, getFieldWidth, getFieldWidth, getFilterButtonPrompt, getFilterButtonProperties, getFilterByCell, getFilterEditor, getFilterEditorCriteria, getFilterEditorCriteria, getFilterEditorCriteriaAsAdvancedCriteria, getFilterEditorCriterion, getFilterEditorHeight, getFilterEditorProperties, getFilterLocalData, getFilterOnKeypress, getFilterUsingText, getFilterViaAIMode, getFilterViaAIPanelInstructions, getFilterViaAIText, getFilterWindow, getFilterWindowCriteria, getFilterWindowCriteriaIndicator, getFilterWindowFilter, getFilterWindowInstructions, getFilterWindowTitle, getFirstCellStyle, getFixedFieldWidths, getFixedRecordHeights, getFocusRow, getFormattedRowCount, getFormattedRowRange, getFormulaBuilderSpanTitleSeparator, getFormulaFieldValue, getFreezeFieldText, getFrozenBaseStyle, getFrozenFieldsMaxWidth, getFrozenFieldsMaxWidthAsInt, getFrozenHeaderBaseStyle, getFrozenHeaderTitleStyle, getFrozenRollOverCanvas, getFrozenRollUnderCanvas, getFullRowRangeDisplayValue, getGenerateClickOnEnter, getGenerateClickOnSpace, getGenerateDoubleClickOnEnter, getGenerateDoubleClickOnSpace, getGridAdditionalCriteriaText, getGridComponents, getGridRenderer, getGridSummary, getGridSummaryData, getGridSummaryRecordProperty, getGroupByAsyncThreshold, getGroupByFields, getGroupByFieldSummaries, getGroupByMaxRecords, getGroupByMaxRecordsExceededMessage, getGroupByText, getGroupedRecordIndex, getGroupIcon, getGroupIconSize, getGroupIconStyle, getGroupIndentSize, getGroupLeadingIndent, getGroupMembers, getGroupNodeBaseStyle, getGroupNodeStyle, getGroupSortDirection, getGroupState, getGroupSummaryData, getGroupSummaryData, getGroupSummaryData, getGroupSummaryData, getGroupSummaryRecordProperty, getGroupSummaryStyle, getGroupTitleColumnProperties, getGroupTitleField, getGroupTree, getGroupTreeSelection, getGroupTreeSelection, getGroupTreeSelection, getHeader, getHeaderAriaRole, getHeaderAutoFitEvent, getHeaderBackgroundColor, getHeaderBarStyle, getHeaderBaseStyle, getHeaderButtonAriaRole, getHeaderButtonAriaState, getHeaderButtonProperties, getHeaderContextMenu, getHeaderContextMenuItems, getHeaderHeight, getHeaderHoverAlign, getHeaderHoverHeight, getHeaderHoverOpacity, getHeaderHoverStyle, getHeaderHoverVAlign, getHeaderHoverWidth, getHeaderHoverWrap, getHeaderMenuButton, getHeaderMenuButtonHeight, getHeaderMenuButtonHeightAsString, getHeaderMenuButtonIcon, getHeaderMenuButtonIconHeight, getHeaderMenuButtonIconWidth, getHeaderMenuButtonSnapOffsetLeft, getHeaderMenuButtonWidth, getHeaderRadius, getHeaderShadowColor, getHeaderShadowHOffset, getHeaderShadowSoftness, getHeaderShadowVOffset, getHeaderSpan, getHeaderSpanContextMenuItems, getHeaderSpanHeight, getHeaderTitleStyle, getHeaderTitleVAlign, getHideEmptySummaryRow, getHideFilterEditorTitle, getHiliteCanReplaceValue, getHiliteEditorSpanTitleSeparator, getHiliteHTMLAfterFormat, getHiliteIconHeight, getHiliteIconLeftPadding, getHiliteIconPosition, getHiliteIconRightPadding, getHiliteIcons, getHiliteIconSize, getHiliteIconWidth, getHiliteProperty, getHiliteReplaceValueFieldTitle, getHiliteRowOnFocus, getHiliteState, getHiliteViaAIMode, getHiliteViaAIText, getHoverMode, getHoverScreen, getHoverStyle, getIconCursor, getIconPadding, getImageSize, getImplicitCriteria, getIncludeHilitesInSummaryFields, getIncludeInSummaryProperty, getInitialCriteria, getInitialSort, getInstantScrollTrackRedraw, getInvalidSummaryValue, getIsGrouped, getIsSeparatorProperty, getLastCellStyle, getLeaveScrollbarGap, getLinkTextProperty, getListEndEditAction, getLoadingDataMessage, getLoadingDataMessageStyle, getLoadingMessage, getLoadingRowCountDisplayIcoHeight, getLoadingRowCountDisplayIcon, getLoadingRowCountDisplayIconWidth, getLocateColumnsBy, getLocateRowsBy, getLongTextEditorThreshold, getLongTextEditorType, getMaxExpandedRecords, getMaxExpandedRecordsPrompt, getMaximumRowCountFormat, getMaxSummaryRowRecords, getMinFieldWidth, getMinHeight, getMinimumCellHeight, getMinimumRowCountFormat, getMissingSummaryFieldValue, getModalEditing, getMultiGroupDialogDefaults, getMultiGroupDialogProperties, getNavigateOnTab, getNeverValidate, getNewRecordRowMessage, getNewSearchText, getNormalBaseStyle, getNormalCellHeight, getNoSavedSearchesText, getNullGroupTitle, getOfflineMessageStyle, getOperatorIcon, getOriginalRecordList, getOriginalResultSet, getOriginBaseStyle, getOverflow, getPendingAsyncCellValue, getPlaceholderAIHoverContents, getPoolComponentsPerColumn, getPreserveFocusStylingOnMouseOut, getPreserveWhitespace, getPreventDuplicates, getPrintAutoFit, getPrintBaseStyle, getPrintBooleanBaseStyle, getPrintBooleanFalseImage, getPrintBooleanPartialImage, getPrintBooleanTrueImage, getPrintCheckboxFieldFalseImage, getPrintCheckboxFieldPartialImage, getPrintCheckboxFieldTrueImage, getPrintHeaderStyle, getPrintMaxRows, getPrintWrapCells, getProgressiveLoading, getQuickDrawAheadRatio, getRangeRowCountFormat, getRecord, getRecordBaseStyleProperty, getRecordCanRemoveProperty, getRecordCanSelectProperty, getRecordCellRoleProperty, getRecordComponent, getRecordComponent, getRecordComponentHeight, getRecordComponentPoolingMode, getRecordComponentPosition, getRecordDetailDSProperty, getRecordDropAppearance, getRecordDropPosition, getRecordEditProperty, getRecordEnabledProperty, getRecordIndex, getRecordIndex, getRecordList, getRecordRadius, getRecordRadiusTargets, getRecordRowAriaStateProperty, getRecordRowRoleProperty, getRecords, getRecordScreen, getRecordShowRollOverProperty, getRecordSummaryAttributePrefix, getRecordSummaryBaseStyle, getRelatedDataSource, getRemovedCSSText, getRemoveFieldDefaults, getRemoveFieldProperties, getRemoveFieldTitle, getRemoveIcon, getRemoveIconSize, getRemoveIconStyle, getRemoveOperation, getReselectOnUpdate, getReselectOnUpdateNotifications, getResizeFieldsInRealTime, getResultSet, getReverseRTLAlign, getRollOverCanvas, getRollUnderCanvas, getRotatedHeaderMenuButtonHeight, getRotatedHeaderMenuButtonHeightAsString, getRotatedHeaderMenuButtonWidth, getRowAriaState, getRowCount, getRowCountDisplayPrecision, getRowCountRange, getRowCountStatus, getRowEndEditAction, getRowErrors, getRowHeight, getRowLocatorField, getRowLocatorFieldAsStringArray, getRowNum, getRowNumberField, getRowNumberStart, getRowNumberStyle, getRowPageTop, getRowRangeDisplay, getRowRangeDisplayStyle, getRowRangeDisplayValue, getRowRangeFormat, getRowRole, getRowSpan, getRowSpanEditMode, getRowSpanSelectionMode, getRowTop, getSaveCriteriaInViewState, getSaveDefaultSearch, getSavedSearchAdminRole, getSavedSearchAdminSeparator, getSavedSearchDS, getSavedSearchId, getSavedSearchStoredState, getSavedSearchText, getSavedViewState, getSaveLocally, getSaveRequestProperties, getScreenReaderCellSeparator, getScreenReaderIncludeFieldTitles, getScreenReaderNavigateByCell, getScreenReaderRowSeparator, getScreenReaderWriteRowLabelledBy, getScrollRedrawDelay, getScrollToCellXPosition, getScrollToCellYPosition, getScrollWheelRedrawDelay, getSearchForm, getSearchFormAsValuesManager, getSelectCellTextOnClick, getSelectedCellData, getSelectedRecord, getSelectedRecords, getSelectedRecords, getSelectedState, getSelectHeaderOnSort, getSelection, getSelection, getSelectionAppearance, getSelectionProperty, getSelectionType, getSelectOnEdit, getSelectOnExpandRecord, getSeparatorRowStyle, getShowAllColumns, getShowAllRecords, getShowAsynchGroupingPrompt, getShowBackgroundComponents, getShowCellContextMenus, getShowClippedHeaderTitlesOnHover, getShowClippedValuesOnHover, getShowCollapsedGroupSummary, getShowComplexFields, getShowDetailFields, getShowDropLines, getShowEllipsisWhenClipped, getShowEmptyMessage, getShowErrorIcons, getShowExpansionEditorSaveButton, getShowFilterEditor, getShowFilterEditorHovers, getShowFilterEditorTitle, getShowFilterWindowCriteriaIndicator, getShowGridSummary, getShowGroupSummary, getShowGroupSummaryInHeader, getShowGroupTitleColumn, getShowGroupTitleInFrozenBody, getShowHeader, getShowHeaderContextMenu, getShowHeaderMenuButton, getShowHeaderPartialSelection, getShowHeaderShadow, getShowHeaderSpanContextMenu, getShowHeaderSpanTitlesInFormulaBuilder, getShowHeaderSpanTitlesInHiliteEditor, getShowHeaderSpanTitlesInSortEditor, getShowHiddenFields, getShowHilitesInGroupSummary, getShowHover, getShowHoverComponents, getShowHoverOnDisabledCells, getShowInitialDragHandles, getShowNewRecordRow, getShowPartialSelection, getShowRecordComponents, getShowRecordComponentsByCell, getShowRollOver, getShowRollOverCanvas, getShowRollOverInExpansion, getShowRollUnderCanvas, getShowRowNumbers, getShowSavedSearchesByDS, getShowSelectedRollOverCanvas, getShowSelectedRollUnderCanvas, getShowSelectedStyle, getShowSelectionCanvas, getShowSelectionUnderCanvas, getShowSortArrow, getShowSortNumerals, getShowTreeColumnPicker, getShrinkForFreeze, getSingleCellValueProperty, getSkipLineBreaks, getSort, getSortArrowMenuButtonSpaceOffset, getSortAscendingImage, getSortAscendingImageAsImgHTMLProperties, getSortBinaryByFileName, getSortByGroupFirst, getSortDescendingImage, getSortDescendingImageAsImgHTMLProperties, getSortEditorSpanTitleSeparator, getSorterButtonTitle, getSortField, getSortFieldAscendingText, getSortFieldCount, getSortFieldDescendingText, getSortNumeralHTML, getSortNumeralMenuButtonSpaceOffset, getSortNumeralStyle, getSortSpecifier, getSortState, getSpanContextMenu, getSpannedHeaderBaseStyle, getSparseFieldState, getStopOnErrors, getStyledRowEnds, getSummaryFieldValue, getSummaryRow, getSummaryRowCriteria, getSummaryRowDataSource, getSummaryRowFetchRequestProperties, getSummaryRowHeight, getSummaryRowStyle, getTableRowStyle, getTallBaseStyle, getTitleField, getTitleFieldValue, getToggleFreezeText, getTotalRows, getTouchScrollRedrawDelay, getTrackerImage, getTrackerImageAsImgHTMLProperties, getUnfreezeFieldText, getUngroupText, getUnknownRowCountDisplayValue, getUnremoveIcon, getUpdateOperation, getUpdateSummariesDuringEditing, getUseAdvancedCriteria, getUseAdvancedFieldPicker, getUseAllDataSourceFields, getUseCellRollOvers, getUseClientFiltering, getUseCopyPasteShortcuts, getUseFlatFields, getUseMultiSelectForFilterValueMaps, getUserCriteriaState, getUseRemoteValidators, getUseRowSpanStyling, getValidateByCell, getValidateOnChange, getValueIcon, getValueIconCursor, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVirtualScrolling, getVisibleRows, getWaitForSave, getWarnOnRemoval, getWarnOnRemovalMessage, getWarnOnUnmappedValueFieldChange, getWrapCells, getWrapHeaderSpanTitles, getWrapHeaderTitles, groupBy, groupSortNormalizer, hasErrors, headerHoverHTML, headerTitleClipped, hideDragHandles, hideField, hideField, hideFields, hideFields, hideFields, hideFields, invalidateCache, invalidateRecordComponents, isCheckboxField, isExpanded, isExpansionField, isExportingClientData, isGrouped, isGroupNode, isPartiallySelected, isRowNumberField, isSelected, isSortField, isSummaryRecord, markForRedraw, markForRedraw, markRecordRemoved, markRecordsRemoved, markRecordsRemoved, markRecordsRemoved, markSelectionRemoved, onInit_ListGrid, onInit, openGroup, openRecordDetailGrid, openRecordEditor, preloadImages, recalculateGridSummary, recalculateSummaries, recalculateSummaries, recalculateSummaries, recordClick, recordMarkedAsRemoved, redrawHeader, refreshCell, refreshCell, refreshCellStyle, refreshData, refreshData, refreshFields, refreshRecordComponent, refreshRecordComponent, refreshRow, regroup, removeData, removeData, removeData, removeEmbeddedComponent, removeEmbeddedComponent, removeEmbeddedComponent, removeRecordClick, removeSelectedData, removeSelectedData, removeSelectedData, removeSelectedData, reorderField, reorderFields, resizeField, resort, rowClick, rowClick, rowDoubleClick, rowDoubleClick, rowHasChanges, rowHasChanges, rowHasErrors, saveAllEdits, saveAllEdits, saveAllEdits, saveEdits, saveEdits, saveEdits, saveEdits, scrollBodyTo, scrollToCell, scrollToCell, scrollToCell, scrollToColumn, scrollToColumn, scrollToRow, scrollToRow, selectAllRecords, selectRange, selectRange, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, selectSingleRecord, selectSingleRecord, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAdvancedFieldPickerThreshold, setAdvancedFilteringText, setAiFilterWindowHint, setAiFilterWindowInstructions, setAiFilterWindowTitle, setAiHoverContentsPrefix, setAiHoverRetryDelay, setAiSortFieldMaxRecordsMessage, setAllowFilterExpressions, setAllowFilterOperators, setAllowFilterWindow, setAllowRowSpanning, setAlternateBodyStyleName, setAlternateFieldFrequency, setAlternateFieldStyles, setAlternateFieldSuffix, setAlternateRecordFrequency, setAlternateRecordSuffix, setAlwaysShowEditors, setAlwaysShowOperatorIcon, setAnimateFolderEffect, setAnimateFolderMaxRows, setAnimateFolders, setAnimateFolderSpeed, setAnimateFolderTime, setAnimateRemoveRecord, setAnimateRemoveSpeed, setAnimateRemoveTime, setAnimateRollOver, setAnimateRollUnder, setAnimateSelection, setAnimateSelectionUnder, setApplyFormulaAfterSummary, setApplyRowCountToLength, setApplyRowNumberStyle, setApproximateRowCountFormat, setAriaRole, setArrowKeyAction, setArrowKeyEditAction, setAsyncErrorCellValue, setAsynchGroupingPrompt, setAsyncMissingCellValue, setAutoChildProperties, setAutoComplete, setAutoConfirmSaveEdits, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchDisplayMap, setAutoFetchRowCount, setAutoFitAllText, setAutoFitClipFields, setAutoFitData, setAutoFitDateFields, setAutoFitExpandField, setAutoFitExtraRecords, setAutoFitFieldsFillViewport, setAutoFitFieldText, setAutoFitHeaderHeights, setAutoFitIconFields, setAutoFitMaxColumns, setAutoFitMaxHeight, setAutoFitMaxRecords, setAutoFitMaxWidth, setAutoFitMaxWidth, setAutoFitTimeFields, setAutoFitWidth, setAutoFitWidthApproach, setAutoPersistViewState, setAutoSaveEdits, setAutoSizeHeaderSpans, setBadFormulaResultValue, setBlockingRowCountFetch, setBodyBackgroundColor, setBodyOverflow, setBooleanBaseStyle, setBooleanFalseImage, setBooleanImageHeight, setBooleanImageWidth, setBooleanPartialImage, setBooleanTrueImage, setBriefRowRangeDisplayValue, setCanAcceptDroppedRecords, setCanAddAISortFields, setCanAddFormulaFields, setCanAddSummaryFields, setCanAutoFitFields, setCancelEditingConfirmationMessage, setCanCollapseGroup, setCanDragRecordsOut, setCanDragSelectText, setCanDropInEmptyArea, setCanEditFieldAttribute, setCanEditHilites, setCanEditTitles, setCanExpandMultipleRecords, setCanExpandRecordProperty, setCanExpandRecords, setCanFocusInEmptyGrid, setCanFreezeFields, setCanGroupBy, setCanHiliteViaAI, setCanHover, setCanMultiGroup, setCanMultiSort, setCanPickFields, setCanPickOmittedFields, setCanRemoveRecords, setCanReorderFields, setCanReorderRecords, setCanRequestRowCount, setCanResizeFields, setCanSaveSearches, setCanSelectAll, setCanSelectCells, setCanSelectGroups, setCanSelectRecordCustomizer, setCanSelectSummaryRows, setCanShowFilterEditor, setCanSort, setCanTabToHeader, setCanTabToSorter, setCellContextMenuItemsCustomizer, setCellCSSTextCustomizer, setCellFormatter, setCellHeight, setCellPadding, setCellRole, setCellValueHoverFormatter, setCheckboxFieldFalseImage, setCheckboxFieldImageHeight, setCheckboxFieldImageWidth, setCheckboxFieldPartialImage, setCheckboxFieldProperties, setCheckboxFieldTrueImage, setChildExpansionMode, setClearAllSortingText, setClearCriteriaOnFilterEditorHide, setClearFilterText, setClearFilterViaAIText, setClearSortFieldText, setClipHeaderTitles, setCollapseGroupOnRowClick, setConfigureGroupingText, setConfigureSortText, setConfirmCancelEditing, setConfirmDiscardEdits, setConfirmDiscardEditsMessage, setCriteria, setCriteriaIndicatorColor, setCriteriaIndicatorHeaderColor, setData, setData, setData, setDataArity, setDataFetchDelay, setDataFetchMode, setDataPageSize, setDataProperties, setDataSource, setDataSource, setDataSource, setDateFormatter, setDateInputFormat, setDatetimeFormatter, setDeepCloneOnEdit, setDefaultDateFieldWidth, setDefaultDateTimeFieldWidth, setDefaultEditableDateFieldWidth, setDefaultEditableDateTimeFieldWidth, setDefaultFields, setDefaultFieldWidthCustomizer, setDefaultFilterOperator, setDefaultFilterOperatorSuffix, setDefaultProperties, setDefaultTimeFieldWidth, setDeferRemoval, setDeselectOnPartialCheckboxClick, setDetailDS, setDetailDS, setDetailField, setDisabledGroupByPrompt, setDiscardEditsOnHideField, setDiscardEditsSaveButtonTitle, setDontAutoDestroyComponent, setDragDataAction, setDragDataCustomizer, setDragHandleFieldTitle, setDragHandleIcon, setDragHandleIconSize, setDragScrollRedrawDelay, setDragTrackerIconCustomizer, setDragTrackerMode, setDragTrackerStyle, setDragTrackerTitleCustomizer, setDrawAheadRatio, setDrawAllMaxCells, setDropValues, setDuplicateDragMessage, setEditByCell, setEditEvent, setEditFailedBaseStyle, setEditFailedCSSText, setEditFormulaFieldText, setEditOnF2Keypress, setEditOnFocus, setEditorCustomizer, setEditorValueMap, setEditorValueMap, setEditPendingBaseStyle, setEditPendingCSSText, setEditPendingMarkerStyle, setEditProxyConstructor, setEditSelectionType, setEditSummaryFieldText, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValues, setEmbeddedComponentIndent, setEmbeddedComponentMargin, setEmptyAIHoverContents, setEmptyCellValue, setEmptyMessage, setEmptyMessageStyle, setEmptyRowRangeDisplayValue, setEnforceVClipping, setEnterKeyEditAction, setEnumCriteriaAsInitialValues, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setEscapeKeyEditAction, setExactRowCountFormat, setExpansionCanEdit, setExpansionComponentPoolingMode, setExpansionEditorSaveDialogPrompt, setExpansionEditorShowSaveDialog, setExpansionFieldFalseImage, setExpansionFieldImageHeight, setExpansionFieldImageShowRTL, setExpansionFieldImageShowSelected, setExpansionFieldImageStyle, setExpansionFieldImageWidth, setExpansionFieldTrueImage, setExpansionIndent, setExpansionMode, setExpansionScreen, setExplicitFetchDelay, setExportAll, setExportAlternateRowBGColor, setExportDefaultBGColor, setExportFieldAlignments, setExportFields, setExportFieldWidths, setExportHeaderHeights, setExportHiddenFieldWidth, setExportIncludeSummaries, setExportRawNumbers, setExportRawValues, setExportWidthScale, setExportWrapHeaderTitles, setFastCellUpdates, setFetchDelay, setFetchFields, setFetchFields, setFetchOperation, setFieldButtonProperties, setFieldCellIcon, setFieldCriteriaText, setFieldError, setFieldError, setFieldHeaderBaseStyle, setFieldHeaderTitleStyle, setFieldIcon, setFieldMaxWidth, setFieldMinWidth, setFieldPickerFieldProperties, setFieldPickerShowSampleValues, setFieldProperties, setFieldProperties, setFields, setFields, setFieldSearchOperator, setFieldState, setFieldTitle, setFieldTitle, setFilterButtonPrompt, setFilterButtonProperties, setFilterByCell, setFilterEditorCriteria, setFilterEditorHeight, setFilterEditorProperties, setFilterEditorProperties, setFilterLocalData, setFilterOnKeypress, setFilterUsingText, setFilterViaAIMode, setFilterViaAIPanelInstructions, setFilterViaAIText, setFilterWindowCriteria, setFilterWindowInstructions, setFilterWindowTitle, setFirstCellStyle, setFixedFieldWidths, setFixedRecordHeights, setFormulaBuilderSpanTitleSeparator, setFreezeFieldText, setFrozenBaseStyle, setFrozenFieldsMaxWidth, setFrozenFieldsMaxWidth, setFrozenHeaderBaseStyle, setFrozenHeaderTitleStyle, setFullRowRangeDisplayValue, setGenerateClickOnEnter, setGenerateClickOnSpace, setGenerateDoubleClickOnEnter, setGenerateDoubleClickOnSpace, setGridAdditionalCriteriaText, setGridComponents, setGridComponents, setGridSummaryRecordProperty, setGroupByAsyncThreshold, setGroupByField, setGroupByField, setGroupByFieldSummaries, setGroupByMaxRecords, setGroupByMaxRecordsExceededMessage, setGroupByText, setGroupIcon, setGroupIconSize, setGroupIconStyle, setGroupIndentSize, setGroupLeadingIndent, setGroupNodeBaseStyle, setGroupNodeStyle, setGroupSortDirection, setGroupSortNormalizer, setGroupStartOpen, setGroupStartOpen, setGroupState, setGroupSummaryRecordProperty, setGroupSummaryStyle, setGroupTitleColumnProperties, setGroupTitleField, setHeaderAriaRole, setHeaderAutoFitEvent, setHeaderBackgroundColor, setHeaderBarStyle, setHeaderBaseStyle, setHeaderButtonAriaRole, setHeaderButtonAriaState, setHeaderButtonProperties, setHeaderHeight, setHeaderHoverAlign, setHeaderHoverFormatter, setHeaderHoverHeight, setHeaderHoverOpacity, setHeaderHoverStyle, setHeaderHoverVAlign, setHeaderHoverWidth, setHeaderHoverWrap, setHeaderMenuButtonHeight, setHeaderMenuButtonHeight, setHeaderMenuButtonIcon, setHeaderMenuButtonIconHeight, setHeaderMenuButtonIconWidth, setHeaderMenuButtonSnapOffsetLeft, setHeaderMenuButtonWidth, setHeaderRadius, setHeaderShadowColor, setHeaderShadowHOffset, setHeaderShadowSoftness, setHeaderShadowVOffset, setHeaderSpanBaseStyle, setHeaderSpanButtonProperties, setHeaderSpanHeaderTitle, setHeaderSpanHeight, setHeaderSpans, setHeaderSpanTitle, setHeaderSpanTitleStyle, setHeaderTitleStyle, setHeaderTitleVAlign, setHideEmptySummaryRow, setHideFilterEditorTitle, setHideOnPhone, setHideOnTablet, setHiliteCanReplaceValue, setHiliteEditorSpanTitleSeparator, setHiliteHTMLAfterFormat, setHiliteIconHeight, setHiliteIconLeftPadding, setHiliteIconPosition, setHiliteIconRightPadding, setHiliteIcons, setHiliteIconSize, setHiliteIconWidth, setHiliteProperty, setHiliteReplaceValueFieldTitle, setHiliteRowOnFocus, setHiliteState, setHiliteViaAIMode, setHiliteViaAIText, setHoverCustomizer, setHoverMode, setHoverScreen, setHoverStyle, setIconCursor, setIconPadding, setImageSize, setImplicitCriteria, setImplicitCriteria, setImplicitCriteria, setInactiveCellFormatter, setIncludeHilitesInSummaryFields, setIncludeInSummaryProperty, setInitialCriteria, setInitialSort, setInstantScrollTrackRedraw, setInvalidSummaryValue, setIsSeparatorProperty, setLastCellStyle, setLeaveHeaderMenuButtonSpace, setLeaveScrollbarGap, setLinkTextProperty, setListEndEditAction, setLoadingDataMessage, setLoadingDataMessageStyle, setLoadingMessage, setLoadingRowCountDisplayIcoHeight, setLoadingRowCountDisplayIcon, setLoadingRowCountDisplayIconWidth, setLocateColumnsBy, setLocateRowsBy, setLogicalStructure, setLongTextEditorThreshold, setLongTextEditorType, setMaxExpandedRecords, setMaxExpandedRecordsPrompt, setMaximumRowCountFormat, setMaxSummaryRowRecords, setMinFieldWidth, setMinHeight, setMinimumCellHeight, setMinimumRowCountFormat, setMissingSummaryFieldValue, setModalEditing, setMultiGroupDialogDefaults, setMultiGroupDialogProperties, setMultiSortDialogDefaults, setMultiSortDialogProperties, setNavigateOnTab, setNeverValidate, setNewRecordRowMessage, setNewSearchText, setNormalBaseStyle, setNormalCellHeight, setNoSavedSearchesText, setNullGroupTitle, setOfflineMessageStyle, setOriginBaseStyle, setOverflow, setPendingAsyncCellValue, setPlaceholderAIHoverContents, setPoolComponentsPerColumn, setPreserveFocusStylingOnMouseOut, setPreserveWhitespace, setPreventDuplicates, setPrintAutoFit, setPrintBaseStyle, setPrintBooleanBaseStyle, setPrintBooleanFalseImage, setPrintBooleanPartialImage, setPrintBooleanTrueImage, setPrintCheckboxFieldFalseImage, setPrintCheckboxFieldPartialImage, setPrintCheckboxFieldTrueImage, setPrintHeaderStyle, setPrintMaxRows, setPrintWrapCells, setProgressiveLoading, setQuickDrawAheadRatio, setRangeRowCountFormat, setRecordBaseStyleProperty, setRecordCanRemoveProperty, setRecordCanSelectProperty, setRecordCellRoleProperty, setRecordComponentHeight, setRecordComponentPoolingMode, setRecordComponentPosition, setRecordDetailDSProperty, setRecordDropAppearance, setRecordEditProperty, setRecordEnabledProperty, setRecordRadius, setRecordRadiusTargets, setRecordRowAriaStateProperty, setRecordRowRoleProperty, setRecords, setRecordScreen, setRecordShowRollOverProperty, setRecordSummaryAttributePrefix, setRecordSummaryBaseStyle, setRemovedCSSText, setRemoveFieldProperties, setRemoveFieldTitle, setRemoveIcon, setRemoveIconSize, setRemoveIconStyle, setRemoveOperation, setReselectOnUpdate, setReselectOnUpdateNotifications, setResizeFieldsInRealTime, setReverseRTLAlign, setRollOverCanvasProperties, setRollUnderCanvasProperties, setRotatedHeaderMenuButtonHeight, setRotatedHeaderMenuButtonHeight, setRotatedHeaderMenuButtonWidth, setRowAriaState, setRowCountDisplayPrecision, setRowEndEditAction, setRowErrors, setRowErrors, setRowLocatorField, setRowLocatorField, setRowNumberFieldProperties, setRowNumberStart, setRowNumberStyle, setRowRangeDisplayStyle, setRowRangeFormat, setRowRole, setRowSpanEditMode, setRowSpanSelectionMode, setSaveByCell, setSaveCriteriaInViewState, setSaveDefaultSearch, setSavedSearchAdminRole, setSavedSearchDS, setSavedSearchId, setSavedSearchStoredState, setSavedSearchText, setSaveLocally, setSaveRequestProperties, setScreenReaderCellSeparator, setScreenReaderIncludeFieldTitles, setScreenReaderNavigateByCell, setScreenReaderRowSeparator, setScreenReaderWriteRowLabelledBy, setScrollRedrawDelay, setScrollToCellXPosition, setScrollToCellYPosition, setScrollWheelRedrawDelay, setSearchForm, setSearchForm, setSelectCellTextOnClick, setSelectedState, setSelectHeaderOnSort, setSelectionAppearance, setSelectionCanvasProperties, setSelectionProperty, setSelectionType, setSelectionUnderCanvasProperties, setSelectOnEdit, setSelectOnExpandRecord, setSeparatorRowStyle, setShowAllColumns, setShowAllRecords, setShowAsynchGroupingPrompt, setShowBackgroundComponents, setShowCellContextMenus, setShowClippedHeaderTitlesOnHover, setShowClippedValuesOnHover, setShowCollapsedGroupSummary, setShowComplexFields, setShowDetailFields, setShowDropLines, setShowEllipsisWhenClipped, setShowEmptyMessage, setShowErrorIcons, setShowFilterEditor, setShowFilterEditorHovers, setShowFilterEditorTitle, setShowFilterWindowCriteriaIndicator, setShowGridSummary, setShowGroupSummary, setShowGroupSummaryInHeader, setShowGroupTitleColumn, setShowGroupTitleInFrozenBody, setShowHeader, setShowHeaderContextMenu, setShowHeaderMenuButton, setShowHeaderPartialSelection, setShowHeaderShadow, setShowHeaderSpanContextMenu, setShowHeaderSpanTitlesInFormulaBuilder, setShowHeaderSpanTitlesInHiliteEditor, setShowHeaderSpanTitlesInSortEditor, setShowHiddenFields, setShowHilitesInGroupSummary, setShowHover, setShowHoverComponents, setShowHoverOnDisabledCells, setShowInitialDragHandles, setShowNewRecordRow, setShowPartialSelection, setShowRecordComponents, setShowRecordComponentsByCell, setShowRollOver, setShowRollOverCanvas, setShowRollOverInExpansion, setShowRollUnderCanvas, setShowRowNumbers, setShowSavedSearchesByDS, setShowSelectedRollOverCanvas, setShowSelectedRollUnderCanvas, setShowSelectedStyle, setShowSelectionCanvas, setShowSelectionUnderCanvas, setShowSortArrow, setShowSortNumerals, setShowTreeColumnPicker, setShrinkForFreeze, setSingleCellValueProperty, setSkipLineBreaks, setSort, setSortArrowMenuButtonSpaceOffset, setSortAscendingImage, setSortAscendingImage, setSortBinaryByFileName, setSortByGroupFirst, setSortDescendingImage, setSortDescendingImage, setSortEditorSpanTitleSeparator, setSorterButtonTitle, setSortField, setSortField, setSortField, setSortFieldAscendingText, setSortFieldDescendingText, setSortNumeralHTMLCustomizer, setSortNumeralMenuButtonSpaceOffset, setSortNumeralStyle, setSortState, setSpannedHeaderBaseStyle, setSparseFieldState, setStopOnErrors, setStyledRowEnds, setSummaryRowCriteria, setSummaryRowDataSource, setSummaryRowFetchRequestProperties, setSummaryRowHeight, setSummaryRowStyle, setTableRowStyle, setTallBaseStyle, setTitleField, setTouchScrollRedrawDelay, setTrackerImage, setTrackerImage, setUnfreezeFieldText, setUngroupText, setUnknownRowCountDisplayValue, setUnremoveIcon, setUpdateOperation, setUpdateSummariesDuringEditing, setUseAdvancedCriteria, setUseAdvancedFieldPicker, setUseAllDataSourceFields, setUseCellRollOvers, setUseClientFiltering, setUseCopyPasteShortcuts, setUseFlatFields, setUseMultiSelectForFilterValueMaps, setUserAIFilterRequest, setUserAIFilterRequest, setUserAIFilterRequest, setUserCriteriaState, setUseRemoteValidators, setUserFormula, setUserFormula, setUserFormula, setUserFormulaText, setUserFormulaText, setUserFormulaText, setUseRowSpanStyling, setUserSummary, setUserSummary, setUserSummary, setUserSummaryText, setUserSummaryText, setUserSummaryText, setValidateByCell, setValidateOnChange, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVirtualScrolling, setWaitForSave, setWarnOnRemoval, setWarnOnRemovalMessage, setWarnOnUnmappedValueFieldChange, setWrapCells, setWrapHeaderSpanTitles, setWrapHeaderTitles, shouldIncludeHiliteInSummaryField, showAIFilterWindow, showAIHiliteWindow, showDragHandles, showField, showField, showFields, showFields, showFields, showFields, showFilterWindow, showRecordComponent, sort, sort, sort, sort, startEditing, startEditing, startEditing, startEditing, startEditingNew, startEditingNew, startEditingNew, startEditingNew, stopHover, summaryUpdated, toggleSort, transferRecords, transferSelectedData, transferSelectedData, unfreezeField, unfreezeField, unfreezeField, unfreezeField, unfreezeFields, unfreezeFields, ungroup, unmarkRecordRemoved, unsort, updateData, updateData, updateData, updateRecordComponent, userSelectAllRecords, validateCell, validateCell, validateRow, willAcceptDrop, willFetchData, willFetchData
setDefaultProperties, setLogicalStructure
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, animateHide, 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, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, 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, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestDataContext, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, 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, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getOrCreateJsObj
public CubeGrid()
public CubeGrid(com.google.gwt.core.client.JavaScriptObject jsObj)
public static CubeGrid getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
protected CubeGrid getTestInstance()
getTestInstance
in class ListGrid
public 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
.AutoChildUsage
public 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
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public CubeGrid setAlternateRecordStyles(java.lang.Boolean alternateRecordStyles)
setAlternateRecordStyles
in class ListGrid
alternateRecordStyles
- New alternateRecordStyles value. Default value is trueCubeGrid
instance, for chaining setter callsAppearance overview and related methods
public java.lang.Boolean getAlternateRecordStyles()
getAlternateRecordStyles
in class ListGrid
Appearance overview and related methods
public CubeGrid setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle) throws java.lang.IllegalStateException
autoFetchData
is true
, this attribute
allows the developer to specify a textMatchStyle for the initial fetchData()
call.setAutoFetchTextMatchStyle
in interface DataBoundComponent
setAutoFetchTextMatchStyle
in class ListGrid
autoFetchTextMatchStyle
- New autoFetchTextMatchStyle value. Default value is "exact"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDataBinding
public TextMatchStyle getAutoFetchTextMatchStyle()
autoFetchData
is true
, this attribute
allows the developer to specify a textMatchStyle for the initial fetchData()
call.getAutoFetchTextMatchStyle
in interface DataBoundComponent
getAutoFetchTextMatchStyle
in class ListGrid
DataBinding
public CubeGrid setAutoFitColumnTitle(java.lang.String autoFitColumnTitle)
autoFitColumnTitle
- New autoFitColumnTitle value. Default value is "AutoFit Column"CubeGrid
instance, for chaining setter callspublic java.lang.String getAutoFitColumnTitle()
public CubeGrid setAutoFitFieldWidths(java.lang.Boolean autoFitFieldWidths) throws java.lang.IllegalStateException
CubeGrid
. Consider setting explicit widths via FacetValue.width
or defaultFacetWidth
.
setAutoFitFieldWidths
in class ListGrid
autoFitFieldWidths
- New autoFitFieldWidths value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoFitFieldWidths()
CubeGrid
. Consider setting explicit widths via FacetValue.width
or defaultFacetWidth
.
getAutoFitFieldWidths
in class ListGrid
public CubeGrid setAutoSelectHeaders(java.lang.Boolean autoSelectHeaders)
autoSelectHeaders
- New autoSelectHeaders value. Default value is trueCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getAutoSelectHeaders()
public CubeGrid setAutoSelectValues(AutoSelectionModel autoSelectValues) throws java.lang.IllegalStateException
autoSelectValues
- New autoSelectValues value. Default value is "both"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic AutoSelectionModel getAutoSelectValues()
public CubeGrid setAutoSizeHeaders(java.lang.Boolean autoSizeHeaders)
autoSizeHeaders
- New autoSizeHeaders value. Default value is falseCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getAutoSizeHeaders()
public CubeGrid 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 ListGrid.normalBaseStyle
or ListGrid.tallBaseStyle
as described in ListGrid.getBaseStyle()
. See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
setBaseStyle
in class ListGrid
baseStyle
- New baseStyle value. Default value is "cubeCell"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getBaseStyle()
base cell style
for this listGrid. If this property
is unset, base style may be derived from ListGrid.normalBaseStyle
or ListGrid.tallBaseStyle
as described in ListGrid.getBaseStyle()
. See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
getBaseStyle
in class ListGrid
getCellStyle()
for a general discussion of how to style cells. Default value is "cubeCell"CSSStyleName
,
Appearance overview and related methods
public CubeGrid setBodyMinHeight(java.lang.Integer bodyMinHeight)
Note : This is an advanced setting
bodyMinHeight
- New bodyMinHeight value. Default value is nullCubeGrid
instance, for chaining setter callspublic java.lang.Integer getBodyMinHeight()
public CubeGrid setBodyMinWidth(java.lang.Integer bodyMinWidth)
Note : This is an advanced setting
bodyMinWidth
- New bodyMinWidth value. Default value is nullCubeGrid
instance, for chaining setter callspublic java.lang.Integer getBodyMinWidth()
public CubeGrid setBodyStyleName(java.lang.String bodyStyleName)
setBodyStyleName
in class ListGrid
bodyStyleName
- New bodyStyleName value. Default value is "cubeGridBody"CubeGrid
instance, for chaining setter callsCSSStyleName
,
Appearance overview and related methods
public java.lang.String getBodyStyleName()
getBodyStyleName
in class ListGrid
CSSStyleName
,
Appearance overview and related methods
public CubeGrid setCanCollapseFacets(java.lang.Boolean canCollapseFacets)
canCollapseFacets
- New canCollapseFacets value. Default value is falseCubeGrid
instance, for chaining setter callssetRowHeaderGridMode(java.lang.Boolean)
public java.lang.Boolean getCanCollapseFacets()
getRowHeaderGridMode()
public CubeGrid setCanDragSelect(java.lang.Boolean canDragSelect) throws java.lang.IllegalStateException
touch browsers
, canDragSelect
defaults to false so
that touch scrolling can be used to navigate scrollable CubeGrids. In all other browsers it defaults to true.
NOTE: If canDragSelect
is enabled, it may be desirable to disable touch scrolling
so that touch-dragging cells of the CubeGrid
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.
setCanDragSelect
in class ListGrid
canDragSelect
- New canDragSelect value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSelection
,
Drag list (select) Examplepublic java.lang.Boolean getCanDragSelect()
touch browsers
, canDragSelect
defaults to false so
that touch scrolling can be used to navigate scrollable CubeGrids. In all other browsers it defaults to true.
NOTE: If canDragSelect
is enabled, it may be desirable to disable touch scrolling
so that touch-dragging cells of the CubeGrid
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.
getCanDragSelect
in class ListGrid
Selection
,
Drag list (select) Examplepublic CubeGrid setCanEdit(java.lang.Boolean canEdit)
setCanEdit
in class ListGrid
canEdit
- New canEdit value. Default value is falseCubeGrid
instance, for chaining setter callsListGrid.startEditing()
,
ListGridField.setCanEdit(java.lang.Boolean)
,
ListGrid.setRecordEditProperty(java.lang.String)
,
ListGrid.canEditCell(int, int)
,
ListGrid.setFields(com.smartgwt.client.widgets.grid.ListGridField...)
,
Grid Editing
,
Edit by row Examplepublic java.lang.Boolean getCanEdit()
getCanEdit
in class ListGrid
ListGrid.startEditing()
,
ListGridField.getCanEdit()
,
ListGrid.getRecordEditProperty()
,
ListGrid.canEditCell(int, int)
,
ListGrid.getFields()
,
Grid Editing
,
Edit by row Examplepublic CubeGrid setCanMinimizeColumns(java.lang.Boolean canMinimizeColumns)
canMinimizeColumns
- New canMinimizeColumns value. Default value is nullCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanMinimizeColumns()
public CubeGrid setCanMinimizeFacets(java.lang.Boolean canMinimizeFacets)
Set FacetValue.isMinimizeValue
to
indicate which facetValues should be shown when a facet is minimized.
canMinimizeFacets
- New canMinimizeFacets value. Default value is falseCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanMinimizeFacets()
Set FacetValue.isMinimizeValue
to
indicate which facetValues should be shown when a facet is minimized.
public CubeGrid setCanMoveFacets(java.lang.Boolean canMoveFacets)
canMoveFacets
- New canMoveFacets value. Default value is falseCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanMoveFacets()
public CubeGrid setCanReorderColumns(java.lang.Boolean canReorderColumns)
canReorderColumns
- New canReorderColumns value. Default value is nullCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanReorderColumns()
public CubeGrid setCanResizeColumns(java.lang.Boolean canResizeColumns)
canResizeColumns
- New canResizeColumns value. Default value is nullCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanResizeColumns()
public CubeGrid setCanSelectHeaders(java.lang.Boolean canSelectHeaders)
canSelectHeaders
- New canSelectHeaders value. Default value is trueCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanSelectHeaders()
public CubeGrid setCanSelectValues(java.lang.Boolean canSelectValues)
canSelectValues
- New canSelectValues value. Default value is trueCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanSelectValues()
public CubeGrid setCanSortData(java.lang.Boolean canSortData)
When clicked, sort controls call CubeGrid.sortByFacetValues()
.
canSortData
- New canSortData value. Default value is nullCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanSortData()
When clicked, sort controls call CubeGrid.sortByFacetValues()
.
public CubeGrid setCanSortFacets(java.lang.Boolean canSortFacets)
When clicked, sort controls call CubeGrid.sortByFacetId()
.
canSortFacets
- New canSortFacets value. Default value is nullCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getCanSortFacets()
When clicked, sort controls call CubeGrid.sortByFacetId()
.
public CubeGrid setCellAlign(Alignment cellAlign)
cellAlign
- New cellAlign value. Default value is "center"CubeGrid
instance, for chaining setter callspublic Alignment getCellAlign()
public CubeGrid setCellIdProperty(java.lang.String cellIdProperty) throws java.lang.IllegalStateException
cellIdProperty
- New cellIdProperty value. Default value is "ID"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdIdentifier
public java.lang.String getCellIdProperty()
Identifier
public CubeGrid setChartConfirmThreshold(int chartConfirmThreshold) throws java.lang.IllegalStateException
makeChart()
is called with a chart specification that
will show more than chartConfirmThreshold
data elements, the user will be presented with a confirmation dialog
. Set to 0 to disable this confirmation.
chartConfirmThreshold
- New chartConfirmThreshold value. Default value is 2000CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getChartConfirmThreshold()
makeChart()
is called with a chart specification that
will show more than chartConfirmThreshold
data elements, the user will be presented with a confirmation dialog
. Set to 0 to disable this confirmation.
public CubeGrid setChartConstructor(java.lang.String chartConstructor) throws java.lang.IllegalStateException
setChartConstructor
in class ListGrid
chartConstructor
- New chartConstructor value. Default value is "FacetChart"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getChartConstructor()
getChartConstructor
in class ListGrid
public CubeGrid setChartDialogTitle(java.lang.String chartDialogTitle)
chartDialogTitle
- New chartDialogTitle value. Default value is "Chart"CubeGrid
instance, for chaining setter callspublic java.lang.String getChartDialogTitle()
public CubeGrid setChartItemTitle(java.lang.String chartItemTitle)
chartItemTitle
- New chartItemTitle value. Default value is "Chart"CubeGrid
instance, for chaining setter callspublic java.lang.String getChartItemTitle()
public CubeGrid setChartStackedTitle(java.lang.String chartStackedTitle)
chartStackedTitle
- New chartStackedTitle value. Default value is "Stacked"CubeGrid
instance, for chaining setter callspublic java.lang.String getChartStackedTitle()
public CubeGrid setChartType(ChartType chartType)
setChartType
in class ListGrid
chartType
- New chartType value. Default value is "Column"CubeGrid
instance, for chaining setter callspublic ChartType getChartType()
getChartType
in class ListGrid
public CubeGrid setChartTypeTitle(java.lang.String chartTypeTitle)
chartTypeTitle
- New chartTypeTitle value. Default value is "Chart Type"CubeGrid
instance, for chaining setter callspublic java.lang.String getChartTypeTitle()
public CubeGrid setColHeaderBaseStyle(java.lang.String colHeaderBaseStyle) throws java.lang.IllegalStateException
baseStyle
for the buttons in this grid's column headers.
Exception: The innermost column header will always be styled using innerHeaderBaseStyle
.
colHeaderBaseStyle
- New colHeaderBaseStyle value. Default value is "colHeader"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getColHeaderBaseStyle()
baseStyle
for the buttons in this grid's column headers.
Exception: The innermost column header will always be styled using innerHeaderBaseStyle
.
CSSStyleName
,
Appearance overview and related methods
public CubeGrid setColHeaderLabelBaseStyle(java.lang.String colHeaderLabelBaseStyle) throws java.lang.IllegalStateException
baseStyle
for the facet-label buttons above this grid's column
headers.colHeaderLabelBaseStyle
- New colHeaderLabelBaseStyle value. Default value is "colHeaderLabel"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getColHeaderLabelBaseStyle()
baseStyle
for the facet-label buttons above this grid's column
headers.CSSStyleName
,
Appearance overview and related methods
public CubeGrid setColumnFacets(java.lang.String... columnFacets) throws java.lang.IllegalStateException
ids
for facets that will appear on top of the body.columnFacets
- New columnFacets value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String[] getColumnFacets()
ids
for facets that will appear on top of the body.public CubeGrid setControlCloseTitle(java.lang.String controlCloseTitle)
controlCloseTitle
- New controlCloseTitle value. Default value is "Close"CubeGrid
instance, for chaining setter callspublic java.lang.String getControlCloseTitle()
public CubeGrid setControlMaximizeTitle(java.lang.String controlMaximizeTitle)
controlMaximizeTitle
- New controlMaximizeTitle value. Default value is "Maximize"CubeGrid
instance, for chaining setter callspublic java.lang.String getControlMaximizeTitle()
public CubeGrid setControlMinimizeTitle(java.lang.String controlMinimizeTitle)
controlMinimizeTitle
- New controlMinimizeTitle value. Default value is "Minimize"CubeGrid
instance, for chaining setter callspublic java.lang.String getControlMinimizeTitle()
public CubeGrid setControlReorderHandleTitle(java.lang.String controlReorderHandleTitle)
controlReorderHandleTitle
- New controlReorderHandleTitle value. Default value is "Move"CubeGrid
instance, for chaining setter callspublic java.lang.String getControlReorderHandleTitle()
public CubeGrid setControlSortDownTitle(java.lang.String controlSortDownTitle)
controlSortDownTitle
- New controlSortDownTitle value. Default value is "Sort Down"CubeGrid
instance, for chaining setter callspublic java.lang.String getControlSortDownTitle()
public CubeGrid setControlSortUpTitle(java.lang.String controlSortUpTitle)
controlSortUpTitle
- New controlSortUpTitle value. Default value is "Sort Up"CubeGrid
instance, for chaining setter callspublic java.lang.String getControlSortUpTitle()
public CubeGrid setDefaultFacetWidth(int defaultFacetWidth)
defaultFacetWidth
- New defaultFacetWidth value. Default value is 100CubeGrid
instance, for chaining setter callspublic int getDefaultFacetWidth()
public java.lang.Boolean getEditByCell() throws java.lang.IllegalStateException
Note : This method should be called only after the widget has been rendered.
getEditByCell
in class ListGrid
java.lang.IllegalStateException
- if this widget has not yet been rendered.ListGrid.getCanEdit()
,
Grid Editing
,
Edit by cell Examplepublic CubeGrid setExportColumnFacetBGColor(java.lang.String exportColumnFacetBGColor) throws java.lang.IllegalStateException
ExportBGColor
.public java.lang.String getExportColumnFacetBGColor()
ExportBGColor
.CSSColor
public CubeGrid setExportColumnFacetTextColor(java.lang.String exportColumnFacetTextColor) throws java.lang.IllegalStateException
public java.lang.String getExportColumnFacetTextColor()
CSSColor
public CubeGrid setExportFacetBGColor(java.lang.String exportFacetBGColor) throws java.lang.IllegalStateException
exportRowFacetBGColor()
and exportColumnFacetBGColor()
). See also ExportBGColor
.public java.lang.String getExportFacetBGColor()
exportRowFacetBGColor()
and exportColumnFacetBGColor()
). See also ExportBGColor
.CSSColor
public CubeGrid setExportFacetSeparatorString(java.lang.String exportFacetSeparatorString)
exportClientData()
to separate column and row facet value titles.
Note : This is an advanced setting
exportFacetSeparatorString
- New exportFacetSeparatorString value. Default value is " - "CubeGrid
instance, for chaining setter callspublic java.lang.String getExportFacetSeparatorString()
exportClientData()
to separate column and row facet value titles.public CubeGrid setExportFacetTextColor(java.lang.String exportFacetTextColor) throws java.lang.IllegalStateException
exportRowFacetTextColor()
and exportColumnFacetTextColor()
).public java.lang.String getExportFacetTextColor()
exportRowFacetTextColor()
and exportColumnFacetTextColor()
).CSSColor
public CubeGrid setExportRowFacetBGColor(java.lang.String exportRowFacetBGColor) throws java.lang.IllegalStateException
ExportBGColor
.public java.lang.String getExportRowFacetBGColor()
ExportBGColor
.CSSColor
public CubeGrid setExportRowFacetTextColor(java.lang.String exportRowFacetTextColor) throws java.lang.IllegalStateException
public java.lang.String getExportRowFacetTextColor()
CSSColor
public CubeGrid setFacetLabelHoverAlign(Alignment facetLabelHoverAlign)
this.hoverAlign
if specified.
Note : This is an advanced setting
facetLabelHoverAlign
- New facetLabelHoverAlign value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverAlign(com.smartgwt.client.types.Alignment)
public Alignment getFacetLabelHoverAlign()
this.hoverAlign
if specified.Canvas.getHoverAlign()
public CubeGrid setFacetLabelHoverHeight(java.lang.Integer facetLabelHoverHeight)
this.showHover
is true, this is the default height to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.
Note : This is an advanced setting
facetLabelHoverHeight
- New facetLabelHoverHeight value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverHeight(java.lang.Integer)
public java.lang.Integer getFacetLabelHoverHeight()
this.showHover
is true, this is the default height to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.Canvas.getHoverHeight()
public CubeGrid setFacetLabelHoverHeight(java.lang.String facetLabelHoverHeight)
this.showHover
is true, this is the default height to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.
Note : This is an advanced setting
facetLabelHoverHeight
- New facetLabelHoverHeight value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverHeight(java.lang.Integer)
public java.lang.String getFacetLabelHoverHeightAsString()
this.showHover
is true, this is the default height to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.Canvas.getHoverHeight()
public CubeGrid setFacetLabelHoverStyle(java.lang.String facetLabelHoverStyle)
this.hoverStyle
is not null, that css class will be applied to facet label hovers instead.
Note : This is an advanced setting
facetLabelHoverStyle
- New facetLabelHoverStyle value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverStyle(java.lang.String)
,
CSSStyleName
public java.lang.String getFacetLabelHoverStyle()
this.hoverStyle
is not null, that css class will be applied to facet label hovers instead.Canvas.getHoverStyle()
,
CSSStyleName
public CubeGrid setFacetLabelHoverVAlign(VerticalAlignment facetLabelHoverVAlign)
this.hoverVAlign
if specified.
Note : This is an advanced setting
facetLabelHoverVAlign
- New facetLabelHoverVAlign value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverVAlign(com.smartgwt.client.types.VerticalAlignment)
public VerticalAlignment getFacetLabelHoverVAlign()
this.hoverVAlign
if specified.Canvas.getHoverVAlign()
public CubeGrid setFacetLabelHoverWidth(java.lang.Integer facetLabelHoverWidth)
this.showHover
is true, this is the default width to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.
Note : This is an advanced setting
facetLabelHoverWidth
- New facetLabelHoverWidth value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverWidth(int)
public java.lang.Integer getFacetLabelHoverWidth()
this.showHover
is true, this is the default width to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.Canvas.getHoverWidth()
public CubeGrid setFacetLabelHoverWidth(java.lang.String facetLabelHoverWidth)
this.showHover
is true, this is the default width to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.
Note : This is an advanced setting
facetLabelHoverWidth
- New facetLabelHoverWidth value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverWidth(int)
public java.lang.String getFacetLabelHoverWidthAsString()
this.showHover
is true, this is the default width to apply to hover tips shown for
facetLabels. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.Canvas.getHoverWidth()
public CubeGrid setFacets(Facet... facets) throws java.lang.IllegalStateException
For example, you can look at profit by the facets "plant and product" or by "product and plant" and it's the same number, because the facets - plant and product - are the same. What would change the profit numbers would be to remove a facet, called "summarizing", or add a new facet, called "drilling down". For example, showing profit by plant and product, you could "drill down" by adding the region facet, which would divide profit among each region. Or you could remove the "plant" facet, showing total profit for each "product", summed across all plants.
This property need not
be set and will automatically be constructed during widget initialization if data is provided up front and rowFacets
and columnFacets
have been set. If facets
is not set and there is no initial data but a DataSource is
present, drawing the grid will automatically issue a fetch to allow facets
to be resolved.
facets
- New facets value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdgetFacet(java.lang.String)
,
Facet
,
getFacetValue(java.lang.String, java.lang.String)
,
FacetValue
public CubeGrid setFacetTitleAlign(Alignment facetTitleAlign)
facetTitleAlign
- facet to update. Default value is "center"CubeGrid
instance, for chaining setter callspublic Alignment getFacetTitleAlign()
public CubeGrid setFacetValueAlign(Alignment facetValueAlign)
facetValueAlign
- New facetValueAlign value. Default value is "center"CubeGrid
instance, for chaining setter callspublic Alignment getFacetValueAlign()
public CubeGrid setFacetValueContextItems(MenuItem... facetValueContextItems)
getDefaultFacetValueContextItems()
to get a
default set of items to start with.facetValueContextItems
- New facetValueContextItems value. Default value is nullCubeGrid
instance, for chaining setter callspublic MenuItem[] getFacetValueContextItems()
getDefaultFacetValueContextItems()
to get a
default set of items to start with.public CubeGrid setFacetValueHoverAlign(Alignment facetValueHoverAlign)
this.hoverAlign
if specified.
Note : This is an advanced setting
facetValueHoverAlign
- New facetValueHoverAlign value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverAlign(com.smartgwt.client.types.Alignment)
public Alignment getFacetValueHoverAlign()
this.hoverAlign
if specified.Canvas.getHoverAlign()
public CubeGrid setFacetValueHoverHeight(java.lang.Integer facetValueHoverHeight)
this.showHover
is true, this is the default height to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.
Note : This is an advanced setting
facetValueHoverHeight
- New facetValueHoverHeight value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverHeight(java.lang.Integer)
public java.lang.Integer getFacetValueHoverHeight()
this.showHover
is true, this is the default height to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.Canvas.getHoverHeight()
public CubeGrid setFacetValueHoverHeight(java.lang.String facetValueHoverHeight)
this.showHover
is true, this is the default height to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.
Note : This is an advanced setting
facetValueHoverHeight
- New facetValueHoverHeight value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverHeight(java.lang.Integer)
public java.lang.String getFacetValueHoverHeightAsString()
this.showHover
is true, this is the default height to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverHeight
if specified instead.Canvas.getHoverHeight()
public CubeGrid setFacetValueHoverStyle(java.lang.String facetValueHoverStyle)
this.hoverStyle
is not null, that css class will be applied to facet value hovers instead.
Note : This is an advanced setting
facetValueHoverStyle
- New facetValueHoverStyle value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverStyle(java.lang.String)
,
CSSStyleName
public java.lang.String getFacetValueHoverStyle()
this.hoverStyle
is not null, that css class will be applied to facet value hovers instead.Canvas.getHoverStyle()
,
CSSStyleName
public CubeGrid setFacetValueHoverVAlign(VerticalAlignment facetValueHoverVAlign)
this.hoverVAlign
if specified.
Note : This is an advanced setting
facetValueHoverVAlign
- New facetValueHoverVAlign value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverVAlign(com.smartgwt.client.types.VerticalAlignment)
public VerticalAlignment getFacetValueHoverVAlign()
this.hoverVAlign
if specified.Canvas.getHoverVAlign()
public CubeGrid setFacetValueHoverWidth(java.lang.Integer facetValueHoverWidth)
this.showHover
is true, this is the default width to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.
Note : This is an advanced setting
facetValueHoverWidth
- New facetValueHoverWidth value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverWidth(int)
public java.lang.Integer getFacetValueHoverWidth()
this.showHover
is true, this is the default width to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.Canvas.getHoverWidth()
public CubeGrid setFacetValueHoverWidth(java.lang.String facetValueHoverWidth)
this.showHover
is true, this is the default width to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.
Note : This is an advanced setting
facetValueHoverWidth
- New facetValueHoverWidth value. Default value is nullCubeGrid
instance, for chaining setter callsCanvas.setHoverWidth(int)
public java.lang.String getFacetValueHoverWidthAsString()
this.showHover
is true, this is the default width to apply to hover tips shown for
facetValues. If unset, the hover canvas will be sized to this.hoverWidth
if specified instead.Canvas.getHoverWidth()
public CubeGrid setFetchRequestProperties(DSRequest fetchRequestProperties) throws java.lang.IllegalStateException
autoFetchData
is true
, this attribute
allows the developer to declaratively specify DSRequest
properties for the initial
fetchData()
call. Note that any properties governing
more specific request attributes for the initial fetch (such as autoFetchTextMatchStyle
) will be applied on top of
this properties block.
setFetchRequestProperties
in class ListGrid
fetchRequestProperties
- New fetchRequestProperties value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDataBinding
public DSRequest getFetchRequestProperties()
autoFetchData
is true
, this attribute
allows the developer to declaratively specify DSRequest
properties for the initial
fetchData()
call. Note that any properties governing
more specific request attributes for the initial fetch (such as autoFetchTextMatchStyle
) will be applied on top of
this properties block.
getFetchRequestProperties
in class ListGrid
DataBinding
public CubeGrid setFieldVisibilitySubmenuTitle(java.lang.String fieldVisibilitySubmenuTitle)
setFieldVisibilitySubmenuTitle
in class ListGrid
fieldVisibilitySubmenuTitle
- New fieldVisibilitySubmenuTitle value. Default value is "Values"CubeGrid
instance, for chaining setter callspublic java.lang.String getFieldVisibilitySubmenuTitle()
getFieldVisibilitySubmenuTitle
in class ListGrid
public CubeGrid setFixedFacetValues(FacetValueMap fixedFacetValues) throws java.lang.IllegalStateException
FacetValueMap
describing the set of facet values that should be regarded as
"fixed" in this cubeGrid. These are used as fixed criteria for load on demand, and also allow using a dataset with more
facets in it than are currently shown in the grid.fixedFacetValues
- New fixedFacetValues value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdaddFacet(java.lang.String)
,
removeFacet(java.lang.String)
public FacetValueMap getFixedFacetValues()
FacetValueMap
describing the set of facet values that should be regarded as
"fixed" in this cubeGrid. These are used as fixed criteria for load on demand, and also allow using a dataset with more
facets in it than are currently shown in the grid.addFacet(java.lang.String)
,
removeFacet(java.lang.String)
public CubeGrid setHideAllHighlightsTitle(java.lang.String hideAllHighlightsTitle)
hideAllHighlightsTitle
- New hideAllHighlightsTitle value. Default value is "Hide all"CubeGrid
instance, for chaining setter callspublic java.lang.String getHideAllHighlightsTitle()
public CubeGrid setHideEmptyAxis(Axis hideEmptyAxis) throws java.lang.IllegalStateException
hideEmptyFacetValues
, controls on which
axis hiding of empty values is applied, "row" (only empty rows are hidden), "column" (only empty columns are hidden) or
both (the default).hideEmptyAxis
- New hideEmptyAxis value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Axis getHideEmptyAxis()
hideEmptyFacetValues
, controls on which
axis hiding of empty values is applied, "row" (only empty rows are hidden), "column" (only empty columns are hidden) or
both (the default).public CubeGrid setHideEmptyFacetValues(java.lang.Boolean hideEmptyFacetValues) throws java.lang.IllegalStateException
To use this feature, either:
setData()
before the CubeGrid is first drawn, OR hideEmptyAxis
must be set to either "row" or "column"
so that empty values are only automatically hidden for one axis loading only visible data
is automatically disabled and only fixedFacetValues
will be sent as criteria.hideEmptyFacetValues
- New hideEmptyFacetValues value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getHideEmptyFacetValues()
To use this feature, either:
setData()
before the CubeGrid is first drawn, OR hideEmptyAxis
must be set to either "row" or "column"
so that empty values are only automatically hidden for one axis loading only visible data
is automatically disabled and only fixedFacetValues
will be sent as criteria.public CubeGrid setHighlightCellTitle(java.lang.String highlightCellTitle)
highlightCellTitle
- New highlightCellTitle value. Default value is "Highlight Cell"CubeGrid
instance, for chaining setter callspublic java.lang.String getHighlightCellTitle()
public CubeGrid setHighlightSelectionTitle(java.lang.String highlightSelectionTitle)
highlightSelectionTitle
- New highlightSelectionTitle value. Default value is "Highlight Selection"CubeGrid
instance, for chaining setter callspublic java.lang.String getHighlightSelectionTitle()
public CubeGrid setHighlightTitle(java.lang.String highlightTitle)
highlightTitle
- New highlightTitle value. Default value is "Highlight"CubeGrid
instance, for chaining setter callspublic java.lang.String getHighlightTitle()
public CubeGrid setHilites(Hilite... hilites)
Hiliting
.setHilites
in interface DataBoundComponent
setHilites
in class ListGrid
hilites
- New hilites value. Default value is nullCubeGrid
instance, for chaining setter callsHiliting
public Hilite[] getHilites()
Hiliting
.getHilites
in interface DataBoundComponent
getHilites
in class ListGrid
Hiliting
public CubeGrid setIndentVTreeFacets(boolean indentVTreeFacets) throws java.lang.IllegalStateException
hierarchical
column facets. This can
be overridden at the facet level via Facet.indentVTree
.
Setting this property also ensures that the header is sized tall enough to accommodate the fully expanded facet.
The amount of indenting per level can be set with vTreeFacetIndent
, and the direction of the indenting specified with vTreeFacetIndentDirection
.
Note that if you
specify an explicit height for such a fscet, such as by setting Facet.height
or Facet.labelHeight
, then the greater of
that or the space required to accommodate the fully expanded facet will determine the actual height used.
indentVTreeFacets
- New indentVTreeFacets value. Default value is falseCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdFacet.setIndentVTree(java.lang.Boolean)
,
setVTreeFacetIndent(int)
,
setVTreeFacetIndentDirection(com.smartgwt.client.types.FacetIndentDirection)
public boolean getIndentVTreeFacets()
hierarchical
column facets. This can
be overridden at the facet level via Facet.indentVTree
.
Setting this property also ensures that the header is sized tall enough to accommodate the fully expanded facet.
The amount of indenting per level can be set with vTreeFacetIndent
, and the direction of the indenting specified with vTreeFacetIndentDirection
.
Note that if you
specify an explicit height for such a fscet, such as by setting Facet.height
or Facet.labelHeight
, then the greater of
that or the space required to accommodate the fully expanded facet will determine the actual height used.
Facet.getIndentVTree()
,
getVTreeFacetIndent()
,
getVTreeFacetIndentDirection()
public CubeGrid setInnerHeaderBaseStyle(java.lang.String innerHeaderBaseStyle) throws java.lang.IllegalStateException
baseStyle
for the buttons in the innermost column header for
this cubeGrid.innerHeaderBaseStyle
- New innerHeaderBaseStyle value. Default value is "innerHeader"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getInnerHeaderBaseStyle()
baseStyle
for the buttons in the innermost column header for
this cubeGrid.CSSStyleName
,
Appearance overview and related methods
public CubeGrid setMaximizeColumnTitle(java.lang.String maximizeColumnTitle)
maximizeColumnTitle
- New maximizeColumnTitle value. Default value is "Maximize Column"CubeGrid
instance, for chaining setter callspublic java.lang.String getMaximizeColumnTitle()
public CubeGrid setMetricFacetId(java.lang.String metricFacetId) throws java.lang.IllegalStateException
The metric facet is treated identically to any
other facet by the CubeGrid: it can be represented as row or column headers, can be innermost or have other facets under
it, can be moved around, etc. However when a metric facet is used, metricFacetId
must be set to allow the CubeGrid to generate
meaningful descriptions of values shown in cells for use in hovers and other situations; see valueTitle
for a full explanation.
metricFacetId
- New metricFacetId value. Default value is "metric"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getMetricFacetId()
The metric facet is treated identically to any
other facet by the CubeGrid: it can be represented as row or column headers, can be innermost or have other facets under
it, can be moved around, etc. However when a metric facet is used, metricFacetId
must be set to allow the CubeGrid to generate
meaningful descriptions of values shown in cells for use in hovers and other situations; see valueTitle
for a full explanation.
public CubeGrid setMinimizeColumnTitle(java.lang.String minimizeColumnTitle)
minimizeColumnTitle
- New minimizeColumnTitle value. Default value is "Minimize Column"CubeGrid
instance, for chaining setter callspublic java.lang.String getMinimizeColumnTitle()
public CubeGrid setNoHighlightsTitle(java.lang.String noHighlightsTitle)
noHighlightsTitle
- New noHighlightsTitle value. Default value is "None"CubeGrid
instance, for chaining setter callspublic java.lang.String getNoHighlightsTitle()
public CubeGrid setPadTitles(java.lang.Boolean padTitles)
padTitles
- New padTitles value. Default value is trueCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getPadTitles()
public CubeGrid setRenameFacetValueMessage(java.lang.String renameFacetValueMessage)
renameFacetValueMessage
- New renameFacetValueMessage value. Default value is "Enter the new name for this facet value:"CubeGrid
instance, for chaining setter callspublic java.lang.String getRenameFacetValueMessage()
public CubeGrid setRenameFacetValueTitle(java.lang.String renameFacetValueTitle)
renameFacetValueTitle
- New renameFacetValueTitle value. Default value is "Rename..."CubeGrid
instance, for chaining setter callspublic java.lang.String getRenameFacetValueTitle()
public CubeGrid setRollupValue(java.lang.String rollupValue) throws java.lang.IllegalStateException
rollupValue
- New rollupValue value. Default value is "sum"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getRollupValue()
public CubeGrid setRotateHeaderTitles(java.lang.Boolean rotateHeaderTitles) throws java.lang.IllegalStateException
CubeGrid
.setRotateHeaderTitles
in class ListGrid
rotateHeaderTitles
- New rotateHeaderTitles value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdListGrid.setHeaderTitleVAlign(com.smartgwt.client.types.VerticalAlignment)
,
ListGridField.setValign(com.smartgwt.client.types.VerticalAlignment)
,
ListGridField.setRotateTitle(java.lang.Boolean)
,
Rotated Titles Examplepublic java.lang.Boolean getRotateHeaderTitles()
CubeGrid
.getRotateHeaderTitles
in class ListGrid
ListGrid.getHeaderTitleVAlign()
,
ListGridField.getValign()
,
ListGridField.getRotateTitle()
,
Rotated Titles Examplepublic CubeGrid setRowFacets(java.lang.String... rowFacets) throws java.lang.IllegalStateException
ids
for facets that will appear to the left of the
body.rowFacets
- New rowFacets value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetRowHeaderGridMode(java.lang.Boolean)
public java.lang.String[] getRowFacets()
ids
for facets that will appear to the left of the
body.getRowHeaderGridMode()
public CubeGrid setRowHeaderBaseStyle(java.lang.String rowHeaderBaseStyle) throws java.lang.IllegalStateException
baseStyle
for the buttons in this grid's row headers.rowHeaderBaseStyle
- New rowHeaderBaseStyle value. Default value is "rowHeader"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getRowHeaderBaseStyle()
baseStyle
for the buttons in this grid's row headers.CSSStyleName
,
Appearance overview and related methods
public CubeGrid setRowHeaderGridMode(java.lang.Boolean rowHeaderGridMode) throws java.lang.IllegalStateException
GridRenderer
component. This improves performance for very large cubeGrids. Note that this attribute must be set for hierarchical row facets to be indented properly.
Note : This is an advanced setting
rowHeaderGridMode
- New rowHeaderGridMode value. Default value is falseCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetRowFacets(java.lang.String...)
,
setCanCollapseFacets(java.lang.Boolean)
public java.lang.Boolean getRowHeaderGridMode()
GridRenderer
component. This improves performance for very large cubeGrids. Note that this attribute must be set for hierarchical row facets to be indented properly.
getRowFacets()
,
getCanCollapseFacets()
public CubeGrid setRowHeaderLabelBaseStyle(java.lang.String rowHeaderLabelBaseStyle) throws java.lang.IllegalStateException
baseStyle
for the facet-label buttons above the grid's row
headers.rowHeaderLabelBaseStyle
- New rowHeaderLabelBaseStyle value. Default value is "rowHeaderLabel"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getRowHeaderLabelBaseStyle()
baseStyle
for the facet-label buttons above the grid's row
headers.CSSStyleName
,
Appearance overview and related methods
public java.lang.Boolean getSaveByCell() throws java.lang.IllegalStateException
Note : This method should be called only after the widget has been rendered.
getSaveByCell
in class ListGrid
java.lang.IllegalStateException
- if this widget has not yet been rendered.ListGrid.getEditByCell()
,
Grid Editing
public CubeGrid setShowAllHighlightsTitle(java.lang.String showAllHighlightsTitle)
showAllHighlightsTitle
- New showAllHighlightsTitle value. Default value is "Show all"CubeGrid
instance, for chaining setter callspublic java.lang.String getShowAllHighlightsTitle()
public CubeGrid setShowFacetContextMenus(boolean showFacetContextMenus)
showFacetContextMenus
- New showFacetContextMenus value. Default value is falseCubeGrid
instance, for chaining setter callspublic boolean getShowFacetContextMenus()
public CubeGrid setShowFacetValueContextMenus(boolean showFacetValueContextMenus)
ListGrid.showHeaderContextMenu
and ListGrid.showHeaderMenuButton
for CubeGrids.showFacetValueContextMenus
- New showFacetValueContextMenus value. Default value is trueCubeGrid
instance, for chaining setter callspublic boolean getShowFacetValueContextMenus()
ListGrid.showHeaderContextMenu
and ListGrid.showHeaderMenuButton
for CubeGrids.public CubeGrid setShowHighlightsTitle(java.lang.String showHighlightsTitle)
showHighlightsTitle
- New showHighlightsTitle value. Default value is "Show Highlights"CubeGrid
instance, for chaining setter callspublic java.lang.String getShowHighlightsTitle()
public CubeGrid setShowHoverTipsTitle(java.lang.String showHoverTipsTitle)
showHoverTipsTitle
- New showHoverTipsTitle value. Default value is "Show Hover Tips"CubeGrid
instance, for chaining setter callspublic java.lang.String getShowHoverTipsTitle()
public CubeGrid setSimpleDeselect(java.lang.Boolean simpleDeselect)
simpleDeselect
- New simpleDeselect value. Default value is falseCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getSimpleDeselect()
public CubeGrid setSkinImgDir(java.lang.String skinImgDir) throws java.lang.IllegalStateException
skinDir
.setSkinImgDir
in class ListGrid
skinImgDir
- New skinImgDir value. Default value is "images/CubeGrid/"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCImgURL
,
Images overview and related methods
public java.lang.String getSkinImgDir()
skinDir
.getSkinImgDir
in class ListGrid
SCImgURL
,
Images overview and related methods
public CubeGrid setSortDirection(SortDirection sortDirection)
setSortDirection
in class ListGrid
sortDirection
- New sortDirection value. Default value is "ascending"CubeGrid
instance, for chaining setter callsSortDirection
,
Sort Examplepublic SortDirection getSortDirection()
getSortDirection
in class ListGrid
SortDirection
,
Sort Examplepublic CubeGrid setSortedFacetValues(FacetValueMap sortedFacetValues)
FacetValueMap
of facet values representing a set of facetValues by which the
cubeGrid data is sorted.sortedFacetValues
- New sortedFacetValues value. Default value is nullCubeGrid
instance, for chaining setter callspublic FacetValueMap getSortedFacetValues()
FacetValueMap
of facet values representing a set of facetValues by which the
cubeGrid data is sorted.public void setStyleName(java.lang.String styleName)
setStyleName
in class ListGrid
styleName
- New styleName value. Default value is "normal"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getStyleName()
getStyleName
in class ListGrid
CSSStyleName
,
Appearance overview and related methods
public CubeGrid setValueExportFormat(java.lang.String valueExportFormat) throws java.lang.IllegalStateException
FormatString
used during exports for numeric or date formatting. See DataSourceField.exportFormat
.valueExportFormat
- New valueExportFormat value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdFormatString
,
Exports & Formatting
public java.lang.String getValueExportFormat()
FormatString
used during exports for numeric or date formatting. See DataSourceField.exportFormat
.FormatString
,
Exports & Formatting
public CubeGrid setValueFormat(java.lang.String valueFormat) throws java.lang.IllegalStateException
FormatString
for numeric or date formatting. See DataSourceField.format
.valueFormat
- New valueFormat value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdFormatString
,
Exports & Formatting
public java.lang.String getValueFormat()
FormatString
for numeric or date formatting. See DataSourceField.format
.FormatString
,
Exports & Formatting
public CubeGrid setValueProperty(java.lang.String valueProperty) throws java.lang.IllegalStateException
valueProperty
- New valueProperty value. Default value is "_value"CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdIdentifier
public java.lang.String getValueProperty()
Identifier
public CubeGrid setValueTitle(java.lang.String valueTitle) throws java.lang.IllegalStateException
For example, in a CubeGrid showing "Revenue" by region and product, a cell with a CellRecord like:
{product:"chairs", region:"northwest", _value:"$5k"}Should be described as "Revenue for Chairs for Northwest Region", not "Chairs for Revenue for Northwest Region".
For CubeGrids that show multiple types of values at once (eg both "Revenue" and
"Income") see metricFacetId
.
valueTitle
- New valueTitle value. Default value is nullCubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getValueTitle()
For example, in a CubeGrid showing "Revenue" by region and product, a cell with a CellRecord like:
{product:"chairs", region:"northwest", _value:"$5k"}Should be described as "Revenue for Chairs for Northwest Region", not "Chairs for Revenue for Northwest Region".
For CubeGrids that show multiple types of values at once (eg both "Revenue" and
"Income") see metricFacetId
.
public CubeGrid setVTreeFacetIndent(int vTreeFacetIndent) throws java.lang.IllegalStateException
hierarchical
column facets are being indented
.vTreeFacetIndent
- New vTreeFacetIndent value. Default value is 8CubeGrid
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetIndentVTreeFacets(boolean)
public int getVTreeFacetIndent()
hierarchical
column facets are being indented
.getIndentVTreeFacets()
public CubeGrid setVTreeFacetIndentDirection(FacetIndentDirection vTreeFacetIndentDirection)
indented
.vTreeFacetIndentDirection
- New vTreeFacetIndentDirection value. Default value is CubeGrid.DESCENDINGCubeGrid
instance, for chaining setter callssetIndentVTreeFacets(boolean)
public FacetIndentDirection getVTreeFacetIndentDirection()
indented
.getIndentVTreeFacets()
public CubeGrid setWrapFacetTitles(java.lang.Boolean wrapFacetTitles)
wrapFacetTitles
- New wrapFacetTitles value. Default value is falseCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getWrapFacetTitles()
public CubeGrid setWrapFacetValueTitles(java.lang.Boolean wrapFacetValueTitles)
Note that this property is incompatible with indented
column facets.
wrapFacetValueTitles
- New wrapFacetValueTitles value. Default value is falseCubeGrid
instance, for chaining setter callspublic java.lang.Boolean getWrapFacetValueTitles()
Note that this property is incompatible with indented
column facets.
public void addColumnFacet(java.lang.String facetId)
facetId
- facetId to add. Definition must have been provided at init time.
See Identifier
removeFacet(java.lang.String)
,
getFixedFacetValues()
,
Identifier
public void addColumnFacet(java.lang.String facetId, java.lang.Integer index)
facetId
- facetId to add. Definition must have been provided at init time.
See Identifier
index
- index to add the facet at. 0 = outermost (default innermost)removeFacet(java.lang.String)
,
getFixedFacetValues()
public void addFacet(java.lang.String facetId)
The facet being added should currently have a fixed facet value (unless it's already part of the view), which will be removed from cubeGrid.fixedFacetValues.
facetId
- facetId to add. Definition must have been provided at init time.
See Identifier
removeFacet(java.lang.String)
,
getFixedFacetValues()
,
Identifier
public void addFacet(java.lang.String facetId, java.lang.Boolean intoRows)
addFacet(java.lang.String)
public void addFacet(java.lang.String facetId, java.lang.Boolean intoRows, java.lang.Integer index)
The facet being added should currently have a fixed facet value (unless it's already part of the view), which will be removed from cubeGrid.fixedFacetValues.
facetId
- facetId to add. Definition must have been provided at init time.
See Identifier
intoRows
- whether to add facet as a row facetindex
- index to add the facet at. 0 = outermost (default innermost)removeFacet(java.lang.String)
,
getFixedFacetValues()
public void addRowFacet(java.lang.String facetId)
facetId
- facetId to add. Definition must have been provided at init time.
See Identifier
removeFacet(java.lang.String)
,
getFixedFacetValues()
,
Identifier
public void addRowFacet(java.lang.String facetId, java.lang.Integer index)
facetId
- facetId to add. Definition must have been provided at init time.
See Identifier
index
- index to add the facet at. 0 = outermost (default innermost)removeFacet(java.lang.String)
,
getFixedFacetValues()
public java.lang.Boolean anyCellSelected()
Selection
public void autoSizeFacet(java.lang.String facetId)
facetId
- ID of facet to resize.public java.lang.Boolean cellIsSelected(CellRecord cell)
cell
- cell to testSelection
public void closeFacet(java.lang.String facetId)
facetId
- ID of facet that was closedpublic java.lang.Boolean collapseField(FacetValueMap facetValueMap)
facetValueMap
- field specified as a facetValueMappublic void dataArrived()
facets
is not set and there is no initial data. Only
applies to databound CubeGrids.public void deselectAll()
Selection
public void deselectAllCells()
Selection
public void deselectAllFacetValues()
Selection
public void deselectAllFacetValues(java.lang.String facetId)
facetId
- ID of facet - if null, selects all headerbars' headersSelection
public void deselectCells(CellRecord[] cellList)
FacetValueMap
. Also supports an explicit list of
CellRecords or cell IDs.cellList
- cells to deselectSelection
public void deselectCells(FacetValueMap cellList)
FacetValueMap
. Also supports an explicit list of
CellRecords or cell IDs.cellList
- cells to deselectSelection
public void deselectCells(java.lang.String... cellList)
FacetValueMap
. Also supports an explicit list of
CellRecords or cell IDs.cellList
- cells to deselectSelection
public void deselectFacetValue(java.lang.String facetId, java.lang.String facetValueId)
facetId
- ID of facetfacetValueId
- ID of facetValue to selectSelection
public java.lang.Boolean expandField(FacetValueMap facetValueMap)
facetValueMap
- field specified as a facetValueMappublic void exportClientData(java.util.Map settings)
The export format will combine the column facet value titles, generating a single row of column headers at the top with titles such as "All Years - Budget" if Time and Scenario were column facets. The row facet value titles for separate facets won't be combined, so that each row facet will have a separate column, with the facet titles at the top in the "column header" row, and the row facet value titles below their corresponding facet title. Data values each get their own row and column position.
settings
- contains configuration settings for the export, including: exportFacetSeparatorString
when combining titles from multiple facet values.ListGrid.exportClientData()
public void exportClientData(java.util.Map settings, DSRequest requestProperties)
exportClientData(java.util.Map)
public void exportClientData(java.util.Map settings, DSRequest requestProperties, RPCCallback callback)
The export format will combine the column facet value titles, generating a single row of column headers at the top with titles such as "All Years - Budget" if Time and Scenario were column facets. The row facet value titles for separate facets won't be combined, so that each row facet will have a separate column, with the facet titles at the top in the "column header" row, and the row facet value titles below their corresponding facet title. Data values each get their own row and column position.
settings
- contains configuration settings for the export, including: exportFacetSeparatorString
when combining titles from multiple facet values.requestProperties
- Request properties for the 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.ListGrid.exportClientData()
public com.google.gwt.event.shared.HandlerRegistration addFacetAddedHandler(FacetAddedHandler handler)
Notification fired when a new facet is added.
addFacetAddedHandler
in interface HasFacetAddedHandlers
handler
- the facetAdded handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFacetContextClickHandler(FacetContextClickHandler handler)
StringMethod handler fired when the user right clicks on a facet label.
addFacetContextClickHandler
in interface HasFacetContextClickHandlers
handler
- the facetContextClick handlerHandlerRegistration
used to remove this handlerpublic java.lang.Boolean facetHasSelection(java.lang.String facetId)
facetId
- Id for facet to testSelection
public com.google.gwt.event.shared.HandlerRegistration addFacetLabelClickHandler(FacetLabelClickHandler handler)
Method handler fired when the user clicks on a facet label.
addFacetLabelClickHandler
in interface HasFacetLabelClickHandlers
handler
- the facetLabelClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFacetMovedHandler(FacetMovedHandler handler)
Notification fired when a facet is moved.
addFacetMovedHandler
in interface HasFacetMovedHandlers
handler
- the facetMoved handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFacetRemovedHandler(FacetRemovedHandler handler)
Notification fired when a facet is removed.
addFacetRemovedHandler
in interface HasFacetRemovedHandlers
handler
- the facetRemoved handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFacetValueContextClickHandler(FacetValueContextClickHandler handler)
StringMethod handler fired when context click occurs over a facetValue button in a header.
addFacetValueContextClickHandler
in interface HasFacetValueContextClickHandlers
handler
- the facetValueContextClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFacetValueSelectionChangedHandler(FacetValueSelectionChangedHandler handler)
Handler/Notification function for facetValue selection change (no default implementation).
addFacetValueSelectionChangedHandler
in interface HasFacetValueSelectionChangedHandlers
handler
- the facetValueSelectionChanged handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFixedFacetValueChangedHandler(FixedFacetValueChangedHandler handler)
Notification fired when a fixed facet value is set for some facet.
addFixedFacetValueChangedHandler
in interface HasFixedFacetValueChangedHandlers
handler
- the fixedFacetValueChanged handlerHandlerRegistration
used to remove this handlerpublic int getCellColumn(CellRecord cellRecord)
cellRecord
- record to find coordinates forpublic FacetValueMap getCellFacetValues(int rowNum, int colNum)
FacetValueMap
indicating
the facet values for the cell.rowNum
- row index of the cellcolNum
- column index of the cellpublic ListGridRecord getCellRecord(int rowNum, int colNum)
rowNum
- row index of record to return.colNum
- column index of record to return.ListGrid.getRecord(int)
,
ListGrid.getEditedRecord(int)
public int getCellRow(CellRecord cellRecord)
cellRecord
- record to find coordinates forpublic FacetValueMap getColumnFacetValues(int colNum)
FacetValueMap
indicating the facet values for a specific column in
the grid.colNum
- index of the columnpublic FacetValueMap getColumnHeaderFacetValues(int colNum, int level)
FacetValueMap
of the facet values for the column field at the
specified level containing the requested column number. Note that outer column fields may span several grid columns.colNum
- 0-based index into the grid columns (and inner column header fields)level
- target header level; 0 represents the outer column headerpublic MenuItem[] getDefaultFacetValueContextItems(FacetValueMap facetValues)
facetValueContextItems
to be used in the context
menu of the appropriate header button.facetValues
- FacetValueMap for the appropriate header buttonpublic java.lang.Object getEditValue(int rowNum, int colNum)
valueProperty
that will be saved for the cell in question.getEditValue
in class ListGrid
rowNum
- index of the row for which the editValue should be returnedcolNum
- index of the column for which value should be returnedGrid Editing
public int getEventColumn()
getEventColumn
in class ListGrid
Selection
public int getEventColumn(java.lang.Integer x)
getEventColumn
in class ListGrid
x
- X-coordinate relative to the left edge of the content to obtain the column number for. If not
provided, then Canvas.getOffsetX()
will be used.Selection
public int getEventRow()
getEventRow
in class ListGrid
Selection
public int getEventRow(java.lang.Integer y)
getEventRow
in class ListGrid
y
- Y-coordinate relative to the top edge of the content to obtain the row number for. If not
provided, then Canvas.getOffsetY()
will be used.Selection
public Facet getFacet(java.lang.String facetId)
facetId
- the id of the facet to retrieveFacet
public java.lang.String[] getFacetsHavingSelection()
Selection
public FacetValue getFacetValue(java.lang.String facetId, java.lang.String facetValueId)
facetId
- the id of the facet to retrievefacetValueId
- the id of the facet value to retrieveFacetValue
public int getFacetValuesColumn(FacetValueMap facetValues)
The facetValues passed in should contain values for at least one column facet. It may contain properties other than column facets, which will be ignored. If values are sparse (values not specified for every column facet), the first column matching the specified facet values will be returned.
facetValues
- facet values to findpublic int getFacetValuesRow(FacetValueMap facetValues)
The facetValues passed in should contain values for at least one row facet. It may contain properties other than row facets, which will be ignored. If values are sparse (values not specified for every row facet), the first row matching the specified facet values will be returned.
facetValues
- facet values to findpublic FacetValueMap getRowFacetValues(int rowNum)
FacetValueMap
indicating the facet values for a specific row in the
grid.rowNum
- index of the rowpublic FacetValueMap getRowHeaderFacetValues(int rowNum, int level)
FacetValueMap
of the facet values for the row field at the specified
level containing the requested row number. Note that outer row fields may span several grid rows.rowNum
- 0-based index into the grid rows (and inner row header fields)level
- target header level; 0 represents the outer row headerpublic java.lang.String[] getSelectedCellIds()
Selection
public CellRecord[] getSelectedCells()
Selection
public FacetValueMap[] getSelectedFacetValues()
Selection
public FacetValueMap[] getSelectedFacetValues(java.lang.String facetId)
facetId
- id for facet for which we are getting selected facetValuesSelection
public java.lang.String getViewState()
getViewState
in class ListGrid
ListGridViewState
ListGridViewState
,
ListGrid.setViewState(java.lang.String)
public java.lang.Boolean hasChanges()
ignorePendingValues
parameter.hasChanges
in class ListGrid
Grid Editing
public java.lang.Boolean hasChanges(java.lang.Boolean ignorePendingValues)
ignorePendingValues
parameter.hasChanges
in class ListGrid
ignorePendingValues
- If true, this method will compare the current edit values against the underlying records in the dataset, not taking
pending edit values into accountGrid Editing
public boolean hideFacetValues(FacetValueMap facetValueMap)
facetValueMap
- field specified as a facetValueMappublic java.lang.Boolean hiliteFacetValue(java.lang.String facetID, java.lang.String facetValueID, java.lang.String hiliteID)
facetID
- facet IDfacetValueID
- facet value IDhiliteID
- hilite IDHiliting
public java.lang.Boolean isFieldOpen(FacetValueMap facetValueMap)
collapsing
and minimizing
. Note that if you don't already have a FacetValueMap
to the field in question, you can get one by calling getRowHeaderFacetValues()
or getColumnHeaderFacetValues()
,
You can also
construct a FacetValueMap
on your own by using the Facet.id
s from rowFacets
or columnFacets
together with the FacetValue.id
s of the Facet.values
for the row or column that you want to query. Given a
Facet.id
, you can use getFacet()
to obtain the correponding Facet
.
facetValueMap
- field specified as a facetValueMappublic java.lang.Boolean loadAllRecords()
ListGrid.loadAllRecords()
for more information.loadAllRecords
in class ListGrid
public java.lang.Boolean loadAllRecords(java.lang.Integer maxRecords)
loadAllRecords
in class ListGrid
loadAllRecords()
public java.lang.Boolean loadAllRecords(java.lang.Integer maxRecords, DSCallback callback)
ListGrid.loadAllRecords()
for more information.loadAllRecords
in class ListGrid
maxRecords
- optional maximum record count - if passed, no fetch takes place if maxRecords is below
the known length of the datacallback
- callback to fire if a fetch is issued - if all data was already loaded, the callback is
fired with no parameterspublic java.lang.Boolean recordHasChanges(int rowNum, int colNum)
Note that if this grid is bound to a dataSource
, and an asynchronous save has been submitted, this
method will compare the local edit values against the submitted values by default, returning false (no changes), if
they match. This is useful for detecting whether the user is actively editing values and hasn't yet committed them.
The ignorePendingValues
parameter may be used by developers who want to ignore this case and simply compare
edit values against the record in the local data set.
rowNum
- row index of record to check for changescolNum
- column index of the record to check for changesGrid Editing
public java.lang.Boolean recordHasChanges(int rowNum, int colNum, java.lang.Boolean ignorePendingValues)
Note that if this grid is bound to a dataSource
, and an asynchronous save has been submitted, this
method will compare the local edit values against the submitted values by default, returning false (no changes), if
they match. This is useful for detecting whether the user is actively editing values and hasn't yet committed them.
The ignorePendingValues
parameter may be used by developers who want to ignore this case and simply compare
edit values against the record in the local data set.
rowNum
- row index of record to check for changescolNum
- column index of the record to check for changesignorePendingValues
- If true, this method will compare the current edit values against the underlying records in the dataset, not taking
pending edit values into accountGrid Editing
public void removeFacet(java.lang.String facetId)
facetId
- facetId to remove.
See Identifier
addFacet(java.lang.String)
,
getFixedFacetValues()
,
Identifier
public void removeFacet(java.lang.String facetId, java.lang.String fixedFacetValueId)
facetId
- facetId to remove.
See Identifier
fixedFacetValueId
- New fixed value for the facet, to be added to fixedFacetValues
. Default is the rollup value for the
facet.
See Identifier
addFacet(java.lang.String)
,
getFixedFacetValues()
public void resizeFacetValue(java.lang.String facetValueId, int newWidth)
facetValueId
- facetValueId of columns to be resized.
See Identifier
newWidth
- column's new widthpublic void selectAllCells()
Selection
public void selectAllFacetValues()
Selection
public void selectAllFacetValues(java.lang.String facetId)
selectAllFacetValues()
public void selectAllFacetValues(java.lang.String facetId, java.lang.Boolean newState)
facetId
- ID of facet - if null, selects all headerbars' headersnewState
- new selection state - if null defaults to trueSelection
public void selectCells(CellRecord[] cellList)
FacetValueMap
. Also supports an explicit
list of CellRecords or cell IDs.cellList
- cells to selectSelection
public void selectCells(FacetValueMap cellList)
FacetValueMap
. Also supports an explicit
list of CellRecords or cell IDs.cellList
- cells to selectSelection
public void selectCells(java.lang.String... cellList)
FacetValueMap
. Also supports an explicit
list of CellRecords or cell IDs.cellList
- cells to selectSelection
public void selectCells(CellRecord[] cellList, boolean newState)
FacetValueMap
. Also supports an explicit
list of CellRecords or cell IDs.cellList
- cells to selectnewState
- new selection state (if null, defaults to true)Selection
public void selectFacetValue(java.lang.String facetId, java.lang.String facetValueId)
facetId
- ID of facetfacetValueId
- ID of facetValue to selectSelection
public void selectFacetValue(java.lang.String facetId, java.lang.String facetValueId, java.lang.Boolean newState)
facetId
- ID of facetfacetValueId
- ID of facetValue to selectnewState
- new selection state - if null defaults to trueSelection
public void setEditValue(int rowNum, int colNum, java.lang.Object value)
Note that cubeGrids display one record per cell - the value passed
in should be the desired edit value for the valueProperty
of the record.
setEditValue
in class ListGrid
rowNum
- Row numbercolNum
- Column numbervalue
- New value for the recordGrid Editing
public void setFacetTitle(java.lang.String facetId, java.lang.String newTitle)
facetId
- facet to update.
See Identifier
newTitle
- title for the facetpublic void setFacetValueTitle(java.lang.String facetId, java.lang.String facetValueId, java.lang.String newTitle)
facetId
- facet to update.
See Identifier
facetValueId
- facetValue to update.
See Identifier
newTitle
- title for the facetpublic void setFacetValueTitleAlign(java.lang.String facetId, java.lang.String facetValueId, Alignment align)
facetId
- facet to update.
See Identifier
facetValueId
- facetValue to update.
See Identifier
align
- new alignment for facet value titlepublic void setFixedFacetValue(java.lang.String facetId, java.lang.String fixedFacetValueId)
facetId
- facetId.
See Identifier
fixedFacetValueId
- New fixed value for the facet, to be added to fixedFacetValues
. Default is the rollup value for the
facet.
See Identifier
public boolean showFacetValues(FacetValueMap facetValueMap)
facetValueMap
- field specified as a facetValueMappublic com.google.gwt.event.shared.HandlerRegistration addSortByFacetIdHandler(SortByFacetIdHandler handler)
Called when a sort control is clicked on a FacetHeader. Does nothing by default.
addSortByFacetIdHandler
in interface HasSortByFacetIdHandlers
handler
- the sortByFacetId handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addSortByFacetValuesHandler(SortByFacetValuesHandler handler)
Called when a sort control is clicked on a FacetValueHeader. Does nothing by default.
addSortByFacetValuesHandler
in interface HasSortByFacetValuesHandlers
handler
- the sortByFacetValues handlerHandlerRegistration
used to remove this handlerpublic java.lang.Boolean toggleFieldOpenState(FacetValueMap facetValueMap)
facetValueMap
- field specified as a facetValueMappublic static void setDefaultProperties(CubeGrid cubeGridProperties)
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.
cubeGridProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public java.lang.Boolean hiliteCell(int rowNum, int colNum, java.lang.String hiliteID)
row
- of cell to hilitecolumn
- of cell to hilitehilite
- idHiliting overview and related methods
public void deselectCell(java.lang.String cell)
cell
- cell to deselectpublic void deselectCell(CellRecord cell)
cell
- cell to deselectpublic void selectCell(java.lang.String ID)
cell
- cell to selectpublic void selectCell(Record cell)
cell
- cell to selectpublic int[] getCellCoordinates(CellRecord cellRecord)
cellRecord
- record to find coordinates for[rowNum,colNum]
for the cell, or null
if the
record is not found.public java.lang.Object getEditedCell(int rowNum, int colNum)
getEditedCell
in class ListGrid
rowNum
- rowNum of the record being editedcolNum
- colNum of the cellEditing overview and related methods
public java.lang.Object getEditedCell(Record record)
record
- rowNum of the record being edited, or an Object containing values for all the
record's primary keyscolNum
- colNum of the cell. Only required if the first parameter is a rowNumEditing overview and related methods
public CellRecord getEditedRecord(int rowNum, int colNum)
The returned value is never null, and can be freely modified.
rowNum
- of the record being editedcolNum
- colNum of the record being editedEditing overview and related methods
public CellRecord getEditedRecord(Record baseRecord)
The returned value is never null, and can be freely modified.
record
- being editedEditing overview and related methods
public void setEnableCharting(java.lang.Boolean enableCharting)
chartData
for
more information.enableCharting
- enableCharting Default value is falsepublic java.lang.Boolean getEnableCharting()
chartData
for
more information.public void setFacetValueHoverCustomizer(FacetValueHoverCustomizer hoverCustomizer)
hoverCustomizer
- the hover customizerpublic static boolean analyticsLoaded()
public FacetChart makeChart(FacetValueMap fixedFacetValues, java.lang.String[] variableFacets, FacetChart chartProperties)
fixedFacetValues
, for all
values of the variableFacets
.
One, two or more variableFacets may be passed. Two variable facets for a column chart will
result in stacking
or clustering. Three facets or more may be
supported by some chartTypes
or
charting engines
.
fixedFacetValues
- (FacetValueMap) set of facet values to hold constant. Pass null to
chart the entire dataset.variableFacets
- (Array of FacetIds) set of facets to be chartedchartProperties
- (FacetChart properties) properties to pass through to the created FacetChart
public CubeGrid setViewState(java.lang.String viewState)
setViewState
in class ListGrid
viewState
- Object describing the desired view state for the grid.CubeGrid
instance, for chaining
setter calls
See ListGridViewState
ListGrid.getViewState()
,
ListGridViewState
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.cube.CubeGridLogicalStructure 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 LogicalStructure
getLogicalStructure
in class ListGrid