Package org.gephi.preview.api

Class PreviewMouseEvent

java.lang.Object

org.gephi.preview.api.PreviewMouseEvent

public class PreviewMouseEvent
extends Object

Mouse event for preview. Contains the event type and graph coordinates for the event. If you attend a PreviewMouseEvent, it should be marked as consumed.

The public keyEvent field contains the keyboard state for the given mouse event. Can be null.

Author:

Eduardo Ramos

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreviewMouseEvent.Button
static class	PreviewMouseEvent.Type

Field Summary

Fields

Modifier and Type	Field	Description
PreviewMouseEvent.Button	button
KeyEvent	keyEvent	Contains the keyboard state for the given mouse event.
PreviewMouseEvent.Type	type
int	x
int	y

Constructor Summary

Constructors

Constructor	Description
PreviewMouseEvent(int x, int y, PreviewMouseEvent.Type type, PreviewMouseEvent.Button button, KeyEvent keyEvent)

Method Summary

Modifier and Type	Method	Description
boolean	isConsumed()
void	setConsumed(boolean consumed)

Methods inherited from class java.lang.Object

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

Field Detail

type

public final PreviewMouseEvent.Type type

button

public final PreviewMouseEvent.Button button

x

public final int x

y

public final int y

keyEvent

public final KeyEvent keyEvent

Contains the keyboard state for the given mouse event. Can be null.

Constructor Detail

PreviewMouseEvent

public PreviewMouseEvent(int x,
                         int y,
                         PreviewMouseEvent.Type type,
                         PreviewMouseEvent.Button button,
                         KeyEvent keyEvent)

Method Detail

isConsumed

public boolean isConsumed()

setConsumed

public void setConsumed(boolean consumed)