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

MetadataEvent  - AS3 OSMF
Packageorg.osmf.events
Classpublic class MetadataEvent
InheritanceMetadataEvent Inheritance Event Inheritance Object
Subclasses TimelineMetadataEvent

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

A MetadataEvent is dispatched by a Metadata object when metadata values are added, removed, or changed.


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
 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
  key : String
[read-only] The key associated with this event.
MetadataEvent
  oldValue : *
[read-only] The old value associated with this event.
MetadataEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  value : *
[read-only] The value associated with this event.
MetadataEvent
Public Methods
 MethodDefined By
  
MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, key:String = null, value:* = null, oldValue:* = null)
Constructor.
MetadataEvent
 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
  VALUE_ADD : String = "valueAdd"
[static] The MetadataEvent.VALUE_ADD constant defines the value of the type property of the event object for a valueAdd event.
MetadataEvent
  VALUE_CHANGE : String = "valueChange"
[static] The MetadataEvent.VALUE_CHANGE constant defines the value of the type property of the event object for a valueChange event.
MetadataEvent
  VALUE_REMOVE : String = "valueRemove"
[static] The MetadataEvent.VALUE_REMOVE constant defines the value of the type property of the event object for a valueRemove event.
MetadataEvent
Property Detail

key

property
key:String  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The key associated with this event.



Implementation
    public function get key():String

oldValue

property 
oldValue:*  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The old value associated with this event. Only valid for VALUE_CHANGE events.



Implementation
    public function get oldValue():*

value

property 
value:*  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The value associated with this event.



Implementation
    public function get value():*
Constructor Detail

MetadataEvent

()Constructor
public function MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, key:String = null, value:* = null, oldValue:* = null)

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
type:String — Event type.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
key:String (default = null) — The key associated with the event.
 
value:* (default = null) — The value associated with the event.
 
oldValue:* (default = null) — The old value associated with the event. Only valid for VALUE_CHANGE events.
Constant Detail

VALUE_ADD

Constant
public static const VALUE_ADD:String = "valueAdd"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MetadataEvent.VALUE_ADD constant defines the value of the type property of the event object for a valueAdd event.

VALUE_CHANGE

Constant 
public static const VALUE_CHANGE:String = "valueChange"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MetadataEvent.VALUE_CHANGE constant defines the value of the type property of the event object for a valueChange event.

VALUE_REMOVE

Constant 
public static const VALUE_REMOVE:String = "valueRemove"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MetadataEvent.VALUE_REMOVE constant defines the value of the type property of the event object for a valueRemove event.




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

 

Legal Notices | Online Privacy Policy