com.yworks.yfiles.view

Class Mouse2DEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

com.yworks.yfiles.view.Mouse2DEvent

All Implemented Interfaces:

IEventArgs, Serializable, Cloneable

public class Mouse2DEvent
extends InputEvent
implements IEventArgs

Enumeration of the possible Mouse2DEvent types.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EventType<Mouse2DEvent>	ANY Any Mouse2DEvent.
static EventType<Mouse2DEvent>	CLICKED A mouse click has been recognized.
static EventType<Mouse2DEvent>	DRAGGED The mouse has been dragged, i.e. it has been moved while at least one button has been pressed.
static EventType<Mouse2DEvent>	ENTERED The mouse has entered the control's bounds.
static EventType<Mouse2DEvent>	EXITED The mouse has exited the control's bounds.
static EventType<Mouse2DEvent>	MOVED The mouse has been moved.
static EventType<Mouse2DEvent>	NONE Not a mouse event.
static EventType<Mouse2DEvent>	PRESSED A button has been pressed.
static EventType<Mouse2DEvent>	RELEASED A button has been released.
static EventType<Mouse2DEvent>	WHEEL_TURNED The mouse wheel has been turned.

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
Mouse2DEvent(Object source, EventType<Mouse2DEvent> eventType, PointD location, MouseButtons changedButtons, ModifierKeys changedModifiers, MouseButtons buttons, ModifierKeys modifiers) Constructs a new mouse event argument.
Mouse2DEvent(Object source, EventType<Mouse2DEvent> eventType, PointD location, MouseButtons changedButtons, ModifierKeys changedModifiers, MouseButtons buttons, ModifierKeys modifiers, int mouseWheelDelta, ScrollType scrollType, int scrollAmount, int clickCount) Constructs a new mouse event argument.

Method Summary

Modifier and Type	Method and Description
MouseButtons	getButtons() The state of the mouse buttons at the time of the event creation.
MouseButtons	getChangedButtons() Returns the mouse buttons that have changed for this event.
ModifierKeys	getChangedModifiers() Returns the modifier keys that have changed for this event.
int	getClickCount() Returns the number of clicks the current event represents if it is of type CLICKED.
EventType<Mouse2DEvent>	getEventType() Gets the type of this event.
PointD	getLocation() Returns the coordinates in the world coordinate space associated with this event.
ModifierKeys	getModifiers() The state of the modifier keys at the time of the event creation.
double	getScrollAmount() Gets the distance to scroll at once when ScrollType is ScrollType.LINES.
ScrollType	getScrollType() Gets the scrolling behavior.
double	getWheelDelta() Gets the signed number of mouse wheel turn units.
String	toString() Provides a human readable string representation of this event.

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final EventType<Mouse2DEvent> ANY

Any Mouse2DEvent.

CLICKED

public static final EventType<Mouse2DEvent> CLICKED

A mouse click has been recognized. This is the case if a press has directly been followed by a release.

DRAGGED

public static final EventType<Mouse2DEvent> DRAGGED

The mouse has been dragged, i.e. it has been moved while at least one button has been pressed.

ENTERED

public static final EventType<Mouse2DEvent> ENTERED

The mouse has entered the control's bounds.

EXITED

public static final EventType<Mouse2DEvent> EXITED

The mouse has exited the control's bounds.

MOVED

public static final EventType<Mouse2DEvent> MOVED

The mouse has been moved.

NONE

public static final EventType<Mouse2DEvent> NONE

Not a mouse event.

PRESSED

public static final EventType<Mouse2DEvent> PRESSED

A button has been pressed.

RELEASED

public static final EventType<Mouse2DEvent> RELEASED

A button has been released. If there was no drag event since the last press event, this will result in a click.

WHEEL_TURNED

public static final EventType<Mouse2DEvent> WHEEL_TURNED

The mouse wheel has been turned.

Constructor Detail

Mouse2DEvent

public Mouse2DEvent(Object source,
                    EventType<Mouse2DEvent> eventType,
                    PointD location,
                    MouseButtons changedButtons,
                    ModifierKeys changedModifiers,
                    MouseButtons buttons,
                    ModifierKeys modifiers)

Constructs a new mouse event argument.

Parameters:

eventType - The type of the event

location - the position of the mouse in world coordinates at the time of the event

changedButtons - the mouse buttons that have changed state if the type of event is PRESSED or RELEASED

changedModifiers - the modifier Keys that have been changed

buttons - the current state of the MouseButtons

modifiers - the current state of the modifier Keys

Mouse2DEvent

public Mouse2DEvent(Object source,
                    EventType<Mouse2DEvent> eventType,
                    PointD location,
                    MouseButtons changedButtons,
                    ModifierKeys changedModifiers,
                    MouseButtons buttons,
                    ModifierKeys modifiers,
                    int mouseWheelDelta,
                    ScrollType scrollType,
                    int scrollAmount,
                    int clickCount)

Constructs a new mouse event argument.

Parameters:

eventType - The type of the event

location - the position of the mouse in world coordinates at the time of the event

changedButtons - the mouse buttons that have changed state if the type of event is PRESSED or RELEASED

changedModifiers - the modifier Keys that have been changed

buttons - the current state of the MouseButtons

modifiers - the current state of the modifier Keys

mouseWheelDelta - the signed number of mouse wheel turn units

scrollType - The type of scrolling performed.

scrollAmount - The number of lines to scroll, if scrollType is ScrollType.LINES.

clickCount - the number of clicks this event represents, 2 for a double click

Method Detail

getButtons

public final MouseButtons getButtons()

The state of the mouse buttons at the time of the event creation.

Returns:

The Buttons.

getChangedButtons

public final MouseButtons getChangedButtons()

Returns the mouse buttons that have changed for this event.

Returns:

The ChangedButtons.

See Also:

getButtons()

getChangedModifiers

public final ModifierKeys getChangedModifiers()

Returns the modifier keys that have changed for this event.

Returns:

The ChangedModifiers.

See Also:

getModifiers()

getClickCount

public final int getClickCount()

Returns the number of clicks the current event represents if it is of type CLICKED.

Returns:

The ClickCount.

getEventType

public final EventType<Mouse2DEvent> getEventType()

Gets the type of this event.

Overrides:

getEventType in class InputEvent

Returns:

The EventType.

getLocation

public final PointD getLocation()

Returns the coordinates in the world coordinate space associated with this event.

Returns:

The Location.

getModifiers

public final ModifierKeys getModifiers()

The state of the modifier keys at the time of the event creation.

Returns:

The Modifiers.

getScrollAmount

public final double getScrollAmount()

Gets the distance to scroll at once when ScrollType is ScrollType.LINES.

This is a system setting that only applies to scrolling (not zooming) and usually translates to the number of small scroll increments per scroll wheel notch.

This property has a value of 1 if ScrollType is ScrollType.PAGE, as it is not applicable in that case.

Returns:

The ScrollAmount.

getScrollType

public final ScrollType getScrollType()

Gets the scrolling behavior.

This is a system setting that only applies to scrolling (not zooming) and can be either ScrollType.LINES, in which case ScrollAmount will contain the number of "lines" to scroll with each scroll wheel notch, or ScrollType.PAGE in which case a single scroll wheel notch should scroll a "page" at a time.

Returns:

The ScrollType.

getWheelDelta

public final double getWheelDelta()

Gets the signed number of mouse wheel turn units.

Note that this can, for high-precision mouse wheels, include fractional turns.

Returns:

The WheelDelta.

toString

public String toString()

Provides a human readable string representation of this event.

Overrides:

toString in class EventObject