MouseInputEvent

class Communicator.Event.MouseInputEvent()

Constructors

constructor()

Mouse Event class

Methods

`altDown()`
`commandDown()`
`controlDown()`
`getButton()`
`getButtons()`
`getDate()`
`getEventType()`
`getHandled()`
`getModifiers()`
`getPosition()`
`setHandled()`
`shiftDown()`

Constructors

constructor

Communicator.Event.MouseInputEvent.constructor(positionX, positionY, button, buttons, modifiers, inputType)

Mouse Event class

Arguments

positionX (number()) –
positionY (number()) –
button (Communicator.Button()) –
buttons (Communicator.Buttons()) –
modifiers (Communicator.KeyModifiers()) –
inputType (Communicator.MouseInputType()) –

Return type

Communicator.Event.MouseInputEvent

Methods

altDown

Communicator.Event.MouseInputEvent.altDown()

gets the state of the alt key

Return type: boolean
Returns: whether the alt key was down when this event was generated

commandDown

Communicator.Event.MouseInputEvent.commandDown()

gets the state of the command key

Return type: boolean
Returns: whether the command key was down when this event was generated

controlDown

Communicator.Event.MouseInputEvent.controlDown()

gets the state of the control key

Return type: boolean
Returns: whether the control key was down when this event was generated

getButton

Communicator.Event.MouseInputEvent.getButton()

gets the mouse button associated with this event

Return type: Communicator.Button
Returns: the mouse button for this event

getButtons

Communicator.Event.MouseInputEvent.getButtons()

gets the mouse buttons currently pressed with this event

Return type: Communicator.Buttons
Returns: the mouse buttons currently pressed for this event

getDate

Communicator.Event.MouseInputEvent.getDate()

Gets the Date this event occurred

Return type: Date
Returns: the event Date

getEventType

Communicator.Event.MouseInputEvent.getEventType()

gets the event type

Return type: Communicator.MouseInputType
Returns: the type of mouse event

getHandled

Communicator.Event.MouseInputEvent.getHandled()

Gets the handled state of the event

Return type: boolean
Returns: whether the event has been handled

getModifiers

Communicator.Event.MouseInputEvent.getModifiers()

gets the event modifiers

Return type: Communicator.KeyModifiers
Returns: bitwise combination of KeyModifiers

getPosition

Communicator.Event.MouseInputEvent.getPosition()

gets the window position of the mouse pointer for this event

Return type: Communicator.Point2
Returns: the mouse position for this event

setHandled

Communicator.Event.MouseInputEvent.setHandled(handled)

Sets the handled state of the event. When an event has been handled it will not propagate any further

Arguments

handled (boolean()) – Indicates whether this event has been handled.

Return type

void

shiftDown

Communicator.Event.MouseInputEvent.shiftDown()

gets the state of the shift key

Return type: boolean
Returns: whether the shift key was down when this event was generated