Packagecom.adobe.xmp.components
Classpublic class XMPDataGrid
InheritanceXMPDataGrid Inheritance mx.controls.DataGrid
ImplementsIXMPComponent

Judy: (new component) Table that visualizes an XMP array of structs. The struct fields are represented by XMPDataGridColumn-objects. Each column has an xmp path that corresponds to a struct field. Allows editing if you double click, press F2 or Insert.



Public Properties
 PropertyDefined by
  dataProvider : Object
[write-only] Prevent the dataProvider to be set.
XMPDataGrid
  modified : Boolean
True if the user has modified at least one table cell or added/deleted rows.
XMPDataGrid
  shiftKey : Boolean
[read-only]
XMPDataGrid
  xmpArray : String
The XMP multi-value data type of the field associated with component, one of:
  • bag
  • seq
  • alt
XMPDataGrid
  xmpPath : String
The XMP path for the field associated with this component.
XMPDataGrid
  xmpSimpleArray : Boolean
The XMP type for data grid decides of the Grid represents is an array of structs or an array of simple properties.
XMPDataGrid
Public Methods
 MethodDefined by
  
Constructor, initializes the data grid.
XMPDataGrid
  
insertRow(e:Event = null):void
Inserts a row at the current position of the selection.
XMPDataGrid
  
A handler for the xmpMultivalue event.
XMPDataGrid
  
readXMP(event:XMPEvent):void
A handler for the xmpRead event.
XMPDataGrid
  
removeRows(e:Event = null):void
Deletes all selected rows.
XMPDataGrid
  
writeXMP(event:XMPEvent):void
A handler for the xmpWrite event.
XMPDataGrid
Protected Methods
 MethodDefined by
  
changeHandler(e:Event):void
XMPDataGrid
  
focusInHandler(event:FocusEvent):void
XMPDataGrid
  
focusOutHandler(event:FocusEvent):void
XMPDataGrid
  
itemFocusInHandler(e:DataGridEvent):void
XMPDataGrid
  
itemFocusOutHandler(event:FocusEvent):void
XMPDataGrid
  
keyDownHandler(e:KeyboardEvent):void
This event handler starts cell editing with the "F2" key, adding a row with the INS key, delting a row with the DEL key.
XMPDataGrid
  
mouseDoubleClickHandler(event:MouseEvent):void
This event handler starts cell editing with a double click.
XMPDataGrid
  
mouseDownHandler(event:MouseEvent):void
Mouse click resets the state of the shift key
XMPDataGrid
  
mouseWheelHandler(event:MouseEvent):void
Change the usability of the mouse wheel compared to Flex default.
XMPDataGrid
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
XMPDataGrid
Events
 EventSummaryDefined by
   Occurs when the value of this component has been changed.XMPDataGrid
   Occurs when user opens this panel.XMPDataGrid
   Occurs when user closes this panel.XMPDataGrid
Property detail
dataProviderproperty
dataProvider:Object  [write-only]

Prevent the dataProvider to be set. It is created by the xmp READ event.

Implementation
    public function set dataProvider(value:Object):void
modifiedproperty 
modified:Boolean  [read-write]

True if the user has modified at least one table cell or added/deleted rows. 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
shiftKeyproperty 
shiftKey:Boolean  [read-only]

Implementation
    public function get shiftKey():Boolean
xmpArrayproperty 
xmpArray:String  [read-write]

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

The default value is bag.

Implementation
    public function get xmpArray():String
    public function set xmpArray(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
xmpSimpleArrayproperty 
public var xmpSimpleArray:Boolean

The XMP type for data grid decides of the Grid represents is an array of structs or an array of simple properties.

Constructor detail
XMPDataGrid()constructor
public function XMPDataGrid()

Constructor, initializes the data grid.

Method detail
changeHandler()method
protected function changeHandler(e:Event):voidParameters
e:Event
focusInHandler()method 
protected override function focusInHandler(event:FocusEvent):voidParameters
event:FocusEvent
focusOutHandler()method 
protected override function focusOutHandler(event:FocusEvent):voidParameters
event:FocusEvent
insertRow()method 
public function insertRow(e:Event = null):void

Inserts a row at the current position of the selection.

Parameters
e:Event (default = null)
itemFocusInHandler()method 
protected function itemFocusInHandler(e:DataGridEvent):voidParameters
e:DataGridEvent
itemFocusOutHandler()method 
protected function itemFocusOutHandler(event:FocusEvent):voidParameters
event:FocusEvent
keyDownHandler()method 
protected override function keyDownHandler(e:KeyboardEvent):void

This event handler starts cell editing with the "F2" key, adding a row with the INS key, delting a row with the DEL key. Cell editing is ended with the ESCAPE key.

Parameters
e:KeyboardEvent
mouseDoubleClickHandler()method 
protected override function mouseDoubleClickHandler(event:MouseEvent):void

This event handler starts cell editing with a double click.

Parameters
event:MouseEvent
mouseDownHandler()method 
protected override function mouseDownHandler(event:MouseEvent):void

Mouse click resets the state of the shift key

Parameters
event:MouseEvent
mouseWheelHandler()method 
protected override function mouseWheelHandler(event:MouseEvent):void

Change the usability of the mouse wheel compared to Flex default. When the mouse pointer hovers over a text input field, the mouse wheel first scrolls inside the text area until the upper or lower end of the text is reached; it then sends the mouse wheel event to the panel to scroll within the panel (this also occurs if the text area contains only a little text and does not have a scrollbar at all.

Parameters
event:MouseEvent
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 reads a complete array of structs (or the simple array) from the associated XMP array property into an array in memory. This cache is modified by the data grid in the UI while the panel is shwon. writeXMP() serializes the whole table back to XMP.

Parameters
event:XMPEvent — The event object for a user-interaction event.
removeRows()method 
public function removeRows(e:Event = null):void

Deletes all selected rows.

Parameters
e:Event (default = null)
updateDisplayList()method 
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number
 
unscaledHeight:Number
writeXMP()method 
public function writeXMP(event:XMPEvent):void

A handler for the xmpWrite event. The default handler serializes the array in memory that has been modified by the UI data grid into the associated XMP array property. The old array is compelted delted upfront. Empty table rows are ignored and not serialized.

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.