Module javafx.graphics

Package javafx.scene.input

Class MouseEventBinding

java.lang.Object

javafx.scene.input.EventBinding<MouseEvent>

javafx.scene.input.MouseEventBinding

All Implemented Interfaces:

EventListener, EventHandler<MouseEvent>

public class MouseEventBinding
extends EventBinding<MouseEvent>

Executes a command when a MouseEvent is received.

Property Summary

Properties

Type	Property	Description
BooleanProperty	altDown
ObjectProperty<MouseButton>	button
IntegerProperty	clickCount
BooleanProperty	controlDown
BooleanProperty	metaDown
BooleanProperty	shiftDown
BooleanProperty	shortcutDown

Properties inherited from class javafx.scene.input.EventBinding

commandParameter, command

Constructor Summary

Constructors

Constructor	Description
MouseEventBinding()
MouseEventBinding(EventType<MouseEvent> eventType)

Method Summary

Modifier and Type	Method	Description
BooleanProperty	altDownProperty()
ObjectProperty<MouseButton>	buttonProperty()
IntegerProperty	clickCountProperty()
BooleanProperty	controlDownProperty()
MouseButton	getButton()	Gets the value of the property button.
int	getClickCount()	Gets the value of the property clickCount.
void	handle(MouseEvent event)	Invoked when a specific event of the type for which this handler is registered happens.
boolean	isAltDown()	Gets the value of the property altDown.
boolean	isControlDown()	Gets the value of the property controlDown.
boolean	isMetaDown()	Gets the value of the property metaDown.
boolean	isShiftDown()	Gets the value of the property shiftDown.
boolean	isShortcutDown()	Gets the value of the property shortcutDown.
BooleanProperty	metaDownProperty()
void	setAltDown(boolean value)	Sets the value of the property altDown.
void	setButton(MouseButton button)	Sets the value of the property button.
void	setClickCount(int value)	Sets the value of the property clickCount.
void	setControlDown(boolean value)	Sets the value of the property controlDown.
void	setMetaDown(boolean value)	Sets the value of the property metaDown.
void	setShiftDown(boolean value)	Sets the value of the property shiftDown.
void	setShortcutDown(boolean value)	Sets the value of the property shortcutDown.
BooleanProperty	shiftDownProperty()
BooleanProperty	shortcutDownProperty()

Methods inherited from class javafx.scene.input.EventBinding

commandParameterProperty, commandProperty, fireCommand, getCommand, getCommandParameter, getEventType, setCommand, setCommandParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

button

public ObjectProperty<MouseButton> buttonProperty

See Also:

getButton(), setButton(MouseButton)

clickCount

public IntegerProperty clickCountProperty

See Also:

getClickCount(), setClickCount(int)

altDown

public BooleanProperty altDownProperty

See Also:

isAltDown(), setAltDown(boolean)

controlDown

public BooleanProperty controlDownProperty

See Also:

isControlDown(), setControlDown(boolean)

shiftDown

public BooleanProperty shiftDownProperty

See Also:

isShiftDown(), setShiftDown(boolean)

metaDown

public BooleanProperty metaDownProperty

See Also:

isMetaDown(), setMetaDown(boolean)

shortcutDown

public BooleanProperty shortcutDownProperty

See Also:

isShortcutDown(), setShortcutDown(boolean)

Constructor Details

MouseEventBinding

public MouseEventBinding()

MouseEventBinding

public MouseEventBinding(EventType<MouseEvent> eventType)

Method Details

buttonProperty

public ObjectProperty<MouseButton> buttonProperty()

See Also:

getButton(), setButton(MouseButton)

getButton

public MouseButton getButton()

Gets the value of the property button.

Property description:

setButton

public void setButton(MouseButton button)

Sets the value of the property button.

Property description:

clickCountProperty

public IntegerProperty clickCountProperty()

See Also:

getClickCount(), setClickCount(int)

getClickCount

public int getClickCount()

Gets the value of the property clickCount.

Property description:

setClickCount

public void setClickCount(int value)

Sets the value of the property clickCount.

Property description:

altDownProperty

public BooleanProperty altDownProperty()

See Also:

isAltDown(), setAltDown(boolean)

isAltDown

public boolean isAltDown()

Gets the value of the property altDown.

Property description:

setAltDown

public void setAltDown(boolean value)

Sets the value of the property altDown.

Property description:

controlDownProperty

public BooleanProperty controlDownProperty()

See Also:

isControlDown(), setControlDown(boolean)

isControlDown

public boolean isControlDown()

Gets the value of the property controlDown.

Property description:

setControlDown

public void setControlDown(boolean value)

Sets the value of the property controlDown.

Property description:

shiftDownProperty

public BooleanProperty shiftDownProperty()

See Also:

isShiftDown(), setShiftDown(boolean)

isShiftDown

public boolean isShiftDown()

Gets the value of the property shiftDown.

Property description:

setShiftDown

public void setShiftDown(boolean value)

Sets the value of the property shiftDown.

Property description:

metaDownProperty

public BooleanProperty metaDownProperty()

See Also:

isMetaDown(), setMetaDown(boolean)

isMetaDown

public boolean isMetaDown()

Gets the value of the property metaDown.

Property description:

setMetaDown

public void setMetaDown(boolean value)

Sets the value of the property metaDown.

Property description:

shortcutDownProperty

public BooleanProperty shortcutDownProperty()

See Also:

isShortcutDown(), setShortcutDown(boolean)

isShortcutDown

public boolean isShortcutDown()

Gets the value of the property shortcutDown.

Property description:

setShortcutDown

public void setShortcutDown(boolean value)

Sets the value of the property shortcutDown.

Property description:

handle

public void handle(MouseEvent event)

Description copied from interface: EventHandler

Invoked when a specific event of the type for which this handler is registered happens.

Parameters:

event - the event which occurred