fl.video.AutoLayoutEvent (ActionScript 3.0)

Package	fl.video
Class	public class AutoLayoutEvent
Inheritance	AutoLayoutEvent LayoutEvent Event Object
Implements	IVPEvent

Language Version :

ActionScript 3.0

Player Version :

Flash Player 9.0.28.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.

See also

AUTO_LAYOUT

	Property	Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event
		vp : uint The index of the VideoPlayer object involved in this event.	AutoLayoutEvent

	Method	Defined 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
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in your custom Event class.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether preventDefault() has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] Defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] Defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the type property of an addedToStage event object.	Event
		AUTO_LAYOUT : String = "autoLayout" [static] Defines the value of the type property of an autoLayout event object.	AutoLayoutEvent
		CANCEL : String = "cancel" [static] Defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] Defines the value of the type property of a change event object.	Event
		CLOSE : String = "close" [static] Defines the value of the type property of a close event object.	Event
		COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] Defines the value of the type property of a connect event object.	Event
		DEACTIVATE : String = "deactivate" [static] Defines the value of the type property of a deactivate event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] Defines the value of the type property of an enterFrame event object.	Event
		FULLSCREEN : String = "fullScreen" [static] Defines the value of the type property of a fullScreen event object.	Event
		ID3 : String = "id3" [static] Defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] Defines the value of the type property of an init event object.	Event
		LAYOUT : String = "layout" [static] Defines the value of the type property of a layout event object.	LayoutEvent
		MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the type property of a mouseLeave event object.	Event
		OPEN : String = "open" [static] Defines the value of the type property of an open event object.	Event
		REMOVED : String = "removed" [static] Defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] Defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object.	Event
		SCROLL : String = "scroll" [static] Defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] Defines the value of the type property of a select event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the type property of a soundComplete event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] Defines the value of the type property of an unload event object.	Event

Property Detail

property

vp:uint [read-write]

Language Version :

ActionScript 3.0

Player Version :

Flash Player 9.0.28.0

The index of the VideoPlayer object involved in this event.

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

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

Player Version :

Flash Player 9.0.28.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.

Constant Detail

AUTO_LAYOUT

Constant

public static const AUTO_LAYOUT:String = "autoLayout"

Language Version :

ActionScript 3.0

Player Version :

Flash Player 9.0.28.0

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

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`oldBounds`	The values of the `x`, `y`, `width`, and `height` properties of the target before the `autoLayout` event occurs.
`oldRegistrationBounds`	The values of the `registrationX`, `registrationY`, `registrationWidth`, and `registrationHeight` properties of the target before the `autoLayout` event occurs.
`vp`	The index of the VideoPlayer object.

See also

FLVPlayback.autoLayout

Submit Feedback on LiveDocs

ActionScript 3.0 Language and Components Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
AutoLayoutEvent	Properties \| Methods \| Constants