Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
DataGrid

Package | org.apache.flex.html
Class | public class DataGrid
Inheritance | DataGrid UIBase HTMLElementWrapper flash.display.Sprite

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The DataGrid class displays a collection of data using columns and rows. Each column represents a specific field in the data set; each row represents a specific datum. The DataGrid is a composite component built with a org.apache.flex.html.ButtonBar for the column headers and a org.apache.flex.html.List for each column. The DataGrid's view bead (usually org.apache.flex.html.beads.DataGridView) constructs these parts while itemRenderer factories contruct the elements to display the data in each cell.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | $height : Number [read-only] Retrieve the low-level bounding box height. | UIBase
|  | $width : Number [read-only] Retrieve the low-level bounding box width. | UIBase
|  | beads : Array The array property that is used to add additional beads to an MXML tag. | UIBase
|  | className : String The classname. | UIBase
|  | columns : Array The array of org.apache.flex.html.supportClasses.DataGridColumns used to describe each column. | DataGrid
|  | dataProvider : Object The object used to provide data to the org.apache.flex.html.DataGrid. | DataGrid
|  | element : IFlexJSElement [read-only] Each IUIBase has an element that is actually added to the platform's display list DOM. | UIBase
|  | explicitHeight : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | explicitWidth : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | height : Number [override] The height of the component. | UIBase
|  | id : String An id property for MXML documents. | UIBase
|  | measurementBead : IMeasurementBead [read-only] A measurement bead, if one exists. | UIBase
|  | model : Object An IBeadModel that serves as the data model for the component. | UIBase
|  | numElements : int [read-only] The number of elements in the parent. | UIBase
|  | percentHeight : Number The requested percentage height this component should have in the parent container. | UIBase
|  | percentWidth : Number The requested percentage width this component should have in the parent container. | UIBase
|  | presentationModel : IDataGridPresentationModel [read-only] The DataGrid's presentation model | DataGrid
|  | rowHeight : Number The default height of each cell in every column | DataGrid
|  | selectedIndex : int [read-only] The currently selected row. | DataGrid
|  | style : Object The object that contains "styles" and other associated name-value pairs. | UIBase
|  | topMostEventDispatcher : IEventDispatcher [read-only] The top most event dispatcher. | UIBase
|  | typeNames : String A list of type names. | UIBase
|  | view : IBeadView An IBeadView that serves as the view for the component. | UIBase
|  | width : Number [override] The width of the component. | UIBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | DataGrid() constructor. | DataGrid
|  | addBead(bead:IBead):void [override] Add a bead to the strand. | UIBase
|  | addedToParent():void The method called when added to a parent. | UIBase
|  | addElement(c:Object, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | addElementAt(c:Object, index:int, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | getBeadByType(classOrInterface:Class):IBead Find a bead on the strand. | UIBase
|  | getElementAt(index:int):Object Get a component from the parent. | UIBase
|  | getElementIndex(c:Object):int Gets the index of this subcomponent. | UIBase
|  | isHeightSizedToContent():Boolean | UIBase
|  | isWidthSizedToContent():Boolean | UIBase
|  | removeBead(value:IBead):IBead Remove a bead from the strand. | UIBase
|  | removeElement(c:Object, dispatchEvent:Boolean = true):void Remove a component from the parent. | UIBase
|  | setHeight(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidth(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void | UIBase
|  | setX(value:Number):void | UIBase
|  | setY(value:Number):void | UIBase

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | repeaterListener(event:Event):void Rebroadcast an event from a sub component from the component. | UIBase

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | change |  | DataGrid
|  | click | Set a different class for click events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseDown | Set a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseMove | Set a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOut | Set a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOver | Set a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseUp | Set a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOut | Set a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOver | Set a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase

Property Detail

columns | property

`columns:Array`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The array of org.apache.flex.html.supportClasses.DataGridColumns used to describe each column.

Implementation
`public function get columns():Array`
`public function set columns(value:Array):void`

dataProvider | property |

`dataProvider:Object`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The object used to provide data to the org.apache.flex.html.DataGrid.

Implementation
`public function get dataProvider():Object`
`public function set dataProvider(value:Object):void`

presentationModel | property |

`presentationModel:IDataGridPresentationModel` [read-only]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The DataGrid's presentation model

Implementation
`public function get presentationModel():IDataGridPresentationModel`

rowHeight | property |

`rowHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The default height of each cell in every column

Implementation
`public function get rowHeight():Number`
`public function set rowHeight(value:Number):void`

selectedIndex | property |

`selectedIndex:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The currently selected row.

Implementation
`public function get selectedIndex():int`
Constructor Detail

DataGrid | () | Constructor

`public function DataGrid()`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

constructor.

Event Detail

change | Event

Event Object Type: `org.apache.flex.events.Event`

Mon Sep 5 2016, 07:19 AM -07:00