Packagecom.adobe.xmp.components
Classpublic class XMPCheckBox
InheritanceXMPCheckBox Inheritance mx.controls.CheckBox
ImplementsIXMPComponent

A component that displays text with a check box, which has a selected/deselected state associated with a Boolean XMP property. Must be contained in an XMPFormItem.

Default MXML Propertyselected



Public Properties
 PropertyDefined by
  modified : Boolean
True if the user has modified the XMP value.
XMPCheckBox
  writeEmptyValues : Boolean = false
When true, empty XMP property values are included when the XMP is written out, when false, they are deleted.
XMPCheckBox
  xmpPath : String
The XMP path for the field associated with this component.
XMPCheckBox
Public Methods
 MethodDefined by
  
A handler for the xmpMultivalue event.
XMPCheckBox
  
readXMP(event:XMPEvent):void
A handler for the xmpRead event.
XMPCheckBox
  
writeXMP(event:XMPEvent):void
A handler for the xmpWrite event.
XMPCheckBox
Events
 EventSummaryDefined by
   Occurs when the value of this component has been changed.XMPCheckBox
   Occurs when user opens this panel.XMPCheckBox
   Occurs when user closes this panel.XMPCheckBox
Property detail
modifiedproperty
modified:Boolean  [read-write]

True if the user has modified the XMP value. False if the value is reset to its original value, which happens ony in the multiple file mode, when the Modification checkbox is deselected.

Implementation
    public function get modified():Boolean
    public function set modified(value:Boolean):void
writeEmptyValuesproperty 
public var writeEmptyValues:Boolean = false

When true, empty XMP property values are included when the XMP is written out, when false, they are deleted.

The default value is false.

xmpPathproperty 
xmpPath:String  [read-write]

The XMP path for the field associated with this component. The path can be nested, or direct to an array, struct or qualifier. Path expressions make use of XML namespaces; all prefixes must be registered.

Implementation
    public function get xmpPath():String
    public function set xmpPath(value:String):void
Method detail
multivalueHandler()method
public function multivalueHandler(event:XMPEvent):void

A handler for the xmpMultivalue event. Called if the File Info dialog is started in multiple-file mode.

Parameters
event:XMPEvent — The event object for a user-interaction event.
readXMP()method 
public function readXMP(event:XMPEvent):void

A handler for the xmpRead event. The default handler updates the component in response to a user-interaction event, using information retrieved from the associated XMP property.

Parameters
event:XMPEvent — The event object for a user-interaction event.
writeXMP()method 
public function writeXMP(event:XMPEvent):void

A handler for the xmpWrite event. The default handler updates the associated XMP property value with the current value of this component, in response to a user-interaction event. It writes the property back to the packet only if the modified flag is true. It writes empty values only if the writeEmptyValues flag is true.

Parameters
event:XMPEvent — The event object for a user-interaction event.
Event detail
xmpModificationevent 
Event object type: com.adobe.xmp.events.XMPEvent

Occurs when the value of this component has been changed. Default handler sets the "modified" flag.

xmpReadevent  
Event object type: com.adobe.xmp.events.XMPEvent

Occurs when user opens this panel. Default handler reads the associated XMP value and updates the display value.

xmpWriteevent  
Event object type: com.adobe.xmp.events.XMPEvent

Occurs when user closes this panel. Default handler writes the associated XMP value from the current component value.