Packagefl.video
Classpublic class CaptionTargetEvent
InheritanceCaptionTargetEvent Inheritance Event Inheritance Object

Language Version : ActionScript 3.0
Player Version : 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.

See also

flash.text.TextField.defaultTextFormat

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
  captionTarget : DisplayObject
The caption target from the FLVPlaybackCaptioning instance property of the same name.
CaptionTargetEvent
 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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined 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
 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 your custom Event class.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() 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
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
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
  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
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property Detail
captionTargetproperty
captionTarget:DisplayObject  [read-write]

Language Version : ActionScript 3.0
Player Version : 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
CaptionTargetEvent()Constructor
public function CaptionTargetEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, captionTarget:DisplayObject = null)

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Creates an Event object that contains information about caption target 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 captionTargetCreated event: CaptionTargetEvent.CAPTION_CHANGE.
 
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.
 
captionTarget:DisplayObject (default = null) — A display object which is from the captionTarget property of the FLVPlaybackCaptioning instance.
Constant Detail
CAPTION_TARGET_CREATEDConstant
public static const CAPTION_TARGET_CREATED:String = "captionTargetCreated"

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

The CaptionTargetEvent.CAPTION_TARGET_CREATED constant defines the value of the type property of a captionTargetCreated event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
captionTargetA display object that is from the captionTarget property of the FLVPlaybackCaptioning instance.




Submit Feedback on LiveDocs
© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Mon Nov 19 2007, 10:27 AM GMT-08:00