com.vaadin.ui.components.grid
Class ColumnGroup

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

All Implemented Interfaces:

java.io.Serializable

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

Column groups are used to group columns together for adding common auxiliary headers and footers. Columns groups are added to ColumnGroupRow's.

Since:

Author:

Vaadin Ltd

See Also:

Serialized Form

Method Summary

protected void	checkGroupIsAttached() Checks if column group is attached to a row and throws an IllegalStateException if it is not.
java.util.List<java.lang.Object>	getColumns() Returns a list of property ids where all also the child groups property ids are included.
java.lang.String	getFooterCaption() The text displayed in the footer of the column group.
java.lang.String	getHeaderCaption() Sets the text displayed in the header of the column group.
boolean	isColumnInGroup(java.lang.Object propertyId) Is a property id in this group or in some sub group of this group.
void	setFooterCaption(java.lang.String footer) Sets the text displayed in the footer of the column group.
void	setHeaderCaption(java.lang.String header) Sets the text displayed in the header of the column group.

Methods inherited from class java.lang.Object

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

Method Detail

setHeaderCaption

public void setHeaderCaption(java.lang.String header)

Sets the text displayed in the header of the column group.

Parameters:

header - the text displayed in the header of the column

getHeaderCaption

public java.lang.String getHeaderCaption()

Sets the text displayed in the header of the column group.

Returns:

the text displayed in the header of the column

setFooterCaption

public void setFooterCaption(java.lang.String footer)

Sets the text displayed in the footer of the column group.

Parameters:

footer - the text displayed in the footer of the column

getFooterCaption

public java.lang.String getFooterCaption()

The text displayed in the footer of the column group.

Returns:

the text displayed in the footer of the column

isColumnInGroup

public boolean isColumnInGroup(java.lang.Object propertyId)

Is a property id in this group or in some sub group of this group.

Parameters:

propertyId - the property id to check for

Returns:

true if the property id is included in this group.

getColumns

public java.util.List<java.lang.Object> getColumns()

Returns a list of property ids where all also the child groups property ids are included.

Returns:

a unmodifiable list with all the columns in the group. Includes any subgroup columns as well.

checkGroupIsAttached

protected void checkGroupIsAttached()
                             throws java.lang.IllegalStateException

Checks if column group is attached to a row and throws an IllegalStateException if it is not.

Throws:

java.lang.IllegalStateException - if the column is no longer attached to any grid