com.vaadin.shared.ui.grid.

java.lang.Object
- com.vaadin.shared.communication.SharedState
- - com.vaadin.shared.AbstractComponentState
  - - com.vaadin.shared.ui.TabIndexState
    - - com.vaadin.shared.AbstractFieldState
      - com.vaadin.shared.ui.abstractlisting.AbstractListingState
        
        com.vaadin.shared.ui.AbstractSingleSelectState
        
        com.vaadin.shared.ui.grid.GridState

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TreeGridState
```
public class GridState
extends AbstractSingleSelectState
```
The shared state for the Grid component.

Since:

8.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`double`	`bodyRowHeight`	Explicit body row height in pixels for grid rows, or -1 to calculate automatically based on the theme.
`List<String>`	`columnOrder`	Column order in grid.
`boolean`	`columnReorderingAllowed`	Whether the columns can be reordered.
`ColumnResizeMode`	`columnResizeMode`	Column resize mode in grid.
`static double`	`DEFAULT_HEIGHT_BY_ROWS`	The default value for height-by-rows for both GWT widgets `Grid` and `Escalator`.
`SectionState`	`footer`	The state of the footer section.
`double`	`footerRowHeight`	Explicit body row height in pixels for grid rows, or -1 to calculate automatically based on the theme.
`int`	`frozenColumnCount`	The number of frozen columns.
`boolean`	`hasDescriptions`	Whether rows and/or cells have generated descriptions (tooltips).
`SectionState`	`header`	The state of the header section.
`double`	`headerRowHeight`	Explicit body row height in pixels for grid rows, or -1 to calculate automatically based on the theme.
`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 or not.
`ContentMode`	`rowDescriptionContentMode`	The content mode for row descriptions.
`GridConstants.SidebarColumnOrder`	`sidebarColumnOrder`	Ordering of columns in the sidebar column hider widget
`String[]`	`sortColumns`	Keys of the currently sorted columns.
`SortDirection[]`	`sortDirs`	Directions for each sorted column.

Fields inherited from class com.vaadin.shared.ui.AbstractSingleSelectState
selectedItemKey

Fields inherited from class com.vaadin.shared.AbstractFieldState
readOnly, required

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 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:
    
    DataProviderRpc.setRowData(int, elemental.json.JsonArray), 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:
    
    DataProviderRpc.setRowData(int, elemental.json.JsonArray), 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:
    
    DataProviderRpc.setRowData(int, elemental.json.JsonArray), 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:
    
    DataProviderRpc.setRowData(int, elemental.json.JsonArray), Constant Field Values
  - JSONKEY_ROWDESCRIPTION
```
public static final String JSONKEY_ROWDESCRIPTION
```
    The key in which a row's description can be found.
    
    See Also:
    
    DataProviderRpc.setRowData(int, elemental.json.JsonArray), Constant Field Values
  - JSONKEY_CELLDESCRIPTION
```
public static final String JSONKEY_CELLDESCRIPTION
```
    The key in which a cell's description can be found.
    
    See Also:
    
    DataProviderRpc.setRowData(int, elemental.json.JsonArray), Constant Field Values
  - JSONKEY_DETAILS_VISIBLE
```
public static final String JSONKEY_DETAILS_VISIBLE
```
    The key that tells whether details are visible for the row.
    
    See Also:
    
    Grid.setDetailsGenerator(com.vaadin.ui.components.grid.DetailsGenerator), 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 or not.
    
    See Also:
    
    Constant Field Values
  - columnResizeMode
```
public ColumnResizeMode columnResizeMode
```
    Column resize mode in grid.
    
    Since:
    
    7.7.5
  - header
```
public SectionState header
```
    The state of the header section.
  - footer
```
public SectionState footer
```
    The state of the footer section.
  - columnOrder
```
public List<String> columnOrder
```
    Column order in grid.
  - 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.
  - sidebarColumnOrder
```
public GridConstants.SidebarColumnOrder sidebarColumnOrder
```
    Ordering of columns in the sidebar column hider widget
  - hasDescriptions
```
public boolean hasDescriptions
```
    Whether rows and/or cells have generated descriptions (tooltips).
  - columnReorderingAllowed
```
public boolean columnReorderingAllowed
```
    Whether the columns can be reordered.
  - bodyRowHeight
```
public double bodyRowHeight
```
    Explicit body row height in pixels for grid rows, or -1 to calculate automatically based on the theme.
    
    Since:
    
    8.2
  - headerRowHeight
```
public double headerRowHeight
```
    Explicit body row height in pixels for grid rows, or -1 to calculate automatically based on the theme.
    
    Since:
    
    8.2
  - footerRowHeight
```
public double footerRowHeight
```
    Explicit body row height in pixels for grid rows, or -1 to calculate automatically based on the theme.
    
    Since:
    
    8.2
  - rowDescriptionContentMode
```
public ContentMode rowDescriptionContentMode
```
    The content mode for row descriptions.
    
    Since:
    
    8.2
- Constructor Detail
  - GridState
```
public GridState()
```

com.vaadin.shared.ui.grid.

Class GridState

Field Summary

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

Fields inherited from class com.vaadin.shared.AbstractFieldState

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

header

footer

columnOrder

frozenColumnCount

heightByRows

heightMode

sortColumns

sortDirs

sidebarColumnOrder

hasDescriptions

columnReorderingAllowed

bodyRowHeight

headerRowHeight

footerRowHeight

rowDescriptionContentMode

Constructor Detail

GridState