com.flexicious.nestedtreedatagrid.FlexDataGridColumnGroup

	Property	Defined By
		calculatedEnd : FlexDataGridColumn = null private	FlexDataGridColumnGroup
		calculatedHeight : Number The height on basis of the data to be displayed.	FlexDataGridColumnGroup
		calculatedStart : FlexDataGridColumn = null private	FlexDataGridColumnGroup
		children : Array	FlexDataGridColumnGroup
		collapseStateColumn : FlexDataGridColumn The column to show when the column group is collapsed.	FlexDataGridColumnGroup
		collapseTooltip : String = Collapse Tooltip to display when user hovers over collapse icon	FlexDataGridColumnGroup
		columnGroupCellRenderer : IFactory Container for the column group renderer.	FlexDataGridColumnGroup
		columnGroupRenderer : IFactory The class factory for item renderer instances that display the column header for the column.	FlexDataGridColumnGroup
		columnGroups : Array Childs groups, if any.	FlexDataGridColumnGroup
		columns : Array A copy of the child columns collection.	FlexDataGridColumnGroup
		depth : int [read-only] The level of nesting for this column group	FlexDataGridColumnGroup
		enableExpandCollapse : Boolean Flag to control whether or not to show an expand collapse icon for this column group.	FlexDataGridColumnGroup
		endColumn : FlexDataGridColumn The FlexDataGridColumn object to end the column group at.	FlexDataGridColumnGroup
		expandCollapsePositionFunction : Function A function that takes a column group cell object and returns a Point object that tells the cell where to position the icon.	FlexDataGridColumnGroup
		expandCollapseTooltipFunction : Function Default function will return the value of expandTooltip or collapseTooltip.	FlexDataGridColumnGroup
		expandTooltip : String = Expand Tooltip to display when user hovers over expand icon	FlexDataGridColumnGroup
		groupedColumns : Array Support for columns and column groups as siblings.	FlexDataGridColumnGroup
		headerRenderer : IFactory Same as columnGroupRenderer, here for consistency with the ADG.	FlexDataGridColumnGroup
		headerText : String Text for the header of this column group.	FlexDataGridColumnGroup
		headerWordWrap : Boolean = false Whether to word wrap the column group	FlexDataGridColumnGroup
		height : Number [read-only] Height of the column group row.	FlexDataGridColumnGroup
		isColumnOnly : Boolean [read-only]	FlexDataGridColumnGroup
		level : FlexDataGridColumnLevel The level that this group belongs to.	FlexDataGridColumnGroup
		rootGroup : FlexDataGridColumnGroup [read-only] If i have a parent group return his group, else return me	FlexDataGridColumnGroup
		startColumn : FlexDataGridColumn The FlexDataGridColumn object to start the column group at.	FlexDataGridColumnGroup
		useLastColumnAsCollapseStateColumn : Boolean = true When this flag is set to true, every time the columns are set, the last column is used as the collapseStateColumn	FlexDataGridColumnGroup
		width : Number [read-only] Iterates through all columns widths	FlexDataGridColumnGroup
		y : int [read-only] The level of nesting for this column group	FlexDataGridColumnGroup
		yPlusHeight : Number [read-only]	FlexDataGridColumnGroup

	Method	Defined By
		clone(newLevel:FlexDataGridColumnLevel):FlexDataGridColumnGroup Clone this Group.	FlexDataGridColumnGroup
		closeColumns():void Sets the visibility of all but the first column to false	FlexDataGridColumnGroup
		defaultExpandCollapseTooltipFunction(cell:IFlexDataGridCell):String If isClosed(), return the value of collapseTooltip+ headerText else expandTooltip + headerText	FlexDataGridColumnGroup
		getAllColumns(result:Array = null):Array Iterates through all child groups and gets columns	FlexDataGridColumnGroup
		getColumnAtExtremity(left:Boolean = true):FlexDataGridColumn Gets the left most or right most column	FlexDataGridColumnGroup
		getColumns():Array	FlexDataGridColumnGroup
		getWX():Array Returns an array of Width and X for this column group.	FlexDataGridColumnGroup
		initializeDepthY(dpIn:int = 1, yIn:int = 0):void	FlexDataGridColumnGroup
		initializeGroup():void private	FlexDataGridColumnGroup
		invalidateCalculations():void Will recalculate the columns at extremeties in the next round.	FlexDataGridColumnGroup
		invalidateCalculationsDown():void Will recalculate the columns at extremeties in the next round.	FlexDataGridColumnGroup
		isClosed():Boolean Returns true if all but the collapseStateColumn column in this column group is visible.	FlexDataGridColumnGroup
		openColumns():void Sets the visibility of all columns to true	FlexDataGridColumnGroup

Property Detail

calculatedEnd

property

public var calculatedEnd:FlexDataGridColumn = null

private

calculatedHeight

property

calculatedHeight:Number

The height on basis of the data to be displayed. If there is a column group renderer, or if there is headerWordWrap we calulate this, otherwise, it is set to what ever the levels.headerHeight is.

Implementation
public function get calculatedHeight():Number
public function set calculatedHeight(value:Number):void

calculatedStart

property

public var calculatedStart:FlexDataGridColumn = null

private

children

property

children:Array

Implementation
public function get children():Array
public function set children(value:Array):void

collapseStateColumn

property

collapseStateColumn:FlexDataGridColumn

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

Implementation
public function get collapseStateColumn():FlexDataGridColumn
public function set collapseStateColumn(value:FlexDataGridColumn):void

collapseTooltip

property

public var collapseTooltip:String = Collapse

Tooltip to display when user hovers over collapse icon

columnGroupCellRenderer

property

columnGroupCellRenderer:IFactory

Container for the column group renderer. Needs to inherit from FlexDataGridColumnGroupCell. Defaults to FlexDataGridColumnGroupCell

Implementation
public function get columnGroupCellRenderer():IFactory
public function set columnGroupCellRenderer(value:IFactory):void

columnGroupRenderer

property

columnGroupRenderer:IFactory

The class factory for item renderer instances that display the column header for the column.

Implementation
public function get columnGroupRenderer():IFactory
public function set columnGroupRenderer(value:IFactory):void

columnGroups

property

columnGroups:Array

Childs groups, if any.

Implementation
public function get columnGroups():Array
public function set columnGroups(value:Array):void

columns

property

columns:Array

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

Implementation
public function get columns():Array
public function set columns(value:Array):void

depth

property

depth:int [read-only]

The level of nesting for this column group

Implementation
public function get depth():int

enableExpandCollapse

property

enableExpandCollapse:Boolean

Flag to control whether or not to show an expand collapse icon for this column group. The icon itself can be controlled using the columnGroupOpenIcon and columnGroupClosedIcon of the grid. The position of the icon can be controlled using the expandCollapsePositionFunction

The default value is false.

Implementation
public function get enableExpandCollapse():Boolean
public function set enableExpandCollapse(value:Boolean):void

endColumn

property

endColumn:FlexDataGridColumn

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

Implementation
public function get endColumn():FlexDataGridColumn
public function set endColumn(value:FlexDataGridColumn):void

expandCollapsePositionFunction

property

expandCollapsePositionFunction:Function

A function that takes a column group cell object and returns a Point object that tells the cell where to position the icon. The point's co-ordinates should be relative to the cell. By default, the icon will be placed 2 px to the left, 1/4th the way from the top (to account for the height of the icon itself).

Implementation
public function get expandCollapsePositionFunction():Function
public function set expandCollapsePositionFunction(value:Function):void

expandCollapseTooltipFunction

property

public var expandCollapseTooltipFunction:Function

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

expandTooltip

property

public var expandTooltip:String = Expand

Tooltip to display when user hovers over expand icon

groupedColumns

property

groupedColumns:Array

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.

Implementation
public function get groupedColumns():Array
public function set groupedColumns(value:Array):void

headerRenderer

property

headerRenderer:IFactory

Same as columnGroupRenderer, here for consistency with the ADG.

Implementation
public function get headerRenderer():IFactory
public function set headerRenderer(value:IFactory):void

headerText

property

headerText:String

Text for the header of this column group.

Implementation
public function get headerText():String
public function set headerText(value:String):void

headerWordWrap

property

public var headerWordWrap:Boolean = false

Whether to word wrap the column group

height

property

height:Number [read-only]

Height of the column group row. Defaults to 25.

Implementation
public function get height():Number

isColumnOnly

property

isColumnOnly:Boolean [read-only]

Implementation
public function get isColumnOnly():Boolean

level

property

level:FlexDataGridColumnLevel

The level that this group belongs to.

Implementation
public function get level():FlexDataGridColumnLevel
public function set level(value:FlexDataGridColumnLevel):void

rootGroup

property

rootGroup:FlexDataGridColumnGroup [read-only]

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

Implementation
public function get rootGroup():FlexDataGridColumnGroup

startColumn

property

startColumn:FlexDataGridColumn

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

Implementation
public function get startColumn():FlexDataGridColumn
public function set startColumn(value:FlexDataGridColumn):void

useLastColumnAsCollapseStateColumn

property

public var useLastColumnAsCollapseStateColumn:Boolean = true

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

width

property

width:Number [read-only]

Iterates through all columns widths

Implementation
public function get width():Number

property

y:int [read-only]

The level of nesting for this column group

Implementation
public function get y():int

yPlusHeight

property

yPlusHeight:Number [read-only]

Implementation
public function get yPlusHeight():Number

Method Detail

clone

()

method

public function clone(newLevel:FlexDataGridColumnLevel):FlexDataGridColumnGroup

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

Parameters

newLevel:FlexDataGridColumnLevel

Returns

FlexDataGridColumnGroup

closeColumns

()

method

public function closeColumns():void

Sets the visibility of all but the first column to false

defaultExpandCollapseTooltipFunction

()

method

public function defaultExpandCollapseTooltipFunction(cell:IFlexDataGridCell):String

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

Parameters

cell:IFlexDataGridCell

Returns

String

getAllColumns

()

method

public function getAllColumns(result:Array = null):Array

Iterates through all child groups and gets columns

Parameters

result:Array (default = null)

Returns

Array —

getColumnAtExtremity

()

method

public function getColumnAtExtremity(left:Boolean = true):FlexDataGridColumn

Gets the left most or right most column

Parameters

left:Boolean (default = true)

Returns

FlexDataGridColumn

getColumns

()

method

public function getColumns():Array

Returns

Array

getWX

()

method

public function getWX():Array

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

Returns

Array

initializeDepthY

()

method

public function initializeDepthY(dpIn:int = 1, yIn:int = 0):void

Parameters

	`dpIn:int` (default = `1`)

	`yIn:int` (default = `0`)

initializeGroup

()

method

public function initializeGroup():void

private

invalidateCalculations

()

method

public function invalidateCalculations():void

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

invalidateCalculationsDown

()

method

public function invalidateCalculationsDown():void

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

isClosed

()

method

public function isClosed():Boolean

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

Returns

Boolean

openColumns

()

method

public function openColumns():void

Sets the visibility of all columns to true

Mon Jun 24 2013, 11:00 PM -04:00

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
FlexDataGridColumnGroup	Properties \| Methods

Package	com.flexicious.nestedtreedatagrid
Class	public class FlexDataGridColumnGroup
Inheritance	FlexDataGridColumnGroup Object