Package com.vaadin.ui.components.grid
Class Header
- java.lang.Object
-
- com.vaadin.ui.components.grid.StaticSection<Header.Row>
-
- com.vaadin.ui.components.grid.Header
-
- All Implemented Interfaces:
Serializable
public abstract class Header extends StaticSection<Header.Row>
Represents the header section of a Grid.- Since:
- 8.0
- Author:
- Vaadin Ltd.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
Header.Row
A row in a Grid header.-
Nested classes/interfaces inherited from class com.vaadin.ui.components.grid.StaticSection
StaticSection.StaticRow<CELL extends com.vaadin.ui.components.grid.StaticSection.StaticCell>
-
-
Constructor Summary
Constructors Constructor Description Header()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Header.Row
createRow()
Creates a new row instance.Header.Row
getDefaultRow()
Returns the default row of this header.void
removeRow(int index)
Removes the row at the given index.void
setDefaultRow(Header.Row defaultRow)
Sets the default row of this header.-
Methods inherited from class com.vaadin.ui.components.grid.StaticSection
addColumn, addRowAt, getColumnByInternalId, getGrid, getInternalIdForColumn, getRow, getRowCount, getRows, getState, isVisible, markAsDirty, readDesign, removeColumn, removeRow, setVisible, writeDesign
-
-
-
-
Method Detail
-
createRow
public Header.Row createRow()
Description copied from class:StaticSection
Creates a new row instance.- Specified by:
createRow
in classStaticSection<Header.Row>
- Returns:
- the new row
-
removeRow
public void removeRow(int index)
Description copied from class:StaticSection
Removes the row at the given index.- Overrides:
removeRow
in classStaticSection<Header.Row>
- Parameters:
index
- the index of the row to remove
-
getDefaultRow
public Header.Row getDefaultRow()
Returns the default row of this header. The default row displays column captions and sort indicators.- Returns:
- the default row, or
null
if there is no default row
-
setDefaultRow
public void setDefaultRow(Header.Row defaultRow)
Sets the default row of this header. The default row displays column captions and sort indicators.- Parameters:
defaultRow
- the new default row, or null for no default row- Throws:
IllegalArgumentException
- if the header does not contain the row
-
-