eu.mihosoft.vrl.workflow.fx

Class NodeUtil

java.lang.Object

eu.mihosoft.vrl.workflow.fx.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>

Method Summary

Modifier and Type	Method and Description
static void	addToParent(Parent p, Node n) Adds the given node to the specified parent.
static void	addToParent(Parent p, Node n, int index) Adds the given node to the specified parent.
static List<Parent>	getAncestors(Node n) Returns all ancestors of the specified node.
static List<Parent>	getAncestors(Node n, Parent parent) Returns all ancestors of the specified node till the specified one is reached.
static List<Parent>	getCommonAncestors(Node n1, Node n2) Returns all common ancestors of the specified nodes.
static Node	getNode(Parent p, double sceneX, double sceneY, Class<?>... nodeClasses) Returns the first node at the given location that is an instance of the specified class object.
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 List<String>	getStylesheetsOfAncestors(Node n) Returns the stylesheets of the node and all ancestors of the specified node.
static eu.mihosoft.vrl.workflow.MouseButton	mouseBtnFromEvent(MouseEvent t)
static List<Node>	nodesThatImplement(List<Node> nodes, Class<?> cls)
static List<Node>	nodesWithParent(Parent p, List<Node> nodes)
static void	removeFromParent(Node n) Removes the specified node from its parent.
static double	screenX(Node node)
static double	screenY(Node node)
static Point2D	transformCoordinates(double x, double y, Node from, Node to)

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.

transformCoordinates

public static Point2D transformCoordinates(double x,
                                           double y,
                                           Node from,
                                           Node to)

getCommonAncestors

public static List<Parent> getCommonAncestors(Node n1,
                                              Node n2)

Returns all common ancestors of the specified nodes.

Parameters:

n1 - first scene graph node

n2 - second scene graph node

Returns:

a list that contains all common ancestors of the specified nodes

getAncestors

public static List<Parent> getAncestors(Node n)

Returns all ancestors of the specified node.

Parameters:

n - scene graph node

Returns:

a list that contains all ancestors of the specified node

getStylesheetsOfAncestors

public static List<String> getStylesheetsOfAncestors(Node n)

Returns the stylesheets of the node and all ancestors of the specified node.

Parameters:

n - scene graph node

Returns:

a list that contains the stylesheets of the node and all ancestors of the specified node

getAncestors

public static List<Parent> getAncestors(Node n,
                                        Parent parent)

Returns all ancestors of the specified node till the specified one is reached.

Parameters:

n - scene graph node

parent - scene graph parent

Returns:

a list that contains all ancestors of the specified 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

addToParent

public static void addToParent(Parent p,
                               Node n,
                               int index)

Adds the given node to the specified parent.

Parameters:

p - parent

n - node

index - child index (z buffer)

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

getNode

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

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

nodeClasses - node classes 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

nodesWithParent

public static List<Node> nodesWithParent(Parent p,
                                         List<Node> nodes)

nodesThatImplement

public static List<Node> nodesThatImplement(List<Node> nodes,
                                            Class<?> cls)

mouseBtnFromEvent

public static eu.mihosoft.vrl.workflow.MouseButton mouseBtnFromEvent(MouseEvent t)