JavaFX 25 · javafx.scene.layout.BackgroundImage · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final int	hash A cached hash code for faster secondary usage.
private final Image	image
pack-priv Boolean	opaque The Background will cache here whether this BackgroundImage is opaque.
pack-priv final BackgroundPosition	position
pack-priv final BackgroundRepeat	repeatX
pack-priv final BackgroundRepeat	repeatY
pack-priv final BackgroundSize	size

Constructor Summary

Access	Constructor and Description
public	BackgroundImage(Image The image to use. This cannot be null. image, BackgroundRepeat The BackgroundRepeat for the x axis. If null, this value defaults to REPEAT. repeatX, BackgroundRepeat The BackgroundRepeat for the y axis. If null, this value defaults to REPEAT. repeatY, BackgroundPosition The BackgroundPosition to use. If null, defaults to BackgroundPosition.DEFAULT. position, BackgroundSize The BackgroundSize. If null, defaults to BackgroundSize.DEFAULT. size) Creates a new BackgroundImage.

Access

Constructor and Description

public

BackgroundImage(Image

The image to use. This cannot be null.

image, BackgroundRepeat

The BackgroundRepeat for the x axis. If null, this value defaults to REPEAT.

repeatX, BackgroundRepeat

The BackgroundRepeat for the y axis. If null, this value defaults to REPEAT.

repeatY, BackgroundPosition

The BackgroundPosition to use. If null, defaults to BackgroundPosition.DEFAULT.

position, BackgroundSize

The BackgroundSize. If null, defaults to BackgroundSize.DEFAULT.

size)

Creates a new BackgroundImage.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final Image	Returns: the image to be used getImage() The image to be used.
public final BackgroundPosition	Returns: the position of this BackgroundImage relative to the Region getPosition() The position of this BackgroundImage relative to the Region.
public final BackgroundRepeat	Returns: the BackgroundRepeat that indicates if the background image is to be repeated along the x-axis of the region getRepeatX() Indicates in what manner (if at all) the background image is to be repeated along the x-axis of the region.
public final BackgroundRepeat	Returns: the BackgroundRepeat that indicates if the background image is to be repeated along the y-axis of the region getRepeatY() Indicates in what manner (if at all) the background image is to be repeated along the y-axis of the region.
public final BackgroundSize	Returns: the size of this image relative to the Region getSize() The size of this image relative to the Region.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public BackgroundImage	interpolate(BackgroundImage endValue, double 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(Image image, BackgroundRepeat repeatX, BackgroundRepeat repeatY, BackgroundPosition position, BackgroundSize size)

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

Field Detail

hash	back to summary
private final int hash A cached hash code for faster secondary usage. It is expected that BackgroundImage will be pulled from a cache in many cases.

image	back to summary
private final Image image

opaque	back to summary
pack-priv Boolean opaque The Background will cache here whether this BackgroundImage is opaque. If this value is null, then it means we don't yet know. If it is non null, then we know for certain it either is, or is not, opaque. Opaque in this case means that the BackgroundImage's image is opaque.

position	back to summary
pack-priv final BackgroundPosition position

repeatX	back to summary
pack-priv final BackgroundRepeat repeatX

repeatY	back to summary
pack-priv final BackgroundRepeat repeatY

size	back to summary
pack-priv final BackgroundSize size

Constructor Detail

BackgroundImage back to summary

BackgroundImage	back to summary
public BackgroundImage(Image image, BackgroundRepeat repeatX, BackgroundRepeat repeatY, BackgroundPosition position, BackgroundSize size) Creates a new BackgroundImage. The `image` must be specified. Parameters image:Image The image to use. This cannot be null. repeatX:BackgroundRepeat The BackgroundRepeat for the x axis. If null, this value defaults to REPEAT. repeatY:BackgroundRepeat The BackgroundRepeat for the y axis. If null, this value defaults to REPEAT. position:BackgroundPosition The BackgroundPosition to use. If null, defaults to BackgroundPosition.DEFAULT. size:BackgroundSize The BackgroundSize. If null, defaults to BackgroundSize.DEFAULT.

public BackgroundImage(Image image, BackgroundRepeat repeatX, BackgroundRepeat repeatY, BackgroundPosition position, BackgroundSize size)

Creates a new BackgroundImage. The image must be specified.

Parameters

image:Image: The image to use. This cannot be null.
repeatX:BackgroundRepeat: The BackgroundRepeat for the x axis. If null, this value defaults to REPEAT.
repeatY:BackgroundRepeat: The BackgroundRepeat for the y axis. If null, this value defaults to REPEAT.
position:BackgroundPosition: The BackgroundPosition to use. If null, defaults to BackgroundPosition.DEFAULT.
size:BackgroundSize: The BackgroundSize. If null, defaults to BackgroundSize.DEFAULT.

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. 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.

Annotations

@Override

getImage	back to summary
public final Image getImage() The image to be used. This will never be null. If this image fails to load, then the entire BackgroundImage will be skipped at rendering time. Returns:Image the image to be used

getImage

back to summary

public final Image getImage()

The image to be used. This will never be null. If this image fails to load, then the entire BackgroundImage will be skipped at rendering time.

Returns:Image: the image to be used

getPosition	back to summary
public final BackgroundPosition getPosition() The position of this BackgroundImage relative to the Region. Note that any position outside the background area of the region will be clipped. Returns:BackgroundPosition the position of this BackgroundImage relative to the Region

getPosition

back to summary

public final BackgroundPosition getPosition()

The position of this BackgroundImage relative to the Region. Note that any position outside the background area of the region will be clipped.

Returns:BackgroundPosition: the position of this BackgroundImage relative to the Region

getRepeatX	back to summary
public final BackgroundRepeat getRepeatX() Indicates in what manner (if at all) the background image is to be repeated along the x-axis of the region. This will never be null. Returns:BackgroundRepeat the BackgroundRepeat that indicates if the background image is to be repeated along the x-axis of the region

getRepeatX

back to summary

public final BackgroundRepeat getRepeatX()

Indicates in what manner (if at all) the background image is to be repeated along the x-axis of the region. This will never be null.

Returns:BackgroundRepeat: the BackgroundRepeat that indicates if the background image is to be repeated along the x-axis of the region

getRepeatY	back to summary
public final BackgroundRepeat getRepeatY() Indicates in what manner (if at all) the background image is to be repeated along the y-axis of the region. This will never be null. Returns:BackgroundRepeat the BackgroundRepeat that indicates if the background image is to be repeated along the y-axis of the region

getRepeatY

back to summary

public final BackgroundRepeat getRepeatY()

Indicates in what manner (if at all) the background image is to be repeated along the y-axis of the region. This will never be null.

Returns:BackgroundRepeat: the BackgroundRepeat that indicates if the background image is to be repeated along the y-axis of the region

getSize	back to summary
public final BackgroundSize getSize() The size of this image relative to the Region. Returns:BackgroundSize the size of this image relative to the Region

getSize

back to summary

public final BackgroundSize getSize()

The size of this image relative to the Region.

Returns:BackgroundSize: the size of this image relative to the Region

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. 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.

Annotations

@Override

interpolate back to summary

interpolate	back to summary
public BackgroundImage interpolate(BackgroundImage 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. Annotations @Override Exceptions NullPointerException: if `endValue` is `null` Since 24

public BackgroundImage interpolate(BackgroundImage 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.

Annotations

@Override

Exceptions

NullPointerException:: if endValue is null

Since

isSame	back to summary
private boolean isSame(Image image, BackgroundRepeat repeatX, BackgroundRepeat repeatY, BackgroundPosition position, BackgroundSize size)

public final Class BackgroundImage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail