Page History

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.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Divcache

indexstyle	true	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#ACTION Constant returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#DATACHANGE Constant returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#DOUBLECLICK Constant returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#FOCUSGAINED Constant returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#FOCUSLOST Constant returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#FORM Constant returned by JSEvent.

...

Table Cell (td)
Number

...

Table Cell (td)
Number

...

refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

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.Constant for the CTRL modifier that can be returned by JSDNDEvent.

...

Constant for the

...

Table Cell (td)
Number

...

META modifier that can be returned by JSDNDEvent.

...

Constant for the

...

SHIFT modifier that can be returned by JSDNDEvent

...

Table Cell (td)
Number

...

Table Cell (td)
String

...

.

Constant returned by JSEvent.

Constant returned by JSDNDEvent.

...

Constant returned by

...

Table Cell (td)
String

...

JSDNDEvent.

Constant returned by JSDNDEvent.

...

Table Cell (td)
String

...

Constant returned by JSDNDEvent.

...

Table Cell (td)
String

...

Constant returned by

...

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#ONDROP Constant returned by JSDNDEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#RIGHTCLICK Constant returned by JSEvent.

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

...

Table Cell (td)
Object

...

Table Cell (td)
String

...

JSEvent.

servoy sSummary12%30%58%height: 30px;3Property SummaryA data object that specific events can set, a user can set data back to the system for events that supports this.

...

padding	0px
width	80px

...

The event data mime type.

...

servoy sSummary

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
Number

...

3

Methods Summary

Returns the result of the drag action.

...

Table Cell (td)
String

...

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

...

Table Cell (td)
String

...

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getModifiers() Returns the modifiers of the event, see JSDNDEvent.

...

Table Cell (td)
JSRecord

...

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

...

Returns the modifiers of the event, see JSDNDEvent.

Returns the name of the event which was triggered

Returns the record of the event.

...

Table Cell (td)
Object

...

returns the source component/element of the event.

...

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Date

Table Cell (td)
#getTimestamp() Returns the time the event occurred.

...

Table Cell (td)
String

...

Table Cell (td)
Number

...

Returns the time the event occurred.

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

...

Table Cell (td)
Number

...

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.

...

id	constant
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Constants Details

...

id	ACTION

Table Row (tr)

id	name

Table Cell (td)
ACTION

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.ACTION) 
{
	// its an action event.
}

...

class	lastDetailRow

...

id	DATACHANGE

Table Row (tr)

id	name

Table Cell (td)
DATACHANGE

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.DATACHANGE) 
{
	// its a data change event
}

...

class	lastDetailRow

...

id	DOUBLECLICK

Table Row (tr)

id	name

Table Cell (td)
DOUBLECLICK

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.DOUBLECLICK) 
{
	// its a double click event.
}

...

class	lastDetailRow

...

id	FOCUSGAINED

Table Row (tr)

id	name

Table Cell (td)
FOCUSGAINED

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant returned by JSEvent.getType() in a method that is attached to an onFocusGained or the forms onElementFocusGained event.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.FOCUSGAINED) 
{
	// its a focus gained event.
}

...

class	lastDetailRow

...

id	FOCUSLOST

Table Row (tr)

id	name

Table Cell (td)
FOCUSLOST

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant returned by JSEvent.getType() in a method that is attached to an onFocusLost or the forms onElementFocusLost event.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.FOCUSLOST) 
{
	// its a focus lost event.
}

...

class	lastDetailRow

...

id	FORM

Table Row (tr)

id	name

Table Cell (td)
FORM

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant returned by JSEvent.getType() in a method that is attached to a form event (like onShow) or command (like onDeleteRecord)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.FORM) 
{
	// its a form event or command
}

...

class	lastDetailRow

...

id	MODIFIER_ALT

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_ALT

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	MODIFIER_CTRL

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_CTRL

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	MODIFIER_META

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_META

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	MODIFIER_SHIFT

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_SHIFT

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	NONE

Table Row (tr)

id	name

Table Cell (td)
NONE

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.NONE) 
{
	// type is not set.
}

...

class	lastDetailRow

...

id	ONDRAG

Table Row (tr)

id	name

Table Cell (td)
ONDRAG

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	ONDRAGEND

Table Row (tr)

id	name

Table Cell (td)
ONDRAGEND

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	ONDRAGOVER

Table Row (tr)

id	name

Table Cell (td)
ONDRAGOVER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	ONDROP

Table Row (tr)

id	name

Table Cell (td)
ONDROP

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	RIGHTCLICK

Table Row (tr)

id	name

Table Cell (td)
RIGHTCLICK

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


if (event.getType() == JSEvent.RIGHTCLICK) 
{
	// its a right click event.
}

...

class	lastDetailRow

...

id	property
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

...

id	data

Table Row (tr)

id	name

Table Cell (td)
data

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	dataMimeType

Table Row (tr)

id	name

Table Cell (td)
dataMimeType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The event data mime type.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	getDragResult

Table Row (tr)

id	name

Table Cell (td)
getDragResult

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getDragResult

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the result of the drag action.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – a DRAGNDROP constant, representing the result of the drag action

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getElementName

Table Row (tr)

id	name

Table Cell (td)
getElementName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getElementName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – a String representing the element name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getFormName

Table Row (tr)

id	name

Table Cell (td)
getFormName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getFormName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – a String representing the form name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getModifiers

Table Row (tr)

id	name

Table Cell (td)
getModifiers

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getModifiers

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – an int which holds the modifiers as a bitset.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getRecord

Table Row (tr)

id	name

Table Cell (td)
getRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSRecord

Span

style	font-weight: bold;

getRecord

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the record of the event.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSRecord – Record of the event

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


event.Record();

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getSource

Table Row (tr)

id	name

Table Cell (td)
getSource

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getSource

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object – an Object representing the source of this event.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getTimestamp

Table Row (tr)

id	name

Table Cell (td)
getTimestamp

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Date

Span

style	font-weight: bold;

getTimestamp

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the time the event occurred.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Date – a Date when this event happened.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


event.getTimestamp();

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getType

Table Row (tr)

id	name

Table Cell (td)
getType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – a String representing the type of this event.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getX

Table Row (tr)

id	name

Table Cell (td)
getX

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getX

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – an int representing the X position.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getY

Table Row (tr)

id	name

Table Cell (td)
getY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getY

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – an int representing the Y position.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

td

constantservoy sDetail

2100%

height:30px

2

Constants Details

ACTION

name

ACTION

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

DATACHANGE

name

DATACHANGE

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

DOUBLECLICK

name

DOUBLECLICK

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

FOCUSGAINED

name

FOCUSGAINED

des

sIndent

Constant returned by JSEvent.getType() in a method that is attached to an onFocusGained or the forms onElementFocusGained event.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

FOCUSLOST

name

FOCUSLOST

des

sIndent

Constant returned by JSEvent.getType() in a method that is attached to an onFocusLost or the forms onElementFocusLost event.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

FORM

name

FORM

des

sIndent

Constant returned by JSEvent.getType() in a method that is attached to a form event (like onShow) or command (like onDeleteRecord)

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_ALT

name

MODIFIER_ALT

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_CTRL

name

MODIFIER_CTRL

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_META

name

MODIFIER_META

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_SHIFT

name

MODIFIER_SHIFT

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

NONE

name

NONE

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ONDRAG

name

ONDRAG

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ONDRAGEND

name

ONDRAGEND

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ONDRAGOVER

name

ONDRAGOVER

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ONDROP

name

ONDROP

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

RIGHTCLICK

name

RIGHTCLICK

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

propertyservoy sDetail2100%height:30px2Property Detailsdataname

data

des

sIndent

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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

dataMimeType

name

dataMimeType

des

sIndent

The event data mime type.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetDragResultname

getDragResult()

des

sIndent

Returns the result of the drag action.

ret

Returns

sIndent

a DRAGNDROP constant, representing the result of the drag action

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getElementName

name

getElementName()

des

sIndent

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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getFormName

name

getFormName()

des

sIndent

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

ret

Returns

sIndent

a String representing the form name.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getModifiers

name

getModifiers()

des

sIndent

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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getName

name

getName()

des

sIndent

Returns the name of the event which was triggered

ret

Returns

sIndent

name of event as string

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getRecord

name

getRecord()

des

sIndent

Returns the record of the event.

ret

Returns

sIndent

Record of the event

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getSource

name

getSource()

des

sIndent

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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getTimestamp

name

getTimestamp()

des

sIndent

Returns the time the event occurred.

ret

Returns

sIndent

a Date when this event happened.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getType

name

getType()

des

sIndent

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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getX

name

getX()

des

sIndent

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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getY

name

getY()

des

sIndent

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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 10

New Version Current

Key

ACTION

DATACHANGE

DOUBLECLICK

FOCUSGAINED

FOCUSLOST

FORM

MODIFIER_ALT

MODIFIER_CTRL

MODIFIER_META

MODIFIER_SHIFT

NONE

ONDRAG

ONDRAGEND

ONDRAGOVER

ONDROP

RIGHTCLICK

data

dataMimeType

getDragResult

getElementName

getFormName

getModifiers

getRecord

getSource

getTimestamp

getType

getX

getY

ACTION

DATACHANGE

DOUBLECLICK

FOCUSGAINED

FOCUSLOST

FORM

MODIFIER_ALT

MODIFIER_CTRL

MODIFIER_META

MODIFIER_SHIFT

NONE

ONDRAG

ONDRAGEND

ONDRAGOVER

ONDROP

RIGHTCLICK

data

dataMimeType

getDragResult()

getElementName()

getFormName()

getModifiers()

getName()

getRecord()

getSource()

getTimestamp()

getType()

getX()

getY()