Child pages
  • JSDNDEvent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
Div
iddescription
HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Constants Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
ACTION
Constant returned by JSEvent.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
DATACHANGE
Constant returned by JSEvent.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
DOUBLECLICK
Constant returned by JSEvent.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
FOCUSGAINED
Constant returned by JSEvent.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
FOCUSLOST
Constant returned by JSEvent.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
FORM
Constant returned by JSEvent.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)MODIFIER_ALT
Constant for
styleindexdisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

Table Cell (td)
Number
Table Cell (td)MODIFIER_CTRL
servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant 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 JSDNDEvent. Table Row (tr)Constant for the CTRL modifier that can be returned by JSDNDEvent. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)MODIFIER_META
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)MODIFIER_SHIFT
Constant for the META modifier that can be returned by JSDNDEvent. Table Row (tr)
Table Cell (td)
String
Table Cell (td)NONE
Constant for the SHIFT modifier that can be returned by JSDNDEvent.Constant returned by JSEvent.Constant returned by JSEvent. Table Row (tr)
Table Cell (td)
String
Table Cell (td)ONDRAG
ONDRAGEND
JSDNDEvent.Constant returned by JSDNDEvent. Table Row (tr)
Table Cell (td)
String
Table Cell (td)ONDRAGOVER
Constant returned by JSDNDEvent. Table Row (tr)
Table Cell (td)
String
Table Cell (td)ONDROP
Constant returned by JSDNDEvent. Table Row (tr)
Table Cell (td)
String
Table Cell (td)Constant returned by JSDNDEvent.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
RIGHTCLICK
Constant returned by JSEvent.
HTML Tableidclassservoy sSummaryidclass
Colgroup Tag
Col
width80px
Col
Table Head (thead) Table Row (tr)styleJSEvent.

servoy sSummary12%30%58%height: 30px;

Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)data
Table Row (tr)
Table Cell (td)
String
Table Cell (td)dataMimeType
The 3Property SummaryA data object that specific events can set, a user can set data back to the system for events that supports this.The event data mime type. HTML Table

Colgroup Tag
Col
width80px
Col
Table Head (thead) Table Row (tr)styleservoy sSummaryid12%30%58%height: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getDragResult()
3Methods SummaryReturns the result of the drag action. Table Row (tr)
Table Cell (td)
String
Table Cell (td)getElementName()
returns the returns the name of the element, can be null if the form was the source of the event. Table Row (tr)
Table Cell (td)
String
Table Cell (td)getFormName()
returns the name of the form the element was placed on. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getModifiers()
Table Row (tr)
Table Cell (td)
JSRecord
Table Cell (td)getRecord()
Returns the modifiers of the event, see JSDNDEvent.Returns the name of the event which was triggeredReturns the record of the event. Table Row (tr)
Table Cell (td)
Object
Table Cell (td)getSource()
returns Table Row (tr)
Table Cell (td)
Date
Table Cell (td)getTimestamp()
returns the source component/element of the event.Returns the time the event occurred. Table Row (tr)
Table Cell (td)
String
Table Cell (td)getType()
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getX()
returns the dnd event type see the JSDNDEvents constants what it can return. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getY()
Returns the y position of 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. HTML Table

constantclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px; Table Head (th)colspan2Constants Details Table Body (tbody)ididACTION Table Row (tr)name

Table Cell (td)

ACTION

tr

iddes Table Cell (td) Div
classsIndent
Constant returned by sIndent
Constant returned by JSEvent.getType() in a method that is attached to an onAction event.
Table Row (tr)idtd
ret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
if (eventsIdentjavascriptlastDetailRowDATACHANGEname

DATACHANGE

dessIndent
Constant returned by JSEvent.getType()
== JSEvent.ACTION) { // its
 in a method that is attached to an 
action
onDataChange event.
}
trret

class

Returns

lastDetailRowsIndentclients

Table Cell (td)
 
Table Body (tbody)
idDATACHANGE
Table Row (tr)
idname
Table Cell (td)

DATACHANGE

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
Constant returned by

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
DOUBLECLICKname

DOUBLECLICK

dessIndent
Constant returned by JSEvent.getType() in a method that is attached to an
onDataChange
 onDoubleClick event.
Table Row (tr)idtd
ret

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (eventsIdentjavascriptlastDetailRowFOCUSGAINEDname

FOCUSGAINED

dessIndent
Constant returned by JSEvent.getType()
== JSEvent.DATACHANGE) { // its a data change event }
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idDOUBLECLICK
Table Row (tr)
idname
Table Cell (td)

DOUBLECLICK

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
Constant returned by
 in a method that is attached to an onFocusGained or the forms onElementFocusGained event.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
FOCUSLOSTname

FOCUSLOST

dessIndent
Constant returned by JSEvent.getType() in a method that is attached to
an onDoubleClick event. Table Row (tr)
idret
td
 an onFocusLost or the forms onElementFocusLost event.
ret

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (eventsIdentjavascriptlastDetailRowFORMname

FORM

dessIndent
Constant returned by JSEvent.getType() 
== JSEvent.DOUBLECLICK) { // its a double click event. }
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idFOCUSGAINED
Table Row (tr)
idname
Table Cell (td)

FOCUSGAINED

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSEvent.getType() in a method that is attached to an onFocusGained or the forms onElementFocusGained event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSEvent.FOCUSGAINED)
{
	// its a focus gained event.
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idFOCUSLOST
Table Row (tr)
idname
Table Cell (td)

FOCUSLOST

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSEvent.getType() in a method that is attached to an onFocusLost or the forms onElementFocusLost event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSEvent.FOCUSLOST)
{
	// its a focus lost event.
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idFORM
Table Row (tr)
idname
Table Cell (td)

FORM

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSEvent.getType() in a method that is attached to a form event (like onShow) or command (like onDeleteRecord)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSEvent.FORM)
{
	// its a form event or command
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idMODIFIER_ALT
Table Row (tr)
idname
Table Cell (td)

MODIFIER_ALT

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for the ALT modifier that can be returned by JSDNDEvent.getModifiers();
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idMODIFIER_CTRL
Table Row (tr)
idname
Table Cell (td)

MODIFIER_CTRL

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for the CTRL modifier that can be returned by JSDNDEvent.getModifiers();
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idMODIFIER_META
Table Row (tr)
idname
Table Cell (td)

MODIFIER_META

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for the META modifier that can be returned by JSDNDEvent.getModifiers();
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idMODIFIER_SHIFT
Table Row (tr)
idname
Table Cell (td)

MODIFIER_SHIFT

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for the SHIFT modifier that can be returned by JSDNDEvent.getModifiers();
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idNONE
Table Row (tr)
idname
Table Cell (td)

NONE

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSEvent.getType() if the event is not used in a known event or command.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSEvent.NONE)
{
	// type is not set.
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idONDRAG
Table Row (tr)
idname
Table Cell (td)

ONDRAG

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDrag event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSDNDEvent.ONDRAG)
{
	// its an ondrag event
	if (event.getElementName() == 'todragelement')
		return DRAGNDROP.COPY
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idONDRAGEND
Table Row (tr)
idname
Table Cell (td)

ONDRAGEND

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDragEnd event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSDNDEvent.ONDRAGEND)
{
	// its an on drag end event.
	// return true if the drop has been completed successfully
	return event.isDropSuccess();
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idONDRAGOVER
Table Row (tr)
idname
Table Cell (td)

ONDRAGOVER

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDragOver event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSDNDEvent.ONDRAGOVER)
{
	// its an on drag over event.
	// return true if it over the right element.
	return event.getElementName() == 'candroponelement';
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idONDROP
Table Row (tr)
idname
Table Cell (td)

ONDROP

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDrop event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSDNDEvent.ONDROP)
{
	// its a on drop event.
	var element = elements[event.getElementName()];
	// do drop on element
	return true;
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idRIGHTCLICK
Table Row (tr)
idname
Table Cell (td)

RIGHTCLICK

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant returned by JSEvent.getType() in a method that is attached to an onRightClick event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSEvent.RIGHTCLICK)
{
	// its a right click event.
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
iddata
Table Row (tr)
idname
Table Cell (td)

data

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
A data object that specific events can set, a user can set data back to the system for events that supports this.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// A client design method that handles ondrag
if (event.getType() == JSEvent.ONDRAG)
{
     // the data is the selected elements array
     var elements = event.data;
     // only start a client design drag when there is 1 element
     if (elements.length == 1)
     {
     	return true;
     }
}

// code for a data drag method
event.data = "drag me!";
return DRAGNDROP.COPY;

// code for a data drop method
var data = event.data;
elemements[event.getElementName()].setText(data);
return true;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddataMimeType
Table Row (tr)
idname
Table Cell (td)

dataMimeType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The event data mime type.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// only accept drag if data is a servoy record
function onDragOver(event)
{
	if(event.dataMimeType.indexOf("application/x-servoy-record-object") == 0) return true;
	else return false;
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetDragResult
Table Row (tr)
idname
Table Cell (td)

getDragResult

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getDragResult
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the result of the drag action.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - a DRAGNDROP constant, representing the result of the drag action
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
function onDragEnd(event)
{
	var dragResult = event.getDragResult();
	if(dragResult == DRAGNDROP.NONE)
	{
		// the drag was canceled
	}
	else if(dragResult == DRAGNDROP.COPY)
	{
		// the drag ended with a copy action
	}
	else if(dragResult == DRAGNDROP.MOVE)
	{
		// the drag ended with a move action
	}
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetElementName
Table Row (tr)
idname
Table Cell (td)

getElementName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getElementName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
returns the name of the element, can be null if the form was the source of the event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the element name.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getElementName() == 'myElement')
{
    elements[event.getElementName()].bgcolor = '#ff0000';
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetFormName
Table Row (tr)
idname
Table Cell (td)

getFormName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getFormName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
returns the name of the form the element was placed on.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the form name.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms[event.getFormName()].myFormMethod();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetModifiers
Table Row (tr)
idname
Table Cell (td)

getModifiers

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getModifiers
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the modifiers of the event, see JSDNDEvent.MODIFIER_XXXX for the modifiers that can be returned.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - an int which holds the modifiers as a bitset.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetRecord
Table Row (tr)
idname
Table Cell (td)

getRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSRecord
Span
stylefont-weight: bold;
getRecord
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the record of the event.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSRecord - Record of the event
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
event.Record();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetSource
Table Row (tr)
idname
Table Cell (td)

getSource

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getSource
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
returns the source component/element of the event.
If it has a name the getElementName() is the name of this component.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object - an Object representing the source of this event.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// cast to runtime text field (change to anoter kind of type if you know the type)
/** @type {RuntimeTextField} */
var source = event.getSource();
var sourceDataProvider = source.getDataProviderID();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetTimestamp
Table Row (tr)
idname
Table Cell (td)

getTimestamp

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Date
Span
stylefont-weight: bold;
getTimestamp
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the time the event occurred.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Date - a Date when this event happened.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
event.getTimestamp();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetType
Table Row (tr)
idname
Table Cell (td)

getType

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getType
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
returns the dnd event type see the JSDNDEvents constants what it can return.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the type of this event.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (event.getType() == JSDNDEvent.ONDROP)
{
	// it's a drop
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetX
Table Row (tr)
idname
Table Cell (td)

getX

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getX
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - an int representing the X position.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var x = event.getX();
var xPrevious = previousEvent.getX();
var movedXPixels = x -xPrevious;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetY
Table Row (tr)
idname
Table Cell (td)

getY

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getY
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - an int representing the Y position.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var y = event.getY();
var yPrevious = previousEvent.getY();
var movedYPixels = y -yPrevious;
Table Row (tr)
classlastDetailRow
Table Cell (td) 
in a method that is attached to a form event (like onShow) or command (like onDeleteRecord)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_ALTname

MODIFIER_ALT

dessIndent
Constant for the ALT modifier that can be returned by JSDNDEvent.getModifiers();
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_CTRLname

MODIFIER_CTRL

dessIndent
Constant for the CTRL modifier that can be returned by JSDNDEvent.getModifiers();
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_METAname

MODIFIER_META

dessIndent
Constant for the META modifier that can be returned by JSDNDEvent.getModifiers();
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_SHIFTname

MODIFIER_SHIFT

dessIndent
Constant for the SHIFT modifier that can be returned by JSDNDEvent.getModifiers();
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
NONEname

NONE

dessIndent
Constant returned by JSEvent.getType() if the event is not used in a known event or command.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
ONDRAGname

ONDRAG

dessIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDrag event.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
ONDRAGENDname

ONDRAGEND

dessIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDragEnd event.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
ONDRAGOVERname

ONDRAGOVER

dessIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDragOver event.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
ONDROPname

ONDROP

dessIndent
Constant returned by JSDNDEvent.getType() in a method that is attached to an onDrop event.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
RIGHTCLICKname

RIGHTCLICK

dessIndent
Constant returned by JSEvent.getType() in a method that is attached to an onRightClick event.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

propertyservoy sDetail2100%height:30px2Property Detailsdataname

data

dessIndent
A data object that specific events can set, a user can set data back to the system for events that supports this.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowdataMimeTypename

dataMimeType

dessIndent
The event data mime type.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetDragResultname

getDragResult()

dessIndent
Returns the result of the drag action.
ret

Returns

sIndent a DRAGNDROP constant, representing the result of the drag action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetElementNamename

getElementName()

dessIndent
returns the name of the element, can be null if the form was the source of the event.
ret

Returns

sIndent a String representing the element name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormNamename

getFormName()

dessIndent
returns the name of the form the element was placed on.
ret

Returns

sIndent a String representing the form name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getModifiersname

getModifiers()

dessIndent
Returns the modifiers of the event, see JSDNDEvent.MODIFIER_XXXX for the modifiers that can be returned.
ret

Returns

sIndent an int which holds the modifiers as a bitset.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getNamename

getName()

dessIndent
Returns the name of the event which was triggered
ret

Returns

sIndent name of event as string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getRecordname

getRecord()

dessIndent
Returns the record of the event.
ret

Returns

sIndent Record of the event
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSourcename

getSource()

dessIndent
returns the source component/element of the event.
If it has a name the getElementName() is the name of this component.
ret

Returns

sIndent an Object representing the source of this event.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTimestampname

getTimestamp()

dessIndent
Returns the time the event occurred.
ret

Returns

sIndent a Date when this event happened.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTypename

getType()

dessIndent
returns the dnd event type see the JSDNDEvents constants what it can return.
ret

Returns

sIndent a String representing the type of this event.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getXname

getX()

dessIndent
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.
ret

Returns

sIndent an int representing the X position.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getYname

getY()

dessIndent
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.
ret

Returns

sIndent an int representing the Y position.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow