Page History

...

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

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 ACTION Constant returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

tbody

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#MODIFIERMODIFIER_ALT Constant for the ALT modifier that can be returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#MODIFIERMODIFIER_CTRL Constant for the CTRL modifier that can be returned by JSEvent.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#MODIFIERMODIFIER_META Constant for the META modifier that can be returned by JSEvent.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#MODIFIERMODIFIER_SHIFT Constant for the SHIFT modifier that can be returned by JSEvent.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#data data A data object that specific events can set, a user can set data back to the system for events that supports this.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getElementName getElementName() returns the name of the element, can be null if the form was the source of the event.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getFormName getFormName() returns the name of the form the element was placed on.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#getSource getSource() returns the source component/element of the event.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Date

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getType getType() returns the event type see the JSEvents constants what it can return.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getX getX() Returns the x position of the event, relative to the component that fired it, if applicable.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getY getY() Returns the y position of the event, relative to the component that fired it, if applicable.

HTML Table

id	constant
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Constants Details

Table Body (tbody)

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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 JSEvent.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() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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 JSEvent.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() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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 JSEvent.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() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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 JSEvent.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() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

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;

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

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	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 JSEvent.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() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}

...

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 event type see the JSEvents constants what it can return.
Plugins can create events with there own types.

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() == JSEvent.ACTION)

...


{
	// its an action event.
}

...

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

Table Cell (td)

Child pages

Versions Compared

Old Version 8

New Version 9

Key

ACTION

DATACHANGE

DOUBLECLICK

FOCUSGAINED

FOCUSLOST

FORM

MODIFIER_ALT

MODIFIER_CTRL

MODIFIER_META

MODIFIER_SHIFT

NONE

RIGHTCLICK

data

getElementName

getFormName

getModifiers

getSource

getTimestamp

getType

getX

getY