Package | com.adobe.xmp.components |
Class | public class XMPTextArea |
Inheritance | XMPTextArea ![]() |
Implements | IXMPComponent |
Subclasses | XMPTextAreaMRU |
Default MXML Propertytext
Property | Defined by | ||
---|---|---|---|
allowCommas : Boolean
When true, commas can be accepted as part of the value in arrays (xmpArray != null).
| XMPTextArea | ||
formatFunction : Function
A custom formatting function for single values.
| XMPTextArea | ||
formatString : String The format to use to evaluate and render date-time values
when XMP type is "Date".
| XMPTextArea | ||
modified : Boolean
True if the user has modified the XMP value.
| XMPTextArea | ||
parseValue : Function = null
A custom parsing function for single values.
| XMPTextArea | ||
useThousandsSeparator : Boolean When true, a separator character is used after the thousands place to
evaluate and render XMP types "Integer" and "Real".
| XMPTextArea | ||
writeEmptyValues : Boolean When true, empty XMP property values are included when the XMP is
written out, when false, they are deleted.
| XMPTextArea | ||
xmpArray : String The XMP multi-value data type of the field associated with component, one of:
| XMPTextArea | ||
xmpFormat : String
A format string used to add prefixes or postfixes to single XMP values,
after they have been returned from the formatting function.
| XMPTextArea | ||
xmpPath : String The XMP path for the field associated with this component.
| XMPTextArea | ||
xmpSeparator : String | XMPTextArea | ||
xmpType : String The XMP data type of the field associated with this component, one of:
| XMPTextArea |
Method | Defined by | ||
---|---|---|---|
multivalueHandler(event:XMPEvent):void
A handler for the
xmpMultivalue event. | XMPTextArea | ||
A handler for the
xmpRead event. | XMPTextArea | ||
A handler for the
xmpRead event. | XMPTextArea |
Event | Summary | Defined by | ||
---|---|---|---|---|
Occurs when the value of this component has been changed. | XMPTextArea | |||
Occurs when user opens this panel. | XMPTextArea | |||
Occurs when user closes this panel. | XMPTextArea |
allowCommas | property |
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
.
public function get allowCommas():Boolean
public function set allowCommas(value:Boolean):void
formatFunction | property |
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
public function get formatFunction():Function
public function set formatFunction(value:Function):void
formatString | property |
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
.
public function get formatString():String
public function set formatString(value:String):void
modified | property |
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
parseValue | property |
public var parseValue:Function = null
A custom parsing function for single values.
The function must have this signature:
function (userValue: String): String
useThousandsSeparator | property |
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
.
public function get useThousandsSeparator():Boolean
public function set useThousandsSeparator(value:Boolean):void
writeEmptyValues | property |
writeEmptyValues:Boolean
[read-write]When true, empty XMP property values are included when the XMP is written out, when false, they are deleted.
The default value is false
.
public function get writeEmptyValues():Boolean
public function set writeEmptyValues(value:Boolean):void
xmpArray | property |
xmpArray:String
[read-write]The XMP multi-value data type of the field associated with component, one of:
The default value is none
.
public function get xmpArray():String
public function set xmpArray(value:String):void
xmpFormat | property |
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
xmpPath | property |
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
xmpSeparator | property |
xmpSeparator:String
[read-write]Implementation
public function get xmpSeparator():String
public function set xmpSeparator(value:String):void
xmpType | property |
xmpType:String
[read-write]The XMP data type of the field associated with this component, one of:
The default value is Text
.
public function get xmpType():String
public function set xmpType(value:String):void
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.
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.
event:XMPEvent — The event object for a user-interaction event.
|
writeXMP | () | method |
public function writeXMP(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.
event:XMPEvent — The event object for a user-interaction event.
|
xmpModification | event |
com.adobe.xmp.events.XMPEvent
Occurs when the value of this component has been changed. Default handler sets the "modified" flag.
xmpRead | event |
com.adobe.xmp.events.XMPEvent
Occurs when user opens this panel. Default handler reads the associated XMP value and updates the display value.
xmpWrite | event |
com.adobe.xmp.events.XMPEvent
Occurs when user closes this panel. Default handler writes the associated XMP value from the current component value.