blob: 2ec66b49afdfc15f237ef877ba51532f41d8bce7 [file] [log] [blame]
{ "type": "class",
"qname": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumn",
"baseClassname": "mx.controls.dataGridClasses.DataGridColumn"
,
"description": "The AdvancedDataGridColumn class describes a column in an AdvancedDataGrid control. There is one AdvancedDataGridColumn per displayable column, even if a column is hidden or off-screen. The data provider items of an AdvancedDataGrid control can contain properties that are not displayed, and therefore, do not need an AdvancedDataGridColumn. An AdvancedDataGridColumn allows specification of the color and font of the text in a column; specification of what kind of component displays the data for the column; specification of whether the column is editable, sortable, or resizeable; and specification of the text for the column header. <p><strong>Notes:</strong><ul> <li>An AdvancedDataGridColumn only holds information about a column; it is not the parent of the item renderers in the column.</li> <li>If you specify an AdvancedDataGridColumn class without a <code>dataField</code> property, you must specify a <code>sortCompareFunction</code> property. Otherwise, sort operations may cause run-time errors.</li></ul> </p> <p>You use the <code>&lt;mx.AdvancedDataGridcolumn&gt;</code> tag to configure a column of a AdvancedDataGrid control. You specify the <code>&lt;mx.AdvancedDataGridcolumn&gt;</code> tag as a child of the <code>columns</code> property in MXML. The <code>&lt;mx.AdvancedDataGridcolumn&gt;</code> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:</p> <pre>\\n &lt;mx:AdvancedDataGridColumn\\n <b>Properties </b>\\n dataField=&quot;<i>No default</i>&quot;\\n dataTipField=&quot;<i>No default</i>&quot;\\n dataTipFunction=&quot;<i>No default</i>&quot;\\n editable=&quot;true|false&quot;\\n editorDataField=&quot;text&quot;\\n editorHeightOffset=&quot;0&quot;\\n editorUsesEnterKey=&quot;false|true&quot;\\n editorWidthOffset=&quot;0&quot;\\n editorXOffset=&quot;0&quot;\\n editorYOffset=&quot;0&quot;\\n formatter=&quot;null&quot;\\n headerRenderer=&quot;AdvancedDataGridHeaderRenderer&quot;\\n headerText=&quot;<i>No default</i>&quot;\\n headerWordWrap=&quot;undefined&quot;\\n imeMode=&quot;null&quot;\\n itemEditor=&quot;TextInput&quot;\\n itemRenderer=&quot;AdvancedDataGridItemRenderer&quot;\\n labelFunction=&quot;<i>No default</i>&quot;\\n minWidth=&quot;20&quot;\\n rendererIsEditor=&quot;false|true&quot;\\n resizable=&quot;true|false&quot;\\n showDataTips=&quot;false|true&quot;\\n sortable=&quot;true|false&quot;\\n sortCompareFunction=&quot;<i>No default</i>&quot;\\n sortDescending=&quot;false|true&quot;\\n styleFunction=&quot;<i>No default</i>&quot;\\n visible=&quot;true|false&quot;\\n width=&quot;100&quot;\\n wordWrap=&quot;false|true&quot;\\n \\n <b>Styles</b>\\n backgroundColor=&quot;0xFFFFFF&quot;\\n color=&quot;<i>No default.</i>&quot;\\n disabledColor=&quot;0xAAB3B3&quot;\\n fontAntiAliasType=&quot;advanced&quot;\\n fontFamily=&quot;<i>No default</i>&quot;\\n fontGridFitType=&quot;pixel&quot;\\n fontSharpness=&quot;0&quot;\\n fontSize=&quot;<i>No default</i>&quot;\\n fontStyle=&quot;normal|italic&quot;\\n fontThickness=&quot;0&quot;\\n fontWeight=&quot;normal|bold&quot;\\n headerStyleName=&quot;<i>No default</i>&quot;\\n kerning=&quot;false|true&quot;\\n letterSpacing=&quot;0&quot;\\n paddingLeft=&quot;0&quot;\\n paddingRight=&quot;0&quot;\\n textAlign=&quot;right|center|left&quot;\\n textDecoration=&quot;none|underline&quot;\\n textIndent=&quot;0&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "see",
"values": ["mx.controls.AdvancedDataGrid", "mx.styles.CSSStyleDeclaration"]},
{ "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": "accessor",
"access": "read-only",
"return": "mx.core.IFactory",
"qname": "defaultItemEditorFactory",
"namespace": "mx_internal",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "method",
"qname": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumn",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor. associated with the column, 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": "accessor",
"access": "read-write",
"return": "String",
"qname": "fontWeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "fontSize",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "uint",
"qname": "color",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "field",
"qname": "editable",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A flag that indicates whether the items in the column are editable. If <code>true</code>, and the AdvancedDataGrid's <code>editable</code> property is also <code>true</code>, the items in a column are editable and can be individually edited by clicking an item or by navigating to the item with the Tab and Arrow keys.",
"tags": [
{ "tagName": "default",
"values": ["true"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "itemEditor",
"return": "mx.core.IFactory",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A class factory for the instances of the item editor to use for the column, when it is editable. <p>The default value is the mx.controls.TextInput control.</p>",
"tags": [
{ "tagName": "see",
"values": ["mx.controls.TextInput"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "editorDataField",
"return": "String",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The name of the property of the item editor that contains the new data for the list item. For example, the default <code>itemEditor</code> is TextInput, so the default value of the <code>editorDataField</code> property is <code>&quot;text&quot;</code>, which specifies the <code>text</code> property of the TextInput control.",
"tags": [
{ "tagName": "default",
"values": [""text""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "editorHeightOffset",
"return": "Number",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The height of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.",
"tags": [
{ "tagName": "default",
"values": ["0"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "editorWidthOffset",
"return": "Number",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The width of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.",
"tags": [
{ "tagName": "default",
"values": ["0"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "editorXOffset",
"return": "Number",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The x location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.",
"tags": [
{ "tagName": "default",
"values": ["0"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "editorYOffset",
"return": "Number",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The y location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.",
"tags": [
{ "tagName": "default",
"values": ["0"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "editorUsesEnterKey",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A flag that indicates whether the item editor uses Enter key. If <code>true</code> the item editor uses the Enter key and the AdvancedDataGrid will not look for the Enter key and move the editor in response. Note that changing this value while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.",
"tags": [
{ "tagName": "default",
"values": ["false"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.core.IFactory",
"qname": "headerRenderer",
"namespace": "public",
"bindable": ["headerRendererChanged"],
"details": [],
"deprecated": {},
"description": "The class factory for item renderer instances that display the column header for the column. You can specify a drop-in item renderer, an inline item renderer, or a custom item renderer component as the value of this property. <p>The default item renderer is the AdvancedDataGridItemRenderer class, which displays the item data as text. </p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "*",
"qname": "headerWordWrap",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Set to <code>true</code> to wrap the text in the column header if it does not fit on one line. If <code>undefined</code>, the AdvancedDataGrid control's <code>wordWrap</code> property is used. This property overrides the <code>headerWordWrap</code> property of the AdvancedDataGrid control.",
"tags": [
{ "tagName": "default",
"values": ["undefined"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Function",
"qname": "styleFunction",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A callback function that is called when rendering each cell. The signature of the function should be: <pre>function myStyleFunction(data:Object, column:AdvancedDataGridColumn):Object</pre> <p><code>data</code> - data object associated with the item being rendered.</p> <p><code>column</code> - AdvancedDataGridColumn instance with which the item renderer is associated.</p> <p>The return value should be a object with styles as properties having the required values. For example: </p> <pre>{ color:0xFF0000, fontWeight:&quot;bold&quot; }</pre>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "clone",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Clone this column and return a new Column with the same properties and styles as this one. It does not set all the available properties",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "return",
"values": ["col AdvancedDataGridColumn."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumn",
"params": []}
]
}