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

styleindex	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

...

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

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

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

...

Table Cell (td)
Number

...

Constant for the CTRL modifier that can be returned by JSEvent.

...

Table Cell (td)
Number

...

Constant for the META modifier that can be returned by JSEvent.

...

Table Cell (td)
Number

...

Table Cell (td)
String

...

Constant for the SHIFT modifier that can be returned by JSEvent.

...

Constant returned by JSEvent.

...

Table Cell (td)
String

...

Constant returned by JSEvent.

...

servoy sSummary

...

padding	0px
width	80px

...

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Property Summary

...

Table Cell (td)
Object

...

3

Property Summary

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

...

servoy sSummary

...

padding	0px
width	80px

...

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
String

...

Table Cell (td)
String

...

3

Methods Summary

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

...

Table Cell (td)
Number

...

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

...

Returns the modifiers of the event, see JSEvent.

...

Table Cell (td)
Object

...

Table Cell (td)
Date

...

Returns the name of the event which was triggered

returns the source component/element of the event.

...

Returns the time the event occurred.

...

Table Cell (td)
String

...

Table Cell (td)
Number

...

returns the event type see the JSEvents 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.

...

constant

...

servoy sDetail

...

padding	0px
width	100%

...

2100%

height:30px

...

colspan	1

...

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

...

class	sIndent

...

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

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

...

class	sIndent

...

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

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

...

class	sIndent

...

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

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

...

class	sIndent

...

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

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

...

class	sIndent

...

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

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

...

class	sIndent

...

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

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_ALT

name

MODIFIER_ALT

des

sIndent

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

...

ret

...

Returns

...

sIndent

clients

...

class	sIndent

...

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
}

...

class	lastDetailRow

...

id	MODIFIER_CTRL

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_CTRL

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_CTRL

name

MODIFIER_CTRL

des

sIndent

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

...

ret

...

Returns

...

sIndent

clients

...

class	sIndent

...

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
}

...

class	lastDetailRow

...

id	MODIFIER_META

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_META

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_META

name

MODIFIER_META

des

sIndent

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

...

ret

...

Returns

...

sIndent

clients

...

class	sIndent

...

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
}

...

class	lastDetailRow

...

id	MODIFIER_SHIFT

Table Row (tr)

id	name

Table Cell (td)
MODIFIER_SHIFT

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

MODIFIER_SHIFT

name

MODIFIER_SHIFT

des

sIndent

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

...

ret

...

Returns

...

sIndent

clients

...

class	sIndent

...

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
}

...

class	lastDetailRow

...

id	NONE

Table Row (tr)

id	name

Table Cell (td)
NONE

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

...

class	sIndent

...

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	RIGHTCLICK

Table Row (tr)

id	name

Table Cell (td)
RIGHTCLICK

...

id	des

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

...

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

...

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 –

sIndent

clients

...

class	sIndent

...

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

Returns
String –

functionservoy sDetail

2100%

height:30px

2

Methods Details

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,MobileClient

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,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

Table Row (tr)

id	ret

Table Cell (td)

Div

class	sIndent

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.

id

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

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

Table Row (tr)

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Table Cell (td) event, see

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

sIdent

javascript

lastDetailRow

getModifiers

name

getModifiers()

des

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)class
Returns DivsIndentNumber – td an int which holds the modifiers as a bitset.clients Table Row (tr)
id sam
 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
 Divclass sIndent
Object – Supported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample 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
idsIdentjavascriptlastDetailRowgetNamenamegetName()dessIndentReturns the name of the event which was triggeredretReturns
sIndent name of event as stringclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowgetSourcenamegetSource()dessIndentreturns the source component/element of the event.
If it has a name the getElementName() is the name of this component.retReturns
sIndent an Object representing the source of this event.clients Table Row (tr)
Supported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsam Table Cell (td) Table Row (tr)
id ret
 Table Cell (td)Returns
 Divclass sIndent
Date – 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)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
 Divclass sIndent
String – sIdentjavascriptlastDetailRowgetTimestampnamegetTimestamp()dessIndentReturns the time the event occurred.retReturns
sIndent a Date when this event happened.clients
 Table Row (tr)
id sam
 Table Cell (td)
Sample
 Div
class sIndent
 Code Block
language javascript

event.getTimestamp();
idSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowgetTypenamegetType()dessIndentreturns the event type see the JSEvents constants what it can return.
Plugins can create events with there own types.retReturns
sIndent a String representing the type of this event.clients Table Row (tr)
Supported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsam Table Cell (td) 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
 Divclass sIndent
Number – Sample Div
class sIndent
 Code Block
language javascript

if (event.getType() == JSEvent.ACTION) 
{
	// its an action event.
}
 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
 Divclass sIndent
Number – sIdentjavascriptlastDetailRowgetXnamegetX()dessIndentReturns 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.retReturns
sIndent an int representing the X position.clients
 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
idSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowgetYnamegetY()dessIndentReturns 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.retReturns
sIndent an int representing the Y position.clients Table Row (tr)
Supported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsam Table Cell (td) Table Row (tr)
class lastDetailRow
tdSample Div
class sIndent
 Code Block
language javascript

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

Child pages

Page History

Versions Compared

Old Version 21

New Version Current

Key

ACTION

DATACHANGE

DATACHANGE

DOUBLECLICK

DOUBLECLICK

FOCUSGAINED

FOCUSGAINED

FOCUSLOST

FOCUSLOST

FORM

FORM

MODIFIER_ALT

MODIFIER_ALT

MODIFIER_CTRL

MODIFIER_CTRL

MODIFIER_META

MODIFIER_META

MODIFIER_SHIFT

MODIFIER_SHIFT

NONE

NONE

RIGHTCLICK

RIGHTCLICK

data

getElementName

data

getElementName()

getFormName

getFormName()

getModifiers

getModifiers()

getSource

getName()

getSource()

getTimestamp

getType

getTimestamp()

getType()

getX

getY

getX()

getY()