com.vaadin.client.widgets.
Class Grid.StaticSection<ROWTYPE extends Grid.StaticSection.StaticRow<?>>
- java.lang.Object
-
- com.vaadin.client.widgets.Grid.StaticSection<ROWTYPE>
-
Type Parameters:
ROWTYPE
- the type of the rows in the sectionDirect Known Subclasses:
public abstract static class Grid.StaticSection<ROWTYPE extends Grid.StaticSection.StaticRow<?>> extends Object
Abstract base class for Grid header and footer sections.
Since:
7.5.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Grid.StaticSection.StaticCell
A header or footer cell.
static class
Grid.StaticSection.StaticRow<CELLTYPE extends Grid.StaticSection.StaticCell>
Abstract base class for Grid header and footer rows.
-
Constructor Summary
Constructors Constructor Description StaticSection()
-
Method Summary
All Methods Modifier and Type Method Description protected void
addColumn(Grid.Column<?,?> column)
Adds cells for the given column to all the rows within this section.
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 abstract ROWTYPE
createRow()
Creates and returns a new instance of the row type.
protected Grid<?>
getGrid()
Returns the grid this section belongs to.
ROWTYPE
getRow(int index)
Returns the row at the given position.
int
getRowCount()
Returns the number of rows in this section.
protected List<ROWTYPE>
getRows()
Returns the current list of rows within this section.
protected int
getVisibleRowCount()
Returns how many visible rows there are within this section (all or nothing, visibility cannot be set on the row level).
boolean
isVisible()
Returns the visibility of this section.
ROWTYPE
prependRow()
Adds a new row at the top of this section.
protected void
removeColumn(Grid.Column<?,?> column)
Removes cells for the given column from all the rows within this section.
void
removeRow(int index)
Removes the row at the given position.
void
removeRow(ROWTYPE row)
Removes the given row from the section.
protected abstract void
requestSectionRefresh()
Informs the grid that this section should be re-rendered.
protected void
setGrid(Grid<?> grid)
Sets the grid this section belongs to.
void
setVisible(boolean visible)
Sets the visibility of the whole section.
protected void
updateColSpans()
Triggers column span calculation for all the rows within this section that contain spanned cells.
-
-
-
Method Detail
-
createRow
protected abstract ROWTYPE createRow()
Creates and returns a new instance of the row type.
Returns:
the created row
-
requestSectionRefresh
protected abstract void requestSectionRefresh()
Informs the grid that this section should be re-rendered.
Note that re-render means calling update() on each cell, preAttach()/postAttach()/preDetach()/postDetach() is not called as the cells are not removed from the DOM.
-
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.
-
addRowAt
public ROWTYPE addRowAt(int index)
Inserts a new row at the given position. Shifts the row currently at that position and any subsequent rows down (adds one to their indices).
Parameters:
index
- the position at which to insert the rowReturns:
the new row
Throws:
IndexOutOfBoundsException
- if the index is out of boundsSee Also:
appendRow()
,prependRow()
,removeRow(int)
,removeRow(StaticRow)
-
prependRow
public ROWTYPE prependRow()
Adds a new row at the top of this section.
Returns:
the new row
See Also:
appendRow()
,addRowAt(int)
,removeRow(int)
,removeRow(StaticRow)
-
appendRow
public ROWTYPE appendRow()
Adds a new row at the bottom of this section.
Returns:
the new row
See Also:
prependRow()
,addRowAt(int)
,removeRow(int)
,removeRow(StaticRow)
-
removeRow
public void removeRow(int index)
Removes the row at the given position.
Parameters:
index
- the position of the rowThrows:
IndexOutOfBoundsException
- if the index is out of boundsSee Also:
addRowAt(int)
,appendRow()
,prependRow()
,removeRow(StaticRow)
-
removeRow
public void removeRow(ROWTYPE row)
Removes the given row from the section.
Parameters:
row
- the row to be removedThrows:
IllegalArgumentException
- if the row does not exist in this sectionSee Also:
-
getRow
public ROWTYPE getRow(int index)
Returns the row at the given position.
Parameters:
index
- the position of the rowReturns:
the row with the given index
Throws:
IndexOutOfBoundsException
- if the index is out of bounds
-
getRowCount
public int getRowCount()
Returns the number of rows in this section.
Returns:
the number of rows
-
getRows
protected List<ROWTYPE> getRows()
Returns the current list of rows within this section.
Returns:
list of rows
-
getVisibleRowCount
protected int getVisibleRowCount()
Returns how many visible rows there are within this section (all or nothing, visibility cannot be set on the row level).
Returns:
amount of visible rows
-
addColumn
protected void addColumn(Grid.Column<?,?> column)
Adds cells for the given column to all the rows within this section.
Parameters:
column
- the column that requires cells
-
removeColumn
protected void removeColumn(Grid.Column<?,?> column)
Removes cells for the given column from all the rows within this section.
Parameters:
column
- the column that should have its cells removed
-
setGrid
protected void setGrid(Grid<?> grid)
Sets the grid this section belongs to. Should not be null.
Parameters:
grid
- the parent grid
-
getGrid
protected Grid<?> getGrid()
Returns the grid this section belongs to.
Returns:
the parent grid
-
updateColSpans
protected void updateColSpans()
Triggers column span calculation for all the rows within this section that contain spanned cells.
-
-