{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{hidden}
{sub-section:description|text=}{sub-section}\\
{table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{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}[#ONDRAG]
Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ONDRAGEND]
Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ONDRAGOVER]
Constant returned by JSEvent.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ONDROP]
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:padding=0px|width=80px}{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:padding=0px|width=80px}{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:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Constants Details{th}{tr}{tbody:id=ACTION|class=node}{tr:id=name}{td}h6.ACTION{td}{tr}{tr:id=des}{td}{sub-section:ACTION_des|text=|trigger=button}{sub-section}{sub-section:ACTION_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onAction event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:ACTION_snc|text=|trigger=button}{sub-section}{sub-section:ACTION_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:ACTION_prs|text=|trigger=button}{sub-section}{sub-section:ACTION_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:ACTION_ret|text=|trigger=button}{sub-section}{sub-section:ACTION_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:ACTION_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ACTION_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:ACTION_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ACTION_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:ACTION_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ACTION_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.ACTION)
{
// its an action event.
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DATACHANGE|class=node}{tr:id=name}{td}h6.DATACHANGE{td}{tr}{tr:id=des}{td}{sub-section:DATACHANGE_des|text=|trigger=button}{sub-section}{sub-section:DATACHANGE_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onDataChange event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:DATACHANGE_snc|text=|trigger=button}{sub-section}{sub-section:DATACHANGE_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:DATACHANGE_prs|text=|trigger=button}{sub-section}{sub-section:DATACHANGE_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:DATACHANGE_ret|text=|trigger=button}{sub-section}{sub-section:DATACHANGE_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DATACHANGE_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DATACHANGE_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DATACHANGE_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DATACHANGE_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DATACHANGE_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DATACHANGE_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.DATACHANGE)
{
// its a data change event
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DOUBLECLICK|class=node}{tr:id=name}{td}h6.DOUBLECLICK{td}{tr}{tr:id=des}{td}{sub-section:DOUBLECLICK_des|text=|trigger=button}{sub-section}{sub-section:DOUBLECLICK_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onDoubleClick event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:DOUBLECLICK_snc|text=|trigger=button}{sub-section}{sub-section:DOUBLECLICK_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:DOUBLECLICK_prs|text=|trigger=button}{sub-section}{sub-section:DOUBLECLICK_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:DOUBLECLICK_ret|text=|trigger=button}{sub-section}{sub-section:DOUBLECLICK_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DOUBLECLICK_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DOUBLECLICK_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DOUBLECLICK_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DOUBLECLICK_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DOUBLECLICK_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DOUBLECLICK_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.DOUBLECLICK)
{
// its a double click event.
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FOCUSGAINED|class=node}{tr:id=name}{td}h6.FOCUSGAINED{td}{tr}{tr:id=des}{td}{sub-section:FOCUSGAINED_des|text=|trigger=button}{sub-section}{sub-section:FOCUSGAINED_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onFocusGained or the forms onElementFocusGained event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:FOCUSGAINED_snc|text=|trigger=button}{sub-section}{sub-section:FOCUSGAINED_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:FOCUSGAINED_prs|text=|trigger=button}{sub-section}{sub-section:FOCUSGAINED_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:FOCUSGAINED_ret|text=|trigger=button}{sub-section}{sub-section:FOCUSGAINED_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FOCUSGAINED_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FOCUSGAINED_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FOCUSGAINED_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FOCUSGAINED_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FOCUSGAINED_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FOCUSGAINED_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.FOCUSGAINED)
{
// its a focus gained event.
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FOCUSLOST|class=node}{tr:id=name}{td}h6.FOCUSLOST{td}{tr}{tr:id=des}{td}{sub-section:FOCUSLOST_des|text=|trigger=button}{sub-section}{sub-section:FOCUSLOST_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onFocusLost or the forms onElementFocusLost event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:FOCUSLOST_snc|text=|trigger=button}{sub-section}{sub-section:FOCUSLOST_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:FOCUSLOST_prs|text=|trigger=button}{sub-section}{sub-section:FOCUSLOST_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:FOCUSLOST_ret|text=|trigger=button}{sub-section}{sub-section:FOCUSLOST_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FOCUSLOST_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FOCUSLOST_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FOCUSLOST_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FOCUSLOST_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FOCUSLOST_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FOCUSLOST_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.FOCUSLOST)
{
// its a focus lost event.
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FORM|class=node}{tr:id=name}{td}h6.FORM{td}{tr}{tr:id=des}{td}{sub-section:FORM_des|text=|trigger=button}{sub-section}{sub-section:FORM_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to a form event (like onShow) or command (like onDeleteRecord){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:FORM_snc|text=|trigger=button}{sub-section}{sub-section:FORM_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:FORM_prs|text=|trigger=button}{sub-section}{sub-section:FORM_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:FORM_ret|text=|trigger=button}{sub-section}{sub-section:FORM_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FORM_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FORM_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FORM_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FORM_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FORM_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FORM_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.FORM)
{
// its a form event or command
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_ALT|class=node}{tr:id=name}{td}h6.MODIFIER_ALT{td}{tr}{tr:id=des}{td}{sub-section:MODIFIER_ALT_des|text=|trigger=button}{sub-section}{sub-section:MODIFIER_ALT_des|trigger=none|class=sIndent}Constant for the ALT modifier that can be returned by JSEvent.getModifiers();{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:MODIFIER_ALT_snc|text=|trigger=button}{sub-section}{sub-section:MODIFIER_ALT_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:MODIFIER_ALT_prs|text=|trigger=button}{sub-section}{sub-section:MODIFIER_ALT_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:MODIFIER_ALT_ret|text=|trigger=button}{sub-section}{sub-section:MODIFIER_ALT_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:MODIFIER_ALT_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_ALT_see|trigger=none}[.getModifiers|JSEvent#getModifiers]\\ {sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:MODIFIER_ALT_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_ALT_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:MODIFIER_ALT_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_ALT_sam|trigger=none}{code:language=javascript}
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
//do shift action
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_CTRL|class=node}{tr:id=name}{td}h6.MODIFIER_CTRL{td}{tr}{tr:id=des}{td}{sub-section:MODIFIER_CTRL_des|text=|trigger=button}{sub-section}{sub-section:MODIFIER_CTRL_des|trigger=none|class=sIndent}Constant for the CTRL modifier that can be returned by JSEvent.getModifiers();{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:MODIFIER_CTRL_snc|text=|trigger=button}{sub-section}{sub-section:MODIFIER_CTRL_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:MODIFIER_CTRL_prs|text=|trigger=button}{sub-section}{sub-section:MODIFIER_CTRL_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:MODIFIER_CTRL_ret|text=|trigger=button}{sub-section}{sub-section:MODIFIER_CTRL_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:MODIFIER_CTRL_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_CTRL_see|trigger=none}[.getModifiers|JSEvent#getModifiers]\\ {sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:MODIFIER_CTRL_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_CTRL_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:MODIFIER_CTRL_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_CTRL_sam|trigger=none}{code:language=javascript}
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
//do shift action
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_META|class=node}{tr:id=name}{td}h6.MODIFIER_META{td}{tr}{tr:id=des}{td}{sub-section:MODIFIER_META_des|text=|trigger=button}{sub-section}{sub-section:MODIFIER_META_des|trigger=none|class=sIndent}Constant for the META modifier that can be returned by JSEvent.getModifiers();{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:MODIFIER_META_snc|text=|trigger=button}{sub-section}{sub-section:MODIFIER_META_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:MODIFIER_META_prs|text=|trigger=button}{sub-section}{sub-section:MODIFIER_META_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:MODIFIER_META_ret|text=|trigger=button}{sub-section}{sub-section:MODIFIER_META_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:MODIFIER_META_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_META_see|trigger=none}[.getModifiers|JSEvent#getModifiers]\\ {sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:MODIFIER_META_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_META_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:MODIFIER_META_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_META_sam|trigger=none}{code:language=javascript}
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
//do shift action
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=MODIFIER_SHIFT|class=node}{tr:id=name}{td}h6.MODIFIER_SHIFT{td}{tr}{tr:id=des}{td}{sub-section:MODIFIER_SHIFT_des|text=|trigger=button}{sub-section}{sub-section:MODIFIER_SHIFT_des|trigger=none|class=sIndent}Constant for the SHIFT modifier that can be returned by JSEvent.getModifiers();{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:MODIFIER_SHIFT_snc|text=|trigger=button}{sub-section}{sub-section:MODIFIER_SHIFT_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:MODIFIER_SHIFT_prs|text=|trigger=button}{sub-section}{sub-section:MODIFIER_SHIFT_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:MODIFIER_SHIFT_ret|text=|trigger=button}{sub-section}{sub-section:MODIFIER_SHIFT_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:MODIFIER_SHIFT_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_SHIFT_see|trigger=none}[.getModifiers|JSEvent#getModifiers]\\ {sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:MODIFIER_SHIFT_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_SHIFT_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:MODIFIER_SHIFT_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:MODIFIER_SHIFT_sam|trigger=none}{code:language=javascript}
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
//do shift action
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=NONE|class=node}{tr:id=name}{td}h6.NONE{td}{tr}{tr:id=des}{td}{sub-section:NONE_des|text=|trigger=button}{sub-section}{sub-section:NONE_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() if the event is not used in a known event or command.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:NONE_snc|text=|trigger=button}{sub-section}{sub-section:NONE_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:NONE_prs|text=|trigger=button}{sub-section}{sub-section:NONE_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:NONE_ret|text=|trigger=button}{sub-section}{sub-section:NONE_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:NONE_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:NONE_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:NONE_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:NONE_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:NONE_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:NONE_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.NONE)
{
// type is not set.
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=ONDRAG|class=node}{tr:id=name}{td}h6.ONDRAG{td}{tr}{tr:id=des}{td}{sub-section:ONDRAG_des|text=|trigger=button}{sub-section}{sub-section:ONDRAG_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onDrag event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:ONDRAG_snc|text=|trigger=button}{sub-section}{sub-section:ONDRAG_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:ONDRAG_prs|text=|trigger=button}{sub-section}{sub-section:ONDRAG_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:ONDRAG_ret|text=|trigger=button}{sub-section}{sub-section:ONDRAG_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:ONDRAG_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAG_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:ONDRAG_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAG_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:ONDRAG_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAG_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.ONDRAG)
{
// its an ondrag event
if (event.getElementName() == 'todragelement')
return DRAGNDROP.COPY
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=ONDRAGEND|class=node}{tr:id=name}{td}h6.ONDRAGEND{td}{tr}{tr:id=des}{td}{sub-section:ONDRAGEND_des|text=|trigger=button}{sub-section}{sub-section:ONDRAGEND_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onDragEnd event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:ONDRAGEND_snc|text=|trigger=button}{sub-section}{sub-section:ONDRAGEND_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:ONDRAGEND_prs|text=|trigger=button}{sub-section}{sub-section:ONDRAGEND_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:ONDRAGEND_ret|text=|trigger=button}{sub-section}{sub-section:ONDRAGEND_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:ONDRAGEND_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAGEND_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:ONDRAGEND_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAGEND_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:ONDRAGEND_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAGEND_sam|trigger=none}{code: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();
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=ONDRAGOVER|class=node}{tr:id=name}{td}h6.ONDRAGOVER{td}{tr}{tr:id=des}{td}{sub-section:ONDRAGOVER_des|text=|trigger=button}{sub-section}{sub-section:ONDRAGOVER_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onDragOver event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:ONDRAGOVER_snc|text=|trigger=button}{sub-section}{sub-section:ONDRAGOVER_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:ONDRAGOVER_prs|text=|trigger=button}{sub-section}{sub-section:ONDRAGOVER_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:ONDRAGOVER_ret|text=|trigger=button}{sub-section}{sub-section:ONDRAGOVER_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:ONDRAGOVER_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAGOVER_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:ONDRAGOVER_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAGOVER_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:ONDRAGOVER_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDRAGOVER_sam|trigger=none}{code: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';
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=ONDROP|class=node}{tr:id=name}{td}h6.ONDROP{td}{tr}{tr:id=des}{td}{sub-section:ONDROP_des|text=|trigger=button}{sub-section}{sub-section:ONDROP_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onDrop event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:ONDROP_snc|text=|trigger=button}{sub-section}{sub-section:ONDROP_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:ONDROP_prs|text=|trigger=button}{sub-section}{sub-section:ONDROP_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:ONDROP_ret|text=|trigger=button}{sub-section}{sub-section:ONDROP_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:ONDROP_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDROP_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:ONDROP_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDROP_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:ONDROP_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ONDROP_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.ONDROP)
{
// its a on drop event.
var element = elements[event.getElementName()];
// do drop on element
return true;
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=RIGHTCLICK|class=node}{tr:id=name}{td}h6.RIGHTCLICK{td}{tr}{tr:id=des}{td}{sub-section:RIGHTCLICK_des|text=|trigger=button}{sub-section}{sub-section:RIGHTCLICK_des|trigger=none|class=sIndent}Constant returned by JSEvent.getType() in a method that is attached to an onRightClick event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:RIGHTCLICK_snc|text=|trigger=button}{sub-section}{sub-section:RIGHTCLICK_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:RIGHTCLICK_prs|text=|trigger=button}{sub-section}{sub-section:RIGHTCLICK_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:RIGHTCLICK_ret|text=|trigger=button}{sub-section}{sub-section:RIGHTCLICK_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:RIGHTCLICK_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:RIGHTCLICK_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:RIGHTCLICK_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:RIGHTCLICK_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:RIGHTCLICK_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:RIGHTCLICK_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.RIGHTCLICK)
{
// its a right click event.
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\
{table:id=property|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=data|class=node}{tr:id=name}{td}h6.data{td}{tr}{tr:id=des}{td}{sub-section:data_des|text=|trigger=button}{sub-section}{sub-section:data_des|trigger=none|class=sIndent}A data object that specific events can set, a user can set data back to the system for events that supports this.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:data_snc|text=|trigger=button}{sub-section}{sub-section:data_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:data_prs|text=|trigger=button}{sub-section}{sub-section:data_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:data_ret|text=|trigger=button}{sub-section}{sub-section:data_ret|trigger=none|class=sIndent}[Object]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:data_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:data_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:data_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:data_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:data_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:data_sam|trigger=none}{code: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}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\
{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getElementName|class=node}{tr:id=name}{td}h6.getElementName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getElementName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getElementName_des|text=|trigger=button}{sub-section}{sub-section:getElementName_des|trigger=none|class=sIndent}returns the name of the element, can be null if the form was the source of the event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getElementName_snc|text=|trigger=button}{sub-section}{sub-section:getElementName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getElementName_prs|text=|trigger=button}{sub-section}{sub-section:getElementName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getElementName_ret|text=|trigger=button}{sub-section}{sub-section:getElementName_ret|trigger=none|class=sIndent}[String] -- a String representing the element name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getElementName_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getElementName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getElementName_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementName_sam|trigger=none}{code:language=javascript}
if (event.getElementName() == 'myElement')
{
elements[event.getElementName()].bgcolor = '#ff0000';
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getFormName|class=node}{tr:id=name}{td}h6.getFormName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getFormName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getFormName_des|text=|trigger=button}{sub-section}{sub-section:getFormName_des|trigger=none|class=sIndent}returns the name of the form the element was placed on.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getFormName_snc|text=|trigger=button}{sub-section}{sub-section:getFormName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getFormName_prs|text=|trigger=button}{sub-section}{sub-section:getFormName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getFormName_ret|text=|trigger=button}{sub-section}{sub-section:getFormName_ret|trigger=none|class=sIndent}[String] -- a String representing the form name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getFormName_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getFormName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getFormName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getFormName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getFormName_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getFormName_sam|trigger=none}{code:language=javascript}
forms[event.getFormName()].myFormMethod();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getModifiers|class=node}{tr:id=name}{td}h6.getModifiers{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getModifiers{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getModifiers_des|text=|trigger=button}{sub-section}{sub-section:getModifiers_des|trigger=none|class=sIndent}Returns the modifiers of the event, see JSEvent.MODIFIER\_XXXX for the modifiers that can be returned.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getModifiers_snc|text=|trigger=button}{sub-section}{sub-section:getModifiers_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getModifiers_prs|text=|trigger=button}{sub-section}{sub-section:getModifiers_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getModifiers_ret|text=|trigger=button}{sub-section}{sub-section:getModifiers_ret|trigger=none|class=sIndent}[Number] -- an int which holds the modifiers as a bitset.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getModifiers_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getModifiers_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getModifiers_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getModifiers_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getModifiers_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getModifiers_sam|trigger=none}{code:language=javascript}
//test if the SHIFT modifier is used.
if (event.getModifiers() & JSEvent.MODIFIER_SHIFT)
{
//do shift action
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSource|class=node}{tr:id=name}{td}h6.getSource{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Object]{span}{span:id=iets|style=float: left; font-weight: bold;}getSource{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getSource_des|text=|trigger=button}{sub-section}{sub-section:getSource_des|trigger=none|class=sIndent}returns the source component/element of the event.
If it has a name the getElementName() is the name of this component.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getSource_snc|text=|trigger=button}{sub-section}{sub-section:getSource_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getSource_prs|text=|trigger=button}{sub-section}{sub-section:getSource_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getSource_ret|text=|trigger=button}{sub-section}{sub-section:getSource_ret|trigger=none|class=sIndent}[Object] -- an Object representing the source of this event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getSource_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSource_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getSource_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSource_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getSource_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSource_sam|trigger=none}{code:language=javascript}
var sourceDataProvider = event.getSource().getDataProviderID();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTimestamp|class=node}{tr:id=name}{td}h6.getTimestamp{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Date]{span}{span:id=iets|style=float: left; font-weight: bold;}getTimestamp{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getTimestamp_des|text=|trigger=button}{sub-section}{sub-section:getTimestamp_des|trigger=none|class=sIndent}Returns the time the event occurred.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getTimestamp_snc|text=|trigger=button}{sub-section}{sub-section:getTimestamp_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getTimestamp_prs|text=|trigger=button}{sub-section}{sub-section:getTimestamp_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getTimestamp_ret|text=|trigger=button}{sub-section}{sub-section:getTimestamp_ret|trigger=none|class=sIndent}[Date] -- a Date when this event happened.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getTimestamp_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getTimestamp_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getTimestamp_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getTimestamp_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getTimestamp_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getTimestamp_sam|trigger=none}{code:language=javascript}
event.getTimestamp();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getType|class=node}{tr:id=name}{td}h6.getType{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getType{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getType_des|text=|trigger=button}{sub-section}{sub-section:getType_des|trigger=none|class=sIndent}returns the event type see the JSEvents constants what it can return.
Plugins can create events with there own types.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getType_snc|text=|trigger=button}{sub-section}{sub-section:getType_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getType_prs|text=|trigger=button}{sub-section}{sub-section:getType_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getType_ret|text=|trigger=button}{sub-section}{sub-section:getType_ret|trigger=none|class=sIndent}[String] -- a String representing the type of this event.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getType_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getType_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getType_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getType_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getType_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getType_sam|trigger=none}{code:language=javascript}
if (event.getType() == JSEvent.ACTION)
{
// its an action event.
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getX|class=node}{tr:id=name}{td}h6.getX{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getX{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getX_des|text=|trigger=button}{sub-section}{sub-section:getX_des|trigger=none|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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getX_snc|text=|trigger=button}{sub-section}{sub-section:getX_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getX_prs|text=|trigger=button}{sub-section}{sub-section:getX_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getX_ret|text=|trigger=button}{sub-section}{sub-section:getX_ret|trigger=none|class=sIndent}[Number] -- an int representing the X position.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getX_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getX_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getX_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getX_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getX_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getX_sam|trigger=none}{code:language=javascript}
var x = event.getX();
var xPrevious = previousEvent.getX();
var movedXPixels = x -xPrevious;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getY|class=node}{tr:id=name}{td}h6.getY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getY_des|text=|trigger=button}{sub-section}{sub-section:getY_des|trigger=none|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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getY_snc|text=|trigger=button}{sub-section}{sub-section:getY_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getY_prs|text=|trigger=button}{sub-section}{sub-section:getY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getY_ret|text=|trigger=button}{sub-section}{sub-section:getY_ret|trigger=none|class=sIndent}[Number] -- an int representing the Y position.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getY_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getY_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getY_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getY_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getY_sam|trigger=none}{code:language=javascript}
var y = event.getY();
var yPrevious = previousEvent.getY();
var movedYPixels = y -yPrevious;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Cache
index
true
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClientservoy 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.
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
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