blob: c302c75636699401ebdea608b6ed173535a5c99c [file] [log] [blame]
{ "type": "class",
"qname": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumnGroup",
"baseClassname": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumn"
,
"description": "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 <code>AdvancedDataGrid.columnGroup</code> property takes an Array of AdvancedDataGridColumnGroup instances to specify the column groups. <p>The following example uses the AdvancedDataGridColumnGroup class to define a column group named Revenues that contains two columns: Actual and Estimate.</p> <pre>\\n &lt;mx:AdvancedDataGrid id=&quot;myADG&quot;\\n dataProvider=&quot;{dpFlat}&quot;\\n width=&quot;100%&quot; height=&quot;100%&quot;&gt;\\n &lt;mx:groupedColumns&gt;\\n &lt;mx:AdvancedDataGridColumn dataField=&quot;Region&quot;/&gt;\\n &lt;mx:AdvancedDataGridColumn dataField=&quot;Territory&quot;/&gt;\\n &lt;mx:AdvancedDataGridColumn dataField=&quot;Territory_Rep&quot;\\n headerText=&quot;Territory Rep&quot;/&gt;\\n &lt;mx:AdvancedDataGridColumnGroup headerText=&quot;Revenues&quot;&gt;\\n &lt;mx:AdvancedDataGridColumn dataField=&quot;Actual&quot;/&gt;\\n &lt;mx:AdvancedDataGridColumn dataField=&quot;Estimate&quot;/&gt;\\n &lt;/mx:AdvancedDataGridColumnGroup&gt;\\n &lt;/mx:groupedColumns&gt;\\n &lt;/mx:AdvancedDataGrid&gt;</pre> <p>You use the <code>&lt;mx.AdvancedDataGridColumnGroup&gt;</code> tag to configure a column group of a AdvancedDataGrid control. You specify the <code>&lt;mx.AdvancedDataGridColumnGroup&gt;</code> tag as a child of the <code>groupedColumns</code> property in MXML. The <code>&lt;mx.AdvancedDataGridcolumn&gt;</code> tag defines the following tag attributes:</p> <pre>\\n &lt;mx:AdvancedDataGridColumn\\n <b>Properties </b>\\n children=&quot;<i>No default</i>&quot;\\n childrenDragEnabled=&quot;true|false&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "see",
"values": ["mx.controls.AdvancedDataGrid", "mx.controls.AdvancedDataGrid#columnGroup"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "mxml",
"values": []},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumnGroup",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor. associated with the column group, and the text for the header cell of this column. This is equivalent to setting the <code>dataField</code> and <code>headerText</code> properties.",
"tags": [
{ "tagName": "param",
"values": ["columnName The name of the field in the data provider"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": [{ "name": "columnName", "type": "String"}]}
,
{ "type": "field",
"qname": "children",
"return": "Array",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "An Array of AdvancedDataGridColumn instances that define the columns of the column group.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}