fl.controls.DataGrid (ActionScript 3.0)

Package	fl.controls
Class	public class DataGrid
Inheritance	DataGrid SelectableList BaseScrollPane UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IFocusManagerComponent

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

The DataGrid class is a list-based component that provides a grid of rows and columns. You can specify an optional header row at the top of the component that shows all the property names. Each row consists of one or more columns, each of which represents a property that belongs to the specified data object. The DataGrid component is used to view data; it is not intended to be used as a layout tool like an HTML table.

A DataGrid component is well suited for the display of objects that contain multiple properties. The data that a DataGrid component displays can be contained in a DataProvider object or as an array of objects. The columns of a DataGrid component can be represented by a list of DataGridColumn objects, each of which contains information that is specific to the column.

The DataGrid component provides the following features:

Columns of different widths or identical fixed widths
Columns that the user can resize at run time
Columns that the user can reorder at run time by using ActionScript
Optional customizable column headers
Support for custom item renderers to display data other than text in any column
Support for sorting data by clicking on the column that contains it

The DataGrid component is composed of subcomponents including ScrollBar, HeaderRenderer, CellRenderer, DataGridCellEditor, and ColumnDivider components, all of which can be skinned during authoring or at run time.

The DataGrid component uses the following classes that can be found in the dataGridClasses package:

DataGridColumn: Describes a column in a DataGrid component. Contains the indexes, widths, and other properties of the column. Does not contain cell data.
HeaderRenderer: Displays the column header for the current DataGrid column. Contains the label and other properties of the column header.
DataGridCellEditor: Manages the editing of the data for each cell.

View the examples

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		allowMultipleSelection : Boolean Gets a Boolean value that indicates whether more than one list item can be selected at a time.	SelectableList
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.	DisplayObject
		columns : Array Gets or sets an array of DataGridColumn objects, one for each column that can be displayed.	DataGrid
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		dataProvider : DataProvider Gets or sets the data model of the list of items to be viewed.	SelectableList
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		editable : Boolean = false Indicates whether or not the user can edit items in the data provider.	DataGrid
		editedItemPosition : Object Gets or sets the column and row index of the item renderer for the data provider item that is being edited.	DataGrid
		editedItemRenderer : ICellRenderer [read-only] Gets a reference to the item renderer in the DataGrid component whose item is currently being edited.	DataGrid
		enabled : Boolean Gets or sets a value that indicates whether the component can accept user interaction.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		headerHeight : Number Gets or sets the height of the DataGrid header, in pixels.	DataGrid
		height : Number Gets or sets the height of the component, in pixels.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		horizontalLineScrollSize : Number Gets or sets a value that describes the amount of content to be scrolled, horizontally, when a scroll arrow is clicked.	BaseScrollPane
		horizontalPageScrollSize : Number Gets or sets the count of pixels by which to move the scroll thumb on the horizontal scroll bar when the scroll bar track is pressed.	BaseScrollPane
		horizontalScrollBar : ScrollBar [read-only] Gets a reference to the horizontal scroll bar.	BaseScrollPane
		horizontalScrollPolicy : String Gets or sets a Boolean value that indicates whether the horizontal scroll bar is always on.	DataGrid
		horizontalScrollPosition : Number Gets or sets a value that describes the horizontal position of the horizontal scroll bar in the scroll pane, in pixels.	BaseScrollPane
		imeMode : String Gets or sets the mode of the input method editor (IME).	DataGrid
		itemEditorInstance : Object A reference to the currently active instance of the item editor, if one exists.	DataGrid
		labelFunction : Function Gets or sets a function that determines which fields of each item to use for the label text.	DataGrid
		length : uint [read-only] Gets the number of items in the data provider.	SelectableList
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		maxHorizontalScrollPosition : Number Gets or sets the number of pixels that the list scrolls to the right when the horizontalScrollPolicy property is set to ScrollPolicy.ON.	SelectableList
		maxVerticalScrollPosition : Number [read-only] Gets the maximum vertical scroll position for the current content, in pixels.	BaseScrollPane
		minColumnWidth : Number Gets or sets the minimum width of a DataGrid column, in pixels.	DataGrid
		mouseChildren : Boolean Determines whether or not the children of the object are mouse enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse messages.	InteractiveObject
		mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		resizableColumns : Boolean = true Indicates whether the user can change the size of the columns.	DataGrid
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rowCount : uint Gets or sets the number of rows that are at least partially visible in the list.	DataGrid
		rowHeight : Number Gets or sets the height of each row in the DataGrid component, in pixels.	DataGrid
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number Multiplies the current width of the component by a scale factor.	UIComponent
		scaleY : Number Multiplies the current height of the component by a scale factor.	UIComponent
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		selectable : Boolean Gets or sets a Boolean value that indicates whether the items in the list can be selected.	SelectableList
		selectedIndex : int Gets or sets the index of the item that is selected in a single-selection list.	SelectableList
		selectedIndices : Array Gets or sets an array that contains the items that were selected from a multiple-selection list.	SelectableList
		selectedItem : Object Gets or sets the item that was selected from a single-selection list.	SelectableList
		selectedItems : Array Gets or sets an array that contains the objects for the items that were selected from the multiple-selection list.	SelectableList
		showHeaders : Boolean Gets or sets a Boolean value that indicates whether the DataGrid component shows column headers.	DataGrid
		sortableColumns : Boolean = true Indicates whether the user can sort the items in the data provider by clicking on a column header cell.	DataGrid
		sortDescending : Boolean [read-only] Gets the order in which a column is sorted when the user clicks its header.	DataGrid
		sortIndex : int [read-only] Gets the index of the column to be sorted.	DataGrid
		soundTransform : SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textSnapshot : TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		transform : Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		useBitmapScrolling : Boolean When set to true, the cacheAsBitmap property for the scrolling content is set to true; when set to false this value is turned off.	BaseScrollPane
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.	Sprite
		version : String = "3.0.0.15" The version number of the components.	UIComponent
		verticalLineScrollSize : Number Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked.	BaseScrollPane
		verticalPageScrollSize : Number Gets or sets the count of pixels by which to move the scroll thumb on the vertical scroll bar when the scroll bar track is pressed.	BaseScrollPane
		verticalScrollBar : ScrollBar [read-only] Gets a reference to the vertical scroll bar.	BaseScrollPane
		verticalScrollPolicy : String Gets or sets a value that indicates the state of the vertical scroll bar.	BaseScrollPane
		verticalScrollPosition : Number Gets or sets a value that describes the vertical position of the vertical scroll bar in the scroll pane, in pixels.	BaseScrollPane
		visible : Boolean Gets or sets a value that indicates whether the current component instance is visible.	UIComponent
		width : Number Gets or sets the width of the component, in pixels.	UIComponent
		x : Number Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.	UIComponent
		y : Number Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.	UIComponent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DataGrid() Creates a new DataGrid component instance.	DataGrid
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addColumn(column:*):DataGridColumn Adds a column to the end of the columns array.	DataGrid
		addColumnAt(column:*, index:uint):DataGridColumn Inserts a column at the specified index in the columns array.	DataGrid
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		addItem(item:Object):void Appends an item to the end of the list of items.	SelectableList
		addItemAt(item:Object, index:uint):void Inserts an item into the list at the specified index location.	SelectableList
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		clearRendererStyle(name:String, column:int = -1):void Clears a style that is set on the renderers in the list.	SelectableList
		clearSelection():void Clears the currently selected item in the list and sets the selectedIndex property to -1.	SelectableList
		clearStyle(style:String):void Deletes a style property from this component instance.	UIComponent
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		createItemEditor(colIndex:uint, rowIndex:uint):void Uses the editor specified by the itemEditor property to create an item editor for the item renderer at the column and row index identified by the editedItemPosition property.	DataGrid
		destroyItemEditor():void Closes an item editor that is currently open on an item renderer.	DataGrid
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component.	UIComponent
		drawNow():void Initiates an immediate draw operation, without invalidating everything as invalidateNow does.	UIComponent
		editField(index:uint, dataField:String, data:Object):void Edits a given field or property in the DataGrid component.	DataGrid
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getCellRendererAt(row:uint, column:uint):ICellRenderer Get the instance of a cell renderer at the specified position in the DataGrid.	DataGrid
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getColumnAt(index:uint):DataGridColumn Retrieves the column that is located at the specified index of the columns array.	DataGrid
		getColumnCount():uint Retrieves the number of columns in the DataGrid component.	DataGrid
		getColumnIndex(name:String):int Retrieves the index of the column of the specified name, or -1 if no match is found.	DataGrid
		getFocus():InteractiveObject Retrieves the object that currently has focus.	UIComponent
		getItemAt(index:uint):Object Retrieves the item at the specified index.	SelectableList
		getNextIndexAtLetter(firstLetter:String, startIndex:int = -1):int Returns the index of the next item in the dataProvider in which the label's first character matches a specified string character.	SelectableList
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		getRendererStyle(name:String, column:int = -1):Object Retrieves a style that is set on the renderers in the list.	SelectableList
		getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component.	UIComponent
		getStyleDefinition():Object [static] Retrieves the default style map for the current component.	DataGrid
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the display object to see if it overlaps or intersects with the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified.	UIComponent
		invalidateItem(item:Object):void Invalidates a specific item renderer.	SelectableList
		invalidateItemAt(index:uint):void Invalidates the renderer for the item at the specified index.	SelectableList
		invalidateList():void Invalidates the whole list, forcing the list items to be redrawn.	SelectableList
		isItemSelected(item:Object):Boolean Checks whether the specified item is selected in the list.	SelectableList
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		itemToCellRenderer(item:Object):ICellRenderer The DataGrid component has multiple cells for any given item, so the itemToCellRenderer method always returns null.	DataGrid
		itemToLabel(item:Object):String Retrieves the string that the renderer displays for the given data object based on the label properties of the object.	SelectableList
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object.	UIComponent
		move(x:Number, y:Number):void Moves the component to the specified position within its parent.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeAll():void Removes all items from the list.	SelectableList
		removeAllColumns():void Removes all columns from the DataGrid component.	DataGrid
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeColumnAt(index:uint):DataGridColumn Removes the column that is located at the specified index of the columns array.	DataGrid
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		removeItem(item:Object):Object Removes the specified item from the list.	SelectableList
		removeItemAt(index:uint):Object Removes the item at the specified index position.	SelectableList
		replaceItemAt(item:Object, index:uint):Object Replaces the item at the specified index location with another item.	SelectableList
		scrollToIndex(newCaretIndex:int):void Scrolls the list to the item at the specified index.	DataGrid
		scrollToSelected():void Scrolls the list to the item at the location indicated by the current value of the selectedIndex property.	SelectableList
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setFocus():void Sets the focus to this component.	UIComponent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setRendererStyle(name:String, style:Object, column:uint = 0):void Sets a style on the renderers in the list.	SelectableList
		setSize(width:Number, height:Number):void Sets the component to the specified width and height.	UIComponent
		setStyle(style:String, value:Object):void Sets a style property on this component instance.	UIComponent
		sortItems(... sortArgs):* Sorts the elements of the current data provider.	SelectableList
		sortItemsOn(field:String, options:Object = null):* Sorts the elements of the current data provider by one or more of its fields.	SelectableList
		spaceColumnsEqually():void Resets the widths of the visible columns to the same size.	DataGrid
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toString():String Returns the string representation of the specified object.	Object
		validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	Summary	Defined By
activate	Dispatched when Flash Player or an AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
change	Dispatched when a different item is selected in the list.	SelectableList
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
columnStretch	Dispatched after a user expands a column horizontally.	DataGrid
contextMenu