import FlexDataGridColumnGroup from 'flexicious-react-datagrid/js/flexgrid/grids/FlexDataGridColumnGroup.js'

public class | source

FlexDataGridColumnGroup

Extends:

react~React.Component → EventDispatcher → FlexDataGridColumnGroup

Class responsible for storing information about grouped columns

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	calculatedEnd: *
public	calculatedStart: *
public	collapseStateColumn: flexiciousNmsp.FlexDataGridColumn The column to show when the column group is collapsed.
public	collapseTooltip: String Tooltip to display when user hovers over collapse icon
public	columnGroupCellRenderer: flexiciousNmsp.ClassFactory
public	columnGroupRenderer: flexiciousNmsp.ClassFactory Storage for the headerRenderer property.
public	columnGroups: Array
public	enableExpandCollapse: Boolean
public	expandCollapsePositionFunction: Function
public	expandCollapseTooltipFunction: Function Default function will return the value of expandTooltip or collapseTooltip.
public	expandTooltip: String Tooltip to display when user hovers over expand icon
public	headerText: String Storage for the headerText property.
public	level: flexiciousNmsp.FlexDataGridColumnLevel
public	parentGroup: *
public	useLastColumnAsCollapseStateColumn: boolean When this flag is set to true, every time the columns are set, the last column is used as the collapseStateColumn

Method Summary

Public Methods
public	clone(newLevel: flexiciousNmsp.FlexDataGridColumnLevel): flexiciousNmsp.FlexDataGridColumnGroup Clone this Group.
public	closeColumns() Sets the visibility of all but the first column to false
public	defaultExpandCollapseTooltipFunction(cell: flexiciousNmsp.FlexDataGridCell): String If isClosed(), return the value of collapseTooltip+ headerText else expandTooltip + headerText
public	defaultPositionFunction(cell: flexiciousNmsp.FlexDataGridCell): flexiciousNmsp.Point
public	getAllColumns(result: *): Array Iterates through all child groups and gets columns
public	getChildren(): Array
public	getClassNames(): string[]
public	getColumnAtExtremity(left: Boolean): flexiciousNmsp.FlexDataGridColumn Gets the left most or right most column
public	getColumns(): Array A copy of the child columns collection.
public	getColumns(): *
public	getDepth(): Number The level of nesting for this column group
public	getEndColumn(): flexiciousNmsp.FlexDataGridColumn The FlexDataGridColumn object to end the column group at.
public	getGroupedColumns(): Array Support for columns and column groups as siblings.
public	getHeaderText(): String Text for the header of this columnGroup
public	getHeight(): Number Height of the column group row.
public	getIsColumnOnly(): Boolean
public	getRootGroup(): flexiciousNmsp.FlexDataGridColumnGroup If i have a parent group return his group, else return me
public	getStartColumn(): flexiciousNmsp.FlexDataGridColumn The FlexDataGridColumn object to start the column group at.
public	getWX(): Array Returns an array of Width and X for this column group.
public	getY(): Number The level of nesting for this column group
public	initializeDepthY(dpIn: Number, yIn: Number)
public	initializeGroup()
public	invalidateCalculations() Will recalculate the columns at extremities in the next round.
public	invalidateCalculationsDown() Will recalculate the columns at extremities in the next round.
public	isClosed(): Boolean Returns true if all but the collapseStateColumn column in this column group is visible.
public	kill()
public	openColumns() Sets the visibility of all columns to true
public	setChildren(val: *)
public	setColumns(value: Array)
public	setEndColumn(value: flexiciousNmsp.FlexDataGridColumn)
public	setGroupedColumns(value: *)
public	setHeaderText(val: String) Text for the header of this columnGroup
public	setStartColumn(value: flexiciousNmsp.FlexDataGridColumn)

Inherited Summary

From class EventDispatcher
public	[prop]: *
public	dead: boolean
public	eventListeners: Array A list of event listeners for this event dispatcher object.
public	typeCache: {}
public	addEventListener(context: , type: , listener: *) Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
public	constructed()
public	dispatchEvent(event: *): boolean Dispatches an event into the event flow.
public	getClassNames(): string[]
public	getStyle(prop: ): Gets the value of the prop property on this object
public	hasEventListener(type: *): Boolean Returns true if an event listener exists
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.
public	kill() Removes all event listeners
public	killArray(arr: *) Given an array of event dispatchers, calls the kill method on each of them.
public	removeEventListener(type: , listener: ) Removes a listener from the EventDispatcher object.
public	setStyle(prop: , val: ) Sets the value of the prop property on this object

Public Constructors

public constructor() source

Override:

EventDispatcher#constructor

Public Members

public calculatedEnd: * source

Properties:

Name	Type	Attribute	Description
calculatedEnd	*

public calculatedStart: * source

Properties:

Name	Type	Attribute	Description
calculatedStart	*

public collapseStateColumn: flexiciousNmsp.FlexDataGridColumn source

The column to show when the column group is collapsed. Defaults to the first column.

Properties:

Name	Type	Attribute	Description
collapseStateColumn	*

public collapseTooltip: String source

Tooltip to display when user hovers over collapse icon

Properties:

Name	Type	Attribute	Description
collapseTooltip	*

public columnGroupCellRenderer: flexiciousNmsp.ClassFactory source

Properties:

Name	Type	Attribute	Description
columnGroupCellRenderer	*

public columnGroupRenderer: flexiciousNmsp.ClassFactory source

Storage for the headerRenderer property.

Properties:

Name	Type	Attribute	Description
columnGroupRenderer	*

public columnGroups: Array source

Properties:

Name	Type	Attribute	Description
columnGroups	*

See:

http://www.reactdatagrid.com/demo/#/largedynamicgrid

public enableExpandCollapse: Boolean source

Properties:

Name	Type	Attribute	Description
enableExpandCollapse	*

See:

http://www.reactdatagrid.com/demo/#/largedynamicgrid

public expandCollapsePositionFunction: Function source

Properties:

Name	Type	Attribute	Description
expandCollapsePositionFunction	*

public expandCollapseTooltipFunction: Function source

Default function will return the value of expandTooltip or collapseTooltip. Should take a IFlexDataGridCell object

Properties:

Name	Type	Attribute	Description
expandCollapseTooltipFunction	*

public expandTooltip: String source

Tooltip to display when user hovers over expand icon

Properties:

Name	Type	Attribute	Description
expandTooltip	*

public headerText: String source

Storage for the headerText property.

Properties:

Name	Type	Attribute	Description
headerText	*

See:

http://www.reactdatagrid.com/demo/#/nested

public level: flexiciousNmsp.FlexDataGridColumnLevel source

Properties:

Name	Type	Attribute	Description
level	*

public parentGroup: * source

Properties:

Name	Type	Attribute	Description
parentGroup	*

public useLastColumnAsCollapseStateColumn: boolean source

When this flag is set to true, every time the columns are set, the last column is used as the collapseStateColumn

Properties:

Name	Type	Attribute	Description
useLastColumnAsCollapseStateColumn	*

Public Methods

public clone(newLevel: flexiciousNmsp.FlexDataGridColumnLevel): flexiciousNmsp.FlexDataGridColumnGroup source

Clone this Group. Copies over the start and end groups.

Params:

Name	Type	Attribute	Description
newLevel	flexiciousNmsp.FlexDataGridColumnLevel

Return:

flexiciousNmsp.FlexDataGridColumnGroup

public closeColumns() source

Sets the visibility of all but the first column to false

public defaultExpandCollapseTooltipFunction(cell: flexiciousNmsp.FlexDataGridCell): String source

If isClosed(), return the value of collapseTooltip+ headerText else expandTooltip + headerText

Params:

Name	Type	Attribute	Description
cell	flexiciousNmsp.FlexDataGridCell

Return:

String

public defaultPositionFunction(cell: flexiciousNmsp.FlexDataGridCell): flexiciousNmsp.Point source

Params:

Name	Type	Attribute	Description
cell	flexiciousNmsp.FlexDataGridCell

Return:

flexiciousNmsp.Point

public getAllColumns(result: *): Array source

Iterates through all child groups and gets columns

Params:

Name	Type	Attribute	Description
result	*

Return:

Array

public getChildren(): Array source

Return:

Array

public getClassNames(): string[] source

Override:

EventDispatcher#getClassNames

Return:

string[]

public getColumnAtExtremity(left: Boolean): flexiciousNmsp.FlexDataGridColumn source

Gets the left most or right most column

Params:

Name	Type	Attribute	Description
left	Boolean

Return:

flexiciousNmsp.FlexDataGridColumn

public getColumns(): Array source

A copy of the child columns collection. Do not modify this, instead, use the setter to set a new value.

Return:

Array

public getColumns(): * source

Return:

public getDepth(): Number source

The level of nesting for this column group

Return:

Number

public getEndColumn(): flexiciousNmsp.FlexDataGridColumn source

The FlexDataGridColumn object to end the column group at. Needs to be at an index greater than the column specified in the start column. If child groups exist, goes through children to get the right most column

Return:

flexiciousNmsp.FlexDataGridColumn

public getGroupedColumns(): Array source

Support for columns and column groups as siblings. Prior to 2.7, you could not have a columngroup next to a column. In other words, a column group could either have sub columngroups OR sub columns. If you use the new groupedColumns property you can have column groups that contain both sub column groups as well as sub columns.

Return:

Array

public getHeaderText(): String source

Text for the header of this columnGroup

Return:

String

public getHeight(): Number source

Height of the column group row. Defaults to 25.

Return:

Number

public getIsColumnOnly(): Boolean source

Return:

Boolean

public getRootGroup(): flexiciousNmsp.FlexDataGridColumnGroup source

If i have a parent group return his group, else return me

Return:

flexiciousNmsp.FlexDataGridColumnGroup

public getStartColumn(): flexiciousNmsp.FlexDataGridColumn source

The FlexDataGridColumn object to start the column group at. Needs to be at an index less than the column specified. If child groups exist, goes through children to get the left most column

Return:

flexiciousNmsp.FlexDataGridColumn

value

public getWX(): Array source

Returns an array of Width and X for this column group.

Return:

Array

public getY(): Number source

The level of nesting for this column group

Return:

Number

public initializeDepthY(dpIn: Number, yIn: Number) source

Params:

Name	Type	Attribute	Description
dpIn	Number
yIn	Number

public initializeGroup() source

public invalidateCalculations() source

Will recalculate the columns at extremities in the next round. Will recursively go up the column group hierarchy invalidating its extremities

public invalidateCalculationsDown() source

Will recalculate the columns at extremities in the next round. Will recursively go down the column group hierarchy invalidating child extremities

public isClosed(): Boolean source

Returns true if all but the collapseStateColumn column in this column group is visible.

Return:

Boolean

public kill() source

Removes all event listeners

Override:

EventDispatcher#kill

public openColumns() source

Sets the visibility of all columns to true

public setChildren(val: *) source

Params:

Name	Type	Attribute	Description
val	*

public setColumns(value: Array) source

Params:

Name	Type	Attribute	Description
value	Array

public setEndColumn(value: flexiciousNmsp.FlexDataGridColumn) source

Params:

Name	Type	Attribute	Description
value	flexiciousNmsp.FlexDataGridColumn

public setGroupedColumns(value: *) source

Params:

Name	Type	Attribute	Description
value	*

public setHeaderText(val: String) source

Text for the header of this columnGroup

Params:

Name	Type	Attribute	Description
val	String

public setStartColumn(value: flexiciousNmsp.FlexDataGridColumn) source

Params:

Name	Type	Attribute	Description
value	flexiciousNmsp.FlexDataGridColumn