Module org.controlsfx.controls

Package org.controlsfx.tools

Class Borders.EtchedBorders

java.lang.Object

org.controlsfx.tools.Borders.EtchedBorders

Enclosing class:

Borders

public class Borders.EtchedBorders
extends Object

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.

Method Summary

Modifier and Type	Method	Description
Borders	build()	Builds the Borders.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.
Node	buildAll()	A convenience method, this is equivalent to calling build() followed by Borders.build().
Borders.EtchedBorders	highlight(Color highlight)	Specifies the highlight colour to use in the etched border.
Borders.EtchedBorders	innerPadding(double padding)	Specifies the inner padding of the four lines of this border.
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.
Borders.EtchedBorders	outerPadding(double padding)	Specifies the outer padding of the four lines of this border.
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.
Borders.EtchedBorders	radius(double radius)	Specifies the radius of the four corners of the lines of this border.
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.
Borders.EtchedBorders	raised()	Specifies the order in which the highlight and shadow colours are placed.
Borders.EtchedBorders	shadow(Color shadow)	Specifies the shadow colour to use in the etched border.
Borders.EtchedBorders	title(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

highlight

public Borders.EtchedBorders highlight(Color highlight)

Specifies the highlight colour to use in the etched border.

shadow

public Borders.EtchedBorders shadow(Color shadow)

Specifies the shadow colour to use in the etched border.

raised

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.

title

public Borders.EtchedBorders title(String title)

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

outerPadding

public Borders.EtchedBorders outerPadding(double padding)

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

outerPadding

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.

innerPadding

public Borders.EtchedBorders innerPadding(double padding)

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

innerPadding

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.

radius

public Borders.EtchedBorders radius(double radius)

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

radius

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.

build

public Borders build()

Builds the Borders.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 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.