Package de.hybris.platform.cockpit.model.listview

Interface ColumnGroup

All Known Implementing Classes:

DefaultColumnGroup

public interface ColumnGroup

A ColumnGroup is a container that can hold ColumnDescriptors as well as other column groups. It allows columns to be organized in a tree-like structure.

Method Summary

Modifier and Type	Method	Description
List<ColumnGroup>	getAllColumnGroups()	Returns a list containing this group and all the groups held by this ColumnGroup and its sub groups.
List<ColumnDescriptor>	getAllColumns()	Returns all columns in this ColumnGroup and its sub groups.
List<ColumnDescriptor>	getAllHiddenColumns()
List<ColumnDescriptor>	getAllVisibleColumns()
List<ColumnGroup>	getColumnGroups()	Returns all the sub groups directly held by this ColumnGroup.
List<ColumnDescriptor>	getColumns()	Returns all columns directly held by this ColumnGroup.
List<ColumnDescriptor>	getHiddenColumns()
String	getName()	Returns the name of this ColumnGroup.
ColumnGroup	getParentColumnGroup()	Returns the parent ColumnGroup of this group or null if it is a root container.
int	getSize()	Returns the number of columns directly in this ColumnGroup.
int	getTotalSize()	Returns the total number of columns in this ColumnGroup and its sub groups.
List<ColumnDescriptor>	getVisibleColumns()

Method Details

getName

String getName()

Returns the name of this ColumnGroup.

Returns:

the name of this column group

getColumns

List<ColumnDescriptor> getColumns()

Returns all columns directly held by this ColumnGroup.

Returns:

all columns assigned directly to this group

See Also:

• getAllColumns()

getAllColumns

List<ColumnDescriptor> getAllColumns()

Returns all columns in this ColumnGroup and its sub groups.

Returns:

all columns assigned to this group or any of its sub groups

See Also:

• getColumns()
• getColumnGroups()

getSize

int getSize()

Returns the number of columns directly in this ColumnGroup.

Returns:

the number of columns assigned directly to this group

See Also:

• getTotalSize()

getVisibleColumns

List<ColumnDescriptor> getVisibleColumns()

getAllVisibleColumns

List<ColumnDescriptor> getAllVisibleColumns()

getHiddenColumns

List<ColumnDescriptor> getHiddenColumns()

getAllHiddenColumns

List<ColumnDescriptor> getAllHiddenColumns()

getTotalSize

int getTotalSize()

Returns the total number of columns in this ColumnGroup and its sub groups.

Returns:

the total number of columns assigned to this group or any of its sub groups

See Also:

• getSize()

getParentColumnGroup

ColumnGroup getParentColumnGroup()

Returns the parent ColumnGroup of this group or null if it is a root container.

Returns:

the column group which this column group is a part of

getColumnGroups

List<ColumnGroup> getColumnGroups()

Returns all the sub groups directly held by this ColumnGroup.

Returns:

the sub groups of this ColumnGroup

See Also:

• getAllColumnGroups()

getAllColumnGroups

List<ColumnGroup> getAllColumnGroups()

Returns a list containing this group and all the groups held by this ColumnGroup and its sub groups.

Returns:

the sub groups of this ColumnGroup and their sub groups

See Also:

• getColumnGroups()