GridState (vaadin-compatibility-shared 8.14.3 API)

java.lang.Object
- com.vaadin.shared.communication.SharedState
- - com.vaadin.shared.AbstractComponentState
  - - com.vaadin.shared.ui.TabIndexState
    - - com.vaadin.v7.shared.ui.grid.GridState

All Implemented Interfaces:

Serializable
```
public class GridState
extends TabIndexState
```
The shared state for the com.vaadin.ui.components.grid.Grid component.

Since:

7.4

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GridState.SharedSelectionMode
A description of which of the three bundled SelectionModels is currently in use.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GridState.SharedSelectionMode` A description of which of the three bundled SelectionModels is currently in use.

Field Summary

Fields
Modifier and Type	Field and Description
`ContentMode`	`cellTooltipContentMode` The content mode used for cell tooltips.
`List<String>`	`columnOrder` Column order in grid.
`boolean`	`columnReorderingAllowed` Whether the columns can be reordered.
`ColumnResizeMode`	`columnResizeMode` Column resize mode in grid.
`List<GridColumnState>`	`columns` Columns in grid.
`static double`	`DEFAULT_HEIGHT_BY_ROWS` The default value for height-by-rows for both GWT widgets `Grid` and `Escalator`.
`boolean`	`editorBuffered` Buffered editor mode.
`String`	`editorCancelCaption` The caption for the cancel button in the editor.
`boolean`	`editorEnabled` The enabled state of the editor interface.
`String`	`editorSaveCaption` The caption for the save button in the editor.
`GridStaticSectionState`	`footer`
`int`	`frozenColumnCount` The number of frozen columns.
`boolean`	`hasDescriptions` Whether rows and/or cells have generated descriptions (tooltips).
`GridStaticSectionState`	`header`
`double`	`heightByRows` The height of the Grid in terms of body rows.
`HeightMode`	`heightMode` The mode by which Grid defines its height.
`static String`	`JSONKEY_CELLDESCRIPTION` The key in which a cell's description can be found.
`static String`	`JSONKEY_CELLSTYLES` The key in which a generated styles for a row's cells can be found.
`static String`	`JSONKEY_DATA` The key in which a row's data can be found.
`static String`	`JSONKEY_DETAILS_VISIBLE` The key that tells whether details are visible for the row.
`static String`	`JSONKEY_ROWDESCRIPTION` The key in which a row's description can be found.
`static String`	`JSONKEY_ROWKEY` The key in which a row's own key can be found.
`static String`	`JSONKEY_ROWSTYLE` The key in which a row's generated style can be found.
`static String`	`JSONKEY_SELECTED` The key that tells whether row is selected.
`ContentMode`	`rowTooltipContentMode` The content mode used for row tooltips.
`String[]`	`sortColumns` Keys of the currently sorted columns.
`SortDirection[]`	`sortDirs` Directions for each sorted column.

Fields inherited from class com.vaadin.shared.ui.TabIndexState
tabIndex

Fields inherited from class com.vaadin.shared.AbstractComponentState
caption, captionAsHtml, description, descriptionContentMode, errorLevel, errorMessage, height, id, primaryStyleName, styles, width

Fields inherited from class com.vaadin.shared.communication.SharedState
enabled, registeredEventListeners, resources

Constructor Summary

Constructors
Constructor and Description

GridState()

Constructors
Constructor and Description
`GridState()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_HEIGHT_BY_ROWS
```
public static final double DEFAULT_HEIGHT_BY_ROWS
```
    The default value for height-by-rows for both GWT widgets Grid and Escalator.
    
    See Also:
    
    Constant Field Values
  - JSONKEY_DATA
```
public static final String JSONKEY_DATA
```
    The key in which a row's data can be found.
    
    See Also:
    
    com.vaadin.shared.data.DataProviderRpc#setRowData(int, String), Constant Field Values
  - JSONKEY_ROWKEY
```
public static final String JSONKEY_ROWKEY
```
    The key in which a row's own key can be found.
    
    See Also:
    
    com.vaadin.shared.data.DataProviderRpc#setRowData(int, String), Constant Field Values
  - JSONKEY_ROWSTYLE
```
public static final String JSONKEY_ROWSTYLE
```
    The key in which a row's generated style can be found.
    
    See Also:
    
    com.vaadin.shared.data.DataProviderRpc#setRowData(int, String), Constant Field Values
  - JSONKEY_CELLSTYLES
```
public static final String JSONKEY_CELLSTYLES
```
    The key in which a generated styles for a row's cells can be found.
    
    See Also:
    
    com.vaadin.shared.data.DataProviderRpc#setRowData(int, String), Constant Field Values
  - JSONKEY_ROWDESCRIPTION
```
public static final String JSONKEY_ROWDESCRIPTION
```
    The key in which a row's description can be found.
    
    Since:
    
    7.6
    
    See Also:
    
    com.vaadin.shared.data.DataProviderRpc#setRowData(int, String), Constant Field Values
  - JSONKEY_CELLDESCRIPTION
```
public static final String JSONKEY_CELLDESCRIPTION
```
    The key in which a cell's description can be found.
    
    Since:
    
    7.6
    
    See Also:
    
    com.vaadin.shared.data.DataProviderRpc#setRowData(int, String), Constant Field Values
  - JSONKEY_DETAILS_VISIBLE
```
public static final String JSONKEY_DETAILS_VISIBLE
```
    The key that tells whether details are visible for the row.
    
    Since:
    
    7.5.0
    
    See Also:
    
    com.vaadin.ui.Grid#setDetailsGenerator(com.vaadin.ui.Grid.DetailsGenerator), com.vaadin.ui.Grid#setDetailsVisible(Object, boolean), DataProviderRpc.setRowData(int, elemental.json.JsonArray), Constant Field Values
  - JSONKEY_SELECTED
```
public static final String JSONKEY_SELECTED
```
    The key that tells whether row is selected.
    
    Since:
    
    7.6
    
    See Also:
    
    Constant Field Values
  - columnResizeMode
```
public ColumnResizeMode columnResizeMode
```
    Column resize mode in grid.
    
    Since:
    
    7.7.5
  - columns
```
public List<GridColumnState> columns
```
    Columns in grid.
  - columnOrder
```
public List<String> columnOrder
```
    Column order in grid.
  - header
```
public GridStaticSectionState header
```
  - footer
```
public GridStaticSectionState footer
```
  - frozenColumnCount
```
public int frozenColumnCount
```
    The number of frozen columns.
  - heightByRows
```
public double heightByRows
```
    The height of the Grid in terms of body rows.
  - heightMode
```
public HeightMode heightMode
```
    The mode by which Grid defines its height.
  - sortColumns
```
public String[] sortColumns
```
    Keys of the currently sorted columns.
  - sortDirs
```
public SortDirection[] sortDirs
```
    Directions for each sorted column.
  - editorEnabled
```
public boolean editorEnabled
```
    The enabled state of the editor interface.
  - editorBuffered
```
public boolean editorBuffered
```
    Buffered editor mode.
    
    Since:
    
    7.6
  - hasDescriptions
```
public boolean hasDescriptions
```
    Whether rows and/or cells have generated descriptions (tooltips).
    
    Since:
    
    7.6
  - editorSaveCaption
```
public String editorSaveCaption
```
    The caption for the save button in the editor.
  - editorCancelCaption
```
public String editorCancelCaption
```
    The caption for the cancel button in the editor.
  - columnReorderingAllowed
```
public boolean columnReorderingAllowed
```
    Whether the columns can be reordered.
  - cellTooltipContentMode
```
public ContentMode cellTooltipContentMode
```
    The content mode used for cell tooltips.
    
    Since:
    
    8.3.2
  - rowTooltipContentMode
```
public ContentMode rowTooltipContentMode
```
    The content mode used for row tooltips.
    
    Since:
    
    8.3.2
- Constructor Detail
  - GridState
```
public GridState()
```

Class GridState

Nested Class Summary

Field Summary

Fields inherited from class com.vaadin.shared.ui.TabIndexState

Fields inherited from class com.vaadin.shared.AbstractComponentState

Fields inherited from class com.vaadin.shared.communication.SharedState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HEIGHT_BY_ROWS

JSONKEY_DATA

JSONKEY_ROWKEY

JSONKEY_ROWSTYLE

JSONKEY_CELLSTYLES

JSONKEY_ROWDESCRIPTION

JSONKEY_CELLDESCRIPTION

JSONKEY_DETAILS_VISIBLE

JSONKEY_SELECTED

columnResizeMode

columns

columnOrder

header

footer

frozenColumnCount

heightByRows

heightMode

sortColumns

sortDirs

editorEnabled

editorBuffered

hasDescriptions

editorSaveCaption

editorCancelCaption

columnReorderingAllowed

cellTooltipContentMode

rowTooltipContentMode

Constructor Detail

GridState