Package com.vaadin.ui

Class Grid.Header

java.lang.Object

com.vaadin.ui.Grid.StaticSection<Grid.HeaderRow>

com.vaadin.ui.Grid.Header

All Implemented Interfaces:

Serializable

Enclosing class:

Grid

protected static class Grid.Header
extends Grid.StaticSection<Grid.HeaderRow>

Represents the header section of a Grid.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.Grid.StaticSection

Grid.StaticSection.StaticRow<CELLTYPE extends com.vaadin.ui.Grid.StaticSection.StaticCell>

Field Summary

Fields inherited from class com.vaadin.ui.Grid.StaticSection

grid, rows

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Header(Grid grid)

Method Summary

Modifier and Type	Method	Description
protected Grid.HeaderRow	createRow()
Grid.HeaderRow	getDefaultRow()	Returns the current default row of this header.
protected GridStaticSectionState	getSectionState()
protected void	readDesign(org.jsoup.nodes.Element tableSectionElement, DesignContext designContext)	Writes the declarative design from the given table section element.
Grid.HeaderRow	removeRow(int rowIndex)	Removes the row at the given position.
protected void	sanityCheck()	Performs a sanity check that section is in correct state.
void	setDefaultRow(Grid.HeaderRow row)	Sets the default row of this header.

Methods inherited from class com.vaadin.ui.Grid.StaticSection

addColumn, addRowAt, appendRow, getRow, getRowCount, isVisible, markAsDirty, prependRow, removeColumn, removeRow, setVisible, writeDesign

Methods inherited from class java.lang.Object

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

Constructor Detail

Header

protected Header(Grid grid)

Method Detail

setDefaultRow

public void setDefaultRow(Grid.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:

IllegalArgumentException - this header does not contain the row

getDefaultRow

public Grid.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 GridStaticSectionState getSectionState()

Specified by:

getSectionState in class Grid.StaticSection<Grid.HeaderRow>

createRow

protected Grid.HeaderRow createRow()

Specified by:

createRow in class Grid.StaticSection<Grid.HeaderRow>

removeRow

public Grid.HeaderRow removeRow(int rowIndex)

Description copied from class: Grid.StaticSection

Removes the row at the given position.

Overrides:

removeRow in class Grid.StaticSection<Grid.HeaderRow>

Parameters:

rowIndex - the position of the row

See Also:

Grid.StaticSection.removeRow(StaticRow), Grid.StaticSection.addRowAt(int), Grid.StaticSection.appendRow(), Grid.StaticSection.prependRow()

sanityCheck

protected void sanityCheck()
                    throws IllegalStateException

Description copied from class: Grid.StaticSection

Performs a sanity check that section is in correct state.

Overrides:

sanityCheck in class Grid.StaticSection<Grid.HeaderRow>

Throws:

IllegalStateException - if merged cells are not i n continuous range

readDesign

protected void readDesign(org.jsoup.nodes.Element tableSectionElement,
                          DesignContext designContext)

Description copied from class: Grid.StaticSection

Writes the declarative design from the given table section element.

Overrides:

readDesign in class Grid.StaticSection<Grid.HeaderRow>

Parameters:

tableSectionElement - Element to read design from

designContext - the design context