com.vaadin.ui.components.grid
Class ColumnGroupRow

java.lang.Object
  com.vaadin.ui.components.grid.ColumnGroupRow

All Implemented Interfaces:

java.io.Serializable

public class ColumnGroupRow
extends java.lang.Object
implements java.io.Serializable

A column group row represents an auxiliary header or footer row added to the grid. A column group row includes column groups that group columns together.

Since:

Author:

Vaadin Ltd

See Also:

Serialized Form

Method Summary

ColumnGroup	addGroup(ColumnGroup... groups) Add a new group to the row by using other already greated groups
ColumnGroup	addGroup(GridColumn... columns) Add a new group to the row by using column instances.
ColumnGroup	addGroup(java.lang.Object... propertyIds) Add a new group to the row by using property ids for the columns.
java.util.List<ColumnGroup>	getGroups() Get the groups in the row.
boolean	isFooterVisible() Is the footer visible for the row.
boolean	isHeaderVisible() Is the header visible for the row.
void	removeGroup(ColumnGroup group) Removes a group from the row.
void	setFooterVisible(boolean visible) Sets the footer visible for the row.
void	setHeaderVisible(boolean visible) Sets the header visible for the row.

Methods inherited from class java.lang.Object

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

Method Detail

addGroup

public ColumnGroup addGroup(java.lang.Object... propertyIds)
                     throws java.lang.IllegalArgumentException

Add a new group to the row by using property ids for the columns.

Parameters:

propertyIds - The property ids of the columns that should be included in the group. A column can only belong in group on a row at a time.

Returns:

a column group representing the collection of columns added to the group

Throws:

java.lang.IllegalArgumentException

addGroup

public ColumnGroup addGroup(GridColumn... columns)
                     throws java.lang.IllegalArgumentException

Add a new group to the row by using column instances.

Parameters:

columns - the columns that should belong to the group

Returns:

a column group representing the collection of columns added to the group

Throws:

java.lang.IllegalArgumentException

addGroup

public ColumnGroup addGroup(ColumnGroup... groups)
                     throws java.lang.IllegalArgumentException

Add a new group to the row by using other already greated groups

Parameters:

groups - the subgroups of the group

Returns:

a column group representing the collection of columns added to the group

Throws:

java.lang.IllegalArgumentException

removeGroup

public void removeGroup(ColumnGroup group)

Removes a group from the row. Does not remove the group from subgroups, to remove it from the subgroup invoke removeGroup on the subgroup.

Parameters:

group - the group to remove

getGroups

public java.util.List<ColumnGroup> getGroups()

Get the groups in the row.

Returns:

unmodifiable list of groups in this row

isHeaderVisible

public boolean isHeaderVisible()

Is the header visible for the row.

Returns:

true if header is visible

setHeaderVisible

public void setHeaderVisible(boolean visible)

Sets the header visible for the row.

Parameters:

visible - should the header be shown

isFooterVisible

public boolean isFooterVisible()

Is the footer visible for the row.

Returns:

true if footer is visible

setFooterVisible

public void setFooterVisible(boolean visible)

Sets the footer visible for the row.

Parameters:

visible - should the footer be shown