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

AutoLayoutEvent  - AS3 Flash

Packagefl.video
Classpublic class AutoLayoutEvent
InheritanceAutoLayoutEvent Inheritance LayoutEvent Inheritance Event Inheritance Object
Implements IVPEvent

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Flash® Player dispatches an AutoLayoutEvent object when the video player is resized and laid out automatically. A video player is laid out automatically when the maintainAspectRatio property or autoSize property is set to true or when a new FLV file is loaded.

There is only one type of AutoLayoutEvent object: AutoLayoutEvent.AUTO_LAYOUT.

After an attempt to automatically lay out a video player occurs, the event object is dispatched even if the dimensions were not changed.

A LayoutEvent object is also dispatched in these three scenarios:

  • If the video player that laid itself out is visible.
  • If there are two video players of different sizes or positions and the visibleVideoPlayerIndex property is switched from one video player to another.
  • If methods or properties that change the size or location of the video player, such as setSize(), setScale(), width, height, scaleX, scaleY, registrationWidth, and registrationHeight, are called.

If multiple video player instances are in use, this event may not apply to the visible video player.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 InheritedoldBounds : Rectangle
Indicates the values of the x, y, width, and height properties of the target before the event occurs.
LayoutEvent
 InheritedoldRegistrationBounds : Rectangle
Indicates the values of the registrationX, registrationY, registrationWidth, and registrationHeight properties of the target before the event occurs.
LayoutEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  vp : uint
The index of the VideoPlayer object involved in this event.
AutoLayoutEvent
Public Methods
 MethodDefined By
  
AutoLayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldBounds:Rectangle = null, oldRegistrationBounds:Rectangle = null, vp:uint = 0)
Creates an Event object that contains information about autoLayout events.
AutoLayoutEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  AUTO_LAYOUT : String = "autoLayout"
[static] Defines the value of the type property of an autoLayout event object.
AutoLayoutEvent
Property Detail

vp

property
vp:uint

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The index of the VideoPlayer object involved in this event.



Implementation
    public function get vp():uint
    public function set vp(value:uint):void

Related API Elements

Constructor Detail

AutoLayoutEvent

()Constructor
public function AutoLayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldBounds:Rectangle = null, oldRegistrationBounds:Rectangle = null, vp:uint = 0)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Creates an Event object that contains information about autoLayout events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of auto layout event: AutoLayoutEvent.AUTO_LAYOUT.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
oldBounds:Rectangle (default = null) — Indicates the values of the x, y, width, and height properties of the target before the autoLayout event occurs. Event listeners can access this information through the LayoutEvent.oldBounds property.
 
oldRegistrationBounds:Rectangle (default = null) — Indicates the values of the registrationX, registrationY, registrationWidth, and registrationHeight properties of the target before the autoLayout event occurs. Event listeners can access this information through the LayoutEvent.oldRegistrationBounds property.
 
vp:uint (default = 0) — The index of the VideoPlayer object involved in this event.

Related API Elements

Constant Detail

AUTO_LAYOUT

Constant
public static const AUTO_LAYOUT:String = "autoLayout"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property of an autoLayout event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
oldBoundsThe values of the x, y, width, and height properties of the target before the autoLayout event occurs.
oldRegistrationBoundsThe values of the registrationX, registrationY, registrationWidth, and registrationHeight properties of the target before the autoLayout event occurs.
vpThe index of the VideoPlayer object.

Related API Elements