com.vaadin.client.widgets
Class Grid.StaticSection<ROWTYPE extends Grid.StaticSection.StaticRow<?>>

java.lang.Object
  extended by com.vaadin.client.widgets.Grid.StaticSection<ROWTYPE>
Type Parameters:
ROWTYPE - the type of the rows in the section
Direct Known Subclasses:
Grid.Footer, Grid.Header
Enclosing class:
Grid<T>

public abstract static class Grid.StaticSection<ROWTYPE extends Grid.StaticSection.StaticRow<?>>
extends java.lang.Object

Abstract base class for Grid header and footer sections.

Since:
7.5.0

Nested Class Summary
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
Grid.StaticSection()
           
 
Method Summary
protected  void addColumn(Grid.Column<?,?> column)
           
 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()
           
 ROWTYPE getRow(int index)
          Returns the row at the given position.
 int getRowCount()
          Returns the number of rows in this section.
protected  java.util.List<ROWTYPE> getRows()
           
protected  int getVisibleRowCount()
           
 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)
           
 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)
           
 void setVisible(boolean visible)
          Sets the visibility of the whole section.
protected  void updateColSpans()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Grid.StaticSection

public Grid.StaticSection()
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 row
Returns:
the new row
Throws:
java.lang.IndexOutOfBoundsException - if the index is out of bounds
See 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 row
Throws:
java.lang.IndexOutOfBoundsException - if the index is out of bounds
See 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 removed
Throws:
java.lang.IllegalArgumentException - if the row does not exist in this section
See Also:
addRowAt(int), appendRow(), prependRow(), removeRow(int)

getRow

public ROWTYPE getRow(int index)
Returns the row at the given position.

Parameters:
index - the position of the row
Returns:
the row with the given index
Throws:
java.lang.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 java.util.List<ROWTYPE> getRows()

getVisibleRowCount

protected int getVisibleRowCount()

addColumn

protected void addColumn(Grid.Column<?,?> column)

removeColumn

protected void removeColumn(Grid.Column<?,?> column)

setGrid

protected void setGrid(Grid<?> grid)

getGrid

protected Grid<?> getGrid()

updateColSpans

protected void updateColSpans()


Copyright © 2000-2014 Vaadin Ltd. All Rights Reserved.