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

CaptionChangeEvent  - AS3

Packagefl.video
Classpublic class CaptionChangeEvent
InheritanceCaptionChangeEvent Inheritance Event Inheritance Object

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

The CaptionChangeEvent is dispatched any time a caption is added or removed from the caption target text field.

The event is also dispatched when the following conditions are true:

  • the captionTargetName property is not set
  • the captionTarget property is not set
  • the FLVPlaybackCaptioning instance creates a TextField object automatically for captioning.


Public Properties
 PropertyDefined By
  added : Boolean
A Boolean value that determines whether the caption was added or removed.
CaptionChangeEvent
 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
  captionCuePointObject : Object
The cue point object for the caption that was added or removed.
CaptionChangeEvent
 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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
CaptionChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, added:Boolean = true, captionCuePointObject:Object = null)
Creates an Event object that contains information about captionChange events.
CaptionChangeEvent
 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
  CAPTION_CHANGE : String = "captionChange"
[static] Defines the value of the type property of a captionChange event object.
CaptionChangeEvent
Property Detail

added

property
added:Boolean

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

A Boolean value that determines whether the caption was added or removed.



Implementation
    public function get added():Boolean
    public function set added(value:Boolean):void

captionCuePointObject

property 
captionCuePointObject:Object

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

The cue point object for the caption that was added or removed.



Implementation
    public function get captionCuePointObject():Object
    public function set captionCuePointObject(value:Object):void
Constructor Detail

CaptionChangeEvent

()Constructor
public function CaptionChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, added:Boolean = true, captionCuePointObject:Object = 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 captionChange 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 captionChange event: CaptionChangeEvent.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.
 
added:Boolean (default = true) — A Boolean value that indicates whether the caption was added or removed from the display.
 
captionCuePointObject:Object (default = null) — The cue point object for this caption.
Constant Detail

CAPTION_CHANGE

Constant
public static const CAPTION_CHANGE:String = "captionChange"

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

Defines the value of the type property of a captionChange event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
addedA Boolean that indicates whether the caption was added or removed from the display.
captionCuePointObjectThe cue point object for this caption.



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

 

Legal Notices | Online Privacy Policy