CaptionTargetEvent

Package	fl.video
Class	public class CaptionTargetEvent
Inheritance	CaptionTargetEvent Event Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9.0.28.0

Type for the captionTargetCreated event, dispatched after the captionTargetCreated event is created automatically and before any captions have been added to it. This event is not dispatched if the captionTarget property is set with a custom display object, or if the captionTargetName property is set. This is useful for customizing the properties of the TextField object, such as the defaultTextFormat property.

Related API Elements

flash.text.TextField.defaultTextFormat

Public Properties

	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
		captionTarget : DisplayObject The caption target from the FLVPlaybackCaptioning instance property of the same name.	CaptionTargetEvent
		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
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		CaptionTargetEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, captionTarget:DisplayObject = null) Creates an Event object that contains information about caption target events.	CaptionTargetEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method 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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		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

	Constant		Defined By
		CAPTION_TARGET_CREATED : String = "captionTargetCreated" [static] The CaptionTargetEvent.CAPTION_TARGET_CREATED constant defines the value of the type property of a captionTargetCreated event object.	CaptionTargetEvent

Property Detail

captionTarget

property

captionTarget:DisplayObject

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9.0.28.0

The caption target from the FLVPlaybackCaptioning instance property of the same name.

Implementation
public function get captionTarget():DisplayObject
public function set captionTarget(value:DisplayObject):void

Constructor Detail