Packagecom.adobe.xmp.components
Classpublic class XMPRating
InheritanceXMPRating Inheritance com.adobe.xmp.utils.Rating
ImplementsIXMPComponent

A component that displays a rating value as a set of stars, associated with an XMP metadata rating property. Must be contained in an XMPFormItem.

Default MXML Propertyvalue



Public Properties
 PropertyDefined by
  modified : Boolean
XMPRating
  writeEmptyValues : Boolean = false
XMPRating
  xmpPath : String
The XMP path for the field associated with this component.
XMPRating
Public Methods
 MethodDefined by
  
A handler for the xmpMultivalue event.
XMPRating
  
writeXMP(event:XMPEvent):void
A handler for the xmpWrite event.
XMPRating
Events
 EventSummaryDefined by
   Occurs when the value of this component has been changed.XMPRating
   Occurs when user opens this panel.XMPRating
   Occurs when user closes this panel.XMPRating
Property detail
modifiedproperty
modified:Boolean  [read-write]

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

See also

writeEmptyValuesproperty 
public var writeEmptyValues:Boolean = false

See also

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.
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.