GxColumnGroup

Inheritance:

```
public class GxColumnGroup
extends GxDefaultColumnGroup
implements GxColumnsManagerInterface
```
The class holds the grid column group. With this object you can group several columns and several column groups together to create deep nested structure.

See Also:
[]

Field Summary

Fields
Modifier and Type	Field and Description
`BBjString`	`GroupId!` The unique ID to give the column.

Fields inherited from class GxColumnDefinition
ColumnGroupShow!, HeaderClass!, HeaderTooltip!, Label!, SuppressFiltersToolPanel!, SuppressToolPanel!, ToolPanelClass! Fields inherited from class GxDefaultColumnGroup HeaderGroupTooltip!, MarryChildren!, OpenByDefault!


	
	
	Constructor Summary
Constructors Constructor and Description
GxColumnGroup(BBjString id!)Construct new GxColumnGroup
GxColumnGroup(BBjString id! , BBjString label!)Construct new GxColumnGroup

	
	
	Method Summary
Methods Modifier and Type Method and Description
 GxColumn addColumn(GxColumn definition!)Add new column definition

#Configuration

#ColumnsRenderer
 GxColumn addColumn(BBjString field!, BBjNumber type!)Add new column definition

#Configuration

#ColumnsRenderer
 GxColumn addColumn(BBjString field!, BBjString label!)Add new column definition

#Configuration

#ColumnsRenderer
 GxColumn addColumn(BBjString field!, BBjString label!, BBjNumber type!)Add new column definition

#Configuration

#ColumnsRenderer
 GxColumn addColumn(BBjString field!)Add new column definition

#Configuration

#ColumnsRenderer
 GxColumnGroup addColumnGroup(GxColumnGroup definition!)Add column group

#Configuration

#ColumnsRenderer
 GxColumnGroup addColumnGroup(BBjString id!)Add column group

#Configuration

#ColumnsRenderer
 GxColumnGroup addColumnGroup(BBjString id!, BBjString label!)Add column group

#Configuration

#ColumnsRenderer
 JsonObject getAsJsonObject()Convert the definition to Json Object
 GxColumn getColumn(BBjString field!)Get the column definition instance

#Configuration

#ColumnsRenderer
 GxColumnGroup getColumnGroup(BBjString id!)Get the column group definition instance

#Configuration

#ColumnsRenderer
 BBjNumber hasColumn(BBjString field!)Check if the column definition exists

#Configuration

#ColumnsRenderer
 BBjNumber hasColumnGroup(BBjString id!)Check if the column group definition exists

#Configuration

#ColumnsRenderer
 GxColumn removeColumn(BBjString field!)Remove a column definition

#Configuration

#ColumnsRenderer
 GxColumnGroup removeColumnGroup(BBjString id!)Remove a column group definition

#Configuration

#ColumnsRenderer
 void resetAllColumns()Clear all columns and column groups

#Configuration

#ColumnsRenderer
 void setGroupId()Throw an error when called because the group id becomes immutable after
the column group's definition creation
Methods inherited from class GxColumnDefinition
COLUMN_GROUP_CLOSED, COLUMN_GROUP_OPENED, getAsJsonObject Methods inherited from class GxDefaultColumnGroup
getAsJsonObject, getHeaderGroupTooltip, setHeaderGroupTooltip

Constructors
Constructor and Description
`GxColumnGroup(BBjString id!)` Construct new GxColumnGroup
`GxColumnGroup(BBjString id! , BBjString label!)` Construct new GxColumnGroup

Methods
Modifier and Type	Method and Description
`GxColumn`	`addColumn(GxColumn definition!)` Add new column definition #Configuration #ColumnsRenderer
`GxColumn`	`addColumn(BBjString field!, BBjNumber type!)` Add new column definition #Configuration #ColumnsRenderer
`GxColumn`	`addColumn(BBjString field!, BBjString label!)` Add new column definition #Configuration #ColumnsRenderer
`GxColumn`	`addColumn(BBjString field!, BBjString label!, BBjNumber type!)` Add new column definition #Configuration #ColumnsRenderer
`GxColumn`	`addColumn(BBjString field!)` Add new column definition #Configuration #ColumnsRenderer
`GxColumnGroup`	`addColumnGroup(GxColumnGroup definition!)` Add column group #Configuration #ColumnsRenderer
`GxColumnGroup`	`addColumnGroup(BBjString id!)` Add column group #Configuration #ColumnsRenderer
`GxColumnGroup`	`addColumnGroup(BBjString id!, BBjString label!)` Add column group #Configuration #ColumnsRenderer
`JsonObject`	`getAsJsonObject()` Convert the definition to Json Object
`GxColumn`	`getColumn(BBjString field!)` Get the column definition instance #Configuration #ColumnsRenderer
`GxColumnGroup`	`getColumnGroup(BBjString id!)` Get the column group definition instance #Configuration #ColumnsRenderer
`BBjNumber`	`hasColumn(BBjString field!)` Check if the column definition exists #Configuration #ColumnsRenderer
`BBjNumber`	`hasColumnGroup(BBjString id!)` Check if the column group definition exists #Configuration #ColumnsRenderer
`GxColumn`	`removeColumn(BBjString field!)` Remove a column definition #Configuration #ColumnsRenderer
`GxColumnGroup`	`removeColumnGroup(BBjString id!)` Remove a column group definition #Configuration #ColumnsRenderer
`void`	`resetAllColumns()` Clear all columns and column groups #Configuration #ColumnsRenderer
`void`	`setGroupId()` Throw an error when called because the group id becomes immutable after the column group's definition creation


	
	
	Field Detail
GroupId!
public BBjString GroupId!
The unique ID to give the column.

	
	
	Constructor Detail
GxColumnGroup
public GxColumnGroup(BBjString id!)
Construct new GxColumnGroup
Parameters:
BBjString id! The group id
GxColumnGroup
public GxColumnGroup(BBjString id! , BBjString label!)
Construct new GxColumnGroup
Parameters:
BBjString id! The group id
BBjString label! The group label
	
	
	Method Detail
addColumn
public GxColumn addColumn(GxColumn definition!)
Add new column definition

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 GxColumn The definition instance
addColumn
public GxColumn addColumn(BBjString field!, BBjNumber type!)
Add new column definition

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 GxColumn The definition instance
addColumn
public GxColumn addColumn(BBjString field!, BBjString label!)
Add new column definition

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 GxColumn The definition instance
addColumn
public GxColumn addColumn(BBjString field!, BBjString label!, BBjNumber type!)
Add new column definition

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 GxColumn The definition instance
addColumn
public GxColumn addColumn(BBjString field!)
Add new column definition

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 GxColumn The definition instance
addColumnGroup
public GxColumnGroup addColumnGroup(GxColumnGroup definition!)
Add column group

#Configuration

#ColumnsRenderer
Parameters:
BBjString id! The group id
BBjString label! The group label
addColumnGroup
public GxColumnGroup addColumnGroup(BBjString id!)
Add column group

#Configuration

#ColumnsRenderer
Parameters:
BBjString id! The group id
BBjString label! The group label
addColumnGroup
public GxColumnGroup addColumnGroup(BBjString id!, BBjString label!)
Add column group

#Configuration

#ColumnsRenderer
Parameters:
BBjString id! The group id
BBjString label! The group label
getAsJsonObject
public JsonObject getAsJsonObject()
Convert the definition to Json Object
getColumn
public GxColumn getColumn(BBjString field!)
Get the column definition instance

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 GxColumn return the column definition instance if found, null() otherwise
getColumnGroup
public GxColumnGroup getColumnGroup(BBjString id!)
Get the column group definition instance

#Configuration

#ColumnsRenderer
Parameters:
BBjString id! The column group definition id
Returns:
 GxColumn return the column group definition instance if found, null() otherwise
hasColumn
public BBjNumber hasColumn(BBjString field!)
Check if the column definition exists

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 BBjNumber return 1 when found, 0 otherwise
hasColumnGroup
public BBjNumber hasColumnGroup(BBjString id!)
Check if the column group definition exists

#Configuration

#ColumnsRenderer
Parameters:
BBjString id! The column group definition id
Returns:
 BBjNumber return 1 when found, 0 otherwise
removeColumn
public GxColumn removeColumn(BBjString field!)
Remove a column definition

#Configuration

#ColumnsRenderer
Parameters:
BBjString field! The column's definition field
Returns:
 GxColumn The removed column instance, null() otherwise
removeColumnGroup
public GxColumnGroup removeColumnGroup(BBjString id!)
Remove a column group definition

#Configuration

#ColumnsRenderer
Parameters:
BBjString id! The column group definition id
Returns:
 GxColumnGroup The removed column group instance, null() otherwise
resetAllColumns
public void resetAllColumns()
Clear all columns and column groups

#Configuration

#ColumnsRenderer
setGroupId
public void setGroupId()
Throw an error when called because the group id becomes immutable after
the column group's definition creation

Class GxColumnGroup

Field Summary

Fields inherited from class GxColumnDefinition

Fields inherited from class GxDefaultColumnGroup

Constructor Summary

Method Summary

Methods inherited from class GxColumnDefinition

Methods inherited from class GxDefaultColumnGroup

Field Detail

GroupId!

Constructor Detail

GxColumnGroup

GxColumnGroup

Method Detail

addColumn

addColumn

addColumn

addColumn

addColumn

addColumnGroup

addColumnGroup

addColumnGroup

getAsJsonObject

getColumn

getColumnGroup

hasColumn

hasColumnGroup

removeColumn

removeColumnGroup

resetAllColumns

setGroupId