Servoy Mobile Documentation
Child pages
  • JSEvent
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Unknown macro: {div}

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'

Unknown macro: {div}


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Constants Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

ACTION
Constant returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

DATACHANGE
Constant returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

DOUBLECLICK
Constant returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

FOCUSGAINED
Constant returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

FOCUSLOST
Constant returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

FORM
Constant returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

MODIFIER_ALT
Constant for the ALT modifier that can be returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

NONE
Constant returned by JSEvent.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

RIGHTCLICK
Constant returned by JSEvent.


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

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


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

getTimestamp()
Returns the time the event occurred.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Constants Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
ACTION
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.ACTION) 
{
	// its an action event.
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
DATACHANGE
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.DATACHANGE) 
{
	// its a data change event
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
DOUBLECLICK
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.DOUBLECLICK) 
{
	// its a double click event.
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
FOCUSGAINED
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.FOCUSGAINED) 
{
	// its a focus gained event.
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
FOCUSLOST
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.FOCUSLOST) 
{
	// its a focus lost event.
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
FORM
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.FORM) 
{
	// its a form event or command
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
MODIFIER_ALT
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
MODIFIER_CTRL
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
MODIFIER_META
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
MODIFIER_SHIFT
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
NONE
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.NONE) 
{
	// type is not set.
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
RIGHTCLICK
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.RIGHTCLICK) 
{
	// its a right click event.
}
Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
data
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
// 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;
Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getElementName
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getElementName

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the element name.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getElementName() == 'myElement')
{
    elements[event.getElementName()].bgcolor = '#ff0000';
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFormName
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getFormName

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the form name.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
forms[event.getFormName()].myFormMethod();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getModifiers
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getModifiers

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
	//do shift action
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSource
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

getSource

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object – an Object representing the source of this event.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
// 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();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTimestamp
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Date

Unknown macro: {span}

getTimestamp

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Returns the time the event occurred.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Date – a Date when this event happened.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
event.getTimestamp();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getType
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getType

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

returns the event type see the JSEvents constants what it can return.
Plugins can create events with there own types.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the type of this event.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
if (event.getType() == JSEvent.ACTION) 
{
	// its an action event.
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getX
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getX

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – an int representing the X position.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
var x = event.getX();
var xPrevious = previousEvent.getX();
var movedXPixels = x -xPrevious;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getY
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getY

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – an int representing the Y position.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div} 
var y = event.getY();
var yPrevious = previousEvent.getY();
var movedYPixels = y -yPrevious;
Unknown macro: {tr}
Unknown macro: {td}
  • No labels