ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.components.supportClasses 

DisplayLayer  - AS3 Flex
Packagespark.components.supportClasses
Classpublic class DisplayLayer
InheritanceDisplayLayer Inheritance EventDispatcher Inheritance Object

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

A DisplayLayer class maintains an ordered list of DisplayObjects sorted on depth. You do not instantiate this class, but use the overlay property of Group and DataGroup.

Related API Elements

spark.components.Group.overlay
spark.components.DataGroup.overlay

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  numDisplayObjects : int
[read-only] Number of objects in the DisplayLayer.
DisplayLayer
Public Methods
 MethodDefined By
  
DisplayLayer()
Constructor.
DisplayLayer
  
addDisplayObject(displayObject:DisplayObject, depth:Number = NaN):DisplayObject
Adds a displayObject with the specified depth to the ordered list.
DisplayLayer
 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
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
getDisplayObjectAt(index:int):DisplayObject
Returns the DisplayObject with the specified index.
DisplayLayer
  
getDisplayObjectDepth(displayObject:DisplayObject):Number
Returns the depth for the specified DisplayObject.
DisplayLayer
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
removeDisplayObject(displayObject:DisplayObject):DisplayObject
Removes the specified displayObject from the sorted list.
DisplayLayer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

numDisplayObjects

property
numDisplayObjects:int  [read-only]

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

Number of objects in the DisplayLayer.



Implementation
    public function get numDisplayObjects():int
Constructor Detail

DisplayLayer

()Constructor
public function DisplayLayer()

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

Constructor.

Method Detail

addDisplayObject

()method
public function addDisplayObject(displayObject:DisplayObject, depth:Number = NaN):DisplayObject

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

Adds a displayObject with the specified depth to the ordered list. The position of the displayObject in the sorted lists is based on its depth. The object is inserted after all objects with less than or equal depth value.

Parameters

displayObject:DisplayObject — The object to add.
 
depth:Number (default = NaN) — The depth of the object.

Returns
DisplayObject — The index of the object.

getDisplayObjectAt

()method 
public function getDisplayObjectAt(index:int):DisplayObject

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

Returns the DisplayObject with the specified index.

Parameters

index:int — The index of the object.

Returns
DisplayObject — The object.

getDisplayObjectDepth

()method 
public function getDisplayObjectDepth(displayObject:DisplayObject):Number

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

Returns the depth for the specified DisplayObject.

Parameters

displayObject:DisplayObject — The object.

Returns
Number — The depth of the object.

removeDisplayObject

()method 
public function removeDisplayObject(displayObject:DisplayObject):DisplayObject

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

Removes the specified displayObject from the sorted list.

Parameters

displayObject:DisplayObject — The object.

Returns
DisplayObject — The removed object.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy