com.vaadin.shared.ui.grid
Class GridColumnState

java.lang.Object
  com.vaadin.shared.ui.grid.GridColumnState

All Implemented Interfaces:

java.io.Serializable

public class GridColumnState
extends java.lang.Object
implements java.io.Serializable

Column state DTO for transferring column properties from the server to the client

Since:

7.4

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

boolean	editable Whether the values in this column are editable when the editor interface is active.
Connector	editorConnector The connector for the field used to edit cells in this column when the editor interface is active.
int	expandRatio How much of the remaining space this column will reserve.
java.lang.String	headerCaption Column header caption
boolean	hidable Can the column be hidden by the UI.
boolean	hidden Is the column currently hidden.
java.lang.String	hidingToggleCaption The caption for the column hiding toggle.
java.lang.String	id Id used by grid connector to map server side column with client side column
double	maxWidth The maximum expansion width of this column.
double	minWidth The minimum expansion width of this column.
Connector	rendererConnector The connector for the renderer used to render the cells in this column.
boolean	sortable Are sorting indicators shown for a column.
double	width Column width in pixels.

Constructor Summary

GridColumnState()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public java.lang.String id

Id used by grid connector to map server side column with client side column

width

public double width

Column width in pixels. Default column width is .

rendererConnector

public Connector rendererConnector

The connector for the renderer used to render the cells in this column.

editable

public boolean editable

Whether the values in this column are editable when the editor interface is active.

editorConnector

public Connector editorConnector

The connector for the field used to edit cells in this column when the editor interface is active.

sortable

public boolean sortable

Are sorting indicators shown for a column. Default is false.

expandRatio

public int expandRatio

How much of the remaining space this column will reserve.

maxWidth

public double maxWidth

The maximum expansion width of this column. -1 for "no maximum". If maxWidth is less than the calculated width, maxWidth is ignored.

minWidth

public double minWidth

The minimum expansion width of this column. -1 for "no minimum". If minWidth is less than the calculated width, minWidth will win.

hidden

public boolean hidden

Is the column currently hidden.

hidable

public boolean hidable

Can the column be hidden by the UI.

hidingToggleCaption

public java.lang.String hidingToggleCaption

The caption for the column hiding toggle.

headerCaption

public java.lang.String headerCaption

Column header caption

Constructor Detail

GridColumnState

public GridColumnState()