| Package | mx.controls.advancedDataGridClasses |
| Class | public class AdvancedDataGridHeaderInfo |
| Inheritance | AdvancedDataGridHeaderInfo  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| actualColNum : int
The actual column index at which the header starts,
relative to the currently displayed columns. | AdvancedDataGridHeaderInfo | ||
| children : Array
An Array of all of the child AdvancedDataGridHeaderInfo instances
of this AdvancedDataGridHeaderInfo instance,
if this column is part of a column group. | AdvancedDataGridHeaderInfo | ||
| column : AdvancedDataGridColumn
A reference to the AdvancedDataGridColumn instance
corresponding to this AdvancedDataGridHeaderInfo instance. | AdvancedDataGridHeaderInfo | ||
| columnSpan : int
Number of actual columns spanned by the column header when using column groups. | AdvancedDataGridHeaderInfo | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| depth : int
The depth of this AdvancedDataGridHeaderInfo instance
in the columns hierarchy of the AdvancedDataGrid control,
if this column is part of a column group. | AdvancedDataGridHeaderInfo | ||
| headerItem : IListItemRenderer
A reference to IListItemRenderer instance used to render the column header. | AdvancedDataGridHeaderInfo | ||
| index : int
The index of this AdvancedDataGridHeaderInfo instance
in the AdvancedDataGrid control. | AdvancedDataGridHeaderInfo | ||
| internalLabelFunction : Function
A function that gets created if the
column grouping requires extracting data from nested objects. | AdvancedDataGridHeaderInfo | ||
| parent : AdvancedDataGridHeaderInfo
The parent AdvancedDataGridHeaderInfo instance
of this AdvancedDataGridHeaderInfo instance
if this column is part of a column group. | AdvancedDataGridHeaderInfo | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| visible : Boolean
Contains true if the column is currently visible. | AdvancedDataGridHeaderInfo | ||
| visibleChildren : Array
An Array of the currently visible child AdvancedDataGridHeaderInfo instances. | AdvancedDataGridHeaderInfo | ||
| visibleIndex : int
The index of this column in the list of visible children of its parent
AdvancedDataGridHeaderInfo instance,
if this column is part of a column group. | AdvancedDataGridHeaderInfo | ||
| Method | Defined By | ||
|---|---|---|---|
AdvancedDataGridHeaderInfo(column:AdvancedDataGridColumn, parent:AdvancedDataGridHeaderInfo, index:int, depth:int, children:Array = null, internalLabelFunction:Function = null, headerItem:IListItemRenderer = null)
Constructor. | AdvancedDataGridHeaderInfo | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
actualColNum | property |
public var actualColNum:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The actual column index at which the header starts, relative to the currently displayed columns.
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 all of the child AdvancedDataGridHeaderInfo instances of this AdvancedDataGridHeaderInfo instance, if this column is part of a column group.
column | property |
public var column:AdvancedDataGridColumn| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the AdvancedDataGridColumn instance corresponding to this AdvancedDataGridHeaderInfo instance.
columnSpan | property |
public var columnSpan:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number of actual columns spanned by the column header when using column groups.
depth | property |
public var depth:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The depth of this AdvancedDataGridHeaderInfo instance in the columns hierarchy of the AdvancedDataGrid control, if this column is part of a column group.
headerItem | property |
public var headerItem:IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to IListItemRenderer instance used to render the column header.
index | property |
public var index:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of this AdvancedDataGridHeaderInfo instance in the AdvancedDataGrid control.
internalLabelFunction | property |
public var internalLabelFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A function that gets created if the column grouping requires extracting data from nested objects.
For example, if each data row appears as:
row = {.., .., Q1: { y2005: 241, y2006:353}};
and you define a column group as:
<mx:AdvancedDataGridColumnGroup dataField="Q1">
<mx:AdvancedDataGridColumn dataField="y2005">
<mx:AdvancedDataGridColumn dataField="y2006">
</mx:AdvancedDataGridColumnGroup>
The function for the column corresponding to y2005 is defined as:
function foo():String
{
return row["Q1"]["2005"];
}
The function also handles the case when any of the column or column groups uses a label function instead of a data field.
parent | property |
public var parent:AdvancedDataGridHeaderInfo| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The parent AdvancedDataGridHeaderInfo instance of this AdvancedDataGridHeaderInfo instance if this column is part of a column group.
The default value is null.
visible | property |
public var visible:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Contains true if the column is currently visible.
visibleChildren | property |
public var visibleChildren:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of the currently visible child AdvancedDataGridHeaderInfo instances. if this column is part of a column group.
visibleIndex | property |
public var visibleIndex:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of this column in the list of visible children of its parent AdvancedDataGridHeaderInfo instance, if this column is part of a column group.
AdvancedDataGridHeaderInfo | () | Constructor |
public function AdvancedDataGridHeaderInfo(column:AdvancedDataGridColumn, parent:AdvancedDataGridHeaderInfo, index:int, depth:int, children:Array = null, internalLabelFunction:Function = null, headerItem:IListItemRenderer = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parameterscolumn:AdvancedDataGridColumn — A reference to the AdvancedDataGridColumn instance
that this AdvancedDataGridHeaderInfo instance corresponds to.
| |
parent:AdvancedDataGridHeaderInfo — The parent AdvancedDataGridHeaderInfo instance
of this AdvancedDataGridHeaderInfo instance.
| |
index:int — The index of this AdvancedDataGridHeaderInfo instance
in the AdvancedDataGrid control.
| |
depth:int — The depth of this AdvancedDataGridHeaderInfo instance
in the columns hierarchy of the AdvancedDataGrid control.
| |
children:Array (default = null) | |
internalLabelFunction:Function (default = null) | |
headerItem:IListItemRenderer (default = null) |
Mon Nov 28 2011, 06:48 AM -08:00