Provides an overview of the namespace for the platform events.
This chapter explains an overview of the namespace, as well as elements and attributes, for the platform events.
Provides an overview of the namespace for the platform events.
This is the namespace for describing user actions on a canvas as XML document fragments. When you write your XVCD, you don't use the XML document fragments for the platform events. The XML document fragments for the platform events are described by platform.
The namespace URI reference for the platform events is http://xmlns.xfytec.com/event. In the descriptions below, we use event: as the namespace prefix to describe every platform event element.
Also, we use the following namespaces and their prefixes in the descriptions below.
xvcd: as the namespace prefix. dtf: as the namespace prefix. Explains the elements and attributes defined in the namespace for the platform event.
The elements and attributes used to describe the mouse events in the platform event namespace are listed below.
event:mouse-entered eventIndicates that the pointer moved into the area where the node is displayed.
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
The event:mouse-entered element is empty.
event:mouse-exited eventIndicates that the pointer moved out of the area where the node is displayed.
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
The event:mouse-exited element is empty.
event:mouse-pressed eventIndicates that one of the mouse buttons was pressed in the area where the node is displayed.
button (mandatory)
Represents the mouse button pressed. It also represents the status of the Alt, Shift, and Ctrl keys when the button was pressed. The pressed button is identified as follows. Items enclosed with [ ] are optional.
[Ctrl+][Alt+][Shift+] <button number>
Ctrl+, Alt+, or Shift+ indicates that the Ctrl, Alt, or Shift key was pressed, respectively. <button number> indicates:
| 1 | For a 1-button mouse, this value should be set. For a 2-button mouse (with or without wheel) and a 3-button mouse, this value means the left button. |
| 2 | For a 1-button mouse and a 2-button mouse without wheel, this value should not be set. For a 2-button mouse with wheel, this value means the wheel. For a 3-button mouse, this value means the middle button. |
| 3 | For a 1-button mouse, this value should not be set. For a 2-button mouse (with or without wheel) and a 3-button mouse, this value means the right button. |
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
popup-trigger
Represents whether the event triggers the pop-up menu to display or not. This can be a true/false value. If set to true, the event triggers the pop-up menu to display. If set to false, the event does not trigger the pop-up menu to display.
If omitted, the event does not trigger the pop-up menu to display.
The event:mouse-pressed element is empty.
event:mouse-released eventIndicates that one of the mouse buttons was released in the area where the node is displayed.
button (mandatory)
Represents the mouse button released. It also represents the status of the Alt, Shift, and Ctrl keys when the button was released. The released button is identified as follows. Items enclosed with [ ] are optional.
[Ctrl+][Alt+][Shift+] <button number>
Ctrl+, Alt+, or Shift+ indicates that the Ctrl, Alt, or Shift key was pressed, respectively. <button number> indicates:
| 1 | For a 1-button mouse, this value should be set. For a 2-button mouse (with or without wheel) and a 3-button mouse, this value means the left button. |
| 2 | For a 1-button mouse and a 2-button mouse without wheel, this value should not be set. For a 2-button mouse with wheel, this value means the wheel. For a 3-button mouse, this value means the middle button. |
| 3 | For a 1-button mouse, this value should not be set. For a 2-button mouse (with or without wheel) and a 3-button mouse, this value means the right button. |
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
popup-trigger
Represents whether the event triggers the pop-up menu to display or not. This can be a true/false value. If set to true, the event triggers the pop-up menu to display. If set to false, the event does not trigger the pop-up menu to display.
If omitted, the event does not trigger the pop-up menu to display.
The event:mouse-released element is empty.
event:mouse-clicked eventIndicates that the mouse was clicked in the area where the node is displayed.
button (mandatory)
Represents the mouse button clicked. It also represents the status of the Alt, Shift, and Ctrl keys when the button was clicked. The button clicked is identified as follows. Items enclosed with [ ] are optional.
[Ctrl+][Alt+][Shift+] <button number>
Ctrl+, Alt+, or Shift+ indicates that the Ctrl, Alt, or Shift key was pressed, respectively. <button number> indicates:
| 1 | For a 1-button mouse, this value should be set. For a 2-button mouse (with or without wheel) and a 3-button mouse, this value means the left button. |
| 2 | For a 1-button mouse and a 2-button mouse without wheel, this value should not be set. For a 2-button mouse with wheel, this value means the wheel. For a 3-button mouse, this value means the middle button. |
| 3 | For a 1-button mouse, this value should not be set. For a 2-button mouse (with or without wheel) and a 3-button mouse, this value means the right button. |
click-count (mandatory)
Represents how many times the button was clicked.
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
popup-trigger
Represents whether the event triggers the pop-up menu to display or not. This can be a true/false value. If set to true, the event triggers the pop-up menu to display. If set to false, the event does not trigger the pop-up menu to display.
If omitted, the event does not trigger the pop-up menu to display.
The event:mouse-clicked element is empty.
event:mouse-moved eventIndicates that the pointer moved in the area where the node is displayed.
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
The event:mouse-moved element is empty.
event:mouse-dragged eventIndicates that the mouse was dragged in the area where the node is displayed.
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
The event:mouse-dragged element is empty.
event:whell-down eventIndicates that the mouse wheel moved down in the area where the node is displayed.
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
The event:whell-down element is empty.
event:whell-up eventIndicates that the mouse wheel moved up in the area where the node is displayed.
area-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
area-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of the document display area.
component-x (mandatory)
Represents the x coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
component-y (mandatory)
Represents the y coordinate of the pointer when the event occurs. This can be a real number value. The coordinate is relative to the top left corner of vocabulary component.
The event:whell-up element is empty.
The elements and attributes used to describe the key events in the platform event namespace are listed below.
event:key-pressed eventIndicates that a key was pressed.
stroke (mandatory)
Represents the key combination that was pressed. It is identified as follows. Items enclosed with [ ] are optional.
[Ctrl+][Alt+][Shift+] key
Ctrl+, Alt+, or Shift+ indicates that the key and the Ctrl, Alt, or Shift key, respectively, were pressed together. <key> is the string that identifies the character, function, or other key. It can be one of the characters or strings as listed below.
| Key name | String notation |
|---|---|
| Enter | ENTER |
| BackSpace | BACK_SPACE |
| Insert | INSERT |
| Delete | DELETE |
| Tab | TAB |
| Pause | PAUSE |
| CapsLock | CAPS_LOCK |
| Esc | ESCAPE |
| F1 | F1 |
| F2 | F2 |
| F3 | F3 |
| F4 | F4 |
| F5 | F5 |
| F6 | F6 |
| F7 | F7 |
| F8 | F8 |
| F9 | F9 |
| F10 | F10 |
| F11 | F11 |
| F12 | F12 |
| Space | SPACE |
| PageUp | PAGE_UP |
| PageDown | PAGE_DOWN |
| Home | HOME |
| End | END |
| Left Arrow | LEFT |
| Up Arrow | UP |
| Right Arrow | RIGHT |
| Down Arrow | DOWN |
| , (comma) | COMMA |
| . (period) | PERIOD |
| / (slash) | SLASH |
popup-trigger
Represents whether the event triggers the pop-up menu to display or not. This can be a true/false value. If set to true, the event triggers the pop-up menu to display. If set to false, the event does not trigger the pop-up menu to display.
If omitted, the event does not trigger the pop-up menu to display.
The event:key-pressed element is empty.
event:key-released eventIndicates that a key was released.
stroke (mandatory)
Represents the key combination that was released. It is identified as follows. Items enclosed with [ ] are optional.
[Ctrl+][Alt+][Shift+] key
Ctrl+, Alt+, or Shift+ indicates that the key and the Ctrl, Alt, or Shift key, respectively, were pressed together. <key> is the string that identifies the character, function, or other key. It can be one of the characters or strings as listed below.
| Key name | String notation |
|---|---|
| Enter | ENTER |
| BackSpace | BACK_SPACE |
| Insert | INSERT |
| Delete | DELETE |
| Tab | TAB |
| Pause | PAUSE |
| CapsLock | CAPS_LOCK |
| Esc | ESCAPE |
| F1 | F1 |
| F2 | F2 |
| F3 | F3 |
| F4 | F4 |
| F5 | F5 |
| F6 | F6 |
| F7 | F7 |
| F8 | F8 |
| F9 | F9 |
| F10 | F10 |
| F11 | F11 |
| F12 | F12 |
| Space | SPACE |
| PageUp | PAGE_UP |
| PageDown | PAGE_DOWN |
| Home | HOME |
| End | END |
| Left Arrow | LEFT |
| Up Arrow | UP |
| Right Arrow | RIGHT |
| Down Arrow | DOWN |
| , (comma) | COMMA |
| . (period) | PERIOD |
| / (slash) | SLASH |
popup-trigger
Represents whether the event triggers the pop-up menu to display or not. This can be a true/false value. If set to true, the event triggers the pop-up menu to display. If set to false, the event does not trigger the pop-up menu to display.
If omitted, the event does not trigger the pop-up menu to display.
The event:key-released element is empty.
The elements and attributes used to describe the drag and drop events in the platform event namespace are listed below.
event:drag-source eventIndicates the event occurred on the drag source.
type (mandatory)
Represents the event type. It can be one of the following values.
gesture
drag-enter
drag-over
drag-exit
drop-end
A drag and drop operation is initiated when the xvcd:start-drag element is invoked, if the type attribute is set to gesture. The gesture event types are propagated throughout the DOM tree. The other event types are only issued to the node where the xvcd:start-drag element is invoked.
action (mandatory)
Represents the action type of the drag operation. This is set when the type attribute is set to gesture or drop-end. For gesture, this attribute indicates the action selected by the user at the beginning of the operation. For drop-end, it indicates the action to be performed by the drop target. For both cases, it can be one of the following values.
copy
move
link
result (mandatory)
Represents the result of the drag and drop operation. This is set when the type attribute is set to drop-end. This can be one of the following values.
success
failure
The event:drag-source element is empty.
event:drop-target eventIndicates the event occurred on the drag target.
type (mandatory)
Represents the event type. It can be one of the following values.
drag-enter
drag-over
drag-exit
drop
action (mandatory)
Represents the action type of the drag operation. This can be one of the following values.
copy
move
link
The event:drop-target element can contain the following elements.
At least one of these elements must be included, and any number and any combination of them can appear in any order.
The elements and attributes used to describe the caret events in the platform event namespace are listed below.
event:caret-moved eventIndicates that the caret moved in the area where the node is displayed.
No attributes for the element.
The event:caret-moved element is empty.
event:caret-entered eventIndicates that the caret moved into the area where the node is displayed.
No attributes for the element.
The event:caret-entered element is empty.
event:caret-exited eventIndicates that the caret moved out of the area where the node is displayed.
No attributes for the element.
The event:caret-exited element is empty.
The elements and attributes used to describe the input events in the platform event namespace are listed below.
event:string-inserted eventIndicates the event that occurs when one or more characters were entered.
direction
Caret's moved position after string input is indicated below:
forward
backward
forward is assumed by default.
The event:string-inserted element contains the entered characters.