javafx.scene.layout

Class BackgroundFill

java.lang.Object

javafx.scene.layout.BackgroundFill

public final class BackgroundFill
extends java.lang.Object

The fill and associated properties that direct how to fill the background of a Region. Because BackgroundFill is an immutable object, it can safely be used in any cache, and can safely be reused among multiple Regions or multiple times in the same Region.

All BackgroundFills are drawn in order.

When applied to a Region with a defined shape, the corner radii are ignored.

Since:

JavaFX 8.0

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Paint	fill
private int	hash A cached hash for improved performance on subsequent hash or equality look ups.
(package private) Insets	insets
(package private) CornerRadii	radii

Constructor Summary

Constructors

Constructor and Description
BackgroundFill(Paint fill, CornerRadii radii, Insets insets) Creates a new BackgroundFill with the specified fill, radii, and insets.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Paint	getFill() The Paint to use for filling the background of the Region.
Insets	getInsets() The Insets to use for this fill.
CornerRadii	getRadii() The Radii to use for representing the four radii of the BackgroundFill.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

fill

final Paint fill

radii

final CornerRadii radii

insets

final Insets insets

hash

private final int hash

A cached hash for improved performance on subsequent hash or equality look ups. It is expected that BackgroundFill will in many instances be loaded from a CSS cache, such that storing this value is beneficial.

Constructor Detail

BackgroundFill

public BackgroundFill(Paint fill,
                      CornerRadii radii,
                      Insets insets)

Creates a new BackgroundFill with the specified fill, radii, and insets. Null values are acceptable, but default values will be used in place of any null value.

Parameters:

fill - Any Paint. If null, the value Color.TRANSPARENT is used.

radii - The corner Radii. If null, the value Radii.EMPTY is used.

insets - The insets. If null, the value Insets.EMPTY is used.

Method Detail

getFill

public final Paint getFill()

The Paint to use for filling the background of the Region. This value will never be null.

Returns:

the Paint to use for filling the background of the Region

getRadii

public final CornerRadii getRadii()

The Radii to use for representing the four radii of the BackgroundFill. Each corner can therefore be independently specified. This will never be null. The radii values will never be negative.

Returns:

the Radii to use for representing the four radii of the BackgroundFill

getInsets

public final Insets getInsets()

The Insets to use for this fill. Each inset indicates at what distance from the Region's bounds the drawing should begin. The insets will never be null, but the values may be negative in order to position the border beyond the natural bounds (that is, (0, 0, width, height)) of the Region.

Returns:

the Insets to use for this fill

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object