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

LayoutEvent  - AS3 Flash
Packagefl.video
Classpublic class LayoutEvent
InheritanceLayoutEvent Inheritance Event Inheritance Object
Subclasses AutoLayoutEvent

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

Event dispatched when the video player is resized and/or laid out. Here are two layout scenarios:
  • If the video player is laid out by using the autoLayout event, calling the setScale(), setSize() methods, or changing the width, height, scaleX, scaleY, registrationWidth, and registrationHeight properties.
  • If there are two video players of different sizes or locations and the visibleVideoPlayerIndex property is switched from one video player to another.

There is only one type of LayoutEvent object: LayoutEvent.LAYOUT.

Related API Elements

LAYOUT

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
  oldBounds : Rectangle
Indicates the values of the x, y, width, and height properties of the target before the event occurs.
LayoutEvent
  oldRegistrationBounds : 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
Public Methods
 MethodDefined By
  
LayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldBounds:Rectangle = null, oldRegistrationBounds:Rectangle = null)
Creates an Event object that contains information about layout events.
LayoutEvent
 Inherited
clone():Event
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
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 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
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  LAYOUT : String = "layout"
[static] Defines the value of the type property of a layout event object.
LayoutEvent
Property Detail

oldBounds

property
oldBounds:Rectangle

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

Indicates the values of the x, y, width, and height properties of the target before the event occurs.



Implementation
    public function get oldBounds():Rectangle
    public function set oldBounds(value:Rectangle):void

oldRegistrationBounds

property 
oldRegistrationBounds:Rectangle

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

Indicates the values of the registrationX, registrationY, registrationWidth, and registrationHeight properties of the target before the event occurs.



Implementation
    public function get oldRegistrationBounds():Rectangle
    public function set oldRegistrationBounds(value:Rectangle):void
Constructor Detail

LayoutEvent

()Constructor
public function LayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldBounds:Rectangle = null, oldRegistrationBounds:Rectangle = null)

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 layout 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: LayoutEvent.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 layout event occurs. Event listeners can access this information through the oldBounds property.
 
oldRegistrationBounds:Rectangle (default = null) — Indicates the values of the registrationX, registrationY, registrationWidth, and registrationHeight properties of the target before the layout event occurs. Event listeners can access this information through the oldRegistrationBounds property.

Related API Elements

oldBounds
oldRegistrationBounds
Constant Detail

LAYOUT

Constant
public static const LAYOUT:String = "layout"

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 a layout 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 layout event occurs.
oldRegistrationBoundsThe values of the registrationX, registrationY, registrationWidth, and registrationHeight properties of the target before the layout event occurs.

Related API Elements

layout event



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

 

Legal Notices | Online Privacy Policy