Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

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 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 Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#MODIFIER_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)
#MODIFIER_CTRL Constant for the CTRL modifier that can be returned by JSEvent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

HTML Table

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 A data object that specific events can set, a user can set data back to the system for events that supports this.

HTML Table

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() 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() returns the name of the form the element was placed on.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#getSource() 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 Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#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
class	node

Table Row (tr)

id	name

Table Cell (td)
ACTION

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
DATACHANGE

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
DOUBLECLICK

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
FOCUSGAINED

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
FOCUSLOST

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
FORM

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_ALT

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	see

Table Cell (td)

Also see

Div

class	sIndent

.getModifiers

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
class	node

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_CTRL

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	see

Table Cell (td)

Also see

Div

class	sIndent

.getModifiers

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
class	node

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_META

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	see

Table Cell (td)

Also see

Div

class	sIndent

.getModifiers

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
class	node

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_SHIFT

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	see

Table Cell (td)

Also see

Div

class	sIndent

.getModifiers

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
class	node

Table Row (tr)

id	name

Table Cell (td)
NONE

Table Row (tr)

id	des

Table Cell (td)
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 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	ONDRAG
class	node

Table Row (tr)

id	name

Table Cell (td)
ONDRAG

Table Row (tr)

id	des

Table Cell (td)
Constant returned by JSEvent.getType() in a method that is attached to an onDrag event.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	ONDRAGEND
class	node

Table Row (tr)

id	name

Table Cell (td)
ONDRAGEND

Table Row (tr)

id	des

Table Cell (td)
Constant returned by JSEvent.getType() in a method that is attached to an onDragEnd event.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	ONDRAGOVER
class	node

Table Row (tr)

id	name

Table Cell (td)
ONDRAGOVER

Table Row (tr)

id	des

Table Cell (td)
Constant returned by JSEvent.getType() in a method that is attached to an onDragOver event.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	ONDROP
class	node

Table Row (tr)

id	name

Table Cell (td)
ONDROP

Table Row (tr)

id	des

Table Cell (td)
Constant returned by JSEvent.getType() in a method that is attached to an onDrop event.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	RIGHTCLICK
class	node

Table Row (tr)

id	name

Table Cell (td)
RIGHTCLICK

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
data

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getElementName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getElementName

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getFormName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getFormName

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getModifiers

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getModifiers

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getSource

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Object

Span

style	float: left; font-weight: bold;
id	iets

getSource

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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

var sourceDataProvider = event.getSource().getDataProviderID();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTimestamp
class	node

Table Row (tr)

id	name

Table Cell (td)
getTimestamp

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Date

Span

style	float: left; font-weight: bold;
id	iets

getTimestamp

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getType

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getX

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getX

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getY

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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 15

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

getElementName

getFormName

getModifiers

getSource

getTimestamp

getType

getX

getY