Packagecom.adobe.xmp.components
Classpublic class XMPLabel
InheritanceXMPLabel Inheritance mx.controls.Label
ImplementsIXMPDisplay

A component that displays a single line of non-editable text, associated with an XMP metadata property. Must be contained in an XMPFormItem.

Default MXML Propertytext



Public Properties
 PropertyDefined by
  allowCommas : Boolean
When true, commas can be accepted as part of the value in arrays (xmpArray != null).
XMPLabel
  dataProvider : Object
Provides a collection of allowed values for an "Enum" XMP data type.
XMPLabel
  formatFunction : Function
A custom formatting function for single values.
XMPLabel
  formatString : String
The format to use to evaluate and render date-time values when XMP type is "Date".
XMPLabel
  useThousandsSeparator : Boolean
When true, a separator character is used after the thousands place to evaluate and render XMP types "Integer" and "Real".
XMPLabel
  xmpArray : String
The XMP multi-value data type of the field associated with component, one of:
  • none
  • bag
  • seq
  • alt
XMPLabel
  xmpFormat : String
A format string used to add prefixes or postfixes to single XMP values, after they have been returned from the formatting function.
XMPLabel
  xmpPath : String
The XMP path for the field associated with this component.
XMPLabel
  xmpSeparator : String
A string of characters that can be used to separate input values for a multi-valued field.
XMPLabel
  xmpType : String
The XMP data type of the field associated with this component, one of:
  • Text
  • Integer
  • Real
  • Boolean
  • Date
  • Localized
XMPLabel
Public Methods
 MethodDefined by
  
A handler for the xmpMultivalue event.
XMPLabel
  
readXMP(event:XMPEvent):void
A handler for the xmpRead event.
XMPLabel
Events
 EventSummaryDefined by
   Occurs when the value of this component has been changed.XMPLabel
   Occurs when user opens this panel.XMPLabel
Property detail
allowCommasproperty
allowCommas:Boolean  [read-write]

When true, commas can be accepted as part of the value in arrays (xmpArray != null). When false, commas are considered separators.

The default value is false.

Implementation
    public function get allowCommas():Boolean
    public function set allowCommas(value:Boolean):void
dataProviderproperty 
dataProvider:Object  [read-write]

Provides a collection of allowed values for an "Enum" XMP data type. The collection is an Array or ArrayCollection that contains Objects with properties "label" and "data", or with the single property "separator".

Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void
formatFunctionproperty 
formatFunction:Function  [read-write]

A custom formatting function for single values. If defined, no other formatter (such as the DateFormatter) is applied. The function must have this signature function (rawValue: String): String. If this function

Implementation
    public function get formatFunction():Function
    public function set formatFunction(value:Function):void
formatStringproperty 
formatString:String  [read-write]

The format to use to evaluate and render date-time values when XMP type is "Date". See XMP documentation for accepted formats.

The default value is MM/DD/YYYY - JJ:NN:SS.

Implementation
    public function get formatString():String
    public function set formatString(value:String):void
useThousandsSeparatorproperty 
useThousandsSeparator:Boolean  [read-write]

When true, a separator character is used after the thousands place to evaluate and render XMP types "Integer" and "Real".

The default value is false.

Implementation
    public function get useThousandsSeparator():Boolean
    public function set useThousandsSeparator(value:Boolean):void
xmpArrayproperty 
xmpArray:String  [read-write]

The XMP multi-value data type of the field associated with component, one of:

The default value is none.

Implementation
    public function get xmpArray():String
    public function set xmpArray(value:String):void
xmpFormatproperty 
xmpFormat:String  [read-write]

A format string used to add prefixes or postfixes to single XMP values, after they have been returned from the formatting function. The XMP value returned by the formatting function is substituted for the variable {0} in this format string.

This value can be a ZString (beginning with '$$$', in which case it is localized using translation dictionaries. In the translated display string, the variable value is designated as ^0.

For arrays values, the array is displayed on one line in a semicolon-separated list, and the formatting process is applied to each single value.

For example, with translation:

xmpFormat="$$$/AWS/FileInfoLib/Panels/Camera1/FocalLengthFormat=^0 mm"

Without translation:

xmpFormat="{0} mm"

In either case, if the format function returns a value of 100, the resulting display string is "100 mm".

Implementation
    public function get xmpFormat():String
    public function set xmpFormat(value:String):void
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
xmpSeparatorproperty 
xmpSeparator:String  [read-write]

A string of characters that can be used to separate input values for a multi-valued field. Must be at least one character long. Each character in this string is accepted as a separator for input. The first character is used to separate values for display.

The default value is The semicolon character (;).

Implementation
    public function get xmpSeparator():String
    public function set xmpSeparator(value:String):void
xmpTypeproperty 
xmpType:String  [read-write]

The XMP data type of the field associated with this component, one of:

The default value is Text.

Implementation
    public function get xmpType():String
    public function set xmpType(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.
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.