com.vaadin.client.ui.grid
Class GridFooter

java.lang.Object
  com.vaadin.client.ui.grid.GridFooter

public class GridFooter
extends java.lang.Object

Represents the footer section of a Grid. The footer is always empty.

Since:

Author:

Vaadin Ltd

Nested Class Summary

class	GridFooter.FooterCell A single cell in a grid Footer row.
class	GridFooter.FooterRow A single row in a grid Footer section.

Constructor Summary

GridFooter()

Method Summary

protected void	addColumn(GridColumn<?,?> column)
ROWTYPE	addRow(int index) Inserts a new row at the given position.
ROWTYPE	appendRow() Adds a new row at the bottom of this section.
protected GridFooter.FooterRow	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(GridColumn<?,?> column)
void	removeRow(int index) Removes the row at the given position.
void	removeRow(ROWTYPE row) Removes the given row from the section.
protected 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridFooter

public GridFooter()

Method Detail

createRow

protected GridFooter.FooterRow createRow()

Creates and returns a new instance of the row type.

Returns:

the created row

requestSectionRefresh

protected 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.

addRow

public ROWTYPE addRow(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

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

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

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 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(GridColumn<?,?> column)

removeColumn

protected void removeColumn(GridColumn<?,?> column)

setGrid

protected void setGrid(Grid<?> grid)

getGrid

protected Grid<?> getGrid()