public class javafx.scene.input.MouseEvent

Inherits from: com.sun.javafx.runtime.FXBase > javafx.scene.input.MouseEvent

Known subclasses:

Jump to Section:
overview
variables
functions

Overview

The mouse (pointer's) location is available relative to several coordinate systems: x,y - relative to the origin of the MouseEvent's node, sceneX,sceneY - relative to to the origin of the Scene that contains the node, screenX,screenY - relative to origin of the screen that contains the mouse pointer, dragX, dragY - if the MouseEvent is part of a press-drag-release gesture, then relative to the location of the press event, otherwise 0.

Profile: common

Variable Summary

access	name	type	description
public-read	altDown	Boolean	Whether or not the Alt modifier is down on this event.
public-read	button	MouseButton	Which, if any, of the mouse buttons has changed state.
public-read	clickCount	Integer	Number of mouse clicks associated with this event.
public-read	controlDown	Boolean	Whether or not the Control modifier is down on this event.
public-read	dragAnchorX	Number	x position of the event that initiated the most recent press event if the `MouseEvent` is part of a press-drag-release gesture, otherwise the value is `0`.
public-read	dragAnchorY	Number	y position of the event that initiated the most recent press event only if the `MouseEvent` is part of a press-drag-release gesture, otherwise the value is `0`.
public-read	dragX	Number	x offset of the event relative to the most recent press event if the `MouseEvent` is part of a press-drag-release gesture, otherwise the value is `0`.
public-read	dragY	Number	y offset of the event relative to the most recent press event only if the `MouseEvent` is part of a press-drag-release gesture, otherwise the value is `0`.
public-read	metaDown	Boolean	Whether or not the Meta modifier is down on this event.
public-read	middleButtonDown	Boolean	`true` if middle button (button 2) is currently pressed. `true` if middle button (button 2) is currently pressed. Note that this is different from the button variable in that the `button` variable indicates which button press was responsible for this event while this variable indicates whether the primary button is depressed. Profile: common
public-init	node	Node	The Node on which this event has occurred.
public-read	popupTrigger	Boolean	Whether or not this mouse event is the popup menu trigger event for the platform. Whether or not this mouse event is the popup menu trigger event for the platform. Note: Popup menus are triggered differently on different systems. Therefore, `popupTrigger` should be checked in both `onMousePressed` and `mouseReleased` for proper cross-platform functionality. Profile: common
public-read	primaryButtonDown	Boolean	`true` if primary button (button 1, usually the left) is currently pressed. `true` if primary button (button 1, usually the left) is currently pressed. Note that this is different from the button variable in that the `button` variable indicates which button press was responsible for this event while this variable indicates whether the primary button is depressed. Profile: common
public-read	sceneX	Number	Horizontal x position of the event relative to the origin of the `Scene` that contains the MouseEvent's node. Horizontal x position of the event relative to the origin of the `Scene` that contains the MouseEvent's node. If the node is not in a `Scene`, then the value is relative to the boundsInParent of the root-most parent of the MouseEvent's node. Profile: common
public-read	sceneY	Number	Vertical y position of the event relative to the origin of the `Scene` that contains the MouseEvent's node. Vertical y position of the event relative to the origin of the `Scene` that contains the MouseEvent's node. If the node is not in a `Scene`, then the value is relative to the boundsInParent of the root-most parent of the MouseEvent's node. Profile: common
public-read	screenX	Number	Absolute horizontal x position of the event.
public-read	screenY	Number	Absolute vertical y position of the event.
public-read	secondaryButtonDown	Boolean	`true` if secondary button (button 3, usually the right) is currently pressed. `true` if secondary button (button 3, usually the right) is currently pressed. Note that this is different from the button variable in that the `button` variable indicates which button press was responsible for this event while this variable indicates whether the primary button is depressed. Profile: common
public-read	shiftDown	Boolean	Whether or not the Shift modifier is down on this event.
public-read	source	Node	Visually top-most `Node` in the `node` subtree under the mouse. Visually top-most `Node` in the `node` subtree under the mouse. In case the `node` is a leaf node `source` is the same as the `node`. In case `node` is an instance of `Parent` `source` is the visually top-most `Node` in the `node` subtree under the mouse.
public-read	wheelRotation	Number	Number of clicks the mouse wheel was rotated.
public-read	x	Number	Horizontal x position of the event relative to the origin of the MouseEvent's node.
public-read	y	Number	Vertical y position of the event relative to the origin of the MouseEvent's node.

Inherited Variables

Script Function Summary

Function Summary

public toString() : java.lang.String

String

Profile: desktop, common