Constants Summery | |
---|---|
String | #ACTION Constant returned by JSEvent. |
String | #DATACHANGE Constant returned by JSEvent. |
String | #DOUBLECLICK Constant returned by JSEvent. |
String | #FOCUSGAINED Constant returned by JSEvent. |
String | #FOCUSLOST Constant returned by JSEvent. |
String | #FORM Constant returned by JSEvent. |
Number | #MODIFIER_ALT Constant for the ALT modifier that can be returned by JSEvent. |
Number | #MODIFIER_CTRL Constant for the CTRL modifier that can be returned by JSEvent. |
Number | #MODIFIER_META Constant for the META modifier that can be returned by JSEvent. |
Number | #MODIFIER_SHIFT Constant for the SHIFT modifier that can be returned by JSEvent. |
String | #NONE Constant returned by JSEvent. |
String | #ONDRAG Constant returned by JSEvent. |
String | #ONDRAGOVER Constant returned by JSEvent. |
String | #ONDROP Constant returned by JSEvent. |
String | #RIGHTCLICK Constant returned by JSEvent. |
Property Summery | |
---|---|
Object | #data A data object that specific events can set, a user can set data back to the system for events that supports this. |
Method Summery | |
---|---|
String | #getElementName() returns the name of the element, can be null if the form was the source of the event. |
String | #getFormName() returns the name of the form the element was placed on. |
Number | #getModifiers() Returns the modifiers of the event, see JSEvent. |
Object | #getSource() returns the source component/element of the event. |
Date | #getTimestamp() Returns the time the event occurred. |
String | #getType() returns the event type see the JSEvents constants what it can return. |
Number | #getX() Returns the x position of the event if applicable. |
Number | #getY() Returns the x position of the event if applicable. |
Constants Details |
---|
ACTION |
Constant returned by JSEvent.getType() in a method that is attached to an onAction event. |
Returns String |
Sampleif (event.getType() == JSEvent.ACTION) { // its an action event. } |
DATACHANGE |
Constant returned by JSEvent.getType() in a method that is attached to an onDataChange event. |
Returns String |
Sampleif (event.getType() == JSEvent.DATACHANGE) { // its a data change event } |
DOUBLECLICK |
Constant returned by JSEvent.getType() in a method that is attached to an onDoubleClick event. |
Returns String |
Sampleif (event.getType() == JSEvent.DOUBLECLICK) { // its a double click event. } |
FOCUSGAINED |
Constant returned by JSEvent.getType() in a method that is attached to an onFocusGained or the forms onElementFocusGained event. |
Returns String |
Sampleif (event.getType() == JSEvent.FOCUSGAINED) { // its a focus gained event. } |
FOCUSLOST |
Constant returned by JSEvent.getType() in a method that is attached to an onFocusLost or the forms onElementFocusLost event. |
Returns String |
Sampleif (event.getType() == JSEvent.FOCUSLOST) { // its a focus lost event. } |
FORM |
Constant returned by JSEvent.getType() in a method that is attached to a form event (like onShow) or command (like onDeleteRecord) |
Returns String |
Sampleif (event.getType() == JSEvent.FORM) { // its a form event or command } |
MODIFIER_ALT |
Constant for the ALT modifier that can be returned by JSEvent.getModifiers(); |
Returns Number |
Also see |
Sample//test if the SHIFT modifier is used. if (event.getModifiers() & JSEvent.MODIFIER_SHIFT) { //do shift action } |
MODIFIER_CTRL |
Constant for the CTRL modifier that can be returned by JSEvent.getModifiers(); |
Returns Number |
Also see |
Sample//test if the SHIFT modifier is used. if (event.getModifiers() & JSEvent.MODIFIER_SHIFT) { //do shift action } |
MODIFIER_META |
Constant for the META modifier that can be returned by JSEvent.getModifiers(); |
Returns Number |
Also see |
Sample//test if the SHIFT modifier is used. if (event.getModifiers() & JSEvent.MODIFIER_SHIFT) { //do shift action } |
MODIFIER_SHIFT |
Constant for the SHIFT modifier that can be returned by JSEvent.getModifiers(); |
Returns Number |
Also see |
Sample//test if the SHIFT modifier is used. if (event.getModifiers() & JSEvent.MODIFIER_SHIFT) { //do shift action } |
NONE |
Constant returned by JSEvent.getType() if the event is not used in a known event or command. |
Returns String |
Sampleif (event.getType() == JSEvent.NONE) { // type is not set. } |
ONDRAG |
Constant returned by JSEvent.getType() in a method that is attached to an onDrag event. |
Returns String |
Sampleif (event.getType() == JSEvent.ONDRAG) { // its an ondrag event if (event.getElementName() == 'todragelement') return DRAGNDROP.COPY } |
ONDRAGOVER |
Constant returned by JSEvent.getType() in a method that is attached to an onDragOver event. |
Returns String |
Sampleif (event.getType() == JSEvent.ONDRAGOVER) { // its an on drag over event. // return true if it over the right element. return event.getElementName() == 'candroponelement'; } |
ONDROP |
Constant returned by JSEvent.getType() in a method that is attached to an onDrop event. |
Returns String |
Sampleif (event.getType() == JSEvent.ONDROP) { // its a on drop event. var element = elements[event.getElementName()]; // do drop on element return true; } |
RIGHTCLICK |
Constant returned by JSEvent.getType() in a method that is attached to an onRightClick event. |
Returns String |
Sampleif (event.getType() == JSEvent.RIGHTCLICK) { // its a right click event. } |
Property Details |
---|
data |
A data object that specific events can set, a user can set data back to the system for events that supports this. |
Returns Object |
Sample// 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; |
Method Details |
---|
getElementName |
String getElementName () |
returns the name of the element, can be null if the form was the source of the event. |
Returns String – a String representing the element name. |
Sampleif (event.getElementName() == 'myElement') { elements[event.getElementName()].bgcolor = '#ff0000'; } |
getFormName |
String getFormName () |
returns the name of the form the element was placed on. |
Returns String – a String representing the form name. |
Sampleforms[event.getFormName()].myFormMethod(); |
getModifiers |
Number getModifiers () |
Returns the modifiers of the event, see JSEvent.MODIFIER_XXXX for the modifiers that can be returned. |
Returns Number – an int which holds the modifiers as a bitset. |
Sample//test if the SHIFT modifier is used. if (event.getModifiers() & JSEvent.MODIFIER_SHIFT) { //do shift action } |
getSource |
Object getSource () |
returns the source component/element of the event. If it has a name the getElementName() is the name of this component. |
Returns Object – an Object representing the source of this event. |
Samplevar sourceDataProvider = event.getSource().getDataProviderID(); |
getTimestamp |
Date getTimestamp () |
Returns the time the event occurred. |
Returns Date – a Date when this event happened. |
Sampleevent.getTimestamp(); |
getType |
String getType () |
returns the event type see the JSEvents constants what it can return. Plugins can create events with there own types. |
Returns String – a String representing the type of this event. |
Sampleif (event.getType() == JSEvent.ACTION) { // its an action event. } |
getX |
Number getX () |
Returns the x position of the event if applicable. For example drag'n'drop events will set the x,y positions. |
Returns Number – an int representing the X position. |
Samplevar x = event.getX(); var xPrevious = previousEvent.getX(); var movedXPixels = x -xPrevious; |
getY |
Number getY () |
Returns the x position of the event if applicable. For example drag'n'drop events will set the x,y positions. |
Returns Number – an int representing the Y position. |
Samplevar y = event.getY(); var yPrevious = previousEvent.getY(); var movedYPixels = y -yPrevious; |