Package | com.adobe.xmp.components |
Class | public class XMPDataGrid |
Inheritance | XMPDataGrid ![]() |
Implements | IXMPComponent |
Property | Defined 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:
| 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 |
Method | Defined by | ||
---|---|---|---|
Constructor, initializes the data grid.
| XMPDataGrid | ||
insertRow(e:Event = null):void
Inserts a row at the current position of the selection.
| XMPDataGrid | ||
multivalueHandler(event:XMPEvent):void
A handler for the
xmpMultivalue event. | XMPDataGrid | ||
A handler for the
xmpRead event. | XMPDataGrid | ||
removeRows(e:Event = null):void
Deletes all selected rows.
| XMPDataGrid | ||
A handler for the
xmpWrite event. | XMPDataGrid |
Method | Defined 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 |
Event | Summary | Defined 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 |
dataProvider | property |
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
modified | property |
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
shiftKey | property |
shiftKey:Boolean
[read-only]Implementation
public function get shiftKey():Boolean
xmpArray | property |
xmpArray:String
[read-write]The XMP multi-value data type of the field associated with component, one of:
The default value is bag
.
public function get xmpArray():String
public function set xmpArray(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
xmpSimpleArray | property |
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.
XMPDataGrid | () | constructor |
public function XMPDataGrid()
Constructor, initializes the data grid.
changeHandler | () | method |
protected function changeHandler(e:Event):void
Parameters
e:Event |
focusInHandler | () | method |
protected override function focusInHandler(event:FocusEvent):void
Parameters
event:FocusEvent |
focusOutHandler | () | method |
protected override function focusOutHandler(event:FocusEvent):void
Parameters
event:FocusEvent |
insertRow | () | method |
public function insertRow(e:Event = null):void
Inserts a row at the current position of the selection.
Parameterse:Event (default = null )
|
itemFocusInHandler | () | method |
protected function itemFocusInHandler(e:DataGridEvent):void
Parameters
e:DataGridEvent |
itemFocusOutHandler | () | method |
protected function itemFocusOutHandler(event:FocusEvent):void
Parameters
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.
Parameterse:KeyboardEvent |
mouseDoubleClickHandler | () | method |
protected override function mouseDoubleClickHandler(event:MouseEvent):void
This event handler starts cell editing with a double click.
Parametersevent:MouseEvent |
mouseDownHandler | () | method |
protected override function mouseDownHandler(event:MouseEvent):void
Mouse click resets the state of the shift key
Parametersevent: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.
Parametersevent: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.
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.
event:XMPEvent — The event object for a user-interaction event.
|
removeRows | () | method |
public function removeRows(e:Event = null):void
Deletes all selected rows.
Parameterse:Event (default = null )
|
updateDisplayList | () | method |
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Parameters
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.
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.