Child pages
  • JSEvent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

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.Constant for the CTRL modifier that can be returned by JSEvent.Constant for the META modifier that can be returned by JSEvent.Constant for the SHIFT modifier that can be returned by JSEvent.Constant returned by JSEvent.Constant returned by JSEvent.

servoy sSummary12%30%58%height: 30px;3Property SummaryA data object that specific events can set, a user can set data back to the system for events that supports this.

servoy sSummary12%30%58%height: 30px;3Methods Summaryreturns the name of the element, can be null if the form was the source of the event.returns the name of the form the element was placed on.Returns the modifiers of the event, see JSEvent.Returns the name of the event which was triggeredreturns the source component/element of the event.Returns the time the event occurred.returns the event type see the JSEvents constants what it can return.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.

constantservoy sDetail2100%height:30px2Constants DetailsACTIONname

ACTION

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowDATACHANGEname

DATACHANGE

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
DOUBLECLICKname

DOUBLECLICK

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
FOCUSGAINEDname

FOCUSGAINED

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
FOCUSLOSTname

FOCUSLOST

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
FORMname

FORM

dessIndent
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

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_ALTname

MODIFIER_ALT

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_CTRLname

MODIFIER_CTRL

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_METAname

MODIFIER_META

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
MODIFIER_SHIFTname

MODIFIER_SHIFT

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
NONEname

NONE

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
RIGHTCLICKname

RIGHTCLICK

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow

propertyservoy sDetail2100%height:30px2Property Detailsdataname

data

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetElementNamename

getElementName()

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowgetFormNamename

getFormName()

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

Returns

sIndent a String representing the form name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getModifiersname

getModifiers()

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

Returns

sIndent an int which holds the modifiers as a bitset.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getNamename

getName()

dessIndent
Returns the name of the event which was triggered
ret

Returns

sIndent name of event as string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSourcename

getSource()

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

Returns

sIndent an Object representing the source of this event.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getTimestampname

getTimestamp()

dessIndent
Returns the time the event occurred.
ret

Returns

sIndent a Date when this event happened.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getTypename

getType()

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

Returns

sIndent a String representing the type of this event.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getXname

getX()

dessIndent
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.
ret

Returns

sIndent an int representing the X position.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getYname

getY()

dessIndent
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.
ret

Returns

sIndent an int representing the Y position.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow