A utility class that allows you to wrap JavaFX Nodes with a border, in a way somewhat analogous to the Swing BorderFactory (although with less options as a lot of what the Swing BorderFactory offers resulted in ugly borders!).

The Borders class provides a fluent API for specifying the properties of each border. It is possible to create multiple borders around a Node simply by continuing to call additional methods before you call the final Borders#build() method. To use the Borders class, you simply call Borders#wrap(Node), passing in the Node you wish to wrap the border(s) around.

Examples

Firstly, lets wrap a JavaFX Button node with a simple line border that looks like the following:

Here's the code:

Button button = new Button("Hello World!");
Node wrappedButton = Borders.wrap(button).lineBorder().buildAll();

Easy, isn't it!? You can make the border look a little nicer by replacing the line border with an etched border. An etched border has a subtle inner (or outer) line that makes the border stand out a bit more, like this:

Now that's one good looking border! Here's the code:

Button button = new Button("Hello World!");
Node wrappedButton = Borders.wrap(button).etchedBorder().buildAll();

In some circumstances you want to have multiple borders. For example, you might two line borders. That's easy:

Node wrappedButton = Borders.wrap(button)
    .lineBorder().color(Color.RED).build()
    .lineBorder().color(Color.GREEN).build()
    .build();

You simply chain the borders together, going from inside to outside!

Because of all the configuration options it isn't possible to list all the functionality of all the border types, so refer to the rest of the javadocs for inspiration.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	Borders.Border The public interface used by the `Borders` API to wrap nodes with zero or more Border implementations.
public class	Borders.EmptyBorders A fluent API that is only indirectly instantiable via the `Borders` fluent API, and which allows for an `empty border` to be wrapped around a given Node.
public class	Borders.EtchedBorders A fluent API that is only indirectly instantiable via the `Borders` fluent API, and which allows for an `etched border` to be wrapped around a given Node.
public class	Borders.LineBorders A fluent API that is only indirectly instantiable via the `Borders` fluent API, and which allows for a `line border` to be wrapped around a given Node.
private static class	Borders.StrokeBorder Private support classes

Modifier and Type	Field and Description
private final List<Borders.Border>	borders
private static final Color	DEFAULT_BORDER_COLOR Static fields
private final Node	node Internal fields

Access	Constructor and Description
private	Borders(Node n) Private Constructor

Method Summary

Modifier and Type	Method and Description
public Borders	addBorder(Borders.Border border) Allows for developers to develop custom `Border` implementations, and to wrap them around a Node.
public Node	build() Returns the original node wrapped in zero or more borders, as specified using the fluent API.
public Borders.EmptyBorders	emptyBorder() Often times it is useful to have a bit of whitespace around a Node, to separate it from what it is next to.
public Borders.EtchedBorders	etchedBorder() The etched border look is essentially equivalent to the `lineBorder()` look, except rather than one line, there are two.
public Borders.LineBorders	lineBorder() Creates a nice, simple border around the node.
public static Borders	wrap(Node n) Fluent API entry method(s)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

borders	back to summary
private final List<Borders.Border> borders

DEFAULT_BORDER_COLOR	back to summary
private static final Color DEFAULT_BORDER_COLOR Static fields

node	back to summary
private final Node node Internal fields

Borders	back to summary
private Borders(Node n) Private Constructor

Method Detail

addBorder	back to summary
public Borders addBorder(Borders.Border border) Allows for developers to develop custom `Border` implementations, and to wrap them around a Node. Note that of course this is mostly redundant (as you could just call `Border#wrap(Node)` directly). The only benefit is if you're creating a compound border consisting of multiple borders, and you want your custom border included as part of this.

build	back to summary
public Node build() Returns the original node wrapped in zero or more borders, as specified using the fluent API.

emptyBorder	back to summary
public Borders.EmptyBorders emptyBorder() Often times it is useful to have a bit of whitespace around a Node, to separate it from what it is next to. Call this method to begin building a border that will wrap the node with a given amount of whitespace (which can vary between the top, right, bottom, and left sides).

etchedBorder	back to summary
public Borders.EtchedBorders etchedBorder() The etched border look is essentially equivalent to the `lineBorder()` look, except rather than one line, there are two. What is commonly done in this circumstance is that one of the lines is a very light colour (commonly white), which gives a nice etched look. Refer to the API in `EtchedBorders` for more information.

lineBorder	back to summary
public Borders.LineBorders lineBorder() Creates a nice, simple border around the node. Note that there are many configuration options in `LineBorders`, so explore it carefully.

wrap	back to summary
public static Borders wrap(Node n) Fluent API entry method(s)

org.controlsfx.tools back to summary

public Interface Borders.Border

Known Direct Implementers

org.controlsfx.tools.Borders.StrokeBorder

Annotations

@FunctionalInterface

The public interface used by the Borders API to wrap nodes with zero or more Border implementations. ControlsFX ships with a few Border implementations (current EmptyBorders, LineBorders, and EtchedBorders). As noted in Borders#addBorder(Border), this interface is relatively pointless, unless you plan to wrap a node with multiple borders and you want to use a custom Border implementation for at least one border. In this case, you can simply call Borders#addBorder(Border) with your custom border, when appropriate.

Method Summary

Modifier and Type	Method and Description
public Node	wrap(Node n) Given a `Node`, this method should return a Node that contains the original Node and also has wrapped it with an appropriate border.

Method Detail

wrap	back to summary
public Node wrap(Node n) Given a `Node`, this method should return a Node that contains the original Node and also has wrapped it with an appropriate border.

org.controlsfx.tools back to summary

public Class Borders.EmptyBorders

Class Inheritance

extends Object

java.lang.Object
org.controlsfx.tools.Borders.EmptyBorders

A fluent API that is only indirectly instantiable via the Borders fluent API, and which allows for an empty border to be wrapped around a given Node.

Field Summary

Modifier and Type	Field and Description
private double	bottom
private double	left
private final Borders	parent
private double	right
private double	top

Constructor Summary

Access	Constructor and Description
private	EmptyBorders(Borders parent)

Method Summary

Modifier and Type	Method and Description
public Borders	build() Builds the `Border` and `adds it` to the list of borders to wrap around the given Node (which will be constructed and returned when `Borders#build()` is called.
public Node	buildAll() A convenience method, this is equivalent to calling `build()` followed by `Borders#build()`.
private BorderStroke	buildStroke()
public Borders.EmptyBorders	padding(double padding) Specifies that the wrapped Node should have the given padding around all four sides of itself.
public Borders.EmptyBorders	padding(double top, double right, double bottom, double left) Specifies that the wrapped Node should be wrapped with the given padding for each of its four sides, going in the order top, right, bottom, and finally left.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bottom	back to summary
private double bottom

left	back to summary
private double left

parent	back to summary
private final Borders parent

right	back to summary
private double right

top	back to summary
private double top

Constructor Detail

EmptyBorders	back to summary
private EmptyBorders(Borders parent)

Method Detail

build	back to summary
public Borders build() Builds the `Border` and `adds it` to the list of borders to wrap around the given Node (which will be constructed and returned when `Borders#build()` is called.

buildAll	back to summary
public Node buildAll() A convenience method, this is equivalent to calling `build()` followed by `Borders#build()`. In other words, calling this will return the original Node wrapped in all its borders specified.

buildStroke	back to summary
private BorderStroke buildStroke()

padding	back to summary
public Borders.EmptyBorders padding(double padding) Specifies that the wrapped Node should have the given padding around all four sides of itself.

padding	back to summary
public Borders.EmptyBorders padding(double top, double right, double bottom, double left) Specifies that the wrapped Node should be wrapped with the given padding for each of its four sides, going in the order top, right, bottom, and finally left.

org.controlsfx.tools back to summary

public Class Borders.EtchedBorders

Class Inheritance

extends Object

java.lang.Object
org.controlsfx.tools.Borders.EtchedBorders

A fluent API that is only indirectly instantiable via the Borders fluent API, and which allows for an etched border to be wrapped around a given Node.

Field Summary

Modifier and Type	Field and Description
private double	bottomLeftRadius
private double	bottomRightRadius
private Color	highlightColor
private double	innerBottomPadding
private double	innerLeftPadding
private double	innerRightPadding
private double	innerTopPadding
private double	outerBottomPadding
private double	outerLeftPadding
private double	outerRightPadding
private double	outerTopPadding
private final Borders	parent
private boolean	raised
private Color	shadowColor
private String	title
private double	topLeftRadius
private double	topRightRadius

Constructor Summary

Access	Constructor and Description
private	EtchedBorders(Borders parent)

Method Summary

Modifier and Type	Method and Description
public Borders	build() Builds the `Border` and `adds it` to the list of borders to wrap around the given Node (which will be constructed and returned when `Borders#build()` is called.
public Node	buildAll() A convenience method, this is equivalent to calling `build()` followed by `Borders#build()`.
public Borders.EtchedBorders	highlight(Color highlight) Specifies the highlight colour to use in the etched border.
public Borders.EtchedBorders	innerPadding(double padding) Specifies the inner padding of the four lines of this border.
public Borders.EtchedBorders	innerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have inner padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.
public Borders.EtchedBorders	outerPadding(double padding) Specifies the outer padding of the four lines of this border.
public Borders.EtchedBorders	outerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have outer padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.
public Borders.EtchedBorders	radius(double radius) Specifies the radius of the four corners of the lines of this border.
public Borders.EtchedBorders	radius(double topLeft, double topRight, double bottomRight, double bottomLeft) Specifies that the etched line wrapping the node should have corner radii as specified, with each radius being independently configured, going in the order top-left, top-right, bottom-right, and finally bottom-left.
public Borders.EtchedBorders	raised() Specifies the order in which the highlight and shadow colours are placed.
public Borders.EtchedBorders	shadow(Color shadow) Specifies the shadow colour to use in the etched border.
public Borders.EtchedBorders	title(String title) If desired, this specifies the title text to show in this border.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bottomLeftRadius	back to summary
private double bottomLeftRadius

bottomRightRadius	back to summary
private double bottomRightRadius

highlightColor	back to summary
private Color highlightColor

innerBottomPadding	back to summary
private double innerBottomPadding

innerLeftPadding	back to summary
private double innerLeftPadding

innerRightPadding	back to summary
private double innerRightPadding

innerTopPadding	back to summary
private double innerTopPadding

outerBottomPadding	back to summary
private double outerBottomPadding

outerLeftPadding	back to summary
private double outerLeftPadding

outerRightPadding	back to summary
private double outerRightPadding

outerTopPadding	back to summary
private double outerTopPadding

parent	back to summary
private final Borders parent

raised	back to summary
private boolean raised

shadowColor	back to summary
private Color shadowColor

title	back to summary
private String title

topLeftRadius	back to summary
private double topLeftRadius

topRightRadius	back to summary
private double topRightRadius

Constructor Detail

EtchedBorders	back to summary
private EtchedBorders(Borders parent)

Method Detail

build	back to summary
public Borders build() Builds the `Border` and `adds it` to the list of borders to wrap around the given Node (which will be constructed and returned when `Borders#build()` is called.

buildAll	back to summary
public Node buildAll() A convenience method, this is equivalent to calling `build()` followed by `Borders#build()`. In other words, calling this will return the original Node wrapped in all its borders specified.

highlight	back to summary
public Borders.EtchedBorders highlight(Color highlight) Specifies the highlight colour to use in the etched border.

innerPadding	back to summary
public Borders.EtchedBorders innerPadding(double padding) Specifies the inner padding of the four lines of this border.

innerPadding	back to summary
public Borders.EtchedBorders innerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have inner padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.

outerPadding	back to summary
public Borders.EtchedBorders outerPadding(double padding) Specifies the outer padding of the four lines of this border.

outerPadding	back to summary
public Borders.EtchedBorders outerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have outer padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.

radius	back to summary
public Borders.EtchedBorders radius(double radius) Specifies the radius of the four corners of the lines of this border.

radius	back to summary
public Borders.EtchedBorders radius(double topLeft, double topRight, double bottomRight, double bottomLeft) Specifies that the etched line wrapping the node should have corner radii as specified, with each radius being independently configured, going in the order top-left, top-right, bottom-right, and finally bottom-left.

raised	back to summary
public Borders.EtchedBorders raised() Specifies the order in which the highlight and shadow colours are placed. A raised etched border has the shadow colour on the outside of the border, whereas a non-raised (or lowered) etched border has the shadow colour on the inside of the border.

shadow	back to summary
public Borders.EtchedBorders shadow(Color shadow) Specifies the shadow colour to use in the etched border.

title	back to summary
public Borders.EtchedBorders title(String title) If desired, this specifies the title text to show in this border.

org.controlsfx.tools back to summary

public Class Borders.LineBorders

Class Inheritance

extends Object

java.lang.Object
org.controlsfx.tools.Borders.LineBorders

A fluent API that is only indirectly instantiable via the Borders fluent API, and which allows for a line border to be wrapped around a given Node.

Field Summary

Modifier and Type	Field and Description
private Color	bottomColor
private double	bottomLeftRadius
private double	bottomRightRadius
private double	bottomThickness
private double	innerBottomPadding
private double	innerLeftPadding
private double	innerRightPadding
private double	innerTopPadding
private Color	leftColor
private double	leftThickness
private double	outerBottomPadding
private double	outerLeftPadding
private double	outerRightPadding
private double	outerTopPadding
private final Borders	parent
private Color	rightColor
private double	rightThickness
private BorderStrokeStyle	strokeStyle
private String	title
private Color	topColor
private double	topLeftRadius
private double	topRightRadius
private double	topThickness

Constructor Summary

Access	Constructor and Description
private	LineBorders(Borders parent)

Method Summary

Modifier and Type	Method and Description
public Borders	build() Builds the `Border` and `adds it` to the list of borders to wrap around the given Node (which will be constructed and returned when `Borders#build()` is called.
public Node	buildAll() A convenience method, this is equivalent to calling `build()` followed by `Borders#build()`.
public Borders.LineBorders	color(Color color) Specifies the colour to use for all four sides of this border.
public Borders.LineBorders	color(Color topColor, Color rightColor, Color bottomColor, Color leftColor) Specifies that the wrapped Node should be wrapped with the given colours for each of its four sides, going in the order top, right, bottom, and finally left.
public Borders.LineBorders	innerPadding(double padding) Specifies the outer padding of the four lines of this border.
public Borders.LineBorders	innerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have inner padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.
public Borders.LineBorders	outerPadding(double padding) Specifies the inner padding of the four lines of this border.
public Borders.LineBorders	outerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have outer padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.
public Borders.LineBorders	radius(double radius) Specifies the radius of the four corners of the line of this border.
public Borders.LineBorders	radius(double topLeft, double topRight, double bottomRight, double bottomLeft) Specifies that the line wrapping the node should have corner radii as specified, with each radius being independently configured, going in the order top-left, top-right, bottom-right, and finally bottom-left.
public Borders.LineBorders	strokeStyle(BorderStrokeStyle strokeStyle) Specifies which `BorderStrokeStyle` to use for this line border.
public Borders.LineBorders	thickness(double thickness) Specifies the thickness of the line to use on all four sides of this border.
public Borders.LineBorders	thickness(double topThickness, double rightThickness, double bottomThickness, double leftThickness) Specifies that the wrapped Node should be wrapped with the given line thickness for each of its four sides, going in the order top, right, bottom, and finally left.
public Borders.LineBorders	title(String title) If desired, this specifies the title text to show in this border.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bottomColor	back to summary
private Color bottomColor

bottomLeftRadius	back to summary
private double bottomLeftRadius

bottomRightRadius	back to summary
private double bottomRightRadius

bottomThickness	back to summary
private double bottomThickness

innerBottomPadding	back to summary
private double innerBottomPadding

innerLeftPadding	back to summary
private double innerLeftPadding

innerRightPadding	back to summary
private double innerRightPadding

innerTopPadding	back to summary
private double innerTopPadding

leftColor	back to summary
private Color leftColor

leftThickness	back to summary
private double leftThickness

outerBottomPadding	back to summary
private double outerBottomPadding

outerLeftPadding	back to summary
private double outerLeftPadding

outerRightPadding	back to summary
private double outerRightPadding

outerTopPadding	back to summary
private double outerTopPadding

parent	back to summary
private final Borders parent

rightColor	back to summary
private Color rightColor

rightThickness	back to summary
private double rightThickness

strokeStyle	back to summary
private BorderStrokeStyle strokeStyle

title	back to summary
private String title

topColor	back to summary
private Color topColor

topLeftRadius	back to summary
private double topLeftRadius

topRightRadius	back to summary
private double topRightRadius

topThickness	back to summary
private double topThickness

Constructor Detail

LineBorders	back to summary
private LineBorders(Borders parent)

Method Detail

build	back to summary
public Borders build() Builds the `Border` and `adds it` to the list of borders to wrap around the given Node (which will be constructed and returned when `Borders#build()` is called.

buildAll	back to summary
public Node buildAll() A convenience method, this is equivalent to calling `build()` followed by `Borders#build()`. In other words, calling this will return the original Node wrapped in all its borders specified.

color	back to summary
public Borders.LineBorders color(Color color) Specifies the colour to use for all four sides of this border.

color	back to summary
public Borders.LineBorders color(Color topColor, Color rightColor, Color bottomColor, Color leftColor) Specifies that the wrapped Node should be wrapped with the given colours for each of its four sides, going in the order top, right, bottom, and finally left.

innerPadding	back to summary
public Borders.LineBorders innerPadding(double padding) Specifies the outer padding of the four lines of this border.

innerPadding	back to summary
public Borders.LineBorders innerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have inner padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.

outerPadding	back to summary
public Borders.LineBorders outerPadding(double padding) Specifies the inner padding of the four lines of this border.

outerPadding	back to summary
public Borders.LineBorders outerPadding(double topPadding, double rightPadding, double bottomPadding, double leftPadding) Specifies that the line wrapping the node should have outer padding as specified, with each padding being independently configured, going in the order top, right, bottom, and left.

radius	back to summary
public Borders.LineBorders radius(double radius) Specifies the radius of the four corners of the line of this border.

radius	back to summary
public Borders.LineBorders radius(double topLeft, double topRight, double bottomRight, double bottomLeft) Specifies that the line wrapping the node should have corner radii as specified, with each radius being independently configured, going in the order top-left, top-right, bottom-right, and finally bottom-left.

strokeStyle back to summary

public Borders.LineBorders strokeStyle(BorderStrokeStyle strokeStyle)

Specifies which BorderStrokeStyle to use for this line border. By default this is BorderStrokeStyle#SOLID, but you can use any other style (such as BorderStrokeStyle#DASHED, BorderStrokeStyle#DOTTED, or a custom style built using BorderStrokeStyle#BorderStrokeStyle(javafx.scene.shape.StrokeType, javafx.scene.shape.StrokeLineJoin, javafx.scene.shape.StrokeLineCap, double, double, List).

thickness	back to summary
public Borders.LineBorders thickness(double thickness) Specifies the thickness of the line to use on all four sides of this border.

thickness	back to summary
public Borders.LineBorders thickness(double topThickness, double rightThickness, double bottomThickness, double leftThickness) Specifies that the wrapped Node should be wrapped with the given line thickness for each of its four sides, going in the order top, right, bottom, and finally left.

title	back to summary
public Borders.LineBorders title(String title) If desired, this specifies the title text to show in this border.

Modifier and Type	Field and Description
private final BorderStroke[]	borderStrokes
private static final double	GAP_PADDING
private final String	title
private static final int	TITLE_PADDING

public final Class Borders

Examples

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Borders.Border

Method Summary

Method Detail

public Class Borders.EmptyBorders

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Borders.EtchedBorders

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Borders.LineBorders

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Borders.StrokeBorder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail