org.eth.cyril.graphdrawing.gui.graphdrawer.events

Class MouseEvent

java.lang.Object

org.eth.cyril.graphdrawing.gui.graphdrawer.events.MouseEvent

public class MouseEvent
extends java.lang.Object

A mouse event instance which contains all information corresponding to a mouse event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MouseEvent.KeyboardModifier The keyboard modifiers active.
static class	MouseEvent.MouseButton The mouse button which caused the event.
static class	MouseEvent.MouseEventType Type of mouse event.

Constructor Summary

Constructors

Constructor and Description
MouseEvent(MouseEvent.MouseEventType eventType, MouseEvent.MouseButton mouseButton, java.util.Set<MouseEvent.KeyboardModifier> modifiers, Position mousePosition)

Method Summary

Modifier and Type	Method and Description
MouseEvent.MouseEventType	getEventType() Get the type of event.
java.util.Collection<MouseEvent.KeyboardModifier>	getModifiers() Get the set of keyboard modifiers active during the event.
MouseEvent.MouseButton	getMouseButton() Get the mouse button due to which the event occurred.
Position	getMousePosition() Get the position of the mouse on screen.
boolean	hasNoModifiers() Returns true iff the set of keyboard modifiers is empty.
boolean	hasOnlyModifier(MouseEvent.KeyboardModifier modifier) Checks if there is exactly one modifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

MouseEvent

public MouseEvent(MouseEvent.MouseEventType eventType,
                  MouseEvent.MouseButton mouseButton,
                  java.util.Set<MouseEvent.KeyboardModifier> modifiers,
                  Position mousePosition)

Method Detail

getMousePosition

public Position getMousePosition()

Get the position of the mouse on screen.

getEventType

public MouseEvent.MouseEventType getEventType()

Get the type of event.

getMouseButton

public MouseEvent.MouseButton getMouseButton()

Get the mouse button due to which the event occurred.

getModifiers

public java.util.Collection<MouseEvent.KeyboardModifier> getModifiers()

Get the set of keyboard modifiers active during the event.

hasNoModifiers

public boolean hasNoModifiers()

Returns true iff the set of keyboard modifiers is empty.

hasOnlyModifier

public boolean hasOnlyModifier(MouseEvent.KeyboardModifier modifier)

Checks if there is exactly one modifier.

Parameters:

modifier - The modifier to be the only one active.

Returns:

True iff there is one modifier, and that modifier matches the given one.