JavaFX 24 · javafx.scene.layout.BackgroundFill · APIdia, the JavaDoc alternative

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

Access	Constructor and Description
public	BackgroundFill(Paint Any Paint. If null, the value Color.TRANSPARENT is used. fill, CornerRadii The corner Radii. If null, the value Radii.EMPTY is used. radii, Insets The insets. If null, the value Insets.EMPTY is used. insets) Creates a new BackgroundFill with the specified fill, radii, and insets.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final Paint	Returns: the Paint to use for filling the background of the `Region` getFill() The Paint to use for filling the background of the `Region`.
public final Insets	Returns: the Insets to use for this fill getInsets() The Insets to use for this fill.
public final CornerRadii	Returns: the Radii to use for representing the four radii of the BackgroundFill getRadii() The Radii to use for representing the four radii of the BackgroundFill.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public BackgroundFill	interpolate(BackgroundFill the target value endValue, double the interpolation factor t) Implements javafx.animation.Interpolatable.interpolate. Returns an intermediate value between the value of this `Interpolatable` and the specified `endValue` using the linear interpolation factor `t`, ranging from 0 (inclusive) to 1 (inclusive).
private boolean	isSame(Paint fill, CornerRadii radii, Insets insets)

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

fill	back to summary
private final Paint fill

hash	back to summary
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.

insets	back to summary
private final Insets insets

radii	back to summary
private final CornerRadii radii

BackgroundFill	back to summary
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:Paint Any Paint. If null, the value Color.TRANSPARENT is used. radii:CornerRadii The corner Radii. If null, the value Radii.EMPTY is used. insets:Insets The insets. If null, the value Insets.EMPTY is used.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getFill back to summary

getFill	back to summary
public final Paint getFill() The Paint to use for filling the background of the `Region`. This value will never be null. Returns:Paint the Paint to use for filling the background of the `Region`

public final Paint getFill()

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

Returns:Paint: the Paint to use for filling the background of the Region

getInsets	back to summary
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:Insets the Insets to use for this fill

getInsets

back to summary

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:Insets: the Insets to use for this fill

getRadii	back to summary
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:CornerRadii the Radii to use for representing the four radii of the BackgroundFill

getRadii

back to summary

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:CornerRadii: the Radii to use for representing the four radii of the BackgroundFill

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

interpolate back to summary

interpolate	back to summary
public BackgroundFill interpolate(BackgroundFill endValue, double t) Implements javafx.animation.Interpolatable.interpolate. Doc from javafx.animation.Interpolatable.interpolate. Returns an intermediate value between the value of this `Interpolatable` and the specified `endValue` using the linear interpolation factor `t`, ranging from 0 (inclusive) to 1 (inclusive). The returned value might not be a new instance; the implementation might also return one of the two existing instances if the intermediate value would be equal to one of the existing values. However, this is an optimization and applications should not assume any particular identity of the returned value. Parameters endValue:BackgroundFill the target value t:double the interpolation factor Returns:BackgroundFill the intermediate value Annotations @Override Exceptions NullPointerException: if `endValue` is `null` Since 24

public BackgroundFill interpolate(BackgroundFill endValue, double t)

Implements javafx.animation.Interpolatable.interpolate.

Doc from javafx.animation.Interpolatable.interpolate.

Returns an intermediate value between the value of this Interpolatable and the specified endValue using the linear interpolation factor t, ranging from 0 (inclusive) to 1 (inclusive).

The returned value might not be a new instance; the implementation might also return one of the two existing instances if the intermediate value would be equal to one of the existing values. However, this is an optimization and applications should not assume any particular identity of the returned value.

Parameters

endValue:BackgroundFill: the target value
t:double: the interpolation factor

Returns:BackgroundFill

the intermediate value

Annotations

@Override

Exceptions

NullPointerException:: if endValue is null

Since

isSame	back to summary
private boolean isSame(Paint fill, CornerRadii radii, Insets insets)

public final Class BackgroundFill

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail