| { "type": "class", | |
| "qname": "mx.controls.DataGrid", | |
| "baseClassname": "mx.controls.listClasses.DataGridListBase" | |
| , | |
| "description": "The <code>DataGrid</code> control is like a List except that it can show more than one column of data making it suited for showing objects with multiple properties. <p> The DataGrid control provides the following features: <ul> <li>Columns of different widths or identical fixed widths</li> <li>Columns that the user can resize at runtime </li> <li>Columns that the user can reorder at runtime </li> <li>Optional customizable column headers</li> <li>Ability to use a custom item renderer for any column to display data other than text</li> <li>Support for sorting the data by clicking on a column</li> </ul> </p> The DataGrid control is intended for viewing data, and not as a layout tool like an HTML table. The mx.containers package provides those layout tools. <p>The DataGrid control has the following default sizing characteristics:</p> <table class="innertable"> <tr> <th>Characteristic</th> <th>Description</th> </tr> <tr> <td>Default size</td> <td>If the columns are empty, the default width is 300 pixels. If the columns contain information but define no explicit widths, the default width is 100 pixels per column. The DataGrid width is sized to fit the width of all columns, if possible. The default number of displayed rows, including the header is 7, and each row, by default, is 20 pixels high. </td> </tr> <tr> <td>Minimum size</td> <td>0 pixels.</td> </tr> <tr> <td>Maximum size</td> <td>5000 by 5000.</td> </tr> </table> <p> The <code><mx:DataGrid></code> tag inherits all of the tag attributes of its superclass, except for <code>labelField</code>, <code>iconField</code>, and <code>iconFunction</code>, and adds the following tag attributes: </p> <pre>\\n <mx:DataGrid\\n <b>Properties</b>\\n columns="<i>From dataProvider</i>"\\n draggableColumns="true|false"\\n editable="false|true"\\n editedItemPosition="<code>null</code>"\\n horizontalScrollPosition="null"\\n imeMode="null"\\n itemEditorInstance="null"\\n minColumnWidth="<code>NaN</code>"\\n resizableColumns="true|false"\\n sortableColumns="true|false"\\n \\n <b>Styles</b>\\n backgroundDisabledColor="0xEFEEEF"\\n columnDropIndicatorSkin="DataGridColumnDropIndicator"\\n columnResizeSkin="DataGridColumnResizeSkin"\\n disabledIconColor="0x999999"\\n headerColors="[#FFFFFF, #E6E6E6]"\\n headerDragProxyStyleName="headerDragProxyStyle"\\n headerSeparatorSkin="DataGridHeaderSeparator"\\n headerStyleName="dataGridStyles"\\n horizontalGridLineColor="0xF7F7F7"\\n horizontalGridLines="false|true"\\n horizontalLockedSeparatorSkin="undefined"\\n horizontalSeparatorSkin="undefined"\\n iconColor="0x111111"\\n rollOverColor="0xB2E1FF"\\n selectionColor="0x7FCEFF"\\n sortArrowSkin="DataGridSortArrow"\\n stretchCursor="<i>"cursorStretch" symbol from the Assets.swf file</i>"\\n verticalGridLineColor="0xCCCCCC"\\n verticalGridLines="false|true"\\n verticalLockedSeparatorSkin="undefined"\\n verticalSeparatorSkin="undefined"\\n \\n <b>Events</b>\\n columnStretch="<i>No default</i>"\\n headerRelease="<i>No default</i>"\\n headerShift="<i>No default</i>"\\n itemEditBegin="<i>No default</i>"\\n itemEditBeginning="<i>No default</i>"\\n itemEditEnd="<i>No default</i>"\\n itemFocusIn="<i>No default</i>"\\n itemFocusOut="<i>No default</i>"\\n />\\n \\n <b>The following DataGrid code sample specifies the column order:</b>\\n <mx:DataGrid>\\n <mx:dataProvider>\\n <mx:Object Artist="Pavement" Price="11.99"\\n Album="Slanted and Enchanted"/>\\n <mx:Object Artist="Pavement"\\n Album="Brighten the Corners" Price="11.99"/>\\n </mx:dataProvider>\\n <mx:columns>\\n <mx:DataGridColumn dataField="Album"/>\\n <mx:DataGridColumn dataField="Price"/>\\n </mx:columns>\\n </mx:DataGrid>\\n </pre> </p>", | |
| "tags": [ | |
| { "tagName": "includeExample", | |
| "values": ["examples/SimpleDataGrid.mxml"]}, | |
| { "tagName": "see", | |
| "values": ["mx.controls.dataGridClasses.DataGridItemRenderer", "mx.controls.dataGridClasses.DataGridColumn", "mx.controls.dataGridClasses.DataGridDragProxy", "mx.events.DataGridEvent"]}, | |
| { "tagName": "mxml", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "mx.controls.DataGrid", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructor.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": []} | |
| , | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Array", | |
| "qname": "columns", | |
| "namespace": "public", | |
| "bindable": ["columnsChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "An array of DataGridColumn objects, one for each column that can be displayed. If not explicitly set, the DataGrid control attempts to examine the first data provider item to determine the set of properties and display those properties in alphabetic order. <p>If you want to change the set of columns, you must get this array, make modifications to the columns and order of columns in the array, and then assign the new array to the columns property. This is because the DataGrid control returned a new copy of the array of columns and therefore did not notice the changes.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "org.apache.royale.core.IBead", | |
| "qname": "presentationModel", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "description": "The DataGrid's presentation model", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10.2", "AIR 2.6"]}, | |
| { "tagName": "productversion", | |
| "values": ["Royale 0.9"]}, | |
| { "tagName": "royaleignorecoercion", | |
| "values": ["org.apache.royale.core.IDataGridPresentationModel", "org.apache.royale.core.IBead"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "addedToParent", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "return": "void", | |
| "params": []} | |
| ] | |
| } |