com.vaadin.ui.components.grid
Class GridHeader

java.lang.Object
  com.vaadin.ui.components.grid.GridHeader

All Implemented Interfaces:

java.io.Serializable

public class GridHeader
extends java.lang.Object

Represents the header section of a Grid.

Since:

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

class	GridHeader.HeaderCell
class	GridHeader.HeaderRow

Field Summary

protected Grid	grid
protected java.util.List<ROWTYPE>	rows

Constructor Summary

protected

GridHeader(Grid grid)

Method Summary

ROWTYPE	addRowAt(int index) Inserts a new row at the given position.
ROWTYPE	appendRow() Adds a new row at the bottom of this section.
protected GridHeader.HeaderRow	createRow()
GridHeader.HeaderRow	getDefaultRow() Returns the current default row of this header.
ROWTYPE	getRow(int rowIndex) Gets row at given index.
int	getRowCount() Gets the amount of rows in this section.
protected com.vaadin.shared.ui.grid.GridStaticSectionState	getSectionState()
boolean	isVisible() Returns the visibility of this section.
protected void	markAsDirty() Informs the grid that state has changed and it should be redrawn.
ROWTYPE	prependRow() Adds a new row at the top of this section.
GridHeader.HeaderRow	removeRow(int rowIndex) Removes the row at the given position.
void	removeRow(ROWTYPE row) Removes the given row from the section.
void	setDefaultRow(GridHeader.HeaderRow row) Sets the default row of this header.
void	setVisible(boolean visible) Sets the visibility of the whole section.

Methods inherited from class java.lang.Object

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

Field Detail

grid

protected Grid grid

rows

protected java.util.List<ROWTYPE extends com.vaadin.ui.components.grid.GridStaticSection.StaticRow<?>> rows

Constructor Detail

GridHeader

protected GridHeader(Grid grid)

Method Detail

setDefaultRow

public void setDefaultRow(GridHeader.HeaderRow row)

Sets the default row of this header. The default row is a special header row providing a user interface for sorting columns.

Parameters:

row - the new default row, or null for no default row

Throws:

java.lang.IllegalArgumentException - this header does not contain the row

getDefaultRow

public GridHeader.HeaderRow getDefaultRow()

Returns the current default row of this header. The default row is a special header row providing a user interface for sorting columns.

Returns:

the default row or null if no default row set

getSectionState

protected com.vaadin.shared.ui.grid.GridStaticSectionState getSectionState()

createRow

protected GridHeader.HeaderRow createRow()

removeRow

public GridHeader.HeaderRow removeRow(int rowIndex)

Removes the row at the given position.

setVisible

public void setVisible(boolean visible)

Sets the visibility of the whole section.

Parameters:

visible - true to show this section, false to hide

isVisible

public boolean isVisible()

Returns the visibility of this section.

Returns:

true if visible, false otherwise.

removeRow

public void removeRow(ROWTYPE row)

Removes the given row from the section.

Parameters:

row - the row to be removed

Throws:

java.lang.IllegalArgumentException - if the row does not exist in this section

getRow

public ROWTYPE getRow(int rowIndex)

Gets row at given index.

Parameters:

rowIndex - 0 based index for row. Counted from top to bottom

Returns:

row at given index

prependRow

public ROWTYPE prependRow()

Adds a new row at the top of this section.

Returns:

the new row

appendRow

public ROWTYPE appendRow()

Adds a new row at the bottom of this section.

Returns:

the new row

addRowAt

public ROWTYPE addRowAt(int index)

Inserts a new row at the given position.

Parameters:

index - the position at which to insert the row

Returns:

the new row

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds

getRowCount

public int getRowCount()

Gets the amount of rows in this section.

Returns:

row count

markAsDirty

protected void markAsDirty()

Informs the grid that state has changed and it should be redrawn.