JSDNDEvent
Overview
The JSDNDEvent
object is designed for use in drag-and-drop callback functions, offering detailed event information and support for client-server interaction. It integrates deeply with event management in scripting environments. ## Overview
Key Features
Constants for identifying event types (
ONDRAG
,ONDROP
, etc.) and modifiers (MODIFIER_ALT
,MODIFIER_SHIFT
).Properties such as
data
anddataMimeType
to handle event-specific data transfer.Methods for retrieving event details, such as
getDragResult()
,getType()
, and positional data (getX()
,getY()
).
Advanced Usage
The JSDNDEventType
class facilitates JSON conversion for events in browser contexts. It ensures that events with a source are correctly handled, mapping them to client-side representations using a WeakHashMap
for efficient reference management.
Constants Summarized
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 x position of the event, relative to the component that fired it, if applicable.
Constants Detailed
ACTION
Constant returned by JSEvent.getType() in a method that is attached to an onAction event.
Type String
Sample
DATACHANGE
Constant returned by JSEvent.getType() in a method that is attached to an onDataChange event.
Type String
Sample
DOUBLECLICK
Constant returned by JSEvent.getType() in a method that is attached to an onDoubleClick event.
Type String
Sample
FOCUSGAINED
Constant returned by JSEvent.getType() in a method that is attached to an onFocusGained or the forms onElementFocusGained event.
Type String
Sample
FOCUSLOST
Constant returned by JSEvent.getType() in a method that is attached to an onFocusLost or the forms onElementFocusLost event.
Type String
Sample
FORM
Constant returned by JSEvent.getType() in a method that is attached to a form event (like onShow) or command (like onDeleteRecord)
Type String
Sample
MODIFIER_ALT
Constant for the ALT modifier that can be returned by JSDNDEvent.getModifiers();
Type Number
Sample
MODIFIER_CTRL
Constant for the CTRL modifier that can be returned by JSDNDEvent.getModifiers();
Type Number
Sample
MODIFIER_META
Constant for the META modifier that can be returned by JSDNDEvent.getModifiers();
Type Number
Sample
MODIFIER_SHIFT
Constant for the SHIFT modifier that can be returned by JSDNDEvent.getModifiers();
Type Number
Sample
NONE
Constant returned by JSEvent.getType() if the event is not used in a known event or command.
Type String
Sample
ONDRAG
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDrag event.
Type String
Sample
ONDRAGEND
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDragEnd event.
Type String
Sample
ONDRAGOVER
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDragOver event.
Type String
Sample
ONDROP
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDrop event.
Type String
Sample
RIGHTCLICK
Constant returned by JSEvent.getType() in a method that is attached to an onRightClick event.
Type String
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.
Type Object
Sample
dataMimeType
The event data mime type.
Type String
Sample
Methods Detailed
getDragResult()
Returns the result of the drag action.
Returns: Number a DRAGNDROP constant, representing the result of the drag action
Sample
getElementName()
returns the name of the element, can be null if the form was the source of the event.
Returns: String a String representing the element name.
Sample
getFormName()
returns the name of the form the element was placed on.
Returns: String a String representing the form name.
Sample
getModifiers()
Returns the modifiers of the event, see JSDNDEvent.MODIFIER_XXXX for the modifiers that can be returned.
Returns: Number an int which holds the modifiers as a bitset.
Sample
getName()
Returns the name of the event which was triggered
Returns: String name of event as string
Sample
getRecord()
Returns the record of the event.
Returns: JSRecord Record of the event
Sample
getSource()
returns the source component/element of the event. If it has a name the getElementName() is the name of this component.
Returns: Object an Object representing the source of this event.
Sample
getTimestamp()
Returns the time the event occurred.
Returns: Date a Date when this event happened.
Sample
getType()
returns the dnd event type see the JSDNDEvents constants what it can return.
Returns: String a String representing the type of this event.
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.
Returns: Number an int representing the X position.
Sample