Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
spark.core 
SpriteVisualElement 
Packagespark.core
Classpublic class SpriteVisualElement
InheritanceSpriteVisualElement Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IVisualElement, IMXMLObject, IFlexModule

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The SpriteVisualElement class is a light-weight Sprite-based implemention of the IVisualElement interface. Spark containers can lay out and render SpriteVisualElement objects.

If you use ActionScript to add an FXG component to an application, it should be of type SpriteVisualElement.



Public Properties
 PropertyDefined By
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
  baseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
SpriteVisualElement
  baselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
SpriteVisualElement
  blendMode : String
[override] A value from the BlendMode class that specifies which blend mode to use.
SpriteVisualElement
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
  bottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
SpriteVisualElement
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 InheritedAIR-only cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
  depth : Number
Determines the order in which items inside of containers are rendered.
SpriteVisualElement
  designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
SpriteVisualElement
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
  hasLayoutMatrix3D : Boolean
[read-only] Contians true if the element has 3D Matrix.
SpriteVisualElement
 Inheritedheight : Number
Indicates the height of the display object, in pixels.
DisplayObject
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
  horizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
SpriteVisualElement
  id : String
The identity of the component.
SpriteVisualElement
  includeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
SpriteVisualElement
  is3D : Boolean
[read-only] Contains true when the element is in 3D.
SpriteVisualElement
  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).
SpriteVisualElement
  left : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
SpriteVisualElement
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
  luminosityClip : Boolean
A property that controls whether the luminosity mask clips the masked content.
SpriteVisualElement
  luminosityInvert : Boolean
A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask.
SpriteVisualElement
  mask : DisplayObject
[override] Sets the mask.
SpriteVisualElement
  maskType : String
The mask type.
SpriteVisualElement
  moduleFactory : IFlexModuleFactory
A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.
SpriteVisualElement
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
  owner : DisplayObjectContainer
The owner of this IVisualElement object.
SpriteVisualElement
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
DisplayObject
  percentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
SpriteVisualElement
  percentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
SpriteVisualElement
  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.
SpriteVisualElement
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  right : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
SpriteVisualElement
 Inheritedroot : 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
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
  rotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
SpriteVisualElement
  rotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
SpriteVisualElement
 InheritedrotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point.
DisplayObject
 InheritedscaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 InheritedscaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
  top : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
SpriteVisualElement
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
  transformX : Number
Sets the x coordinate for the transform center of the component.
SpriteVisualElement
  transformY : Number
Sets the y coordinate for the transform center of the component.
SpriteVisualElement
  transformZ : Number
Sets the z coordinate for the transform center of the component.
SpriteVisualElement
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
  verticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
SpriteVisualElement
  visible : Boolean
[override] Controls the visibility of this visual element.
SpriteVisualElement
 Inheritedwidth : Number
Indicates the width of the display object, in pixels.
DisplayObject
 Inheritedx : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
DisplayObject
 Inheritedy : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
DisplayObject
 Inheritedz : Number
Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
DisplayObject
Protected Properties
 PropertyDefined By
  viewHeight : Number
[write-only] Defines the vertical space that the graphic uses in the layout.
SpriteVisualElement
  viewWidth : Number
[write-only] Defines the horizontal space that the graphic uses in the layout.
SpriteVisualElement
Public Methods
 MethodDefined By
  
Constructor.
SpriteVisualElement
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
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
 Inherited
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
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
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
  
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
SpriteVisualElement
  
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
SpriteVisualElement
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
  
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
SpriteVisualElement
  
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
SpriteVisualElement
  
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
SpriteVisualElement
  
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
SpriteVisualElement
  
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
SpriteVisualElement
  
Returns the layout transform Matrix3D for this element.
SpriteVisualElement
  
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
SpriteVisualElement
  
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
SpriteVisualElement
  
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
SpriteVisualElement
  
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
SpriteVisualElement
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
  
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
SpriteVisualElement
  
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
SpriteVisualElement
 Inherited
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
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
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
  
Called automatically by the MXML compiler when the SpriteVisualElement is created using an MXML tag.
SpriteVisualElement
  
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
SpriteVisualElement
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
  
setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
SpriteVisualElement
  
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
SpriteVisualElement
  
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.
SpriteVisualElement
  
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.
SpriteVisualElement
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
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
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
  
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.
SpriteVisualElement
  
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
SpriteVisualElement
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
  
Invalidates parent size and display list if this object affects its layout (includeInLayout is true).
SpriteVisualElement
  
transformHeightForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Transform the element's size.
SpriteVisualElement
  
transformWidthForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Transform the element's size.
SpriteVisualElement
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched 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
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a fingers from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outisde the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
Property Detail

baseline

property
baseline:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The vertical distance in pixels from the anchor target to the control's baseline position.

By default the anchor target is the top edge of the container's content area. In layouts with advanced constraints, the target can be a constraint row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format: "anchorTargetName:value". For example, "row1:10".



Implementation
    public function get baseline():Object
    public function set baseline(value:Object):void

baselinePosition

property 
baselinePosition:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The y-coordinate of the baseline of the first line of text of the component.

This property is used to implement the baseline constraint style. It is also used to align the label of a FormItem with the controls in the FormItem.

Each component should override this property.



Implementation
    public function get baselinePosition():Number

blendMode

property 
blendMode:String[override]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

A value from the BlendMode class that specifies which blend mode to use.

The default value is auto.



Implementation
    override public function get blendMode():String
    override public function set blendMode(value:String):void

See also

bottom

property 
bottom:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format: "anchorTargetName:value". For example, "row1:10".



Implementation
    public function get bottom():Object
    public function set bottom(value:Object):void

depth

property 
depth:Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Determines the order in which items inside of containers are rendered. Spark containers order their items based on their depth property, with the lowest depth in the back, and the higher in the front. Items with the same depth value appear in the order they are added to the container.



Implementation
    public function get depth():Number
    public function set depth(value:Number):void

designLayer

property 
designLayer:DesignLayer

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies the optional DesignLayer instance associated with this visual element.

When a DesignLayer is assigned, a visual element must consider the visibility and alpha of its parent layer when ultimately committing its own effective visibility or alpha to its backing DisplayObject (if applicable).

A visual element must listen for layerPropertyChange notifications from the associated layer parent. When the effectiveAlpha or effectiveVisibility of the layer changes, the element must then compute its own effective visibility (or alpha) and apply it accordingly.

This property should not be set within MXML directly.

The designLayer property is not used for z-order control, please see depth.



Implementation
    public function get designLayer():DesignLayer
    public function set designLayer(value:DesignLayer):void

hasLayoutMatrix3D

property 
hasLayoutMatrix3D:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Contians true if the element has 3D Matrix.

Use hasLayoutMatrix3D instead of calling and examining the return value of getLayoutMatrix3D() becasue that method returns a valid matrix even when the element is in 2D.



Implementation
    public function get hasLayoutMatrix3D():Boolean

horizontalCenter

property 
horizontalCenter:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.

The default anchor target is the container itself.

In layouts with advanced constraints, the anchor target can be a constraint column. Then the content area is the space between the preceding column (or container side) and the target column.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "constraintColumnId:value". For example, "col1:10".



Implementation
    public function get horizontalCenter():Object
    public function set horizontalCenter(value:Object):void

id

property 
id:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The identity of the component.



Implementation
    public function get id():String
    public function set id(value:String):void

includeInLayout

property 
includeInLayout:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether this component is included in the layout of the parent container. If true, the object is included in its parent container's layout and is sized and positioned by its parent container as per its layout rules. If false, the object size and position are not affected by its parent container's layout.



Implementation
    public function get includeInLayout():Boolean
    public function set includeInLayout(value:Boolean):void

is3D

property 
is3D:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Contains true when the element is in 3D. The element can be in 3D either because it has 3D transform properties or it has 3D post layout transform offsets or both.



Implementation
    public function get is3D():Boolean

layoutDirection

property 
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). This property is typically backed by an inheriting style. If null, the layoutDirection style will be set to undefined. Classes like GraphicElement, which implement ILayoutDirectionElement but do not support styles, must additionally support a null value for this property which means the layoutDirection must be inherited from its parent.



Implementation
    public function get layoutDirection():String
    public function set layoutDirection(value:String):void

left

property 
left:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint column.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "col1:10".



Implementation
    public function get left():Object
    public function set left(value:Object):void

luminosityClip

property 
luminosityClip:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

A property that controls whether the luminosity mask clips the masked content. This property can only have an effect if the graphic element has a mask applied to it that is of type MaskType.LUMINOSITY.



Implementation
    public function get luminosityClip():Boolean
    public function set luminosityClip(value:Boolean):void

luminosityInvert

property 
luminosityInvert:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask. If true, the RGB color value of a pixel in the source content is inverted and multipled by the corresponding region in the mask. If false, the source content's pixel's RGB color value is used directly.



Implementation
    public function get luminosityInvert():Boolean
    public function set luminosityInvert(value:Boolean):void

mask

property 
mask:DisplayObject[override]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Sets the mask. The mask will be added to the display list. The mask must not already on a display list nor in the elements array.



Implementation
    override public function get mask():DisplayObject
    override public function set mask(value:DisplayObject):void

maskType

property 
maskType:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The mask type. Possible values are MaskType.CLIP, MaskType.ALPHA or MaskType.LUMINOSITY.

Clip Masking

When masking in clip mode, a clipping masks is reduced to 1-bit. This means that a mask will not affect the opacity of a pixel in the source content; it either leaves the value unmodified, if the corresponding pixel in the mask is has a non-zero alpha value, or makes it fully transparent, if the mask pixel value has an alpha value of zero.

Alpha Masking

In alpha mode, the opacity of each pixel in the source content is multiplied by the opacity of the corresponding region of the mask. i.e., a pixel in the source content with an opacity of 1 that is masked by a region of opacity of .5 will have a resulting opacity of .5. A source pixel with an opacity of .8 masked by a region with opacity of .5 will have a resulting opacity of .4.

Luminosity Masking

A luminosity mask, sometimes called a 'soft mask', works very similarly to an alpha mask except that both the opacity and RGB color value of a pixel in the source content is multiplied by the opacity and RGB color value of the corresponding region in the mask.

Luminosity masking is not native to Flash but is common in Adobe Creative Suite tools like Adobe Illustrator and Adobe Photoshop. In order to accomplish the visual effect of a luminosity mask in Flash-rendered content, a graphic element specifying a luminosity mask actually instantiates a shader filter that mimics the visual look of a luminosity mask as rendered in Adobe Creative Suite tools.

Objects being masked by luminosity masks can set properties to control the RGB color value and clipping of the mask. See the luminosityInvert and luminosityClip attributes.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get maskType():String
    public function set maskType(value:String):void

moduleFactory

property 
moduleFactory:IFlexModuleFactory

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 9, AIR 1.1

A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.



Implementation
    public function get moduleFactory():IFlexModuleFactory
    public function set moduleFactory(value:IFlexModuleFactory):void

owner

property 
owner:DisplayObjectContainer

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The owner of this IVisualElement object. By default, it is the parent of this IVisualElement object. However, if this IVisualElement object is a child component that is popped up by its parent, such as the drop-down list of a ComboBox control, the owner is the component that popped up this IVisualElement object.

This property is not managed by Flex, but by each component. Therefore, if you use the PopUpManger.createPopUp() or PopUpManger.addPopUp() method to pop up a child component, you should set the owner property of the child component to the component that popped it up.

The default value is the value of the parent property.



Implementation
    public function get owner():DisplayObjectContainer
    public function set owner(value:DisplayObjectContainer):void

percentHeight

property 
percentHeight:Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0-100. Setting the height or explicitHeight properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.



Implementation
    public function get percentHeight():Number
    public function set percentHeight(value:Number):void

percentWidth

property 
percentWidth:Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies the width of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the width or explicitWidth properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.

This property is always set to NaN for the UITextField control.

When used with Spark layouts, this property is used to calculate the width of the component's bounds after scaling and rotation. For example if the component is rotated at 90 degrees, then specifying percentWidth will affect the component's height.



Implementation
    public function get percentWidth():Number
    public function set percentWidth(value:Number):void

postLayoutTransformOffsets

property 
postLayoutTransformOffsets:mx.geom:TransformOffsets

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

For example, if you want a layout to adjust for an object that is rotated 90 degrees, set the object's rotation property. If you want the layout to not adjust for the object being rotated, set its postLayoutTransformOffsets.rotationZ property.



Implementation
    public function get postLayoutTransformOffsets():mx.geom:TransformOffsets
    public function set postLayoutTransformOffsets(value:mx.geom:TransformOffsets):void

right

property 
right:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint column.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "col1:10".



Implementation
    public function get right():Object
    public function set right(value:Object):void

rotationX

property 
rotationX:Number[override]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.



Implementation
    override public function get rotationX():Number
    override public function set rotationX(value:Number):void

rotationY

property 
rotationY:Number[override]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.



Implementation
    override public function get rotationY():Number
    override public function set rotationY(value:Number):void

top

property 
top:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The vertical distance in pixels from the top edge of the component to the anchor target's top edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "row1:10".



Implementation
    public function get top():Object
    public function set top(value:Object):void

transformX

property 
transformX:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the x coordinate for the transform center of the component.

When this object is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformX, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Setting this property on the Spark effect class overrides the setting on the target object.



Implementation
    public function get transformX():Number
    public function set transformX(value:Number):void

See also

transformY

property 
transformY:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the y coordinate for the transform center of the component.

When this object is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformY, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Setting this property on the Spark effect class overrides the setting on the target object.



Implementation
    public function get transformY():Number
    public function set transformY(value:Number):void

See also

transformZ

property 
transformZ:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the z coordinate for the transform center of the component.

When this object is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformZ, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Setting this property on the Spark effect class overrides the setting on the target object.



Implementation
    public function get transformZ():Number
    public function set transformZ(value:Number):void

See also

verticalCenter

property 
verticalCenter:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The vertical distance in pixels from the center of the component to the center of the anchor target's content area.

The default anchor target is the container itself.

In layouts with advanced constraints, the anchor target can be a constraint row. Then the content area is the space between the preceding row (or container side) and the target row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "constraintColumnId:value". For example, "row1:10".



Implementation
    public function get verticalCenter():Object
    public function set verticalCenter(value:Object):void

viewHeight

property 
viewHeight:Number  [write-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Defines the vertical space that the graphic uses in the layout. When you set this value, the content is not scaled. Whereas, if you specify the value of the height property, the content is scaled.

There are two cases where this can be useful: 1) Specify a viewHeight larger than the natural size of the content. You might do this so that the graphic takes up more space than its visual size. 2) Specify a viewHeight that is smaller than the natural size of the content. You might do this if your graphic has extra chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.



Implementation
    protected function set viewHeight(value:Number):void

viewWidth

property 
viewWidth:Number  [write-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Defines the horizontal space that the graphic uses in the layout. When you set this value, the content is not scaled. Whereas, if you specify the value of the width property, the content is scaled.

There are two cases where this can be useful: 1) Specify a viewWidth larger than the natural size of the content. You might do this so that the graphic takes up more space than its visual size. 2) Specify a viewWidth that is smaller than the natural size of the content. You might do this if your graphic has extra chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.



Implementation
    protected function set viewWidth(value:Number):void

visible

property 
visible:Boolean[override]

Controls the visibility of this visual element. If true, the object is visible.

If an object is not visible, but the includeInLayout property is set to true, then the object takes up space in the container, but is invisible.

If visible is set to true, the object may not necessarily be visible due to its size and whether container clipping is enabled.

Setting visible to false, prevents the component from getting focus.



Implementation
    override public function get visible():Boolean
    override public function set visible(value:Boolean):void
Constructor Detail

SpriteVisualElement

()Constructor
public function SpriteVisualElement()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Method Detail

getBoundsXAtSize

()method
public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the x coordinate of the element's bounds at the specified element size. This method is typically used by layouts during a call to the measure() method to predict what the element position will be, if the element is resized to particular dimensions.

Parameters

width:Number — The element's bounds width, or NaN to use the preferred width.
 
height:Number — The element's bounds height, or NaN to use the preferred height.
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns x coordinate of the element's bounding box top-left corner. Bounding box is in element's parent coordinate space and is calculated from the specified bounds size, layout position and layout transform matrix.

Returns
Number

getBoundsYAtSize

()method 
public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the y coordinate of the element's bounds at the specified element size. This method is typically used by layouts during a call to the measure() to predict what the element position will be, if the element is resized to particular dimensions.

Parameters

width:Number — The element's bounds width, or NaN to use the preferred width.
 
height:Number — The element's bounds height, or NaN to use the preferred height.
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns y coordinate of the element's bounding box top-left corner. Bounding box is in element's parent coordinate space and is calculated from the specified bounds size, layout position and layout transform matrix.

Returns
Number

getLayoutBoundsHeight

()method 
public function getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's layout height. This is the size that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns the element's bounding box width. Bounding box is in element's parent coordinate space and is calculated from the element's layout size and layout transform matrix.

Returns
Number

getLayoutBoundsWidth

()method 
public function getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's layout width. This is the size that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns the element's bounding box width. Bounding box is in element's parent coordinate space and is calculated from the element's layout size and layout transform matrix.

Returns
Number

getLayoutBoundsX

()method 
public function getLayoutBoundsX(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the x coordinate that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns x coordinate of the element's bounding box top-left corner. Bounding box is in element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix.

Returns
Number

getLayoutBoundsY

()method 
public function getLayoutBoundsY(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the y coordinate that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns y coordinate of the element's bounding box top-left corner. Bounding box is in element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix.

Returns
Number

getLayoutMatrix

()method 
public function getLayoutMatrix():Matrix

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the transform matrix that is used to calculate the component's layout relative to its siblings.

This matrix is typically defined by the component's 2D properties such as x, y, rotation, scaleX, scaleY, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Returns
Matrix — The layout transform Matrix for this element. Don't directly modify the return value but call setLayoutMatrix instead.

getLayoutMatrix3D

()method 
public function getLayoutMatrix3D():Matrix3D

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the layout transform Matrix3D for this element.

This matrix is typically defined by the component's transform properties such as x, y, z, rotationX, rotationY, rotationZ, scaleX, scaleY, scaleZ, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Returns
Matrix3D — The layout transform Matrix3D for this element. Don't directly modify the return value but call setLayoutMatrix instead.

getMaxBoundsHeight

()method 
public function getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's maximum height.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns the element's bounding box height. Bounding box is in element's parent coordinate space and is calculated from the element's maximum size and layout transform matrix.

Returns
Number

getMaxBoundsWidth

()method 
public function getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's maximum width.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true the method returns the element's bounding box width. Bounding box is in element's parent coordinate space and is calculated from the element's maximum size and layout transform matrix.

Returns
Number

getMinBoundsHeight

()method 
public function getMinBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's minimum height.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box height. Bounding box is in element's parent coordinate space and is calculated from the element's minimum size and layout transform matrix.

Returns
Number

getMinBoundsWidth

()method 
public function getMinBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's minimum width.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box width. Bounding box is in element's parent coordinate space and is calculated from the element's minimum size and layout transform matrix.

Returns
Number

getPreferredBoundsHeight

()method 
public function getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's preferred height.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box height. Bounding box is in element's parent coordinate space and is calculated from the element's preferred size and layout transform matrix.

Returns
Number — Returns the element's preferred height. Preferred height is usually based on the default element size and any explicit overrides. For UIComponent this is the same value as returned by the getExplicitOrMeasuredHeight() method.

getPreferredBoundsWidth

()method 
public function getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the element's preferred width.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box width. Bounding box is in element's parent coordinate space and is calculated from the element's preferred size and layout transform matrix.

Returns
Number — Returns the element's preferred width. Preferred width is usually based on the default element size and any explicit overrides. For UIComponent this is the same value as returned by the getExplicitOrMeasuredWidth() method.

initialized

()method 
public function initialized(document:Object, id:String):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Called automatically by the MXML compiler when the SpriteVisualElement is created using an MXML tag. If you create the SpriteVisualElement through ActionScript you must set the id property manually.

Parameters

document:Object — The MXML document containing this SpriteVisualElement (not used).
 
id:String — The MXML id for this SpriteVisualElement.

invalidateLayoutDirection

()method 
public function invalidateLayoutDirection():void

An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. If they differ, this method is responsible for mirroring the element’s contents and for updating the element’s post-layout transform so that descendants inherit a mirrored coordinate system. IVisualElements typically implement mirroring by using postLayoutTransformOffsets to scale the X axis by -1 and to translate the x coordinate of the origin by the element's width. The net effect of this "mirror" transform is to reverse the direction in which the X axis increases without changing the element's location relative to its parent's origin.

invalidateParentSizeAndDisplayList

()method 
protected function invalidateParentSizeAndDisplayList():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Invalidates parent size and display list if this object affects its layout (includeInLayout is true).

setLayoutBoundsPosition

()method 
public function setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Sets the coordinates that the element uses to draw on screen.

Parameters

newBoundsX:Number — When postLayoutTransform is true, the element is positioned in such a way that the top-left corner of its bounding box is (x, y). Bounding box is in element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix. Note that calls to the setLayoutBoundSize() method can affect the layout position, so call setLayoutBoundPosition() after calling setLayoutBoundSize().
 
newBoundsY:Number
 
postLayoutTransform:Boolean (default = true)

setLayoutBoundsSize

()method 
public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Sets the layout size of the element. This is the size that the element uses to draw on screen.

If the width and/or height parameters are left unspecified (NaN), Flex sets the element's layout size to its preferred width and/or preferred height.

Note that calls to the setLayoutBoundSize() method can affect the layout position, so call setLayoutBoundPosition() after calling setLayoutBoundSize().

Parameters

width:Number — The element's layout width.
 
height:Number — The element's layout height.
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the specified sizes are those of the element's bounding box. Bounding box is in element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix.

setLayoutMatrix

()method 
public function setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.

The matrix is typically defined by the component's 2D properties such as x, y, rotation, scaleX, scaleY, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets.

Note that layout Matrix is factored in the getPreferredSize(), getMinSize(), getMaxSize(), getLayoutSize() methods when computed in parent coordinates as well as in getLayoutPosition() in both parent and child coordinates. Layouts that calculate the transform matrix explicitly typically call this method and work with sizes in child coordinates. Layouts calling this method pass false to invalidateLayout so that a subsequent layout pass is not triggered.

Parameters

value:Matrix — The matrix.
 
invalidateLayout:Booleantrue to cause theparetn container to re-layout its children.You typically pass true to invalidateLayout.

setLayoutMatrix3D

()method 
public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.

This matrix is typically defined by the component's transform properties such as x, y, z, rotationX, rotationY, rotationZ, scaleX, scaleY, scaleZ, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Note that layout Matrix3D is factored in the getPreferredSize(), getMinSize(), getMaxSize(), getLayoutSize() when computed in parent coordinates as well as in getLayoutPosition() in both parent and child coordinates. Layouts that calculate the transform matrix explicitly typically call this method and work with sizes in child coordinates. Layouts calling this method pass false to invalidateLayout so that a subsequent layout pass is not triggered.

Parameters

value:Matrix3D — The matrix.
 
invalidateLayout:Booleantrue to cause theparetn container to re-layout its children.You typically pass true to invalidateLayout.

transformAround

()method 
public function 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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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. This function will assign the rotation, scale, and translation values provided, then update the x/y/z properties as necessary to keep the transform center fixed.

Parameters

transformCenter:Vector3D — the point, in the component's own coordinates, to keep fixed relative to its parent.
 
scale:Vector3D (default = null) — the new values for the scale of the transform
 
rotation:Vector3D (default = null) — the new values for the rotation of the transform
 
translation:Vector3D (default = null) — the new values for the translation of the transform
 
postLayoutScale:Vector3D (default = null) — the new values for the post-layout scale of the transform
 
postLayoutRotation:Vector3D (default = null) — the new values for the post-layout rotation of the transform
 
postLayoutTranslation:Vector3D (default = null) — the new values for the post-layout translation of the transform
 
invalidateLayout:Boolean (default = true) — If true, the parent container size and display are invalidated. Layouts calling this method pass false so that a subsequent layout pass is not triggered.

transformHeightForLayout

()method 
protected function transformHeightForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Transform the element's size.

Parameters

width:Number — The target pre-transform width.
 
height:Number — The target pre-transform height.
 
postLayoutTransform:Boolean (default = true)

Returns
Number — Returns the transformed height. Transformation is this element's layout transformation matrix.

transformPointToParent

()method 
public function transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates. The pre-layout and post-layout result will be set on the position and postLayoutPosition parameters, if they are non-null.

Parameters

localPosition:Vector3D — The point to be transformed, specified in the local coordinates of the object.
 
position:Vector3D — A Vector3D point that will hold the pre-layout result. If null, the parameter is ignored.
 
postLayoutPosition:Vector3D — A Vector3D point that will hold the post-layout result. If null, the parameter is ignored.

transformWidthForLayout

()method 
protected function transformWidthForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Transform the element's size.

Parameters

width:Number — The target pre-transform width.
 
height:Number — The target pre-transform height.
 
postLayoutTransform:Boolean (default = true)

Returns
Number — Returns the transformed width. Transformation is this element's layout transformation matrix.