Packagecom.adobe.xmp.events
Classpublic class XMPEvent
InheritanceXMPEvent Inheritance flash.events.Event

Provides an event object for XMP state events.



Public Properties
 PropertyDefined by
  readOnly : Boolean
[read-only] Reports whether the dialog has been opened in read-only mode.
XMPEvent
  xmpAccess : IXMPAccess
Associates the XMP event with an XMP access object that it can send to components, so that they can respond to the event by accessing the XMP.
XMPEvent
Public Methods
 MethodDefined by
  
XMPEvent(type:String, xmpAccess:IXMPAccess = null, bubbles:Boolean = false, readOnly:Boolean = false)
Creates an event instance for a specific XMP interaction event, with an associated XMP access object.
XMPEvent
  
clone():Event
Creates a duplicate of this event object.
XMPEvent
Public Constants
 ConstantDefined by
  XMP_MODIFICATION : String = "xmpModification"
[static] Event type dispatched by an XMP component when its XMP value has been changed.
XMPEvent
  XMP_MULTIVALUE : String = "xmpMultivalue"
[static] Event type dispatched to the XMP components when the File Info dialog has been opened in multifile mode.
XMPEvent
  XMP_READ : String = "xmpRead"
[static] Event type dispatched to the XMP components when the XMP value of a component needs to be read or refreshed.
XMPEvent
  XMP_WRITE : String = "xmpWrite"
[static] Event type dispatched to the XMP components when the XMP value set in a component needs to be stored.
XMPEvent
Property detail
readOnlyproperty
readOnly:Boolean  [read-only]

Reports whether the dialog has been opened in read-only mode. Typically the components react to this by disabling themselves. If an XMP value is modified while the dialog is in read-only mode, the new value should not be stored.

Implementation
    public function get readOnly():Boolean
xmpAccessproperty 
public var xmpAccess:IXMPAccess

Associates the XMP event with an XMP access object that it can send to components, so that they can respond to the event by accessing the XMP.

Constructor detail
XMPEvent()constructor
public function XMPEvent(type:String, xmpAccess:IXMPAccess = null, bubbles:Boolean = false, readOnly:Boolean = false)

Creates an event instance for a specific XMP interaction event, with an associated XMP access object.

Parameters
type:String — The event type, which identifies the type of interaction that has occurred. One of "xmpRead", "xmpWrite", "xmpModification", "xmpMultivalue".
 
xmpAccess:IXMPAccess (default = null) — An access object, which provides access to XMP properties.
 
bubbles:Boolean (default = false) — When true, this event propagates up through the element hierarchy from where it is triggered.
 
readOnly:Boolean (default = false) — True if the XMP value is read-only. Normally, this means that "enabled = false" for the component.
Method detail
clone()method
public override function clone():Event

Creates a duplicate of this event object. Overrides the inherited clone() method.

Returns
Event — The new XMP event object.
Constant detail
XMP_MODIFICATIONconstant
public static const XMP_MODIFICATION:String = "xmpModification"

Event type dispatched by an XMP component when its XMP value has been changed.

XMP_MULTIVALUEconstant 
public static const XMP_MULTIVALUE:String = "xmpMultivalue"

Event type dispatched to the XMP components when the File Info dialog has been opened in multifile mode.

XMP_READconstant 
public static const XMP_READ:String = "xmpRead"

Event type dispatched to the XMP components when the XMP value of a component needs to be read or refreshed.

XMP_WRITEconstant 
public static const XMP_WRITE:String = "xmpWrite"

Event type dispatched to the XMP components when the XMP value set in a component needs to be stored.