jfxtras.labs.util.event

Class MouseControlUtil

java.lang.Object

jfxtras.labs.util.event.MouseControlUtil

public class MouseControlUtil
extends Object

This is a utility class that provides methods for mouse gesture control. Currently, it can be used to make nodes draggable.

Author:

Michael Hoffer <info@michaelhoffer.de>

Method Summary

Modifier and Type	Method and Description
static void	addSelectionRectangleGesture(Parent root, Rectangle rect) Adds a selection rectangle gesture to the specified parent node.
static void	addSelectionRectangleGesture(Parent root, Rectangle rect, EventHandler<MouseEvent> dragHandler, EventHandler<MouseEvent> pressHandler, EventHandler<MouseEvent> releaseHandler) Adds a selection rectangle gesture to the specified parent node.
static void	makeDraggable(Node n) Makes a node draggable via mouse gesture.
static void	makeDraggable(Node n, boolean centerNode) Makes a node draggable via mouse gesture.
static void	makeDraggable(Node n, EventHandler<MouseEvent> dragHandler, EventHandler<MouseEvent> pressHandler) Makes a node draggable via mouse gesture.
static void	makeDraggable(Node n, EventHandler<MouseEvent> dragHandler, EventHandler<MouseEvent> pressHandler, boolean centerNode) Makes a node draggable via mouse gesture.

Methods inherited from class java.lang.Object

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

Method Detail

makeDraggable

public static void makeDraggable(Node n)

Makes a node draggable via mouse gesture.

Note: Existing handlers will be replaced!

Parameters:

n - the node that shall be made draggable

makeDraggable

public static void makeDraggable(Node n,
                                 boolean centerNode)

Makes a node draggable via mouse gesture.

Note: Existing handlers will be replaced!

Parameters:

n - the node that shall be made draggable

addSelectionRectangleGesture

public static void addSelectionRectangleGesture(Parent root,
                                                Rectangle rect)

Adds a selection rectangle gesture to the specified parent node. A rectangle node must be specified that is used to indicate the selection area.

Note:

To support selection a node must implement the jfxtras.labs.scene.control.window.SelectableNode interface.

Parameters:

root - parent node

rect - selectionn rectangle

See Also:

jfxtras.labs.scene.control.window.Clipboard, jfxtras.labs.util.WindowUtil#getDefaultClipboard()

addSelectionRectangleGesture

public static void addSelectionRectangleGesture(Parent root,
                                                Rectangle rect,
                                                EventHandler<MouseEvent> dragHandler,
                                                EventHandler<MouseEvent> pressHandler,
                                                EventHandler<MouseEvent> releaseHandler)

Adds a selection rectangle gesture to the specified parent node. A rectangle node must be specified that is used to indicate the selection area.

Note:

To support selection a node must implement the jfxtras.labs.scene.control.window.SelectableNode interface.

Parameters:

root - parent node

rect - selectionn rectangle

dragHandler - additional drag handler (optional, may be null)

pressHandler - additional press handler (optional, may be null)

releaseHandler - additional release handler (optional, may be null)

See Also:

jfxtras.labs.scene.control.window.Clipboard, jfxtras.labs.util.WindowUtil#getDefaultClipboard()

makeDraggable

public static void makeDraggable(Node n,
                                 EventHandler<MouseEvent> dragHandler,
                                 EventHandler<MouseEvent> pressHandler)

Makes a node draggable via mouse gesture.

Note: Existing handlers will be replaced!

Parameters:

n - the node that shall be made draggable

dragHandler - additional drag handler

pressHandler - additional press handler

makeDraggable

public static void makeDraggable(Node n,
                                 EventHandler<MouseEvent> dragHandler,
                                 EventHandler<MouseEvent> pressHandler,
                                 boolean centerNode)

Makes a node draggable via mouse gesture.

Note: Existing handlers will be replaced!

Parameters:

n - the node that shall be made draggable

dragHandler - additional drag handler

pressHandler - additional press handler