jfxtras.scene.control.window

Class NodeUtil

java.lang.Object

jfxtras.scene.control.window.NodeUtil

public class NodeUtil
extends Object

Utility class that provides methods to simplify node handling. Possible use cases are searching for nodes at specific locations, adding/removing nodes to/from parents (Parent interface does not give write access to children).

Author:

Michael Hoffer <info@michaelhoffer.de>, Tom Eugelink <tbee@tbee.org>

Method Summary

Modifier and Type	Method and Description
static void	addToParent(Parent p, Node n) Adds the given node to the specified parent.
static Node	getNode(Parent p, double sceneX, double sceneY, Class<?> nodeClass) Returns the first node at the given location that is an instance of the specified class object.
static void	removeFromParent(Node n) Removes the specified node from its parent.
static double	screenX(Node node)
static double	screenY(Node node)
static double	snapWH(double position, double offset) This method prevents blurry horizontal or vertical lines, use snapWH(x, w) instead of w.
static DoubleBinding	snapWH(ObservableNumberValue position, ObservableNumberValue offset, Observable... dependencies) This is the snapXY method for using in a binding, for example: p1.bind( snapXY( p2.multiply(0.1) ));
static double	snapXY(double position) This method prevents blurry horizontal or vertical lines, use snapXY(x) instead of x.
static DoubleBinding	snapXY(ObservableNumberValue position) This is the snapXY method for using in a binding, for example: p1.bind( snapXY( p2.multiply(0.1) ));

Methods inherited from class java.lang.Object

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

Method Detail

screenX

public static double screenX(Node node)

Parameters:

node -

Returns:

The X screen coordinate of the node.

screenY

public static double screenY(Node node)

Parameters:

node -

Returns:

The Y screen coordinate of the node.

removeFromParent

public static void removeFromParent(Node n)

Removes the specified node from its parent.

Parameters:

n - the node to remove

Throws:

IllegalArgumentException - if an unsupported parent class has been specified or the parent is null

addToParent

public static void addToParent(Parent p,
                               Node n)

Adds the given node to the specified parent.

Parameters:

p - parent

n - node

Throws:

IllegalArgumentException - if an unsupported parent class has been specified or the parent is null

getNode

public static Node getNode(Parent p,
                           double sceneX,
                           double sceneY,
                           Class<?> nodeClass)

Returns the first node at the given location that is an instance of the specified class object. The search is performed recursively until either a node has been found or a leaf node is reached.

Parameters:

p - parent node

sceneX - x coordinate

sceneY - y coordinate

nodeClass - node class to search for

Returns:

a node that contains the specified screen coordinates and is an instance of the specified class or null if no such node exist

snapXY

public static double snapXY(double position)

This method prevents blurry horizontal or vertical lines, use snapXY(x) instead of x.

Parameters:

position - (x or y)

Returns:

snapXY

public static DoubleBinding snapXY(ObservableNumberValue position)

This is the snapXY method for using in a binding, for example: p1.bind( snapXY( p2.multiply(0.1) ));

Parameters:

position - (x or y)

Returns:

snapWH

public static double snapWH(double position,
                            double offset)

This method prevents blurry horizontal or vertical lines, use snapWH(x, w) instead of w.

Parameters:

position - (x or y)

offset - (width or height)

Returns:

snapWH

public static DoubleBinding snapWH(ObservableNumberValue position,
                                   ObservableNumberValue offset,
                                   Observable... dependencies)

This is the snapXY method for using in a binding, for example: p1.bind( snapXY( p2.multiply(0.1) ));

Parameters:

position - (x or y)

offset - (width or height)

dependencies -

Returns: