Page History

{div:style=}

Wiki Markup

Div

style	display:none

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

Enter additional information related to this 'class'

inside

the

\{

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Constants Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#ACTION] Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#DATACHANGE] Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#DOUBLECLICK] Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#FOCUSGAINED] Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#FOCUSLOST] Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#FORM] Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#MODIFIER_ALT] Constant for the ALT modifier that can be returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#MODIFIER_CTRL] Constant for the CTRL modifier that can be returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#MODIFIER_META] Constant for the META modifier that can be returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#MODIFIER_SHIFT] Constant for the SHIFT modifier that can be returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#NONE] Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#RIGHTCLICK] Constant returned by JSEvent.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Object]{td}{td}[#data] A data object that specific events can set, a user can set data back to the system for events that supports this.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#getElementName]\() returns the name of the element, can be null if the form was the source of the event.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getFormName]\() returns the name of the form the element was placed on.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getModifiers]\() Returns the modifiers of the event, see JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{td}[#getSource]\() returns the source component/element of the event.{td}{tr}{tbody}{tbody}{tr}{td}[Date]{td}{td}[#getTimestamp]\() Returns the time the event occurred.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getType]\() returns the event type see the JSEvents constants what it can return.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getX]\() Returns the x position of the event, relative to the component that fired it, if applicable.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getY]\() Returns the y position of the event, relative to the component that fired it, if applicable.{td}{tr}{tbody}{table}\\ {table:id=constant|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Constants Details{th}{tr}{tbody:id=ACTION}{tr:id=name}{td}h6.ACTION{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onAction event.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
ACTION Constant returned by JSEvent.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
DATACHANGE Constant returned by JSEvent.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
DOUBLECLICK Constant returned by JSEvent.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
FOCUSGAINED Constant returned by JSEvent.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
FOCUSLOST Constant returned by JSEvent.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
FORM Constant returned by JSEvent.

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
NONE Constant returned by JSEvent.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
RIGHTCLICK Constant returned by JSEvent.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

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

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

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 Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Date

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

Table Row (tr)

Table Cell (td)
String

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

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

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DATACHANGE}{tr:id=name}{td}h6.DATACHANGE{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by

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.

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DOUBLECLICK}{tr:id=name}{td}h6.DOUBLECLICK{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by

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.

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FOCUSGAINED}{tr:id=name}{td}h6.FOCUSGAINED{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by

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.

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FOCUSLOST}{tr:id=name}{td}h6.FOCUSLOST{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by

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.

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FORM}{tr:id=name}{td}h6.FORM{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by

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)

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_ALT}{tr:id=name}{td}h6.MODIFIER_ALT{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant for the ALT modifier that can be returned by

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_CTRL}{tr:id=name}{td}h6.MODIFIER_CTRL{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant for the CTRL modifier that can be returned by

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_META}{tr:id=name}{td}h6.MODIFIER_META{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant for the META modifier that can be returned by

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_SHIFT}{tr:id=name}{td}h6.MODIFIER_SHIFT{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant for the SHIFT modifier that can be returned by

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=NONE}{tr:id=name}{td}h6.NONE{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by

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.

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=RIGHTCLICK}{tr:id=name}{td}h6.RIGHTCLICK{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant returned by

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.

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=data}{tr:id=name}{td}h6.data{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getElementName}{tr:id=name}{td}h6.getElementName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getElementName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}returns the name of the element, can be null if the form was the source of the event.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the element name.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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

} {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getFormName}{tr:id=name}{td}h6.getFormName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getFormName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}returns the name of the form the element was placed on.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the form name.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getModifiers}{tr:id=name}{td}h6.getModifiers{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getModifiers{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the modifiers of the event, see JSEvent.MODIFIER\_XXXX for the modifiers that can be returned.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- an int which holds the modifiers as a bitset.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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 } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSource}{tr:id=name}{td}h6.getSource{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getSource{span}{span}\(){span}{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object] -- an Object representing the source of this event.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTimestamp}{tr:id=name}{td}h6.getTimestamp{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Date]{span}{span:style=font-weight: bold;}getTimestamp{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the time the event occurred.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Date] -- a Date when this event happened.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} event.getTimestamp(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getType}{tr:id=name}{td}h6.getType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}returns the event type see the JSEvents constants what it can return. Plugins can create events with there own types.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the type of this event.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getX}{tr:id=name}{td}h6.getX{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getX{span}{span}\(){span}{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- an int representing the X position.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getY}{tr:id=name}{td}h6.getY{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getY{span}{span}\(){span}{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- an int representing the Y position.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 7

New Version Current

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