RealObjects Nimbudocs Editor 3.0.3929_Beta1

Class: Event


NimbudocsEditor. Event

The event object which is passed to the event handler. The this keyword returns the NimbudocsEditor.Action in case of an action event and the target property otherwise.
This:
  • Object|Action

Properties

altKeyBooleanreadonly
Whether or not the "alt" key was pressed when the event was triggered.
Type:
  • Boolean
argumentStringreadonly
For actioninvoke events, this property specifies the passed action argument. It is null if no argument was passed.
Type:
  • String
buttonNumberreadonly
In case of a mouse button related event, which mouse button has triggered the event. 0 = left, 1 = middle, 2 = right.
Type:
  • Number
buttonsNumberreadonly
In case of a mouse button related event, which mouse buttons were pressed when the event was triggered. The values of the pressed button are summed up: 1 = left, 2 = right, 4 = wheel, 8 = button 4, 16 = button 5.
Type:
  • Number
ctrlKeyBooleanreadonly
Whether or not the "ctrl" key was pressed when the event was triggered.
Type:
  • Boolean
detailNumberreadonly
In case of a mouse button related event, how often the button has been clicked, e.g. for a double click, the value is two. NOTE: Some versions of Internet Explorer do not reset this value, neither after a certain amount of time nor after mouse movement, thus rendering this information for these browsers more or less useless.

OR

The amount of pages for the pageCountChange event, or the current page for the caretPageChange event.
Type:
  • Number
dictionaryObjectreadonly
For dictionary events, this property specifies the new dictionary that was set.
Type:
  • Object
See:
languageStringreadonly
For dictionary events, this property specifies the langauge of the word that was learned or unlearned.
Type:
  • String
metaKeyBooleanreadonly
Whether or not the "meta" key was pressed when the event was triggered.
Type:
  • Boolean
originalTypeStringreadonly
The type of the original HTML DOM Event or jQuery Event
Type:
  • String
pageXNumberreadonly
The x coordinate relative to the page of the mouse when the event was triggered.
Type:
  • Number
pageYNumberreadonly
The y coordinate relative to the page of the mouse when the event was triggered.
Type:
  • Number
persistenceLevelStringreadonly
For dictionary events, this property specifies the persistence level of the dictionaryChange event.
Type:
  • String
See:
preventDefaultFunctionreadonly
Prevents the default functionality of this event to execute. Currently only works for actioninvoke events.
Type:
  • Function
shiftKeyBooleanreadonly
Whether or not the "shift" key was pressed when the event was triggered.
Type:
  • Boolean
targetStringreadonly
For action and document events, this is the document or UI element which triggered the event. Returns null if no element triggered the event.

For dictionary events, this is a {String} that indicates the name of the API method or action that triggered the event.

Type:
  • String
Properties:
Name Type Argument Description
xpath String optional
The XPath expression of the target element. Only for mouse events.
attributes Object optional
An object containing key-value-pairs of all attributes of the element. Only for mouse events.
style Object optional
An object containing key-value-pairs of all inline styles of the element. Only for mouse events.
offsetLeft Number The left offset of the element.
offsetTop Number The top offset of the element.
height Number The height in px of the element.
width Number The width in px of the element.
timeStampNumberreadonly
The time stamp at the time when the event was triggered.
Type:
  • Number
typeStringreadonly
The type of the event.
Type:
  • String
whichNumberreadonly
In case of a mouse button related event, which mouse button has triggered the event.
Type:
  • Number
wordStringreadonly
For dictionary events, this property specifies the word that was learned or unlearned.
Type:
  • String