com.vaadin.client.widgets
Class Grid.SelectionColumn

java.lang.Object
  com.vaadin.client.widgets.Grid.Column<java.lang.Boolean,T>
      com.vaadin.client.widgets.Grid.SelectionColumn

Enclosing class:

Grid<T>

public final class Grid.SelectionColumn
extends Grid.Column<java.lang.Boolean,T>

Method Summary

int	getExpandRatio() Gets the expand ratio for this column.
double	getMaximumWidth() Gets the maximum width for this column.
double	getMinimumWidth() Gets the minimum width for this column.
java.lang.Boolean	getValue(T row) Returns the data that should be rendered into the cell.
protected void	setDefaultHeaderContent(Grid.HeaderCell selectionCell) Resets the default header cell contents to column header captions.
Grid.Column<java.lang.Boolean,T>	setEditable(boolean editable) Sets whether the values in this column should be editable by the user when the row editor is active.
Grid.Column<java.lang.Boolean,T>	setExpandRatio(int ratio) Sets the ratio with which the column expands.
Grid.Column<java.lang.Boolean,T>	setMaximumWidth(double pixels) Sets the maximum width for this column.
Grid.Column<java.lang.Boolean,T>	setMinimumWidth(double pixels) Sets the minimum width for this column.
Grid.Column<java.lang.Boolean,T>	setWidth(double pixels) Sets the pixel width of the column.

Methods inherited from class com.vaadin.client.widgets.Grid.Column

clearExpandRatio, getHeaderCaption, getHidingToggleCaption, getRenderer, getWidth, getWidthActual, isEditable, isHidable, isHidden, isResizable, isSortable, setHeaderCaption, setHidable, setHidden, setHidingToggleCaption, setRenderer, setResizable, setSortable, toString

Methods inherited from class java.lang.Object

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

Method Detail

setDefaultHeaderContent

protected void setDefaultHeaderContent(Grid.HeaderCell selectionCell)

Description copied from class: Grid.Column

Resets the default header cell contents to column header captions.

Overrides:

setDefaultHeaderContent in class Grid.Column<java.lang.Boolean,T>

Parameters:

selectionCell - default header cell for this column

setWidth

public Grid.Column<java.lang.Boolean,T> setWidth(double pixels)

Description copied from class: Grid.Column

Sets the pixel width of the column. Use a negative value for the grid to autosize column based on content and available space.

This action is done "finally", once the current execution loop returns. This is done to reduce overhead of unintentionally always recalculate all columns, when modifying several columns at once.

If the column is currently hidden, then this set width has effect only once the column has been made visible again.

Overrides:

setWidth in class Grid.Column<java.lang.Boolean,T>

Parameters:

pixels - the width in pixels or negative for auto sizing

getValue

public java.lang.Boolean getValue(T row)

Description copied from class: Grid.Column

Returns the data that should be rendered into the cell. By default returning Strings and Widgets are supported. If the return type is a String then it will be treated as preformatted text.

To support other types you will need to pass a custom renderer to the column via the column constructor.

Specified by:

getValue in class Grid.Column<java.lang.Boolean,T>

Parameters:

row - The row object that provides the cell content.

Returns:

The cell content

setExpandRatio

public Grid.Column<java.lang.Boolean,T> setExpandRatio(int ratio)

Description copied from class: Grid.Column

Sets the ratio with which the column expands.

By default, all columns expand equally (treated as if all of them had an expand ratio of 1). Once at least one column gets a defined expand ratio, the implicit expand ratio is removed, and only the defined expand ratios are taken into account.

If a column has a defined width (Grid.Column.setWidth(double)), it overrides this method's effects.

Example: A grid with three columns, with expand ratios 0, 1 and 2, respectively. The column with a ratio of 0 is exactly as wide as its contents requires. The column with a ratio of 1 is as wide as it needs, plus a third of any excess space, bceause we have 3 parts total, and this column reservs only one of those. The column with a ratio of 2, is as wide as it needs to be, plus two thirds of the excess width.

This action is done "finally", once the current execution loop returns. This is done to reduce overhead of unintentionally always recalculate all columns, when modifying several columns at once.

Overrides:

setExpandRatio in class Grid.Column<java.lang.Boolean,T>

Returns:

this column

getExpandRatio

public int getExpandRatio()

Description copied from class: Grid.Column

Gets the expand ratio for this column.

Overrides:

getExpandRatio in class Grid.Column<java.lang.Boolean,T>

Returns:

the expand ratio for this column

See Also:

Grid.Column.setExpandRatio(int)

setMaximumWidth

public Grid.Column<java.lang.Boolean,T> setMaximumWidth(double pixels)

Description copied from class: Grid.Column

Sets the maximum width for this column.

This defines the maximum allowed pixel width of the column when it is set to expand.

This action is done "finally", once the current execution loop returns. This is done to reduce overhead of unintentionally always recalculate all columns, when modifying several columns at once.

Overrides:

setMaximumWidth in class Grid.Column<java.lang.Boolean,T>

Parameters:

pixels - the maximum width

Returns:

this column

getMaximumWidth

public double getMaximumWidth()

Description copied from class: Grid.Column

Gets the maximum width for this column.

Overrides:

getMaximumWidth in class Grid.Column<java.lang.Boolean,T>

Returns:

the maximum width for this column

See Also:

Grid.Column.setMaximumWidth(double)

setMinimumWidth

public Grid.Column<java.lang.Boolean,T> setMinimumWidth(double pixels)

Description copied from class: Grid.Column

Sets the minimum width for this column.

This defines the minimum guaranteed pixel width of the column when it is set to expand.

This action is done "finally", once the current execution loop returns. This is done to reduce overhead of unintentionally always recalculate all columns, when modifying several columns at once.

Overrides:

setMinimumWidth in class Grid.Column<java.lang.Boolean,T>

Parameters:

pixels - the minimum width

Returns:

this column

getMinimumWidth

public double getMinimumWidth()

Description copied from class: Grid.Column

Gets the minimum width for this column.

Overrides:

getMinimumWidth in class Grid.Column<java.lang.Boolean,T>

Returns:

the minimum width for this column

See Also:

Grid.Column.setMinimumWidth(double)

setEditable

public Grid.Column<java.lang.Boolean,T> setEditable(boolean editable)

Description copied from class: Grid.Column

Sets whether the values in this column should be editable by the user when the row editor is active. By default columns are editable.

Overrides:

setEditable in class Grid.Column<java.lang.Boolean,T>

Parameters:

editable - true to set this column editable, false otherwise

Returns:

this column

See Also:

Grid.editRow(int), Grid.isEditorActive()