org.gillius.jfxutils

Class JFXUtil

java.lang.Object

org.gillius.jfxutils.JFXUtil

public class JFXUtil
extends Object

JFXUtil contains JavaFX utility methods used in the Gillius jfxutils project.

Author:

Jason Winnebeck

Constructor Summary

Constructors

Constructor and Description
JFXUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static javafx.scene.layout.StackPane	createScalePane(javafx.scene.layout.Region region, double w, double h, boolean override) Creates a "Scale Pane", which is a pane that scales as it resizes, instead of reflowing layout like a normal pane.
static double	getXShift(javafx.scene.Node descendant, javafx.scene.Node ancestor) Find the X coordinate in ancestor's coordinate system that corresponds to the X=0 axis in descendant's coordinate system.
static double	getYShift(javafx.scene.Node descendant, javafx.scene.Node ancestor) Find the Y coordinate in ancestor's coordinate system that corresponds to the Y=0 axis in descendant's coordinate system.
static void	replaceComponent(javafx.scene.Node original, javafx.scene.Node replacement) Make a best attempt to replace the original component with the replacement, and keep the same position and layout constraints in the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

JFXUtil

public JFXUtil()

Method Detail

getXShift

public static double getXShift(javafx.scene.Node descendant,
               javafx.scene.Node ancestor)

Find the X coordinate in ancestor's coordinate system that corresponds to the X=0 axis in descendant's coordinate system.

Parameters:

descendant - a Node that is a descendant (direct or indirectly) of the ancestor

ancestor - a Node that is an ancestor of descendant

getYShift

public static double getYShift(javafx.scene.Node descendant,
               javafx.scene.Node ancestor)

Find the Y coordinate in ancestor's coordinate system that corresponds to the Y=0 axis in descendant's coordinate system.

Parameters:

descendant - a Node that is a descendant (direct or indirectly) of the ancestor

ancestor - a Node that is an ancestor of descendant

replaceComponent

public static void replaceComponent(javafx.scene.Node original,
                    javafx.scene.Node replacement)

Make a best attempt to replace the original component with the replacement, and keep the same position and layout constraints in the container.

Currently this method is probably not perfect. It uses three strategies:

1. If the original has any properties, move all of them to the replacement
2. If the parent of the original is a BorderPane, preserve the position
3. Preserve the order of the children in the parent's list

This method does not transfer any handlers (mouse handlers for example).

Parameters:

original - non-null Node whose parent is a Pane.

replacement - non-null Replacement Node

createScalePane

public static javafx.scene.layout.StackPane createScalePane(javafx.scene.layout.Region region,
                                            double w,
                                            double h,
                                            boolean override)

Creates a "Scale Pane", which is a pane that scales as it resizes, instead of reflowing layout like a normal pane. It can be used to create an effect like a presentation slide. There is no attempt to preserve the aspect ratio.

If the region has an explicitly set preferred width and height, those are used unless override is set true.

If the region already has a parent, the returned pane will replace it via the replaceComponent(Node, Node) method. The Region's parent must be a Pane in this case.

Parameters:

region - non-null Region

w - default width, used if the region's width is calculated

h - default height, used if the region's height is calculated

override - if true, w,h is the region's "100%" size even if the region has an explicit preferred width and height set.

Returns:

the created StackPane, with preferred width and height set based on size determined by w, h, and override parameters.