com.smartgwt.client.widgets.cube
Class CubeGrid

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.layout.Layout
                      extended by com.smartgwt.client.widgets.layout.VLayout
                          extended by com.smartgwt.client.widgets.grid.ListGrid
                              extended by com.smartgwt.client.widgets.cube.CubeGrid
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasFacetAddedHandlers, HasFacetMovedHandlers, HasFacetRemovedHandlers, HasFacetValueSelectionChangedHandlers, HasFixedFacetValueChangedHandlers, HasSortByFacetIdHandlers, HasSortByFacetValuesHandlers, DataBoundComponent, HasClickHandlers, HasDoubleClickHandlers, HasDragCompleteHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropCompleteHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFetchDataHandlers, HasFocusChangedHandlers, HasFormulaUpdatedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasBodyKeyPressHandlers, HasCellClickHandlers, HasCellContextClickHandlers, HasCellDoubleClickHandlers, HasCellHoverHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellSavedHandlers, HasCellSelectionChangedHandlers, HasCellValueHoverHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasFilterEditorSubmitHandlers, HasGroupByCompleteHandlers, HasGroupByHandlers, HasGroupStateChangedHandlers, HasHeaderClickHandlers, HasHeaderDoubleClickHandlers, HasHeaderHoverHandlers, HasHilitesChangedHandlers, HasRecordClickHandlers, HasRecordCollapseHandlers, HasRecordDoubleClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRemoveRecordClickHandlers, HasRowContextClickHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasRowHoverHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRowOutHandlers, HasRowOverHandlers, HasSelectionChangedHandlers, HasSelectionUpdatedHandlers, HasSortChangedHandlers, HasSorterClickHandlers, HasSorterContextClickHandlers, HasViewStateChangedHandlers, HasMembersChangedHandlers

public class CubeGrid
extends ListGrid
implements HasFacetAddedHandlers, HasFacetMovedHandlers, HasFacetRemovedHandlers, HasFacetValueSelectionChangedHandlers, HasFixedFacetValueChangedHandlers, HasSortByFacetIdHandlers, HasSortByFacetValuesHandlers

The CubeGrid is an interactive grid component that presents very large, multi-dimensional data sets (also known as data cubes) for reporting or analytic applications.

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.

See Also:
Facet, FacetValue

Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, nativeObject, scClassName
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
CubeGrid()
           
CubeGrid(JavaScriptObject jsObj)
           
 
Method Summary
 void addColumnFacet(String facetId)
          Add a column facet to the view at index "index".
 void addColumnFacet(String facetId, Integer index)
          Add a column facet to the view at index "index".
 void addFacet(String facetId)
          Add a facet to the view, into the row or column facets (intoRows true or false), at index "index".
 void addFacet(String facetId, Boolean intoRows)
           
 void addFacet(String facetId, Boolean intoRows, Integer index)
          Add a facet to the view, into the row or column facets (intoRows true or false), at index "index".
 HandlerRegistration addFacetAddedHandler(FacetAddedHandler handler)
          Add a facetAdded handler.
 HandlerRegistration addFacetMovedHandler(FacetMovedHandler handler)
          Add a facetMoved handler.
 HandlerRegistration addFacetRemovedHandler(FacetRemovedHandler handler)
          Add a facetRemoved handler.
 HandlerRegistration addFacetValueSelectionChangedHandler(FacetValueSelectionChangedHandler handler)
          Add a facetValueSelectionChanged handler.
 HandlerRegistration addFixedFacetValueChangedHandler(FixedFacetValueChangedHandler handler)
          Add a fixedFacetValueChanged handler.
 void addRowFacet(String facetId)
          Add a row facet to the view at index "index".
 void addRowFacet(String facetId, Integer index)
          Add a row facet to the view at index "index".
 HandlerRegistration addSortByFacetIdHandler(SortByFacetIdHandler handler)
          Add a sortByFacetId handler.
 HandlerRegistration addSortByFacetValuesHandler(SortByFacetValuesHandler handler)
          Add a sortByFacetValues handler.
static boolean analyticsLoaded()
          Static method indicating whether the optional Analytics module is loaded for the page.
 Boolean anyCellSelected()
          Determine whether any cells are selected in this cubeGrid.
 Boolean cellIsSelected(CellRecord cell)
          Determine whether the cell passed in is selected in this cubeGrid.
static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
          Changes the defaults for Canvas AutoChildren named autoChildName.
static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
          Changes the defaults for FormItem AutoChildren named autoChildName.
 void closeFacet(String facetId)
          Handler fired when facet is closed
methodType handler
 Boolean collapseField(FacetValueMap facetValueMap)
          Collapses the specified field.
protected  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(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(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(String... cellList)
          Deselect cells that match a FacetValueMap.
 void deselectFacetValue(String facetId, String facetValueId)
          Deselect the header for a given facet value.
 Boolean expandField(FacetValueMap facetValueMap)
          Expands the specified field.
 Boolean facetHasSelection(String facetId)
          Return whether any facet value for this facet is selected in headers.
 Boolean getAlternateRecordStyles()
          Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
 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.
 Boolean getAutoSizeHeaders()
          Automatically size row headers to fit wrapped text.
 String getBaseStyle()
          base cell style for this listGrid.
 Integer getBodyMinHeight()
          Minimum height for the body of this cubeGrid.
 Integer getBodyMinWidth()
          Minimum width for the body of this cubeGrid.
 String getBodyStyleName()
          CSS class for the CubeGrid body
 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.
 Boolean getCanEdit()
          Whether cells can be edited in this grid.
 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.
 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.
 Boolean getCanMoveFacets()
          Whether row and column facets can be rearranged by the user, by dragging and dropping the facet labels.
 Boolean getCanReorderColumns()
          If true, body columns can be reordered via the innermost column headers.
 Boolean getCanResizeColumns()
          If true, body columns can be resized via the innermost column headers.
 Boolean getCanSelectHeaders()
          Determines whether row or column facetValue headers can be selected.
 Boolean getCanSelectValues()
          Determines whether cell values in the body can be selected.
 Boolean getCanSortData()
          If true, sort controls will be shown on facet values.
 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.
 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 CubeGrid.makeChart is called with a chart specification that will show more than chartConfirmThreshold data elements, the user will be presented with a confirmation dialog.
 String getChartConstructor()
          Name of the Smart GWT Class to be used when creating charts.
 ChartType getChartType()
          Default type of chart to plot.
 String getColHeaderBaseStyle()
          baseStyle for the buttons in this grid's column headers.
 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.
 int getDefaultFacetWidth()
          Default width of inner column headers.
 Boolean getEditByCell()
          CubeGrids only support editing by cell.
 Object getEditedCell(int rowNum, int colNum)
          Returns the current value of a cell.
 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.
 Object getEditValue(int rowNum, int colNum)
          Returns the current temporary locally stored edit value for a cell being edited.
 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 most recent mouse event.
 int getEventColumn(Integer x)
          Returns the column number of the most recent mouse event.
 int getEventRow()
          Returns the row number of the most recent mouse event.
 int getEventRow(Integer y)
          Returns the row number of the most recent mouse event.
 Facet getFacet(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.
 Integer getFacetLabelHoverHeight()
          If specified and this.showHover is true, this is the default height to apply to hover tips shown for facetLabels.
 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.
 Integer getFacetLabelHoverWidth()
          If specified and this.showHover is true, this is the default width to apply to hover tips shown for facetLabels.
 String[] getFacetsHavingSelection()
          Return the list of facets that have any selection in their headers.
 Alignment getFacetTitleAlign()
          Default alignment for facet labels.
 FacetValue getFacetValue(String facetId, String facetValueId)
          Get a facet value definition by facetId and facetValueId.
 Alignment getFacetValueAlign()
          Default alignment for facet values (in headers).
 Alignment getFacetValueHoverAlign()
          Allows the developer to override the horizontal text alignment of hover tips shown for facet values.
 Integer getFacetValueHoverHeight()
          If specified and this.showHover is true, this is the default height to apply to hover tips shown for facetValues.
 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.
 Integer getFacetValueHoverWidth()
          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.
 FacetValueMap getFixedFacetValues()
          A FacetValueMap describing the set of facet values that should be regarded as "fixed" in this cubeGrid.
 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).
 Boolean getHideEmptyFacetValues()
          This causes the headers for any combination of facetValues for which there are no cellRecords to be suppressed.
 Hilite[] getHilites()
          Hilites to be applied to the data for this component.
 String getInnerHeaderBaseStyle()
          baseStyle for the buttons in the innermost column header for this cubeGrid.
 com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
           
 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".
static CubeGrid getOrCreateRef(JavaScriptObject jsObj)
           
 Boolean getPadTitles()
          Whether to pad titles so they aren't flush with header borders.
 String getRollupValue()
          facetValueId of the default rollupValue for each facet.
 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.
 String getRowHeaderBaseStyle()
          baseStyle for the buttons in this grid's row headers.
 Boolean getRowHeaderGridMode()
          If enabled row headers for this cubeGrid will be rendered using a GridRenderer component.
 Boolean getSaveByCell()
          CubeGrids only support editing by cell.
 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(String facetId)
          Returns an array of facetValues objects indicating the headers that are selected in the headerBar for this facet.
 boolean getShowFacetValueContextMenus()
          If true, show facet value context menus with some built-in operations.
 Boolean getSimpleDeselect()
          If true, clicking on the existing selection causes it to be entirely deselected.
 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.
 String getStyleName()
          CSS class for the CubeGrid as a whole
protected  CubeGrid getTestInstance()
           
 String getValueProperty()
          Name of the property in a cell record that holds the cell value.
 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.
 Boolean getWrapFacetTitles()
          Whether to allow text wrapping on facet titles.
 Boolean getWrapFacetValueTitles()
          Whether to allow text wrapping on facet value titles.
 Boolean hasChanges()
          Determines whether any cells in this cubeGrid have been edited but not yet saved to the underlying data set.
 Boolean hiliteCell(int rowNum, int colNum, String hiliteID)
          Apply a hilite to a specific cell.
 Boolean hiliteFacetValue(String facetID, String facetValueID, String hiliteID)
          Apply a hilite to all cells corresponding to a facetValue.
 FacetChart makeChart(FacetValueMap fixedFacetValues, String[] variableFacets, FacetChart chartProperties)
          Chart the portion of the dataset indicated by fixedFacetValues, for all values of the variableFacets.
 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.
 void removeFacet(String facetId)
          Remove a facet from the current view, using a fixed value from that facet.
 void removeFacet(String facetId, String fixedFacetValueId)
          Remove a facet from the current view, using a fixed value from that facet.
 void resizeFacetValue(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(String facetId)
           
 void selectAllFacetValues(String facetId, 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(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(String... cellList)
          Select/deselect cells that match a FacetValueMap.
 void selectFacetValue(String facetId, String facetValueId)
          Select/deselect the header for a given facet value.
 void selectFacetValue(String facetId, String facetValueId, Boolean newState)
          Select/deselect the header for a given facet value.
 void setAlternateRecordStyles(Boolean alternateRecordStyles)
          Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading.
 void setAutoSelectHeaders(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.
 void setAutoSelectValues(AutoSelectionModel autoSelectValues)
          Whether to select cells in the body when row or column headers are selected.
 void setAutoSizeHeaders(Boolean autoSizeHeaders)
          Automatically size row headers to fit wrapped text.
 void setBaseStyle(String baseStyle)
          base cell style for this listGrid.
 void setBodyMinHeight(Integer bodyMinHeight)
          Minimum height for the body of this cubeGrid.
 void setBodyMinWidth(Integer bodyMinWidth)
          Minimum width for the body of this cubeGrid.
 void setBodyStyleName(String bodyStyleName)
          CSS class for the CubeGrid body
 void setCanCollapseFacets(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.
 void setCanEdit(Boolean canEdit)
          Whether cells can be edited in this grid.
 void setCanMinimizeColumns(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.
 void setCanMinimizeFacets(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.
 void setCanMoveFacets(Boolean canMoveFacets)
          Whether row and column facets can be rearranged by the user, by dragging and dropping the facet labels.
 void setCanReorderColumns(Boolean canReorderColumns)
          If true, body columns can be reordered via the innermost column headers.
 void setCanResizeColumns(Boolean canResizeColumns)
          If true, body columns can be resized via the innermost column headers.
 void setCanSelectHeaders(Boolean canSelectHeaders)
          Determines whether row or column facetValue headers can be selected.
 void setCanSelectValues(Boolean canSelectValues)
          Determines whether cell values in the body can be selected.
 void setCanSortData(Boolean canSortData)
          If true, sort controls will be shown on facet values.
 void setCanSortFacets(Boolean canSortFacets)
          If true, sort controls will be shown on FacetHeaders.
 void setCellAlign(Alignment cellAlign)
          Default align for cell values (in body).
 void setCellIdProperty(String cellIdProperty)
          Name of the property in a cell record that holds it's unique ID.
 void setChartConfirmThreshold(int chartConfirmThreshold)
          If CubeGrid.makeChart is called with a chart specification that will show more than chartConfirmThreshold data elements, the user will be presented with a confirmation dialog.
 void setChartConstructor(String chartConstructor)
          Name of the Smart GWT Class to be used when creating charts.
 void setChartType(ChartType chartType)
          Default type of chart to plot.
 void setColHeaderBaseStyle(String colHeaderBaseStyle)
          baseStyle for the buttons in this grid's column headers.
 void setColumnFacets(String... columnFacets)
          The list of ids for facets that will appear on top of the body.
 void 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, Object value)
          Set the edit value for some cell in the cube grid.
 void setEnableCharting(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.
 void setFacetLabelHoverAlign(Alignment facetLabelHoverAlign)
          Allows the developer to override the horizontal text alignment of hover tips shown for facetLabels.
 void setFacetLabelHoverHeight(Integer facetLabelHoverHeight)
          If specified and this.showHover is true, this is the default height to apply to hover tips shown for facetLabels.
 void setFacetLabelHoverStyle(String facetLabelHoverStyle)
          Allows the developer to override the css class applied to hover tips shown for facet labels.
 void setFacetLabelHoverVAlign(VerticalAlignment facetLabelHoverVAlign)
          Allows the developer to override the vertical text alignment of hover tips shown for facetLabels.
 void setFacetLabelHoverWidth(Integer facetLabelHoverWidth)
          If specified and this.showHover is true, this is the default width to apply to hover tips shown for facetLabels.
 void setFacets(Facet... facets)
          Facet definitions for this CubeGrid.
 void setFacetTitle(String facetId, String newTitle)
          Set the title of a facet (appears in facet label).
 void setFacetTitleAlign(Alignment facetTitleAlign)
          Default alignment for facet labels.
 void setFacetValueAlign(Alignment facetValueAlign)
          Default alignment for facet values (in headers).
 void setFacetValueHoverAlign(Alignment facetValueHoverAlign)
          Allows the developer to override the horizontal text alignment of hover tips shown for facet values.
 void setFacetValueHoverHeight(Integer facetValueHoverHeight)
          If specified and this.showHover is true, this is the default height to apply to hover tips shown for facetValues.
 void setFacetValueHoverStyle(String facetValueHoverStyle)
          Allows the developer to override the css class applied to hover tips shown for facet values.
 void setFacetValueHoverVAlign(VerticalAlignment facetValueHoverVAlign)
          Allows the developer to override the vertical text alignment of hover tips shown for facet values.
 void setFacetValueHoverWidth(Integer facetValueHoverWidth)
          If specified and this.showHover is true, this is the default width to apply to hover tips shown for facetValues.
 void setFacetValueTitle(String facetId, String facetValueId, String newTitle)
          Set the title for a facet value.
 void setFacetValueTitleAlign(String facetId, String facetValueId, Alignment align)
          Set the align for the title for a facet value.
 void setFixedFacetValue(String facetId, String fixedFacetValueId)
          Modify fixedFacetValues for this cubeGrid.
 void setFixedFacetValues(FacetValueMap fixedFacetValues)
          A FacetValueMap describing the set of facet values that should be regarded as "fixed" in this cubeGrid.
 void 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).
 void setHideEmptyFacetValues(Boolean hideEmptyFacetValues)
          This causes the headers for any combination of facetValues for which there are no cellRecords to be suppressed.
 void setHilites(Hilite... hilites)
          Hilites to be applied to the data for this component.
 void setInnerHeaderBaseStyle(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)
           
 void setMetricFacetId(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".
 void setPadTitles(Boolean padTitles)
          Whether to pad titles so they aren't flush with header borders.
 void setRollupValue(String rollupValue)
          facetValueId of the default rollupValue for each facet.
 void setRowFacets(String... rowFacets)
          The list of ids for facets that will appear to the left of the body.
 void setRowHeaderBaseStyle(String rowHeaderBaseStyle)
          baseStyle for the buttons in this grid's row headers.
 void setRowHeaderGridMode(Boolean rowHeaderGridMode)
          If enabled row headers for this cubeGrid will be rendered using a GridRenderer component.
 void setShowFacetValueContextMenus(boolean showFacetValueContextMenus)
          If true, show facet value context menus with some built-in operations.
 void setSimpleDeselect(Boolean simpleDeselect)
          If true, clicking on the existing selection causes it to be entirely deselected.
 void setSkinImgDir(String skinImgDir)
          Default directory for skin images (those defined by the class), relative to the Page-wide skinDir.
 void setSortDirection(SortDirection sortDirection)
          Direction of sorting if sortedFacet or sortedFacetValues is specified.
 void setSortedFacetValues(FacetValueMap sortedFacetValues)
          FacetValueMap of facet values representing a set of facetValues by which the cubeGrid data is sorted.
 void setStyleName(String styleName)
          CSS class for the CubeGrid as a whole
 void setValueProperty(String valueProperty)
          Name of the property in a cell record that holds the cell value.
 void setValueTitle(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.
 void setWrapFacetTitles(Boolean wrapFacetTitles)
          Whether to allow text wrapping on facet titles.
 void setWrapFacetValueTitles(Boolean wrapFacetValueTitles)
          Whether to allow text wrapping on facet value titles.
 Boolean toggleFieldOpenState(FacetValueMap facetValueMap)
          Toggles the open state of the specified field.
 
Methods inherited from class com.smartgwt.client.widgets.grid.ListGrid
addBodyKeyPressHandler, addCellClickHandler, addCellContextClickHandler, addCellDoubleClickHandler, addCellHoverHandler, addCellMouseDownHandler, addCellMouseUpHandler, addCellOutHandler, addCellOverHandler, addCellSavedHandler, addCellSelectionChangedHandler, addCellValueHoverHandler, addData, addData, addData, addDataArrivedHandler, addDragCompleteHandler, addDrawAreaChangedHandler, addDropCompleteHandler, addEditCompleteHandler, addEditFailedHandler, addEditorEnterHandler, addEditorExitHandler, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addFetchDataHandler, addFieldStateChangedHandler, addFilterEditorSubmitHandler, addFormulaField, addFormulaUpdatedHandler, addGroupByCompleteHandler, addGroupByHandler, addGroupStateChangedHandler, addHeaderClickHandler, addHeaderDoubleClickHandler, addHeaderHoverHandler, addHilitesChangedHandler, addRecordClickHandler, addRecordCollapseHandler, addRecordDoubleClickHandler, addRecordDropHandler, addRecordExpandHandler, addRemoveRecordClickHandler, addRowContextClickHandler, addRowEditorEnterHandler, addRowEditorExitHandler, addRowHoverHandler, addRowMouseDownHandler, addRowMouseUpHandler, addRowOutHandler, addRowOverHandler, addSelectionChangedHandler, addSelectionUpdatedHandler, addSort, addSortChangedHandler, addSorterClickHandler, addSorterContextClickHandler, addSummaryField, addViewStateChangedHandler, anySelected, applyCellData, applyRecordData, autoFitField, autoFitFields, autoFitFields, cancelEditing, canEditCell, canExpandRecord, canSelectCell, canSelectRecord, cellHasChanges, cellHasErrors, cellHasErrors, cellValueHoverHTML, cellValueIsClipped, chartData, chartData, chartData, chartData, chartData, clearCriteria, clearCriteria, clearCriteria, clearEditValue, clearFieldError, clearFieldError, clearRowErrors, clearSort, closeRecord, collapseRecord, collapseRecords, configureGrouping, createRecordComponent, deselectAllRecords, deselectRange, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, discardAllEdits, discardAllEdits, discardAllEdits, discardEdits, discardEdits, displayHeaderContextMenu, editFields, editHilites, enableHilite, enableHilite, enableHiliting, enableHiliting, endEditing, expandRecord, expandRecords, exportClientData, exportClientData, exportClientData, exportData, exportData, fetchData, fetchData, fetchData, fetchData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fieldIsVisible, filterByEditor, filterData, filterData, filterData, filterData, find, findAll, findIndex, findNextIndex, findNextIndex, focusInCell, focusInFilterEditor, focusInFilterEditor, focusInRow, freezeField, freezeField, freezeField, freezeField, freezeFields, freezeFields, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAdvancedFieldPickerThreshold, getAllEditRows, getAllFields, getAllowFilterExpressions, getAllowRowSpanning, getAlternateBodyStyleName, getAlternateFieldFrequency, getAlternateFieldStyles, getAlternateRecordFrequency, getAlwaysShowEditors, getAnimateFolderEffect, getAnimateFolderMaxRows, getAnimateFolders, getAnimateFolderSpeed, getAnimateFolderTime, getAnimateRemoveRecord, getAnimateRemoveSpeed, getAnimateRemoveTime, getAnimateRollOver, getAnimateRollUnder, getAnimateSelection, getAnimateSelectionUnder, getApplyFormulaAfterSummary, getApplyRowNumberStyle, getArrowKeyAction, getAsynchGroupingPrompt, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchDisplayMap, getAutoFetchTextMatchStyle, getAutoFitAllText, getAutoFitClipFields, getAutoFitData, getAutoFitExpandField, getAutoFitExtraRecords, getAutoFitFieldsFillViewport, getAutoFitFieldText, getAutoFitFieldWidths, getAutoFitHeaderHeights, getAutoFitIconFields, getAutoFitMaxColumns, getAutoFitMaxHeight, getAutoFitMaxRecords, getAutoFitMaxWidth, getAutoFitWidthApproach, getAutoSaveEdits, getAutoSizeHeaderSpans, getBackgroundComponent, getBadFormulaResultValue, getBaseStyle, getBody, getBodyBackgroundColor, getBodyOverflow, getBodyScrollLeft, getBodyScrollTop, getBooleanBaseStyle, getBooleanFalseImage, getBooleanImageHeight, getBooleanImageWidth, getBooleanPartialImage, getBooleanTrueImage, getCanAcceptDroppedRecords, getCanAddFormulaFields, getCanAddSummaryFields, getCanAutoFitFields, getCancelEditingConfirmationMessage, getCanCollapseGroup, getCanDragRecordsOut, getCanDragSelect, getCanDragSelectText, getCanDropInEmptyArea, getCanEditFieldAttribute, getCanEditTitles, getCanExpandMultipleRecords, getCanExpandRecordProperty, getCanExpandRecords, getCanFreezeFields, getCanGroupBy, getCanHover, getCanMultiGroup, getCanMultiSort, getCanPickFields, getCanPickOmittedFields, getCanRemoveRecords, getCanReorderFields, getCanReorderRecords, getCanResizeFields, getCanSelectAll, getCanSelectCells, getCanSort, getCanTabToHeader, getCellContextMenu, getCellCSSText, getCellErrors, getCellHeight, getCellHoverComponent, getCellPadding, getCellPageRect, getCellRowSpan, getCellSelection, getCellStartRow, getCellStyle, getCheckboxFieldFalseImage, getCheckboxFieldImageHeight, getCheckboxFieldImageWidth, getCheckboxFieldPartialImage, getCheckboxFieldTrueImage, getChildExpansionMode, getClearAllSortingText, getClearFilterText, getClearSortFieldText, getClipHeaderTitles, getColumnLeft, getColumnPageLeft, getColumnWidth, getConfigureGroupingText, getConfigureSortText, getConfirmCancelEditing, getConfirmDiscardEdits, getConfirmDiscardEditsMessage, getCriteria, getCurrentExpansionComponent, getCurrentExpansionComponent, getDataAsJSList, getDataAsRecordList, getDataFetchMode, getDataPageSize, getDataSource, getDateFormatter, getDatetimeFormatter, getDefaultFields, getDefaultFieldWidth, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedValue, getDeferRemoval, getDetailDS, getDetailField, getDiscardEditsOnHideField, getDiscardEditsSaveButtonTitle, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDragData, getDragDataAction, getDragTrackerMode, getDragTrackerStyle, getDrawAheadRatio, getDrawAllMaxCells, getDrawArea, getDrawnRowHeight, getDrawnRows, getDropValues, getDuplicateDragMessage, getEditCol, getEditedCell, getEditedCell, getEditedCell, getEditedRecord, getEditEvent, getEditFailedBaseStyle, getEditFailedCSSText, getEditFormItem, getEditFormItem, getEditFormulaFieldText, getEditOnF2Keypress, getEditOnFocus, getEditPendingBaseStyle, getEditPendingCSSText, getEditRow, getEditSummaryFieldText, getEditValue, getEditValueAsBoolean, getEditValueAsDate, getEditValueAsFloat, getEditValueAsInt, getEditValueAsRecord, getEditValueAsRecordArray, getEditValueAsString, getEditValues, getEditValues, getEmptyCellValue, getEmptyMessage, getEmptyMessageStyle, getEnforceVClipping, getEnterKeyEditAction, getEnumCriteriaAsInitialValues, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getEscapeKeyEditAction, getExpansionCanEdit, getExpansionComponent, getExpansionComponentPoolingMode, getExpansionDetailField, getExpansionDetailRelated, getExpansionDetails, getExpansionEditor, getExpansionEditorCollapseOnSave, getExpansionEditorSaveButton, getExpansionEditorSaveButtonTitle, getExpansionEditorSaveDialogPrompt, getExpansionEditorShowSaveDialog, getExpansionField, getExpansionFieldFalseImage, getExpansionFieldImageHeight, getExpansionFieldImageWidth, getExpansionFieldTrueImage, getExpansionLayout, getExpansionMode, getExpansionRelated, getExportAll, getExportAlternateRowBGColor, getExportBGColor, getExportColumnBGColor, getExportDefaultBGColor, getExportFieldAlignments, getExportFields, getExportFieldWidths, getExportHeaderHeights, getExportRawValues, getExportRowBGColor, getExportWidthScale, getExportWrapHeaderTitles, getFetchDelay, getFetchOperation, getField, getField, getFieldName, getFieldNum, getFieldNum, getFieldPickerFieldProperties, getFieldPickerShowSampleValues, getFieldPickerWindow, getFields, getFieldState, getFieldVisibilitySubmenuTitle, getFieldWidth, getFieldWidth, getFieldWidth, getFilterButtonPrompt, getFilterButtonProperties, getFilterByCell, getFilterEditor, getFilterEditorCriteria, getFilterEditorCriteria, getFilterEditorHeight, getFilterEditorProperties, getFilterLocalData, getFilterOnKeypress, getFixedFieldWidths, getFixedRecordHeights, getFocusRow, getFormulaBuilderSpanTitleSeparator, getFormulaFieldValue, getFreezeFieldText, getFreezeOnLeftText, getFreezeOnRightText, getFrozenBaseStyle, getFrozenHeaderBaseStyle, getFrozenHeaderTitleStyle, getGenerateClickOnEnter, getGenerateClickOnSpace, getGenerateDoubleClickOnEnter, getGenerateDoubleClickOnSpace, getGridComponents, getGridRenderer, getGridSummary, getGridSummaryData, getGridSummaryRecordProperty, getGroupByAsyncThreshold, getGroupByFields, getGroupByFieldSummaries, getGroupByMaxRecords, getGroupByText, getGroupIcon, getGroupIconSize, getGroupIndentSize, getGroupLeadingIndent, getGroupNodeBaseStyle, getGroupNodeStyle, getGroupState, getGroupSummaryRecordProperty, getGroupSummaryStyle, getGroupTitleColumnProperties, getGroupTitleField, getGroupTree, getHeader, getHeaderAutoFitEvent, getHeaderBackgroundColor, getHeaderBarStyle, getHeaderBaseStyle, getHeaderButtonProperties, getHeaderContextMenu, getHeaderContextMenuItems, getHeaderHeight, getHeaderHoverAlign, getHeaderHoverHeight, getHeaderHoverOpacity, getHeaderHoverStyle, getHeaderHoverVAlign, getHeaderHoverWidth, getHeaderHoverWrap, getHeaderMenuButton, getHeaderMenuButtonHeight, getHeaderMenuButtonIcon, getHeaderMenuButtonIconHeight, getHeaderMenuButtonIconWidth, getHeaderMenuButtonWidth, getHeaderSpan, getHeaderSpanContextMenuItems, getHeaderSpanHeight, getHeaderTitleStyle, getHiliteCanReplaceValue, getHiliteEditorSpanTitleSeparator, getHiliteHTMLAfterFormat, getHiliteIconHeight, getHiliteIconLeftPadding, getHiliteIconPosition, getHiliteIconRightPadding, getHiliteIcons, getHiliteIconSize, getHiliteIconWidth, getHiliteProperty, getHiliteReplaceValueFieldTitle, getHiliteState, getHoverMode, getHoverStyle, getIconPadding, getImageSize, getIncludeHilitesInSummaryFields, getIncludeInSummaryProperty, getInitialCriteria, getInitialSort, getInstantScrollTrackRedraw, getInvalidSummaryValue, getIsGrouped, getIsSeparatorProperty, getLeaveScrollbarGap, getLinkTextProperty, getListEndEditAction, getLoadingDataMessage, getLoadingDataMessageStyle, getLoadingMessage, getLocateColumnsBy, getLocateRowsBy, getLongTextEditorThreshold, getLongTextEditorType, getMaxExpandedRecords, getMaxExpandedRecordsPrompt, getMinFieldWidth, getMissingSummaryFieldValue, getModalEditing, getNavigateOnTab, getNeverValidate, getNormalBaseStyle, getNormalCellHeight, getNullGroupTitle, getOfflineMessageStyle, getOriginalRecordList, getOriginalResultSet, getOriginBaseStyle, getPoolComponentsPerColumn, getPreventDuplicates, getPrintAutoFit, getPrintBaseStyle, getPrintHeaderStyle, getPrintMaxRows, getPrintWrapCells, getProgressiveLoading, getQuickDrawAheadRatio, getRecord, getRecordBaseStyleProperty, getRecordCanRemoveProperty, getRecordCanSelectProperty, getRecordComponent, getRecordComponent, getRecordComponentHeight, getRecordComponentPoolingMode, getRecordComponentPosition, getRecordDetailDSProperty, getRecordDropAppearance, getRecordDropPosition, getRecordEditProperty, getRecordEnabledProperty, getRecordIndex, getRecordIndex, getRecordList, getRecords, getRecordSummaryBaseStyle, getRelatedDataSource, getRemovedCSSText, getRemoveFieldDefaults, getRemoveFieldProperties, getRemoveFieldTitle, getRemoveIcon, getRemoveIconSize, getRemoveOperation, getReselectOnUpdate, getReselectOnUpdateNotifications, getResizeFieldsInRealTime, getResultSet, getReverseRTLAlign, getRollOverCanvas, getRollUnderCanvas, getRowEndEditAction, getRowErrors, getRowHeight, getRowNumberField, getRowNumberStart, getRowNumberStyle, getRowPageTop, getRowSpan, getRowSpanEditMode, getRowSpanSelectionMode, getRowTop, getSaveLocally, getSaveRequestProperties, getScreenReaderCellSeparator, getScrollRedrawDelay, getScrollToCellXPosition, getScrollToCellYPosition, getScrollWheelRedrawDelay, getSelectedCellData, getSelectedRecord, getSelectedRecords, getSelectedRecords, getSelectedState, getSelectHeaderOnSort, getSelection, getSelection, getSelectionAppearance, getSelectionProperty, getSelectionType, getSelectOnEdit, getShowAllColumns, getShowAllRecords, getShowAsynchGroupingPrompt, getShowBackgroundComponents, getShowCellContextMenus, getShowClippedHeaderTitlesOnHover, getShowClippedValuesOnHover, getShowCollapsedGroupSummary, getShowComplexFields, getShowDetailFields, getShowEmptyMessage, getShowErrorIcons, getShowExpansionEditorSaveButton, getShowFilterEditor, getShowGridSummary, getShowGroupSummary, getShowGroupSummaryInHeader, getShowGroupTitleColumn, getShowHeader, getShowHeaderContextMenu, getShowHeaderMenuButton, getShowHeaderSpanTitlesInFormulaBuilder, getShowHeaderSpanTitlesInHiliteEditor, getShowHeaderSpanTitlesInSortEditor, getShowHiddenFields, getShowHilitesInGroupSummary, getShowHover, getShowHoverComponents, getShowRecordComponents, getShowRecordComponentsByCell, getShowRollOver, getShowRollOverCanvas, getShowRowNumbers, getShowSelectedStyle, getShowSelectionCanvas, getShowSortArrow, getShowSortNumerals, getShowTreeColumnPicker, getShrinkForFreeze, getSingleCellValueProperty, getSort, getSortAscendingImage, getSortDescendingImage, getSortEditorSpanTitleSeparator, getSorterButtonTitle, getSortField, getSortFieldAscendingText, getSortFieldCount, getSortFieldDescendingText, getSortNumeralHTML, getSortNumeralStyle, getSortSpecifier, getSortState, getSpanContextMenu, getStopOnErrors, getSummaryFieldValue, getSummaryRow, getSummaryRowCriteria, getSummaryRowDataSource, getSummaryRowFetchRequestProperties, getSummaryRowHeight, getSummaryRowStyle, getTallBaseStyle, getTitleField, getTitleFieldValue, getToggleFreezeText, getTotalRows, getTrackerImage, getUnfreezeFieldText, getUngroupText, getUnremoveIcon, getUpdateOperation, getUseAdvancedFieldPicker, getUseAllDataSourceFields, getUseCellRollOvers, getUseCopyPasteShortcuts, getUseFlatFields, getUseRemoteValidators, getUseRowSpanStyling, getValidateByCell, getValidateOnChange, getValueIcon, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getViewState, getVirtualScrolling, getVisibleRows, getWaitForSave, getWarnOnRemoval, getWarnOnRemovalMessage, getWarnOnUnmappedValueFieldChange, getWrapCells, getWrapHeaderTitles, groupBy, hasErrors, headerHoverHTML, headerTitleClipped, hideField, hideField, hideFields, hideFields, hideFields, hideFields, invalidateCache, invalidateRecordComponents, isCheckboxField, isExpanded, isExpansionField, isGrouped, isGroupNode, isPartiallySelected, isRowNumberField, isSelected, isSortField, markForRedraw, markForRedraw, markRecordRemoved, markRecordsRemoved, markRecordsRemoved, markSelectionRemoved, onInit_ListGrid, onInit, openRecordDetailGrid, openRecordEditor, preloadImages, recalculateGridSummary, recalculateSummaries, recalculateSummaries, recalculateSummaries, recordClick, recordMarkedAsRemoved, refreshCell, refreshCell, refreshCellStyle, refreshFields, refreshRecordComponent, refreshRecordComponent, refreshRow, removeData, removeData, removeData, removeEmbeddedComponent, removeEmbeddedComponent, removeEmbeddedComponent, removeRecordClick, removeSelectedData, removeSelectedData, removeSelectedData, reorderField, reorderFields, resizeField, resort, rowClick, rowClick, rowDoubleClick, rowDoubleClick, 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, setAllowFilterExpressions, setAllowRowSpanning, setAlternateBodyStyleName, setAlternateFieldFrequency, setAlternateFieldStyles, setAlternateRecordFrequency, setAlwaysShowEditors, setAnimateFolderEffect, setAnimateFolderMaxRows, setAnimateFolders, setAnimateFolderSpeed, setAnimateFolderTime, setAnimateRemoveRecord, setAnimateRemoveSpeed, setAnimateRemoveTime, setAnimateRollOver, setAnimateRollUnder, setAnimateSelection, setAnimateSelectionUnder, setApplyFormulaAfterSummary, setApplyRowNumberStyle, setArrowKeyAction, setAsynchGroupingPrompt, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchDisplayMap, setAutoFetchTextMatchStyle, setAutoFitAllText, setAutoFitClipFields, setAutoFitData, setAutoFitExpandField, setAutoFitExtraRecords, setAutoFitFieldsFillViewport, setAutoFitFieldText, setAutoFitFieldWidths, setAutoFitHeaderHeights, setAutoFitIconFields, setAutoFitMaxColumns, setAutoFitMaxHeight, setAutoFitMaxRecords, setAutoFitMaxWidth, setAutoFitWidth, setAutoFitWidthApproach, setAutoSaveEdits, setAutoSizeHeaderSpans, setBadFormulaResultValue, setBodyBackgroundColor, setBodyOverflow, setBooleanBaseStyle, setBooleanFalseImage, setBooleanImageHeight, setBooleanImageWidth, setBooleanPartialImage, setBooleanTrueImage, setCanAcceptDroppedRecords, setCanAddFormulaFields, setCanAddSummaryFields, setCanAutoFitFields, setCancelEditingConfirmationMessage, setCanCollapseGroup, setCanDragRecordsOut, setCanDragSelect, setCanDragSelectText, setCanDropInEmptyArea, setCanEditFieldAttribute, setCanEditTitles, setCanExpandMultipleRecords, setCanExpandRecordProperty, setCanExpandRecords, setCanFreezeFields, setCanGroupBy, setCanHover, setCanMultiGroup, setCanMultiSort, setCanPickFields, setCanPickOmittedFields, setCanRemoveRecords, setCanReorderFields, setCanReorderRecords, setCanResizeFields, setCanSelectAll, setCanSelectCells, setCanSort, setCanTabToHeader, setCellFormatter, setCellHeight, setCellPadding, setCellValueHoverFormatter, setCheckboxFieldFalseImage, setCheckboxFieldImageHeight, setCheckboxFieldImageWidth, setCheckboxFieldPartialImage, setCheckboxFieldProperties, setCheckboxFieldTrueImage, setChildExpansionMode, setClearAllSortingText, setClearFilterText, setClearSortFieldText, setClipHeaderTitles, setConfigureGroupingText, setConfigureSortText, setConfirmCancelEditing, setConfirmDiscardEdits, setConfirmDiscardEditsMessage, setCriteria, setData, setData, setData, setDataFetchMode, setDataPageSize, setDataProperties, setDataSource, setDataSource, setDateFormatter, setDateInputFormat, setDatetimeFormatter, setDefaultFields, setDefaultProperties, setDeferRemoval, setDetailDS, setDetailDS, setDetailField, setDiscardEditsOnHideField, setDiscardEditsSaveButtonTitle, setDontAutoDestroyComponent, setDragDataAction, setDragTrackerIconCustomizer, setDragTrackerMode, setDragTrackerStyle, setDragTrackerTitleCustomizer, setDrawAheadRatio, setDrawAllMaxCells, setDropValues, setDuplicateDragMessage, setEditByCell, setEditEvent, setEditFailedBaseStyle, setEditFailedCSSText, setEditFormulaFieldText, setEditOnF2Keypress, setEditOnFocus, setEditorCustomizer, setEditorValueMap, setEditorValueMap, setEditPendingBaseStyle, setEditPendingCSSText, setEditSummaryFieldText, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValues, setEmptyCellValue, setEmptyMessage, setEmptyMessageStyle, setEnforceVClipping, setEnterKeyEditAction, setEnumCriteriaAsInitialValues, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setEscapeKeyEditAction, setExpansionCanEdit, setExpansionComponentPoolingMode, setExpansionEditorSaveDialogPrompt, setExpansionEditorShowSaveDialog, setExpansionFieldFalseImage, setExpansionFieldImageHeight, setExpansionFieldImageWidth, setExpansionFieldTrueImage, setExpansionMode, setExportAll, setExportAlternateRowBGColor, setExportDefaultBGColor, setExportFieldAlignments, setExportFields, setExportFieldWidths, setExportHeaderHeights, setExportRawValues, setExportWidthScale, setExportWrapHeaderTitles, setFastCellUpdates, setFetchDelay, setFetchOperation, setFieldButtonProperties, setFieldCellIcon, setFieldError, setFieldError, setFieldHeaderBaseStyle, setFieldHeaderTitleStyle, setFieldIcon, setFieldPickerFieldProperties, setFieldPickerShowSampleValues, setFields, setFieldState, setFieldTitle, setFieldTitle, setFieldVisibilitySubmenuTitle, setFilterButtonPrompt, setFilterButtonProperties, setFilterByCell, setFilterEditorCriteria, setFilterEditorHeight, setFilterEditorProperties, setFilterEditorProperties, setFilterLocalData, setFilterOnKeypress, setFixedFieldWidths, setFixedRecordHeights, setFormulaBuilderSpanTitleSeparator, setFreezeFieldText, setFreezeOnLeftText, setFreezeOnRightText, setFrozenBaseStyle, setFrozenHeaderBaseStyle, setFrozenHeaderTitleStyle, setGenerateClickOnEnter, setGenerateClickOnSpace, setGenerateDoubleClickOnEnter, setGenerateDoubleClickOnSpace, setGridComponents, setGridComponents, setGridSummaryRecordProperty, setGroupByAsyncThreshold, setGroupByField, setGroupByField, setGroupByFieldSummaries, setGroupByMaxRecords, setGroupByText, setGroupIcon, setGroupIconSize, setGroupIndentSize, setGroupLeadingIndent, setGroupNodeBaseStyle, setGroupNodeStyle, setGroupStartOpen, setGroupStartOpen, setGroupState, setGroupSummaryRecordProperty, setGroupSummaryStyle, setGroupTitleColumnProperties, setGroupTitleField, setHeaderAutoFitEvent, setHeaderBackgroundColor, setHeaderBarStyle, setHeaderBaseStyle, setHeaderButtonProperties, setHeaderHeight, setHeaderHoverAlign, setHeaderHoverFormatter, setHeaderHoverHeight, setHeaderHoverOpacity, setHeaderHoverStyle, setHeaderHoverVAlign, setHeaderHoverWidth, setHeaderHoverWrap, setHeaderMenuButtonHeight, setHeaderMenuButtonIcon, setHeaderMenuButtonIconHeight, setHeaderMenuButtonIconWidth, setHeaderMenuButtonWidth, setHeaderSpanBaseStyle, setHeaderSpanButtonProperties, setHeaderSpanHeaderTitle, setHeaderSpanHeight, setHeaderSpans, setHeaderSpanTitle, setHeaderSpanTitleStyle, setHeaderTitleStyle, setHiliteCanReplaceValue, setHiliteEditorSpanTitleSeparator, setHiliteHTMLAfterFormat, setHiliteIconHeight, setHiliteIconLeftPadding, setHiliteIconPosition, setHiliteIconRightPadding, setHiliteIcons, setHiliteIconSize, setHiliteIconWidth, setHiliteProperty, setHiliteReplaceValueFieldTitle, setHiliteState, setHoverCustomizer, setHoverMode, setHoverStyle, setIconPadding, setImageSize, setIncludeHilitesInSummaryFields, setIncludeInSummaryProperty, setInitialCriteria, setInitialSort, setInstantScrollTrackRedraw, setInvalidSummaryValue, setIsSeparatorProperty, setLeaveHeaderMenuButtonSpace, setLeaveScrollbarGap, setLinkTextProperty, setListEndEditAction, setLoadingDataMessage, setLoadingDataMessageStyle, setLoadingMessage, setLocateColumnsBy, setLocateRowsBy, setLogicalStructure, setLongTextEditorThreshold, setLongTextEditorType, setMaxExpandedRecords, setMaxExpandedRecordsPrompt, setMinFieldWidth, setMissingSummaryFieldValue, setModalEditing, setNavigateOnTab, setNeverValidate, setNormalBaseStyle, setNormalCellHeight, setNullGroupTitle, setOfflineMessageStyle, setOriginBaseStyle, setPoolComponentsPerColumn, setPreventDuplicates, setPrintAutoFit, setPrintBaseStyle, setPrintHeaderStyle, setPrintMaxRows, setPrintWrapCells, setProgressiveLoading, setQuickDrawAheadRatio, setRecordBaseStyleProperty, setRecordCanRemoveProperty, setRecordCanSelectProperty, setRecordComponentHeight, setRecordComponentPoolingMode, setRecordComponentPosition, setRecordDetailDSProperty, setRecordDropAppearance, setRecordEditProperty, setRecordEnabledProperty, setRecords, setRecordSummaryBaseStyle, setRemovedCSSText, setRemoveFieldProperties, setRemoveFieldTitle, setRemoveIcon, setRemoveIconSize, setRemoveOperation, setReselectOnUpdate, setReselectOnUpdateNotifications, setResizeFieldsInRealTime, setReverseRTLAlign, setRollUnderCanvasProperties, setRowEndEditAction, setRowErrors, setRowErrors, setRowNumberFieldProperties, setRowNumberStart, setRowNumberStyle, setRowSpanEditMode, setRowSpanSelectionMode, setSaveByCell, setSaveLocally, setSaveRequestProperties, setScreenReaderCellSeparator, setScrollRedrawDelay, setScrollToCellXPosition, setScrollToCellYPosition, setScrollWheelRedrawDelay, setSelectedState, setSelectHeaderOnSort, setSelectionAppearance, setSelectionCanvasProperties, setSelectionProperty, setSelectionType, setSelectionUnderCanvasProperties, setSelectOnEdit, setShowAllColumns, setShowAllRecords, setShowAsynchGroupingPrompt, setShowBackgroundComponents, setShowCellContextMenus, setShowClippedHeaderTitlesOnHover, setShowClippedValuesOnHover, setShowCollapsedGroupSummary, setShowComplexFields, setShowDetailFields, setShowEmptyMessage, setShowErrorIcons, setShowFilterEditor, setShowGridSummary, setShowGroupSummary, setShowGroupSummaryInHeader, setShowGroupTitleColumn, setShowHeader, setShowHeaderContextMenu, setShowHeaderMenuButton, setShowHeaderSpanTitlesInFormulaBuilder, setShowHeaderSpanTitlesInHiliteEditor, setShowHeaderSpanTitlesInSortEditor, setShowHiddenFields, setShowHilitesInGroupSummary, setShowHover, setShowHoverComponents, setShowRecordComponents, setShowRecordComponentsByCell, setShowRollOver, setShowRollOverCanvas, setShowRowNumbers, setShowSelectedStyle, setShowSelectionCanvas, setShowSortArrow, setShowSortNumerals, setShowTreeColumnPicker, setShrinkForFreeze, setSingleCellValueProperty, setSort, setSortAscendingImage, setSortDescendingImage, setSortEditorSpanTitleSeparator, setSorterButtonTitle, setSortField, setSortField, setSortField, setSortFieldAscendingText, setSortFieldDescendingText, setSortNumeralStyle, setSortState, setStopOnErrors, setSummaryRowCriteria, setSummaryRowDataSource, setSummaryRowFetchRequestProperties, setSummaryRowHeight, setSummaryRowStyle, setTallBaseStyle, setTitleField, setTrackerImage, setUnfreezeFieldText, setUngroupText, setUnremoveIcon, setUpdateOperation, setUseAdvancedFieldPicker, setUseAllDataSourceFields, setUseCellRollOvers, setUseCopyPasteShortcuts, setUseFlatFields, setUseRemoteValidators, setUseRowSpanStyling, setValidateByCell, setValidateOnChange, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setViewState, setVirtualScrolling, setWaitForSave, setWarnOnRemoval, setWarnOnRemovalMessage, setWarnOnUnmappedValueFieldChange, setWrapCells, setWrapHeaderTitles, shouldIncludeHiliteInSummaryField, showField, showField, showFields, showFields, showFields, showFields, showRecordComponent, sort, sort, sort, sort, startEditing, startEditing, startEditing, startEditing, startEditingNew, startEditingNew, startEditingNew, startEditingNew, stopHover, summaryUpdated, toggleSort, transferSelectedData, transferSelectedData, unfreezeField, unfreezeField, unfreezeField, unfreezeField, unfreezeFields, unfreezeFields, ungroup, unmarkRecordRemoved, unsort, updateData, updateData, updateData, updateRecordComponent, userSelectAllRecords, validateCell, validateCell, validateRow, willAcceptDrop, willFetchData, willFetchData
 
Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructure
 
Methods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowResizeBar, getShowShadow, getShrinkElementOnHide, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowResizeBar, setShowShadow, setShrinkElementOnHide, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, 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, setDragTracker, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObj
 

Constructor Detail

CubeGrid

public CubeGrid()

CubeGrid

public CubeGrid(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static CubeGrid getOrCreateRef(JavaScriptObject jsObj)

getTestInstance

protected CubeGrid getTestInstance()
Overrides:
getTestInstance in class ListGrid

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
                                           Canvas defaults)
Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:
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.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
                                           FormItem defaults)
Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:
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.
See Also:
AutoChildUsage

create

protected JavaScriptObject create()
Overrides:
create in class ListGrid

setAlternateRecordStyles

public void setAlternateRecordStyles(Boolean alternateRecordStyles)
Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading. If enabled, the cell style for alternate rows will have "Dark" appended to it.

Overrides:
setAlternateRecordStyles in class ListGrid
Parameters:
alternateRecordStyles - Default value is true
See Also:
Appearance overview and related methods

getAlternateRecordStyles

public Boolean getAlternateRecordStyles()
Whether alternating rows should be drawn in alternating styles, in order to create a "ledger" effect for easier reading. If enabled, the cell style for alternate rows will have "Dark" appended to it.

Overrides:
getAlternateRecordStyles in class ListGrid
Returns:
Boolean
See Also:
Appearance overview and related methods

setAutoSelectHeaders

public void setAutoSelectHeaders(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.

Parameters:
autoSelectHeaders - Default value is true

getAutoSelectHeaders

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

Returns:
Boolean

setAutoSelectValues

public void setAutoSelectValues(AutoSelectionModel autoSelectValues)
                         throws IllegalStateException
Whether to select cells in the body when row or column headers are selected.

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

getAutoSelectValues

public AutoSelectionModel getAutoSelectValues()
Whether to select cells in the body when row or column headers are selected.

Returns:
AutoSelectionModel

setAutoSizeHeaders

public void setAutoSizeHeaders(Boolean autoSizeHeaders)
Automatically size row headers to fit wrapped text.

Parameters:
autoSizeHeaders - Default value is false

getAutoSizeHeaders

public Boolean getAutoSizeHeaders()
Automatically size row headers to fit wrapped text.

Returns:
Boolean

setBaseStyle

public void setBaseStyle(String baseStyle)
                  throws IllegalStateException
base cell style for this listGrid. If this property is unset, base style may be derived from normalBaseStyle or tallBaseStyle as described in ListGrid.getBaseStyle.

Overrides:
setBaseStyle in class ListGrid
Parameters:
baseStyle - See CSSStyleName . Default value is "cubeCell"
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getBaseStyle

public String getBaseStyle()
base cell style for this listGrid. If this property is unset, base style may be derived from normalBaseStyle or tallBaseStyle as described in ListGrid.getBaseStyle.

Overrides:
getBaseStyle in class ListGrid
Returns:
Return the base stylename for this cell. Default implementation just returns this.baseStyle. See getCellStyle() for a general discussion of how to style cells. See CSSStyleName
See Also:
Appearance overview and related methods

setBodyMinHeight

public void setBodyMinHeight(Integer bodyMinHeight)
Minimum height for the body of this cubeGrid.

Note : This is an advanced setting

Parameters:
bodyMinHeight - Default value is null

getBodyMinHeight

public Integer getBodyMinHeight()
Minimum height for the body of this cubeGrid.

Returns:
Integer

setBodyMinWidth

public void setBodyMinWidth(Integer bodyMinWidth)
Minimum width for the body of this cubeGrid.

Note : This is an advanced setting

Parameters:
bodyMinWidth - Default value is null

getBodyMinWidth

public Integer getBodyMinWidth()
Minimum width for the body of this cubeGrid.

Returns:
Integer

setBodyStyleName

public void setBodyStyleName(String bodyStyleName)
CSS class for the CubeGrid body

Overrides:
setBodyStyleName in class ListGrid
Parameters:
bodyStyleName - See CSSStyleName . Default value is "cubeGridBody"
See Also:
Appearance overview and related methods

getBodyStyleName

public String getBodyStyleName()
CSS class for the CubeGrid body

Overrides:
getBodyStyleName in class ListGrid
Returns:
See CSSStyleName
See Also:
Appearance overview and related methods

setCanCollapseFacets

public void setCanCollapseFacets(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.

Parameters:
canCollapseFacets - Default value is false

getCanCollapseFacets

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

Returns:
Boolean

setCanEdit

public void setCanEdit(Boolean canEdit)
Whether cells can be edited in this grid. Can be overridden on a per-facetValue basis.

Overrides:
setCanEdit in class ListGrid
Parameters:
canEdit - Default value is false
See Also:
ListGrid.startEditing(), ListGridField.setCanEdit(java.lang.Boolean), ListGrid.setRecordEditProperty(java.lang.String), ListGrid.canEditCell(int, int), ListGrid.setFields(com.smartgwt.client.widgets.grid.ListGridField...), Editing overview and related methods, Edit by row Example

getCanEdit

public Boolean getCanEdit()
Whether cells can be edited in this grid. Can be overridden on a per-facetValue basis.

Overrides:
getCanEdit in class ListGrid
Returns:
Boolean
See Also:
ListGrid.startEditing(), ListGridField.getCanEdit(), ListGrid.getRecordEditProperty(), ListGrid.canEditCell(int, int), ListGrid.getFields(), Editing overview and related methods, Edit by row Example

setCanMinimizeColumns

public void setCanMinimizeColumns(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.

Parameters:
canMinimizeColumns - Default value is null

getCanMinimizeColumns

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

Returns:
Boolean

setCanMinimizeFacets

public void setCanMinimizeFacets(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. Minimizing means showing only one, or very few, of the next facet's values.

Set isMinimizeValue to indicate which facetValues should be shown when a facet is minimized.

Parameters:
canMinimizeFacets - Default value is false

getCanMinimizeFacets

public 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. Minimizing means showing only one, or very few, of the next facet's values.

Set isMinimizeValue to indicate which facetValues should be shown when a facet is minimized.

Returns:
Boolean

setCanMoveFacets

public void setCanMoveFacets(Boolean canMoveFacets)
Whether row and column facets can be rearranged by the user, by dragging and dropping the facet labels.

Parameters:
canMoveFacets - Default value is false

getCanMoveFacets

public Boolean getCanMoveFacets()
Whether row and column facets can be rearranged by the user, by dragging and dropping the facet labels.

Returns:
Boolean

setCanReorderColumns

public void setCanReorderColumns(Boolean canReorderColumns)
If true, body columns can be reordered via the innermost column headers.

Parameters:
canReorderColumns - Default value is null

getCanReorderColumns

public Boolean getCanReorderColumns()
If true, body columns can be reordered via the innermost column headers.

Returns:
Boolean

setCanResizeColumns

public void setCanResizeColumns(Boolean canResizeColumns)
If true, body columns can be resized via the innermost column headers.

Parameters:
canResizeColumns - Default value is null

getCanResizeColumns

public Boolean getCanResizeColumns()
If true, body columns can be resized via the innermost column headers.

Returns:
Boolean

setCanSelectHeaders

public void setCanSelectHeaders(Boolean canSelectHeaders)
Determines whether row or column facetValue headers can be selected.

Parameters:
canSelectHeaders - Default value is true

getCanSelectHeaders

public Boolean getCanSelectHeaders()
Determines whether row or column facetValue headers can be selected.

Returns:
Boolean

setCanSelectValues

public void setCanSelectValues(Boolean canSelectValues)
Determines whether cell values in the body can be selected.

Parameters:
canSelectValues - Default value is true

getCanSelectValues

public Boolean getCanSelectValues()
Determines whether cell values in the body can be selected.

Returns:
Boolean

setCanSortData

public void setCanSortData(Boolean canSortData)
If true, sort controls will be shown on facet values.

When clicked, sort controls call CubeGrid.sortByFacetValues.

Parameters:
canSortData - Default value is null

getCanSortData

public Boolean getCanSortData()
If true, sort controls will be shown on facet values.

When clicked, sort controls call CubeGrid.sortByFacetValues.

Returns:
Boolean

setCanSortFacets

public void setCanSortFacets(Boolean canSortFacets)
If true, sort controls will be shown on FacetHeaders.

When clicked, sort controls call CubeGrid.sortByFacetId.

Parameters:
canSortFacets - Default value is null

getCanSortFacets

public Boolean getCanSortFacets()
If true, sort controls will be shown on FacetHeaders.

When clicked, sort controls call CubeGrid.sortByFacetId.

Returns:
Boolean

setCellAlign

public void setCellAlign(Alignment cellAlign)
Default align for cell values (in body).

Parameters:
cellAlign - Default value is "center"

getCellAlign

public Alignment getCellAlign()
Default align for cell values (in body).

Returns:
Alignment

setCellIdProperty

public void setCellIdProperty(String cellIdProperty)
                       throws IllegalStateException
Name of the property in a cell record that holds it's unique ID. Note cell record IDs are optional.

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

getCellIdProperty

public String getCellIdProperty()
Name of the property in a cell record that holds it's unique ID. Note cell record IDs are optional.

Returns:
String

setChartConfirmThreshold

public void setChartConfirmThreshold(int chartConfirmThreshold)
                              throws IllegalStateException
If CubeGrid.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.

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

getChartConfirmThreshold

public int getChartConfirmThreshold()
If CubeGrid.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.

Returns:
int

setChartConstructor

public void setChartConstructor(String chartConstructor)
                         throws IllegalStateException
Name of the Smart GWT Class to be used when creating charts. Must support the Chart interface.

Overrides:
setChartConstructor in class ListGrid
Parameters:
chartConstructor - Default value is "FacetChart"
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getChartConstructor

public String getChartConstructor()
Name of the Smart GWT Class to be used when creating charts. Must support the Chart interface.

Overrides:
getChartConstructor in class ListGrid
Returns:
String

setChartType

public void setChartType(ChartType chartType)
Default type of chart to plot.

Overrides:
setChartType in class ListGrid
Parameters:
chartType - Default value is "Column"

getChartType

public ChartType getChartType()
Default type of chart to plot.

Overrides:
getChartType in class ListGrid
Returns:
ChartType

setColHeaderBaseStyle

public void setColHeaderBaseStyle(String colHeaderBaseStyle)
                           throws IllegalStateException
baseStyle for the buttons in this grid's column headers.

Exception: The innermost column header will always be styled using innerHeaderBaseStyle.

Parameters:
colHeaderBaseStyle - See CSSStyleName . Default value is colHeader
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getColHeaderBaseStyle

public String getColHeaderBaseStyle()
baseStyle for the buttons in this grid's column headers.

Exception: The innermost column header will always be styled using innerHeaderBaseStyle.

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

setColumnFacets

public void setColumnFacets(String... columnFacets)
                     throws IllegalStateException
The list of ids for facets that will appear on top of the body.

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

getColumnFacets

public String[] getColumnFacets()
The list of ids for facets that will appear on top of the body.

Returns:
String...

setDefaultFacetWidth

public void setDefaultFacetWidth(int defaultFacetWidth)
Default width of inner column headers.

Parameters:
defaultFacetWidth - Default value is 100

getDefaultFacetWidth

public int getDefaultFacetWidth()
Default width of inner column headers.

Returns:
int

getEditByCell

public Boolean getEditByCell()
                      throws IllegalStateException
CubeGrids only support editing by cell.

Note : This method should be called only after the widget has been rendered.

Overrides:
getEditByCell in class ListGrid
Returns:
Boolean
Throws:
IllegalStateException - if this widget has not yet been rendered.
See Also:
ListGrid.getCanEdit(), Editing overview and related methods, Edit by cell Example

setFacetLabelHoverAlign

public void setFacetLabelHoverAlign(Alignment facetLabelHoverAlign)
Allows the developer to override the horizontal text alignment of hover tips shown for facetLabels. If unspecified the hover canvas content alignment will be set by this.hoverAlign if specified.

Note : This is an advanced setting

Parameters:
facetLabelHoverAlign - Default value is null
See Also:
Canvas.setHoverAlign(com.smartgwt.client.types.Alignment)

getFacetLabelHoverAlign

public Alignment getFacetLabelHoverAlign()
Allows the developer to override the horizontal text alignment of hover tips shown for facetLabels. If unspecified the hover canvas content alignment will be set by this.hoverAlign if specified.

Returns:
Alignment
See Also:
Canvas.getHoverAlign()

setFacetLabelHoverHeight

public void setFacetLabelHoverHeight(Integer facetLabelHoverHeight)
If specified and 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

Parameters:
facetLabelHoverHeight - Default value is null
See Also:
Canvas.setHoverHeight(java.lang.Integer)

getFacetLabelHoverHeight

public Integer getFacetLabelHoverHeight()
If specified and 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.

Returns:
Integer
See Also:
Canvas.getHoverHeight()

setFacetLabelHoverStyle

public void setFacetLabelHoverStyle(String facetLabelHoverStyle)
Allows the developer to override the css class applied to hover tips shown for facet labels. If unspecified, and this.hoverStyle is not null, that css class will be applied to facet label hovers instead.

Note : This is an advanced setting

Parameters:
facetLabelHoverStyle - See CSSStyleName . Default value is null
See Also:
Canvas.setHoverStyle(java.lang.String)

getFacetLabelHoverStyle

public String getFacetLabelHoverStyle()
Allows the developer to override the css class applied to hover tips shown for facet labels. If unspecified, and this.hoverStyle is not null, that css class will be applied to facet label hovers instead.

Returns:
See CSSStyleName
See Also:
Canvas.getHoverStyle()

setFacetLabelHoverVAlign

public void setFacetLabelHoverVAlign(VerticalAlignment facetLabelHoverVAlign)
Allows the developer to override the vertical text alignment of hover tips shown for facetLabels. If unspecified the hover canvas content alignment will be set by this.hoverVAlign if specified.

Note : This is an advanced setting

Parameters:
facetLabelHoverVAlign - Default value is null
See Also:
Canvas.setHoverVAlign(com.smartgwt.client.types.VerticalAlignment)

getFacetLabelHoverVAlign

public VerticalAlignment getFacetLabelHoverVAlign()
Allows the developer to override the vertical text alignment of hover tips shown for facetLabels. If unspecified the hover canvas content alignment will be set by this.hoverVAlign if specified.

Returns:
VerticalAlignment
See Also:
Canvas.getHoverVAlign()

setFacetLabelHoverWidth

public void setFacetLabelHoverWidth(Integer facetLabelHoverWidth)
If specified and 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

Parameters:
facetLabelHoverWidth - Default value is null
See Also:
Canvas.setHoverWidth(java.lang.Integer)

getFacetLabelHoverWidth

public Integer getFacetLabelHoverWidth()
If specified and 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.

Returns:
Integer
See Also:
Canvas.getHoverWidth()

setFacets

public void setFacets(Facet... facets)
               throws IllegalStateException
Facet definitions for this CubeGrid. Facets, also called "dimensions", are orthogonal aspects of the data model.

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.

Parameters:
facets - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
getFacet(java.lang.String), Facet, getFacetValue(java.lang.String, java.lang.String), FacetValue

setFacetTitleAlign

public void setFacetTitleAlign(Alignment facetTitleAlign)
Default alignment for facet labels.

If this method is called after the component has been drawn/initialized: Set the align of a facet title (appears in facet label).

Parameters:
facetTitleAlign - facet to update. Default value is "center"

getFacetTitleAlign

public Alignment getFacetTitleAlign()
Default alignment for facet labels.

Returns:
Alignment

setFacetValueAlign

public void setFacetValueAlign(Alignment facetValueAlign)
Default alignment for facet values (in headers).

Parameters:
facetValueAlign - Default value is "center"

getFacetValueAlign

public Alignment getFacetValueAlign()
Default alignment for facet values (in headers).

Returns:
Alignment

setFacetValueHoverAlign

public void setFacetValueHoverAlign(Alignment facetValueHoverAlign)
Allows the developer to override the horizontal text alignment of hover tips shown for facet values. If unspecified the hover canvas content alignment will be set by this.hoverAlign if specified.

Note : This is an advanced setting

Parameters:
facetValueHoverAlign - Default value is null
See Also:
Canvas.setHoverAlign(com.smartgwt.client.types.Alignment)

getFacetValueHoverAlign

public Alignment getFacetValueHoverAlign()
Allows the developer to override the horizontal text alignment of hover tips shown for facet values. If unspecified the hover canvas content alignment will be set by this.hoverAlign if specified.

Returns:
Alignment
See Also:
Canvas.getHoverAlign()

setFacetValueHoverHeight

public void setFacetValueHoverHeight(Integer facetValueHoverHeight)
If specified and 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

Parameters:
facetValueHoverHeight - Default value is null
See Also:
Canvas.setHoverHeight(java.lang.Integer)

getFacetValueHoverHeight

public Integer getFacetValueHoverHeight()
If specified and 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.

Returns:
Integer
See Also:
Canvas.getHoverHeight()

setFacetValueHoverStyle

public void setFacetValueHoverStyle(String facetValueHoverStyle)
Allows the developer to override the css class applied to hover tips shown for facet values. If unspecified, and this.hoverStyle is not null, that css class will be applied to facet value hovers instead.

Note : This is an advanced setting

Parameters:
facetValueHoverStyle - See CSSStyleName . Default value is null
See Also:
Canvas.setHoverStyle(java.lang.String)

getFacetValueHoverStyle

public String getFacetValueHoverStyle()
Allows the developer to override the css class applied to hover tips shown for facet values. If unspecified, and this.hoverStyle is not null, that css class will be applied to facet value hovers instead.

Returns:
See CSSStyleName
See Also:
Canvas.getHoverStyle()

setFacetValueHoverVAlign

public void setFacetValueHoverVAlign(VerticalAlignment facetValueHoverVAlign)
Allows the developer to override the vertical text alignment of hover tips shown for facet values. If unspecified the hover canvas content alignment will be set by this.hoverVAlign if specified.

Note : This is an advanced setting

Parameters:
facetValueHoverVAlign - Default value is null
See Also:
Canvas.setHoverVAlign(com.smartgwt.client.types.VerticalAlignment)

getFacetValueHoverVAlign

public VerticalAlignment getFacetValueHoverVAlign()
Allows the developer to override the vertical text alignment of hover tips shown for facet values. If unspecified the hover canvas content alignment will be set by this.hoverVAlign if specified.

Returns:
VerticalAlignment
See Also:
Canvas.getHoverVAlign()

setFacetValueHoverWidth

public void setFacetValueHoverWidth(Integer facetValueHoverWidth)
If specified and 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

Parameters:
facetValueHoverWidth - Default value is null
See Also:
Canvas.setHoverWidth(java.lang.Integer)

getFacetValueHoverWidth

public Integer getFacetValueHoverWidth()
If specified and 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.

Returns:
Integer
See Also:
Canvas.getHoverWidth()

setFixedFacetValues

public void setFixedFacetValues(FacetValueMap fixedFacetValues)
                         throws IllegalStateException
A 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.

Parameters:
fixedFacetValues - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
addFacet(java.lang.String), removeFacet(java.lang.String)

getFixedFacetValues

public FacetValueMap getFixedFacetValues()
A 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.

Returns:
FacetValueMap
See Also:
addFacet(java.lang.String), removeFacet(java.lang.String)

setHideEmptyAxis

public void setHideEmptyAxis(Axis hideEmptyAxis)
                      throws IllegalStateException
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).

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

getHideEmptyAxis

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

Returns:
Axis

setHideEmptyFacetValues

public void setHideEmptyFacetValues(Boolean hideEmptyFacetValues)
                             throws IllegalStateException
This causes the headers for any combination of facetValues for which there are no cellRecords to be suppressed.

To use this feature, either:

This last point is required because there is no way to determine whether a row is empty unless data for all columns of the row has been loaded (and vice-versa). For this reason if you set hideEmptyFacetValues but do not set hideEmptyAxis, the default behavior of loading only visible data is automatically disabled and only fixedFacetValues will be sent as criteria.

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

getHideEmptyFacetValues

public Boolean getHideEmptyFacetValues()
This causes the headers for any combination of facetValues for which there are no cellRecords to be suppressed.

To use this feature, either:

This last point is required because there is no way to determine whether a row is empty unless data for all columns of the row has been loaded (and vice-versa). For this reason if you set hideEmptyFacetValues but do not set hideEmptyAxis, the default behavior of loading only visible data is automatically disabled and only fixedFacetValues will be sent as criteria.

Returns:
Boolean

setHilites

public void setHilites(Hilite... hilites)
Hilites to be applied to the data for this component. See Hiliting.

Specified by:
setHilites in interface DataBoundComponent
Overrides:
setHilites in class ListGrid
Parameters:
hilites - Default value is null
See Also:
Hiliting overview and related methods

getHilites

public Hilite[] getHilites()
Hilites to be applied to the data for this component. See Hiliting.

Specified by:
getHilites in interface DataBoundComponent
Overrides:
getHilites in class ListGrid
Returns:
Hilite...
See Also:
Hiliting overview and related methods

setInnerHeaderBaseStyle

public void setInnerHeaderBaseStyle(String innerHeaderBaseStyle)
                             throws IllegalStateException
baseStyle for the buttons in the innermost column header for this cubeGrid.

Parameters:
innerHeaderBaseStyle - See CSSStyleName . Default value is innerHeader
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getInnerHeaderBaseStyle

public String getInnerHeaderBaseStyle()
baseStyle for the buttons in the innermost column header for this cubeGrid.

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

setMetricFacetId

public void setMetricFacetId(String metricFacetId)
                      throws IllegalStateException
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".

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.

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

getMetricFacetId

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

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.

Returns:
String

setPadTitles

public void setPadTitles(Boolean padTitles)
Whether to pad titles so they aren't flush with header borders.

Parameters:
padTitles - Default value is true

getPadTitles

public Boolean getPadTitles()
Whether to pad titles so they aren't flush with header borders.

Returns:
Boolean

setRollupValue

public void setRollupValue(String rollupValue)
                    throws IllegalStateException
facetValueId of the default rollupValue for each facet. Can be overridden per facet via facet.rollupValue.

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

getRollupValue

public String getRollupValue()
facetValueId of the default rollupValue for each facet. Can be overridden per facet via facet.rollupValue.

Returns:
Get the facetValue definition for the facetValue to show when this facet is "rolled up" under another facet, during a breakout.

A facet is not required to have a rollup value, and if it does not have one, then rollups will simply be blank rows. The facetValueId of the rollup value can be declared as cubeGrid.rollupValue or facet.rollupValue.

setRowFacets

public void setRowFacets(String... rowFacets)
                  throws IllegalStateException
The list of ids for facets that will appear to the left of the body.

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

getRowFacets

public String[] getRowFacets()
The list of ids for facets that will appear to the left of the body.

Returns:
String...

setRowHeaderBaseStyle

public void setRowHeaderBaseStyle(String rowHeaderBaseStyle)
                           throws IllegalStateException
baseStyle for the buttons in this grid's row headers.

Parameters:
rowHeaderBaseStyle - See CSSStyleName . Default value is rowHeader
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getRowHeaderBaseStyle

public String getRowHeaderBaseStyle()
baseStyle for the buttons in this grid's row headers.

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

setRowHeaderGridMode

public void setRowHeaderGridMode(Boolean rowHeaderGridMode)
                          throws IllegalStateException
If enabled row headers for this cubeGrid will be rendered using a GridRenderer component. This improves performance for very large cubeGrids.

Note : This is an advanced setting

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

getRowHeaderGridMode

public Boolean getRowHeaderGridMode()
If enabled row headers for this cubeGrid will be rendered using a GridRenderer component. This improves performance for very large cubeGrids.

Returns:
Boolean

getSaveByCell

public Boolean getSaveByCell()
                      throws IllegalStateException
CubeGrids only support editing by cell.

Note : This method should be called only after the widget has been rendered.

Overrides:
getSaveByCell in class ListGrid
Returns:
Boolean
Throws:
IllegalStateException - if this widget has not yet been rendered.
See Also:
ListGrid.getEditByCell(), Editing overview and related methods

setShowFacetValueContextMenus

public void setShowFacetValueContextMenus(boolean showFacetValueContextMenus)
If true, show facet value context menus with some built-in operations. Otherwise, use generic context menu handling. Use this in place of showHeaderContextMenu and showHeaderMenuButton for CubeGrids.

Parameters:
showFacetValueContextMenus - Default value is true

getShowFacetValueContextMenus

public boolean getShowFacetValueContextMenus()
If true, show facet value context menus with some built-in operations. Otherwise, use generic context menu handling. Use this in place of showHeaderContextMenu and showHeaderMenuButton for CubeGrids.

Returns:
boolean

setSimpleDeselect

public void setSimpleDeselect(Boolean simpleDeselect)
If true, clicking on the existing selection causes it to be entirely deselected.

Parameters:
simpleDeselect - Default value is false

getSimpleDeselect

public Boolean getSimpleDeselect()
If true, clicking on the existing selection causes it to be entirely deselected.

Returns:
Boolean

setSkinImgDir

public void setSkinImgDir(String skinImgDir)
                   throws IllegalStateException
Default directory for skin images (those defined by the class), relative to the Page-wide skinDir.

Overrides:
setSkinImgDir in class ListGrid
Parameters:
skinImgDir - See SCImgURL . Default value is "images/CubeGrid/"
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Images overview and related methods

getSkinImgDir

public String getSkinImgDir()
Default directory for skin images (those defined by the class), relative to the Page-wide skinDir.

Overrides:
getSkinImgDir in class ListGrid
Returns:
See SCImgURL
See Also:
Images overview and related methods

setSortDirection

public void setSortDirection(SortDirection sortDirection)
Direction of sorting if sortedFacet or sortedFacetValues is specified.

Overrides:
setSortDirection in class ListGrid
Parameters:
sortDirection - Default value is "ascending"

getSortDirection

public SortDirection getSortDirection()
Direction of sorting if sortedFacet or sortedFacetValues is specified.

Overrides:
getSortDirection in class ListGrid
Returns:
SortDirection

setSortedFacetValues

public void setSortedFacetValues(FacetValueMap sortedFacetValues)
FacetValueMap of facet values representing a set of facetValues by which the cubeGrid data is sorted.

Parameters:
sortedFacetValues - Default value is null

getSortedFacetValues

public FacetValueMap getSortedFacetValues()
FacetValueMap of facet values representing a set of facetValues by which the cubeGrid data is sorted.

Returns:
FacetValueMap

setStyleName

public void setStyleName(String styleName)
CSS class for the CubeGrid as a whole

Overrides:
setStyleName in class ListGrid
Parameters:
styleName - See CSSStyleName . Default value is "normal"
See Also:
Appearance overview and related methods

getStyleName

public String getStyleName()
CSS class for the CubeGrid as a whole

Overrides:
getStyleName in class ListGrid
Returns:
See CSSStyleName
See Also:
Appearance overview and related methods

setValueProperty

public void setValueProperty(String valueProperty)
                      throws IllegalStateException
Name of the property in a cell record that holds the cell value.

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

getValueProperty

public String getValueProperty()
Name of the property in a cell record that holds the cell value.

Returns:
String

setValueTitle

public void setValueTitle(String valueTitle)
                   throws IllegalStateException
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.

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.

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

getValueTitle

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

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.

Returns:
String

setWrapFacetTitles

public void setWrapFacetTitles(Boolean wrapFacetTitles)
Whether to allow text wrapping on facet titles.

Parameters:
wrapFacetTitles - Default value is false

getWrapFacetTitles

public Boolean getWrapFacetTitles()
Whether to allow text wrapping on facet titles.

Returns:
Boolean

setWrapFacetValueTitles

public void setWrapFacetValueTitles(Boolean wrapFacetValueTitles)
Whether to allow text wrapping on facet value titles.

Parameters:
wrapFacetValueTitles - Default value is false

getWrapFacetValueTitles

public Boolean getWrapFacetValueTitles()
Whether to allow text wrapping on facet value titles.

Returns:
Boolean

addColumnFacet

public void addColumnFacet(String facetId)
Add a column facet to the view at index "index". Handles the facet already being in the view (does a pivot).

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

Parameters:
facetId - facetId to add. Definition must have been provided at init time.
See Also:
removeFacet(java.lang.String), getFixedFacetValues()

addColumnFacet

public void addColumnFacet(String facetId,
                           Integer index)
Add a column facet to the view at index "index". Handles the facet already being in the view (does a pivot).

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

Parameters:
facetId - facetId to add. Definition must have been provided at init time.
index - index to add the facet at. 0 = outermost (default innermost)
See Also:
removeFacet(java.lang.String), getFixedFacetValues()

addFacet

public void addFacet(String facetId)
Add a facet to the view, into the row or column facets (intoRows true or false), at index "index". Handles the facet already being in the view (does a pivot).

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.

Parameters:
facetId - facetId to add. Definition must have been provided at init time.
See Also:
removeFacet(java.lang.String), getFixedFacetValues()

addFacet

public void addFacet(String facetId,
                     Boolean intoRows)
See Also:
CubeGrid#addFacet()}

addFacet

public void addFacet(String facetId,
                     Boolean intoRows,
                     Integer index)
Add a facet to the view, into the row or column facets (intoRows true or false), at index "index". Handles the facet already being in the view (does a pivot).

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.

Parameters:
facetId - facetId to add. Definition must have been provided at init time.
intoRows - whether to add facet as a row facet
index - index to add the facet at. 0 = outermost (default innermost)
See Also:
removeFacet(java.lang.String), getFixedFacetValues()

addRowFacet

public void addRowFacet(String facetId)
Add a row facet to the view at index "index". Handles the facet already being in the view (does a pivot).

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

Parameters:
facetId - facetId to add. Definition must have been provided at init time.
See Also:
removeFacet(java.lang.String), getFixedFacetValues()

addRowFacet

public void addRowFacet(String facetId,
                        Integer index)
Add a row facet to the view at index "index". Handles the facet already being in the view (does a pivot).

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

Parameters:
facetId - facetId to add. Definition must have been provided at init time.
index - index to add the facet at. 0 = outermost (default innermost)
See Also:
removeFacet(java.lang.String), getFixedFacetValues()

anyCellSelected

public Boolean anyCellSelected()
Determine whether any cells are selected in this cubeGrid.
methodType tester

Returns:
true if any cells are selected
See Also:
Selection overview and related methods

cellIsSelected

public Boolean cellIsSelected(CellRecord cell)
Determine whether the cell passed in is selected in this cubeGrid.
methodType tester

Parameters:
cell - cell to test
Returns:
true if any cells are selected
See Also:
Selection overview and related methods

closeFacet

public void closeFacet(String facetId)
Handler fired when facet is closed
methodType handler

Parameters:
facetId - ID of facet that was closed

collapseField

public Boolean collapseField(FacetValueMap facetValueMap)
Collapses the specified field. No-ops if it's not showing, or it it's already collapsed.

Parameters:
facetValueMap - field specified as a facetValueMap
Returns:
whether specified field was actually collapsed

dataArrived

public void dataArrived()
Notification method fired when new data arrives from the server to be displayed in this CubeGrid. For example in response to the user openng a collapsed facet, or as a result of an initial fetch request for all data from a CubeGrid where facets is not set and there is no initial data. Only applies to databound CubeGrids.


deselectAll

public void deselectAll()
Deselect all cells and facetValues.
methodType action

See Also:
Selection overview and related methods

deselectAllCells

public void deselectAllCells()
Deselect all cells.

See Also:
Selection overview and related methods

deselectAllFacetValues

public void deselectAllFacetValues()
Deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
methodType action

See Also:
Selection overview and related methods

deselectAllFacetValues

public void deselectAllFacetValues(String facetId)
Deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
methodType action

Parameters:
facetId - ID of facet - if null, selects all headerbars' headers
See Also:
Selection overview and related methods

deselectCells

public void deselectCells(CellRecord[] cellList)
Deselect cells that match a FacetValueMap. Also supports an explicit list of CellRecords or cell IDs.

Parameters:
cellList - cells to deselect
See Also:
Selection overview and related methods

deselectCells

public void deselectCells(FacetValueMap cellList)
Deselect cells that match a FacetValueMap. Also supports an explicit list of CellRecords or cell IDs.

Parameters:
cellList - cells to deselect
See Also:
Selection overview and related methods

deselectCells

public void deselectCells(String... cellList)
Deselect cells that match a FacetValueMap. Also supports an explicit list of CellRecords or cell IDs.

Parameters:
cellList - cells to deselect
See Also:
Selection overview and related methods

deselectFacetValue

public void deselectFacetValue(String facetId,
                               String facetValueId)
Deselect the header for a given facet value.
methodType action

Parameters:
facetId - ID of facet
facetValueId - ID of facetValue to select
See Also:
Selection overview and related methods

expandField

public Boolean expandField(FacetValueMap facetValueMap)
Expands the specified field. No-ops if it's not showing, or if it's already expanded.

Parameters:
facetValueMap - field specified as a facetValueMap
Returns:
whether specified field was actually expanded

addFacetAddedHandler

public HandlerRegistration addFacetAddedHandler(FacetAddedHandler handler)
Add a facetAdded handler.

Notification fired when a new facet is added.

Specified by:
addFacetAddedHandler in interface HasFacetAddedHandlers
Parameters:
handler - the facetAdded handler
Returns:
HandlerRegistration used to remove this handler

facetHasSelection

public Boolean facetHasSelection(String facetId)
Return whether any facet value for this facet is selected in headers. If no facetId passed, return whether any facet has a selection.
methodType tester

Parameters:
facetId - Id for facet to test
Returns:
true if any facet value in this header is selected
See Also:
Selection overview and related methods

addFacetMovedHandler

public HandlerRegistration addFacetMovedHandler(FacetMovedHandler handler)
Add a facetMoved handler.

Notification fired when a facet is moved.

Specified by:
addFacetMovedHandler in interface HasFacetMovedHandlers
Parameters:
handler - the facetMoved handler
Returns:
HandlerRegistration used to remove this handler

addFacetRemovedHandler

public HandlerRegistration addFacetRemovedHandler(FacetRemovedHandler handler)
Add a facetRemoved handler.

Notification fired when a facet is removed.

Specified by:
addFacetRemovedHandler in interface HasFacetRemovedHandlers
Parameters:
handler - the facetRemoved handler
Returns:
HandlerRegistration used to remove this handler

addFacetValueSelectionChangedHandler

public HandlerRegistration addFacetValueSelectionChangedHandler(FacetValueSelectionChangedHandler handler)
Add a facetValueSelectionChanged handler.

Handler/Notification function for facetValue selection change (no default implementation).

Specified by:
addFacetValueSelectionChangedHandler in interface HasFacetValueSelectionChangedHandlers
Parameters:
handler - the facetValueSelectionChanged handler
Returns:
HandlerRegistration used to remove this handler

addFixedFacetValueChangedHandler

public HandlerRegistration addFixedFacetValueChangedHandler(FixedFacetValueChangedHandler handler)
Add a fixedFacetValueChanged handler.

Notification fired when a fixed facet value is set for some facet.

Specified by:
addFixedFacetValueChangedHandler in interface HasFixedFacetValueChangedHandlers
Parameters:
handler - the fixedFacetValueChanged handler
Returns:
HandlerRegistration used to remove this handler

getCellColumn

public int getCellColumn(CellRecord cellRecord)
Given a record in this grid, this method returns the colNum in which the record is displayed.

Parameters:
cellRecord - record to find coordinates for
Returns:
Column number for the record. Returns -1 if the record is not found.

getCellFacetValues

public FacetValueMap getCellFacetValues(int rowNum,
                                        int colNum)
Given a cell coordinate within this CubeGrid return a FacetValueMap indicating the facet values for the cell.

Parameters:
rowNum - row index of the cell
colNum - column index of the cell
Returns:
facet values for the specified cell. Returns null if the specified cell is not present in the grid.

getCellRecord

public ListGridRecord getCellRecord(int rowNum,
                                    int colNum)
Return the pointer to a particular record by record and column number.

Parameters:
rowNum - row index of record to return.
colNum - column index of record to return.
Returns:
Record object for the row.
See Also:
ListGrid.getRecord(int), ListGrid.getEditedRecord(int)

getCellRow

public int getCellRow(CellRecord cellRecord)
Given a record in this grid, this method returns the rowNum on which the record is displayed.

Parameters:
cellRecord - record to find coordinates for
Returns:
Row number for the record. Returns -1 if the record is not found.

getColumnFacetValues

public FacetValueMap getColumnFacetValues(int colNum)
Return a FacetValueMap indicating the facet values for a specific column in the grid.

Parameters:
colNum - index of the column
Returns:
facet values for the specified column. Returns null if the specified column is not present in the grid.

getEditValue

public Object getEditValue(int rowNum,
                           int colNum)
Returns the current temporary locally stored edit value for a cell being edited. Note this is the valueProperty that will be saved for the cell in question.

Overrides:
getEditValue in class ListGrid
Parameters:
rowNum - index of the row for which the editValue should be returned
colNum - index of the column for which value should be returned
Returns:
edit value for the cell
See Also:
Editing overview and related methods

getEventColumn

public int getEventColumn()
Returns the column number of the most recent mouse event.

Overrides:
getEventColumn in class ListGrid
Returns:
column number, or -2 if beyond last drawn column
See Also:
Selection overview and related methods

getEventColumn

public int getEventColumn(Integer x)
Returns the column number of the most recent mouse event.

Overrides:
getEventColumn in class ListGrid
Parameters:
x - optional x-coordinate to obtain column number for, in lieu of the x coordinate of the last mouse event
Returns:
column number, or -2 if beyond last drawn column
See Also:
Selection overview and related methods

getEventRow

public int getEventRow()
Returns the row number of the most recent mouse event.

Overrides:
getEventRow in class ListGrid
Returns:
row number, or -2 if beyond last drawn row
See Also:
Selection overview and related methods

getEventRow

public int getEventRow(Integer y)
Returns the row number of the most recent mouse event.

Overrides:
getEventRow in class ListGrid
Parameters:
y - optional y-coordinate to obtain row number, in lieu of the y coordinate of the last mouse event
Returns:
row number, or -2 if beyond last drawn row
See Also:
Selection overview and related methods

getFacet

public Facet getFacet(String facetId)
Get a facet definition by facetId. Constant time.

Parameters:
facetId - the id of the facet to retrieve
Returns:
the Facet if found, or null
See Also:
Facet

getFacetsHavingSelection

public String[] getFacetsHavingSelection()
Return the list of facets that have any selection in their headers.
methodType getter

Returns:
list of facets that have any selection in their headers
See Also:
Selection overview and related methods

getFacetValue

public FacetValue getFacetValue(String facetId,
                                String facetValueId)
Get a facet value definition by facetId and facetValueId. Constant time.

Parameters:
facetId - the id of the facet to retrieve
facetValueId - the id of the facet value to retrieve
Returns:
the FacetValue if found, or null
See Also:
FacetValue

getFacetValuesColumn

public int getFacetValuesColumn(FacetValueMap facetValues)
Get the index of the first column in the grid that matches the specified FacetValueMap.

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.

Parameters:
facetValues - facet values to find
Returns:
index of first column in the grid that matches the facet values passed in, or -1 if not found

getFacetValuesRow

public int getFacetValuesRow(FacetValueMap facetValues)
Get the index of the first row in the grid that matches the specified FacetValueMap.

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.

Parameters:
facetValues - facet values to find
Returns:
index of first row in the grid that matches the facet values passed in, or -1 if not found

getRowFacetValues

public FacetValueMap getRowFacetValues(int rowNum)
Return a FacetValueMap indicating the facet values for a specific row in the grid.

Parameters:
rowNum - index of the row
Returns:
facet values for the specified row. Returns null if the specified row is not present in the grid.

getSelectedCellIds

public String[] getSelectedCellIds()
Returns an array of the IDs of all selected cell records.
methodType getter

Returns:
array of the selected cell IDs
See Also:
Selection overview and related methods

getSelectedCells

public CellRecord[] getSelectedCells()
Returns an array of the selected cell records.
methodType getter

Returns:
array of the selected cell records
See Also:
Selection overview and related methods

getSelectedFacetValues

public FacetValueMap[] getSelectedFacetValues(String facetId)
Returns an array of facetValues objects indicating the headers that are selected in the headerBar for this facet. If facetId is not passed, returns selection for all facets.

Parameters:
facetId - id for facet for which we are getting selected facetValues
Returns:
selected facetValues
See Also:
Selection overview and related methods

hasChanges

public Boolean hasChanges()
Determines whether any cells in this cubeGrid have been edited but not yet saved to the underlying data set.

Overrides:
hasChanges in class ListGrid
Returns:
true if any record in the grid has been edited but not yet saved
See Also:
Editing overview and related methods

hiliteFacetValue

public Boolean hiliteFacetValue(String facetID,
                                String facetValueID,
                                String hiliteID)
Apply a hilite to all cells corresponding to a facetValue.
methodType action

Parameters:
facetID - facet ID
facetValueID - facet value ID
hiliteID - hilite ID
Returns:
true if the cells were successfully hilited.
See Also:
Hiliting overview and related methods

recordHasChanges

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

Parameters:
rowNum - row index of record to check for changes
colNum - column index of the record to check for changes
Returns:
true if the record has been edited but not yet saved
See Also:
Editing overview and related methods

removeFacet

public void removeFacet(String facetId)
Remove a facet from the current view, using a fixed value from that facet. For example, remove the "months" facet from the view, collapsing to just January, or total for all months.

Parameters:
facetId - facetId to remove
See Also:
addFacet(java.lang.String), getFixedFacetValues()

removeFacet

public void removeFacet(String facetId,
                        String fixedFacetValueId)
Remove a facet from the current view, using a fixed value from that facet. For example, remove the "months" facet from the view, collapsing to just January, or total for all months.

Parameters:
facetId - facetId to remove
fixedFacetValueId - New fixed value for the facet, to be added to cubeGrid.fixedFacetValues. Default is the rollup value for the facet.
See Also:
addFacet(java.lang.String), getFixedFacetValues()

resizeFacetValue

public void resizeFacetValue(String facetValueId,
                             int newWidth)
Resizes all columns for the provided facetValueId, which must be a facetValueId from the innermost column facet.

Parameters:
facetValueId - facetValueId of columns to be resized
newWidth - column's new width

selectAllCells

public void selectAllCells()
Select all cells.

See Also:
Selection overview and related methods

selectAllFacetValues

public void selectAllFacetValues()
Select/deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
methodType action

See Also:
Selection overview and related methods

selectAllFacetValues

public void selectAllFacetValues(String facetId)
See Also:
CubeGrid#selectAllFacetValues()}

selectAllFacetValues

public void selectAllFacetValues(String facetId,
                                 Boolean newState)
Select/deselect all headers in a headerBar (specified by facetId) or all headerBars (if no facetId).
methodType action

Parameters:
facetId - ID of facet - if null, selects all headerbars' headers
newState - new selection state - if null defaults to true
See Also:
Selection overview and related methods

selectCells

public void selectCells(CellRecord[] cellList)
Select/deselect cells that match a FacetValueMap. Also supports an explicit list of CellRecords or cell IDs.

Parameters:
cellList - cells to select
See Also:
Selection overview and related methods

selectCells

public void selectCells(FacetValueMap cellList)
Select/deselect cells that match a FacetValueMap. Also supports an explicit list of CellRecords or cell IDs.

Parameters:
cellList - cells to select
See Also:
Selection overview and related methods

selectCells

public void selectCells(String... cellList)
Select/deselect cells that match a FacetValueMap. Also supports an explicit list of CellRecords or cell IDs.

Parameters:
cellList - cells to select
See Also:
Selection overview and related methods

selectCells

public void selectCells(CellRecord[] cellList,
                        boolean newState)
Select/deselect cells that match a FacetValueMap. Also supports an explicit list of CellRecords or cell IDs.

Parameters:
cellList - cells to select
newState - new selection state (if null, defaults to true)
See Also:
Selection overview and related methods

selectFacetValue

public void selectFacetValue(String facetId,
                             String facetValueId)
Select/deselect the header for a given facet value.
methodType action

Parameters:
facetId - ID of facet
facetValueId - ID of facetValue to select
See Also:
Selection overview and related methods

selectFacetValue

public void selectFacetValue(String facetId,
                             String facetValueId,
                             Boolean newState)
Select/deselect the header for a given facet value.
methodType action

Parameters:
facetId - ID of facet
facetValueId - ID of facetValue to select
newState - new selection state - if null defaults to true
See Also:
Selection overview and related methods

setEditValue

public void setEditValue(int rowNum,
                         int colNum,
                         Object value)
Set the edit value for some cell in the cube grid.

Note that cubeGrids display one record per cell - the value passed in should be the desired edit value for the valueProperty of the record.

Overrides:
setEditValue in class ListGrid
Parameters:
rowNum - Row number
colNum - Column number
value - New value for the record
See Also:
Editing overview and related methods

setFacetTitle

public void setFacetTitle(String facetId,
                          String newTitle)
Set the title of a facet (appears in facet label).

Parameters:
facetId - facet to update
newTitle - title for the facet

setFacetValueTitle

public void setFacetValueTitle(String facetId,
                               String facetValueId,
                               String newTitle)
Set the title for a facet value.

Parameters:
facetId - facet to update
facetValueId - facetValue to update
newTitle - title for the facet

setFacetValueTitleAlign

public void setFacetValueTitleAlign(String facetId,
                                    String facetValueId,
                                    Alignment align)
Set the align for the title for a facet value.

Parameters:
facetId - facet to update
facetValueId - facetValue to update
align - new alignment for facet value title

setFixedFacetValue

public void setFixedFacetValue(String facetId,
                               String fixedFacetValueId)
Modify fixedFacetValues for this cubeGrid.

Parameters:
facetId - facetId
fixedFacetValueId - fixedFacetValue New fixed value for the facet, to be added to cubeGrid.fixedFacetValues. Default is the rollup value for the facet.

addSortByFacetIdHandler

public HandlerRegistration addSortByFacetIdHandler(SortByFacetIdHandler handler)
Add a sortByFacetId handler.

Called when a sort control is clicked on a FacetHeader. Does nothing by default.

Specified by:
addSortByFacetIdHandler in interface HasSortByFacetIdHandlers
Parameters:
handler - the sortByFacetId handler
Returns:
HandlerRegistration used to remove this handler

addSortByFacetValuesHandler

public HandlerRegistration addSortByFacetValuesHandler(SortByFacetValuesHandler handler)
Add a sortByFacetValues handler.

Called when a sort control is clicked on a FacetValueHeader. Does nothing by default.

Specified by:
addSortByFacetValuesHandler in interface HasSortByFacetValuesHandlers
Parameters:
handler - the sortByFacetValues handler
Returns:
HandlerRegistration used to remove this handler

toggleFieldOpenState

public Boolean toggleFieldOpenState(FacetValueMap facetValueMap)
Toggles the open state of the specified field. No-ops if it's not showing.

Parameters:
facetValueMap - field specified as a facetValueMap
Returns:
whether specified field's open state was toggled

setDefaultProperties

public static void setDefaultProperties(CubeGrid cubeGridProperties)
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

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.

Parameters:
cubeGridProperties - properties that should be used as new defaults when instances of this class are created

hiliteCell

public Boolean hiliteCell(int rowNum,
                          int colNum,
                          String hiliteID)
Apply a hilite to a specific cell. Note: can be called either as hiliteCell(cellObject, hiliteID) or hiliteCell(row, column, hiliteID)
methodType action

Parameters:
row - of cell to hilite
column - of cell to hilite
hilite - id
Returns:
true if the cell was successfully hilited.
See Also:
Hiliting overview and related methods

deselectCell

public void deselectCell(String cell)
Deselect a single cell - accepts cell ID.

Parameters:
cell - cell to deselect

deselectCell

public void deselectCell(CellRecord cell)
Deselect a single cell - accepts cellRecord.

Parameters:
cell - cell to deselect

selectCell

public void selectCell(String ID)
Select a single cell - accepts cell ID or cell record.
methodType action

Parameters:
cell - cell to select

selectCell

public void selectCell(Record cell)
Select a single cell - accepts cell ID or cell record.
methodType action

Parameters:
cell - cell to select

getCellCoordinates

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

Parameters:
cellRecord - record to find coordinates for
Returns:
2 element array containing [rowNum,colNum] for the cell, or null if the record is not found.

getEditedCell

public Object getEditedCell(int rowNum,
                            int colNum)
Returns the current value of a cell. If the cell has an outstanding edit value, this will be returned, otherwise the underlying value of the record will be returned.

Overrides:
getEditedCell in class ListGrid
Parameters:
rowNum - rowNum of the record being edited
colNum - colNum of the cell
Returns:
Current edit value, or underlying value for the cell.
See Also:
Editing overview and related methods

getEditedCell

public Object getEditedCell(Record record)
Returns the current value of a cell. If the cell has an outstanding edit value, this will be returned, otherwise the underlying value of the record will be returned.

Parameters:
record - rowNum of the record being edited, or an Object containing values for all the record's primary keys
colNum - colNum of the cell. Only required if the first parameter is a rowNum
Returns:
Current edit value, or underlying value for the cell.
See Also:
Editing overview and related methods

getEditedRecord

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

The returned value is never null, and can be freely modified.

Parameters:
rowNum - of the record being edited
colNum - colNum of the record being edited
Returns:
A copy of the record with unsaved edits included
See Also:
Editing overview and related methods

getEditedRecord

public CellRecord getEditedRecord(Record baseRecord)
Returns the combination of unsaved edits (if any) and original values (if any) for a given cell being edited.

The returned value is never null, and can be freely modified.

Parameters:
record - being edited
Returns:
A copy of the record with unsaved edits included
See Also:
Editing overview and related methods

setEnableCharting

public void setEnableCharting(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. See chartData for more information.

Parameters:
enableCharting - enableCharting Default value is false

getEnableCharting

public 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. See chartData for more information.

Returns:
Boolean

analyticsLoaded

public static boolean analyticsLoaded()
Static method indicating whether the optional Analytics module is loaded for the page. The CubeGrid component requires this module.

Returns:
true if the Analytics module is present

makeChart

public FacetChart makeChart(FacetValueMap fixedFacetValues,
                            String[] variableFacets,
                            FacetChart chartProperties)
Chart the portion of the dataset indicated by 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.

Parameters:
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 charted
chartProperties - (FacetChart properties) properties to pass through to the created FacetChart
Returns:
(FacetChart) created Chart instance

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.cube.CubeGridLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
Specified by:
getLogicalStructure in interface LogicalStructure
Overrides:
getLogicalStructure in class ListGrid