(Beta)
| 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 |
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
Public Properties
Hide Inherited Public Properties
Show Inherited 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 | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
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):voidConstructor Detail
CaptionTargetEvent | () | Constructor |
public function CaptionTargetEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, captionTarget:DisplayObject = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, 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.
Parameterstype: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)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
captionTarget:DisplayObject (default = null)captionTarget
property of the FLVPlaybackCaptioning instance.
|
Constant Detail
CAPTION_TARGET_CREATED | Constant |
public static const CAPTION_TARGET_CREATED:String = "captionTargetCreated"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
captionTarget | A display object that is from the captionTarget
property of the FLVPlaybackCaptioning instance. |
Wed Nov 21 2018, 06:34 AM -08:00