org.controlsfx.tools

Class Borders.LineBorders

java.lang.Object

org.controlsfx.tools.Borders.LineBorders

Enclosing class:

Borders

public class Borders.LineBorders
extends java.lang.Object

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.

Method Summary

Modifier and Type	Method and Description
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.
javafx.scene.Node	buildAll() A convenience method, this is equivalent to calling build() followed by Borders.build().
Borders.LineBorders	color(javafx.scene.paint.Color color) Specifies the colour to use for all four sides of this border.
Borders.LineBorders	color(javafx.scene.paint.Color topColor, javafx.scene.paint.Color rightColor, javafx.scene.paint.Color bottomColor, javafx.scene.paint.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.
Borders.LineBorders	innerPadding(double padding) Specifies the outer padding of the four lines of this border.
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.
Borders.LineBorders	outerPadding(double padding) Specifies the inner padding of the four lines of this border.
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.
Borders.LineBorders	radius(double radius) Specifies the radius of the four corners of the line of this border.
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.
Borders.LineBorders	strokeStyle(javafx.scene.layout.BorderStrokeStyle strokeStyle) Specifies which BorderStrokeStyle to use for this line border.
Borders.LineBorders	thickness(double thickness) Specifies the thickness of the line to use on all four sides of this border.
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.
Borders.LineBorders	title(java.lang.String title) If desired, this specifies the title text to show in this border.

Methods inherited from class java.lang.Object

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

Method Detail

color

public Borders.LineBorders color(javafx.scene.paint.Color color)

Specifies the colour to use for all four sides of this border.

color

public Borders.LineBorders color(javafx.scene.paint.Color topColor,
                                 javafx.scene.paint.Color rightColor,
                                 javafx.scene.paint.Color bottomColor,
                                 javafx.scene.paint.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.

strokeStyle

public Borders.LineBorders strokeStyle(javafx.scene.layout.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).

outerPadding

public Borders.LineBorders outerPadding(double padding)

Specifies the inner padding of the four lines of this border.

outerPadding

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.

innerPadding

public Borders.LineBorders innerPadding(double padding)

Specifies the outer padding of the four lines of this border.

innerPadding

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.

thickness

public Borders.LineBorders thickness(double thickness)

Specifies the thickness of the line to use on all four sides of this border.

thickness

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.

radius

public Borders.LineBorders radius(double radius)

Specifies the radius of the four corners of the line of this border.

radius

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.

title

public Borders.LineBorders title(java.lang.String title)

If desired, this specifies the title text to show in this border.

build

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

public javafx.scene.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.