IDataGridElement - Adobe ActionScript® 3 (AS3 Flex) API Reference

Package	spark.components.gridClasses
Interface	public interface IDataGridElement extends IVisualElement , ILayoutManagerClient , IInvalidating , ILayoutElement , ILayoutDirectionElement , IEventDispatcher
Implementors	Grid, GridColumnHeaderGroup

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

Visual elements of the Spark DataGrid control that must remain in sync with the grid's layout and scroll position must implement this interface. When the DataGrid control's grid skin part is added, it sets the IDataGridElement.dataGrid property. The IDataGridElements object can respond by adding event listeners for scroll position changes. When the DataGrid control is changed in a way that affects its row or column layout, all IDataGridElements object are invalidated.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		alpha : Number Indicates the alpha transparency value of the object specified.	IVisualElement
		baseline : Object The vertical distance in pixels from the anchor target to the control's baseline position.	ILayoutElement
		baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component.	ILayoutElement
		bottom : Object The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.	ILayoutElement
		dataGrid : DataGrid The DataGrid control associated with this element.	IDataGridElement
		depth : Number Determines the order in which items inside of containers are rendered.	IVisualElement
		designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element.	IVisualElement
		hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix.	ILayoutElement
		height : Number Indicates the height of the display object, in pixels.	IVisualElement
		horizontalCenter : Object The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	ILayoutElement
		initialized : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required) This flag should only be modified by the LayoutManager.	ILayoutManagerClient
		is3D : Boolean [read-only] Contains true when the element is in 3D.	IVisualElement
		layoutDirection : String Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit).	ILayoutDirectionElement
		left : Object The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.	ILayoutElement
		nestLevel : int The top-level SystemManager has a nestLevel of 1.	ILayoutManagerClient
		owner : DisplayObjectContainer The owner of this IVisualElement object.	IVisualElement
		parent : DisplayObjectContainer [read-only] The parent container or component for this component.	IVisualElement
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	ILayoutElement
		percentWidth : Number Specifies the width of a component as a percentage of its parent's size.	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.	IVisualElement
		processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens.	ILayoutManagerClient
		right : Object The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.	ILayoutElement
		top : Object The vertical distance in pixels from the top edge of the component to the anchor target's top edge.	ILayoutElement
		updateCompletePendingFlag : Boolean A flag that determines if an object is waiting to have its updateComplete event dispatched.	ILayoutManagerClient
		verticalCenter : Object The vertical distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		visible : Boolean Controls the visibility of this visual element.	IVisualElement
		width : Number Indicates the width of the display object, in pixels.	IVisualElement
		x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	IVisualElement
		y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	IVisualElement

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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.	IEventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	IEventDispatcher
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	ILayoutElement
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	ILayoutElement
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	ILayoutElement
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	ILayoutElement
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	ILayoutElement
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	ILayoutElement
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	ILayoutElement
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	ILayoutElement
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	ILayoutElement
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	ILayoutElement
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	ILayoutElement
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	ILayoutElement
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		invalidateDisplayList():void Calling this method results in a call to the component's validateDisplayList() method before the display list is rendered.	IInvalidating
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	ILayoutDirectionElement
		invalidateProperties():void Calling this method results in a call to the component's validateProperties() method before the display list is rendered.	IInvalidating
		invalidateSize():void Calling this method results in a call to the component's validateSize() method before the display list is rendered.	IInvalidating
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	IEventDispatcher
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	ILayoutElement
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	ILayoutElement
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	ILayoutElement
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	ILayoutElement
		transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.	ILayoutElement
		validateDisplayList():void Validates the position and size of children and draws other visuals.	ILayoutManagerClient
		validateNow():void Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary.	IInvalidating
		validateProperties():void Validates the properties of a component.	ILayoutManagerClient
		validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.	ILayoutManagerClient
		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.	IEventDispatcher

Property Detail

dataGrid

property

dataGrid:DataGrid

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

The DataGrid control associated with this element.

Implementation
public function get dataGrid():DataGrid
public function set dataGrid(value:DataGrid):void

IDataGridElement - AS3 Flex

Classes x

dataGrid

spark.components.gridClasses IDataGridElement - AS3 Flex		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples