JSEvent
Overview
The JSEvent
object serves as the primary argument for user-event callbacks, encapsulating key details about application-triggered events. It provides information such as event type, source element or form, position, and any associated data, enabling developers to handle interactions dynamically and efficiently. Constants like ACTION
, DATACHANGE
, and DOUBLECLICK
help identify specific event types, while methods such as getType()
, getSource()
, and getElementName()
give precise context for each event.
In addition to identifying event origins and types, the object supports positional data with methods like getX()
and getY()
, and tracks the timing of occurrences using getTimestamp()
. It also features a data
property to carry event-specific payloads, enhancing customization options. This makes JSEvent
a flexible and powerful tool for implementing responsive, user-driven functionality in applications.
Constants Summarized
Constant returned by JSEvent.
Constant returned by JSEvent.
Constant returned by JSEvent.
Constant returned by JSEvent.
Constant returned by JSEvent.
Constant returned by JSEvent.
Constant for the ALT modifier that can be returned by JSEvent.
Constant for the CTRL modifier that can be returned by JSEvent.
Constant for the META modifier that can be returned by JSEvent.
Constant for the SHIFT modifier that can be returned by JSEvent.
Constant returned by JSEvent.
Constant returned by JSEvent.
Properties Summarized
A data object that specific events can set, a user can set data back to the system for events that supports this.
Methods Summarized
returns the name of the element, can be null if the form was the source of the event.
returns the name of the form the element was placed on.
Returns the modifiers of the event, see JSEvent.
Returns the name of the event which was triggered
returns the source component/element of the event.
Returns the time the event occurred.
returns the event type see the JSEvents constants what it can return.
Returns the x position of the event, relative to the component that fired it, if applicable.
Returns the y position of the event, relative to the component that fired it, if applicable.
void
stopPropagation is used in case of multiple event listeners (added via application.
Constants Detailed
ACTION
Constant returned by JSEvent.getType() in a method that is attached to an onAction event.
Sample
DATACHANGE
Constant returned by JSEvent.getType() in a method that is attached to an onDataChange event.
Sample
DOUBLECLICK
Constant returned by JSEvent.getType() in a method that is attached to an onDoubleClick event.
Sample
FOCUSGAINED
Constant returned by JSEvent.getType() in a method that is attached to an onFocusGained or the forms onElementFocusGained event.
Sample
FOCUSLOST
Constant returned by JSEvent.getType() in a method that is attached to an onFocusLost or the forms onElementFocusLost event.
Sample
FORM
Constant returned by JSEvent.getType() in a method that is attached to a form event (like onShow) or command (like onDeleteRecord)
Sample
MODIFIER_ALT
Constant for the ALT modifier that can be returned by JSEvent.getModifiers();
Sample
MODIFIER_CTRL
Constant for the CTRL modifier that can be returned by JSEvent.getModifiers();
Sample
MODIFIER_META
Constant for the META modifier that can be returned by JSEvent.getModifiers();
Sample
MODIFIER_SHIFT
Constant for the SHIFT modifier that can be returned by JSEvent.getModifiers();
Sample
NONE
Constant returned by JSEvent.getType() if the event is not used in a known event or command.
Sample
RIGHTCLICK
Constant returned by JSEvent.getType() in a method that is attached to an onRightClick event.
Sample
Properties Detailed
data
A data object that specific events can set, a user can set data back to the system for events that supports this.
Sample
Methods Detailed
getElementName()
returns the name of the element, can be null if the form was the source of the event.
Sample
getFormName()
returns the name of the form the element was placed on.
Sample
getModifiers()
Returns the modifiers of the event, see JSEvent.MODIFIER_XXXX for the modifiers that can be returned.
Sample
getName()
Returns the name of the event which was triggered
Sample
getSource()
returns the source component/element of the event. If it has a name the getElementName() is the name of this component.
Sample
getTimestamp()
Returns the time the event occurred.
Sample
getType()
returns the event type see the JSEvents constants what it can return. Plugins can create events with there own types.
Sample
getX()
Returns the x position of the event, relative to the component that fired it, if applicable. For example drag'n'drop events will set the x,y positions.
Sample
getY()
Returns the y position of the event, relative to the component that fired it, if applicable. For example drag'n'drop events will set the x,y positions.
Sample
stopPropagation()
stopPropagation is used in case of multiple event listeners (added via application.addEventListener). When application.fireEventListeners is called you can use this api to stop executing further listeners.
Returns: void
Sample
Last updated
Was this helpful?