AdvancedDataGridColumnGroup

Package	mx.controls.advancedDataGridClasses
Class	public class AdvancedDataGridColumnGroup
Inheritance	AdvancedDataGridColumnGroup AdvancedDataGridColumn CSSStyleDeclaration EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Use the AdvancedDataGridColumnGroup class to specify column groups for the AdvancedDataGrid control. You can specify one or more AdvancedDataGridColumn classes as children of the AdvancedDataGridColumnGroup class, or nest AdvancedDataGridColumnGroup classes to create nested column groups. The AdvancedDataGrid.columnGroup property takes an Array of AdvancedDataGridColumnGroup instances to specify the column groups.

The following example uses the AdvancedDataGridColumnGroup class to define a column group named Revenues that contains two columns: Actual and Estimate.

  <mx:AdvancedDataGrid id="myADG"
       dataProvider="{dpFlat}"
       width="100%" height="100%">
       <mx:groupedColumns>
           <mx:AdvancedDataGridColumn dataField="Region"/>
           <mx:AdvancedDataGridColumn dataField="Territory"/>
           <mx:AdvancedDataGridColumn dataField="Territory_Rep"
               headerText="Territory Rep"/>
           <mx:AdvancedDataGridColumnGroup headerText="Revenues">    
               <mx:AdvancedDataGridColumn dataField="Actual"/>
               <mx:AdvancedDataGridColumn dataField="Estimate"/>
           </mx:AdvancedDataGridColumnGroup>    
       </mx:groupedColumns>
  </mx:AdvancedDataGrid>

MXML Syntax expanded

Hide MXML Syntax

You use the <mx.AdvancedDataGridColumnGroup> tag to configure a column group of a AdvancedDataGrid control. You specify the <mx.AdvancedDataGridColumnGroup> tag as a child of the groupedColumns property in MXML. The <mx.AdvancedDataGridcolumn> tag defines the following tag attributes:

  <mx:AdvancedDataGridColumn
  Properties 
    children="No default"
    childrenDragEnabled="true|false"
  />

Default MXML Propertychildren

Related API Elements

mx.controls.AdvancedDataGrid
mx.controls.AdvancedDataGrid.columnGroup

Public Properties

	Property		Defined By
		children : Array An Array of AdvancedDataGridColumn instances that define the columns of the column group.	AdvancedDataGridColumnGroup
		childrenDragEnabled : Boolean = true Specifies whether the child columns can be dragged to reposition them in the group.	AdvancedDataGridColumnGroup
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataField : String The name of the field or property in the data provider item associated with the column.	AdvancedDataGridColumn
		dataTipField : String The name of the field in the data provider to display as the data tip.	AdvancedDataGridColumn
		dataTipFunction : Function Specifies a callback function to run on each item of the data provider to determine its data tip.	AdvancedDataGridColumn
		defaultFactory : Function This function, if it isn't null, is usually autogenerated by the MXML compiler.	CSSStyleDeclaration
		draggable : Boolean = true A flag that indicates whether the user is allowed to drag the column to a new position If true, the user can drag the the column headers to a new position	AdvancedDataGridColumn
		editable : Boolean = true A flag that indicates whether the items in the column are editable.	AdvancedDataGridColumn
		editorDataField : String = "text" The name of the property of the item editor that contains the new data for the list item.	AdvancedDataGridColumn
		editorHeightOffset : Number = 0 The height of the item editor, in pixels, relative to the size of the item renderer.	AdvancedDataGridColumn
		editorUsesEnterKey : Boolean = false A flag that indicates whether the item editor uses Enter key.	AdvancedDataGridColumn
		editorWidthOffset : Number = 0 The width of the item editor, in pixels, relative to the size of the item renderer.	AdvancedDataGridColumn
		editorXOffset : Number = 0 The x location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item.	AdvancedDataGridColumn
		editorYOffset : Number = 0 The y location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item.	AdvancedDataGridColumn
		enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus.	AdvancedDataGridColumn
		factory : Function This function, if it isn't null, is usually autogenerated by the MXML compiler.	CSSStyleDeclaration
		formatter : IFormatter An instance of a subclasses of mx.formatters.Formatter.	AdvancedDataGridColumn
		headerRenderer : IFactory The class factory for item renderer instances that display the column header for the column.	AdvancedDataGridColumn
		headerText : String Text for the header of this column.	AdvancedDataGridColumn
		headerWordWrap : * Set to true to wrap the text in the column header if it does not fit on one line.	AdvancedDataGridColumn
		imeMode : String Specifies the IME (input method editor) mode.	AdvancedDataGridColumn
		itemEditor : IFactory A class factory for the instances of the item editor to use for the column, when it is editable.	AdvancedDataGridColumn
		itemRenderer : IFactory The class factory for item renderer instances that display the data for each item in the column.	AdvancedDataGridColumn
		labelFunction : Function A function that determines the text to display in this column.	AdvancedDataGridColumn
		minWidth : Number The minimum width of the column, in pixels.	AdvancedDataGridColumn
		overrides : Object If the setStyle() method is called on a UIComponent or CSSStyleDeclaration at run time, this object stores the name/value pairs that were set; they override the name/value pairs in the objects produced by the methods specified by the defaultFactory and factory properties.	CSSStyleDeclaration
		rendererIsEditor : Boolean = false A flag that indicates that the item renderer is also an item editor.	AdvancedDataGridColumn
		resizable : Boolean = true Set to true if the user is allowed to resize the width of the column.	AdvancedDataGridColumn
		selector : CSSSelector This property is the base selector of a potential chain of selectors and conditions that are used to match CSS style declarations to components.	CSSStyleDeclaration
		selectorIndex : int = 0 The order this CSSStyleDeclaration was added to its StyleManager.	CSSStyleDeclaration
		showDataTips : * Set to true to show data tips in the column.	AdvancedDataGridColumn
		sortable : Boolean = true Set to true to indicate that the user can click on the header of this column to sort the data provider.	AdvancedDataGridColumn
		sortCompareFunction : Function A callback function that gets called when sorting the data in the column.	AdvancedDataGridColumn
		sortDescending : Boolean = false Indicates whether the column sort is in ascending order, false, or descending order, true.	AdvancedDataGridColumn
		specificity : int [read-only] Determines the order of precedence when applying multiple style declarations to a component.	CSSStyleDeclaration
		styleFunction : Function A callback function that is called when rendering each cell.	AdvancedDataGridColumn
		subject : String [read-only] The subject describes the name of a component that may be a potential match for this style declaration.	CSSStyleDeclaration
		visible : Boolean If true, the column is visible.	AdvancedDataGridColumn
		width : Number The width of the column, in pixels.	AdvancedDataGridColumn
		wordWrap : * Set to false to wrap the text in a row of this column because it does not fit on one line If undefined, the AdvancedDataGrid control's wordWrap property is used.	AdvancedDataGridColumn

Public Methods

	Method		Defined By
		AdvancedDataGridColumnGroup(columnName:String = null) Constructor.	AdvancedDataGridColumnGroup
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		clearStyle(styleProp:String):void Clears a style property on this CSSStyleDeclaration.	CSSStyleDeclaration
		clone():AdvancedDataGridColumn Clone this column and return a new Column with the same properties and styles as this one.	AdvancedDataGridColumn
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getStyle(styleProp:String):* Gets the value for a specified style property, as determined solely by this CSSStyleDeclaration.	CSSStyleDeclaration
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		itemToData(data:Object):* Returns the data from the data provider for the specified Object.	AdvancedDataGridColumnGroup
		itemToDataTip(data:Object):String Returns a String that the item renderer displays as the data tip for the given data object, based on the dataTipField and dataTipFunction properties.	AdvancedDataGridColumn
		itemToLabel(data:Object, withFormatting:Boolean = true):String Returns the String that the item renderer displays for the given data object.	AdvancedDataGridColumn
		matchesStyleClient(object:IAdvancedStyleClient):Boolean Determines whether this style declaration applies to the given component based on a match of the selector chain.	CSSStyleDeclaration
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setStyle(styleProp:String, newValue:*):void Sets a style property on this CSSStyleDeclaration.	CSSStyleDeclaration
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles

Click for more information on styles

	Description	Defined By
backgroundColor	Type: uint Format: Color CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The background color of the column.	AdvancedDataGridColumn
color	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component, including the component label.	AdvancedDataGridColumn
disabledColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component if it is disabled.	AdvancedDataGridColumn
fontAntiAliasType	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `antiAliasType` property of internal TextFields.	AdvancedDataGridColumn
fontFamily	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Name of the font to use.	AdvancedDataGridColumn
fontGridFitType	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `gridFitType` property of internal TextFields that represent text in Flex controls.	AdvancedDataGridColumn
fontSharpness	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `sharpness` property of internal TextFields that represent text in Flex controls.	AdvancedDataGridColumn
fontSize	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Height of the text, in pixels.	AdvancedDataGridColumn
fontStyle	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is italic font.	AdvancedDataGridColumn
fontThickness	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `thickness` property of internal TextFields that represent text in Flex controls.	AdvancedDataGridColumn
fontWeight	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is boldface.	AdvancedDataGridColumn
headerStyleName	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.	AdvancedDataGridColumn
kerning	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`).	AdvancedDataGridColumn
letterSpacing	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of additional pixels to appear between each character.	AdvancedDataGridColumn
paddingLeft	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of pixels between the container's left border and its content area.	AdvancedDataGridColumn
paddingRight	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of pixels between the container's right border and its content area.	AdvancedDataGridColumn
textAlign	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alignment of text within a container.	AdvancedDataGridColumn
textDecoration	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is underlined.	AdvancedDataGridColumn
textIndent	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Offset of first line of text from the left side of the container, in pixels.	AdvancedDataGridColumn

Property Detail

children

property

public var children:Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An Array of AdvancedDataGridColumn instances that define the columns of the column group.

childrenDragEnabled

property

public var childrenDragEnabled:Boolean = true

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Specifies whether the child columns can be dragged to reposition them in the group. If false, child columns cannot be reordered even if the AdvancedDataGridColumn.dragEnabled property is set to true for a child column.

The default value is true.

Constructor Detail

AdvancedDataGridColumnGroup

()

Constructor

public function AdvancedDataGridColumnGroup(columnName:String = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

columnName:String (default = null) — The name of the field in the data provider associated with the column group, and the text for the header cell of this column. This is equivalent to setting the dataField and headerText properties.

Method Detail

itemToData

()

method

public function itemToData(data:Object):*

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the data from the data provider for the specified Object.

This method is useful when the data for a row contains nested Objects. For example, a row is defined by the following data in the data provider:

      row = { name:"Adobe", address : {
                                        street  : "345 Park Avenue", 
                                        city    : "San Jose",
                                        state   : "CA 95110",
                                        country : "USA"
                                      }
                       }

You then assign the "address" field to the dataField property of the AdvancedDataGridColumnGroup instance. A call to itemToData(row) then returns the address object.

This method is similar to the AdvancedDataGridColumn.itemToLabel() method.

Parameters

data:Object — The data provider element.

Returns

* — The data from the data provider for the specified Object.

Related API Elements

mx.controls.advancedDataGridClasses.AdvancedDataGridColumn

Legal Notices | Online Privacy Policy

AdvancedDataGridColumnGroup - AS3 Flex

Classes x

children

childrenDragEnabled

AdvancedDataGridColumnGroup

itemToData