Supported Clients
SmartClient
WebClient

Constants Summary
Number
MODIFIER_ALT
Constant for the ALT modifier that can be returned by JSDNDEvent.
Number
MODIFIER_CTRL
Constant for the CTRL modifier that can be returned by JSDNDEvent.
Number
MODIFIER_META
Constant for the META modifier that can be returned by JSDNDEvent.
Number
MODIFIER_SHIFT
Constant for the SHIFT modifier that can be returned by JSDNDEvent.
String
ONDRAG
Constant returned by JSDNDEvent.
String
ONDRAGEND
Constant returned by JSDNDEvent.
String
ONDRAGOVER
Constant returned by JSDNDEvent.
String
ONDROP
Constant returned by JSDNDEvent.

Property Summary
Object
data
A data object that specific events can set, a user can set data back to the system for events that supports this.
String
dataMimeType
The event data mime type.

Methods Summary
Number
getDragResult()
Returns the result of the drag action.
String
getElementName()
returns the name of the element, can be null if the form was the source of the event.
String
getFormName()
returns the name of the form the element was placed on.
Number
getModifiers()
Returns the modifiers of the event, see JSDNDEvent.
JSRecord
getRecord()
Returns the record of the event.
Object
getSource()
returns the source component/element of the event.
Date
getTimestamp()
Returns the time the event occurred.
String
getType()
returns the dnd event type see the JSDNDEvents constants what it can return.
Number
getX()
Returns the x position of the event, relative to the component that fired it, if applicable.
Number
getY()
Returns the y position of the event, relative to the component that fired it, if applicable.

Constants Details

MODIFIER_ALT

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

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}

MODIFIER_CTRL

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

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}

MODIFIER_META

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

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}

MODIFIER_SHIFT

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

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}

ONDRAG

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

Returns

String

Supported Clients

SmartClient,WebClient

Sample

if (event.getType() == JSDNDEvent.ONDRAG) 
{
	// its an ondrag event
	if (event.getElementName() == 'todragelement')
		return DRAGNDROP.COPY
}

ONDRAGEND

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

Returns

String

Supported Clients

SmartClient,WebClient

Sample

if (event.getType() == JSDNDEvent.ONDRAGEND) 
{
	// its an on drag end event.
	// return true if the drop has been completed successfully
	return event.isDropSuccess(); 
}

ONDRAGOVER

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

Returns

String

Supported Clients

SmartClient,WebClient

Sample

if (event.getType() == JSDNDEvent.ONDRAGOVER) 
{
	// its an on drag over event.
	// return true if it over the right element.
	return event.getElementName() == 'candroponelement';
}

ONDROP

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

Returns

String

Supported Clients

SmartClient,WebClient

Sample

if (event.getType() == JSDNDEvent.ONDROP) 
{
	// its a on drop event.
	var element = elements[event.getElementName()];
	// do drop on element
	return true;
}

Property Details

data

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

Returns

Object

Supported Clients

SmartClient,WebClient,NGClient

Sample

// 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;

dataMimeType

The event data mime type.

Returns

String

Supported Clients

SmartClient,WebClient

Sample

// 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;
}

Methods Details

getDragResult()

Returns the result of the drag action.

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

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
	}
}

getElementName()

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

if (event.getElementName() == 'myElement')
{
    elements[event.getElementName()].bgcolor = '#ff0000';
}

getFormName()

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

forms[event.getFormName()].myFormMethod();

getModifiers()

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

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

//test if the SHIFT modifier is used.
if (event.getModifiers() & JSDNDEvent.MODIFIER_SHIFT)
{
	//do shift action
}

getRecord()

Returns the record of the event.

Returns

JSRecord

Supported Clients

SmartClient,WebClient

Sample

event.Record();

getSource()

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

Returns

Object

Supported Clients

SmartClient,WebClient,NGClient

Sample

// 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();

getTimestamp()

Returns the time the event occurred.

Returns

Date

Supported Clients

SmartClient,WebClient,NGClient

Sample

event.getTimestamp();

getType()

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

Returns

String

Supported Clients

SmartClient,WebClient

Sample

if (event.getType() == JSDNDEvent.ONDROP) 
{
	// it's a drop
}

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

var x = event.getX();
var xPrevious = previousEvent.getX();
var movedXPixels = x -xPrevious;

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.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

var y = event.getY();
var yPrevious = previousEvent.getY();
var movedYPixels = y -yPrevious;