TGML Mouse Event Methods

The following table contains an overview of the methods that are specific for the mouse event object:

Method Description

getButton()

Returns an integer describing which button was pressed or released. Applicable for MouseDownEvent and MouseUpEvent.
0 = Left button
1 = Middle button 2 = Right button

getClientX()

Returns the X coordinate of the cursor, relative the origin of the target coordinate system.
The coordinate is calculated using the transformations of the target element.

getClientY()

Returns the Y coordinate of the cursor, relative the origin of the target coordinate system.
The coordinate is calculated using the transformations of the target element.

getCurrentTargetX()

Returns the X coordinate of the cursor, relative the origin of the current target coordinate system.
The coordinate is calculated using the transformations of the current target element.

getCurrentTargetY()

Returns the Y coordinate of the cursor, relative the origin of the current target coordinate system.
The coordinate is calculated using the transformations of the current target element.

getCurrentTargetParentX()

Returns the X coordinate of the cursor, relative the origin of the current target's parent coordinate system.
The coordinate is calculated using the transformations of the current target's parent.

getCurrentTargetParentY()

Returns the Y coordinate of the cursor, relative the origin of the current target's parent coordinate system.
The coordinate is calculated using the transformations of the current target's parent.

getScreenX()

Returns the X coordinate of the cursor, relative to the origin of the document coordinate system.

getScreenY()

Returns the Y coordinate of the cursor, relative to the origin of the document coordinate system.