Packagecom.adobe.xmp.components
Classpublic class XMPDataGridColumn
InheritanceXMPDataGridColumn Inheritance mx.controls.dataGridClasses.DataGridColumn

Judy: new class A an XMPDataGridColumn extends the default DataGridColumn with XMP capabilities. It automatically localizes the column header when it is a ZString beginning with "$$$". This class representing a table column has a similar interface like XMPTextInput. The column has an xmp path that corresponds to a struct field of one item of the array (that is represented by the DataGrid). Each column has a certain data type and its data is automatically read and written when the panel is shown and hidden.



Public Properties
 PropertyDefined 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:
  • none
  • bag
  • seq
  • alt
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:
  • Text
  • Integer
  • Real
  • Boolean
  • Localized
XMPDataGridColumn
Protected Properties
 PropertyDefined by
  _xmpHelper : XMPAccessHelper
Helper to read/write xmp data of different data types
XMPDataGridColumn
Public Methods
 MethodDefined by
  
Constructor
XMPDataGridColumn
Property detail
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.

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
headerTextproperty 
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
headerTipproperty 
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
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
_xmpHelperproperty 
protected var _xmpHelper:XMPAccessHelper

Helper to read/write xmp data of different data types

xmpHelperproperty 
xmpHelper:XMPAccessHelper  [read-only]

Provide access to the helper for XMPDataGrid

Implementation
    public function get xmpHelper():XMPAccessHelper
xmpPathproperty 
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

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
Constructor detail
XMPDataGridColumn()constructor
public function XMPDataGridColumn()

Constructor