Package | com.adobe.xmp.components |
Class | public class XMPDataGridColumn |
Inheritance | XMPDataGridColumn ![]() |
Property | Defined by | ||
---|---|---|---|
formatFunction : Function
A custom formatting function for single values.
| XMPDataGridColumn | ||
formatString : String The format to use to evaluate and render date-time values
when XMP type is "Date".
| XMPDataGridColumn | ||
headerText : String [write-only]
Sets the header text, first translating the value if it is a ZString.
| XMPDataGridColumn | ||
headerTip : String
Tooltip for the column header.
| XMPDataGridColumn | ||
xmpArray : String The XMP multi-value data type of the field associated with component, one of:
| XMPDataGridColumn | ||
xmpFormat : String
A format string used to add prefixes or postfixes to single XMP values,
after they have been returned from the formatting function.
| XMPDataGridColumn | ||
xmpHelper : XMPAccessHelper [read-only] Provide access to the helper for XMPDataGrid
| XMPDataGridColumn | ||
xmpPath : String
The XMP struct field for the array table column.
| XMPDataGridColumn | ||
xmpType : String The XMP data type of the field associated with this component, one of:
| XMPDataGridColumn |
Property | Defined by | ||
---|---|---|---|
_xmpHelper : XMPAccessHelper Helper to read/write xmp data of different data types
| XMPDataGridColumn |
Method | Defined by | ||
---|---|---|---|
Constructor
| XMPDataGridColumn |
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
.
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
headerText | property |
headerText:String
[write-only]Sets the header text, first translating the value if it is a ZString.
Implementation public function set headerText(value:String):void
headerTip | property |
headerTip:String
[read-write]Tooltip for the column header. It is implicitly resolved if its a localization key/value pair.
Implementation public function get headerTip():String
public function set headerTip(value:String):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
_xmpHelper | property |
protected var _xmpHelper:XMPAccessHelper
Helper to read/write xmp data of different data types
xmpHelper | property |
xmpHelper:XMPAccessHelper
[read-only]Provide access to the helper for XMPDataGrid
Implementation public function get xmpHelper():XMPAccessHelper
xmpPath | property |
xmpPath:String
[read-write]The XMP struct field for the array table column. Example: If the table has the xmp-path "my:array" and this column the xmp-path "my:struct-field", the path for one table cell is "my:array[table-row]/my:struct-field".
Technically it is just an alias for the "dataField" property.
Implementation
public function get xmpPath():String
public function set xmpPath(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
XMPDataGridColumn | () | constructor |
public function XMPDataGridColumn()
Constructor