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

Field Summary

Modifier and Type	Field and Description
public static final double	AUTO From the CSS Specification: An "auto" value for one dimension is resolved by using the image's intrinsic ratio and the size of the other dimension, or failing that, using the image's intrinsic size, or failing that, treating it as 100%. If both values are "auto" then the intrinsic width and/or height of the image should be used, if any, the missing dimension (if any) behaving as "auto" as described above. If the image has neither an intrinsic width nor an intrinsic height, its size is determined as for "contain".
private final boolean	contain
private final boolean	cover
public static final BackgroundSize	DEFAULT The default BackgroundSize used by BackgroundImages when an explicit size is not defined.
private final int	hash A cached hash code value
private final double	height
private final boolean	heightAsPercentage
private final double	width
private final boolean	widthAsPercentage

Constructor Summary

Access	Constructor and Description
public	BackgroundSize(double The width. Cannot be less than 0, except for the value of AUTO. width, double The height. Cannot be less than 0, except for the value of AUTO. height, boolean Whether the width is to be interpreted as a percentage widthAsPercentage, boolean Whether the height is to be interpreted as a percentage heightAsPercentage, boolean Whether the image should be sized to fit within the Region maximally contain, boolean Whether the image should be sized to "cover" the Region cover) Create a new BackgroundSize.

Access

Constructor and Description

public

BackgroundSize(double

The width. Cannot be less than 0, except for the value of AUTO.

width, double

The height. Cannot be less than 0, except for the value of AUTO.

height, boolean

Whether the width is to be interpreted as a percentage

widthAsPercentage, boolean

Whether the height is to be interpreted as a percentage

heightAsPercentage, boolean

Whether the image should be sized to fit within the Region maximally

contain, boolean

Whether the image should be sized to "cover" the Region

cover)

Create a new BackgroundSize.

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 double	Returns: the height of the area within the Region where the associated BackgroundImage should render getHeight() The height of the area within the Region where the associated BackgroundImage should render.
public final double	Returns: the width of the area within the Region where the associated BackgroundImage should render getWidth() The width of the area within the Region where the associated BackgroundImage should render.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public BackgroundSize	interpolate(BackgroundSize 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 static double	interpolate(double start, double end, boolean startIsPercentage, boolean endIsPercentage, double t)
public final boolean	Returns: true if the image can fit inside the background positioning area isContain() If true, scale the image, while preserving its intrinsic aspect ratio (if any), to the largest size such that both its width and its height can fit inside the background positioning area.
public final boolean	Returns: true if image can completely cover the background positioning area isCover() If true, scale the image, while preserving its intrinsic aspect ratio (if any), to the smallest size such that both its width and its height can completely cover the background positioning area.
public final boolean	Returns: true if height should be interpreted as a percentage isHeightAsPercentage() Specifies whether the value contained in `height` should be interpreted as a percentage or as a normal value.
private boolean	isSame(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage)
public final boolean	Returns: true if width should be interpreted as a percentage isWidthAsPercentage() Specifies whether the value contained in `width` should be interpreted as a percentage or as a normal value.

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

Field Detail

AUTO	back to summary
public static final double AUTO From the CSS Specification: An "auto" value for one dimension is resolved by using the image's intrinsic ratio and the size of the other dimension, or failing that, using the image's intrinsic size, or failing that, treating it as 100%. If both values are "auto" then the intrinsic width and/or height of the image should be used, if any, the missing dimension (if any) behaving as "auto" as described above. If the image has neither an intrinsic width nor an intrinsic height, its size is determined as for "contain". When set to AUTO, the values for widthAsPercentage and heightAsPercentage are ignored.

AUTO

back to summary

public static final double AUTO

From the CSS Specification:

An "auto" value for one dimension is resolved by using the image's intrinsic ratio and the size of the other dimension, or failing that, using the image's intrinsic size, or failing that, treating it as 100%.
If both values are "auto" then the intrinsic width and/or height of the image should be used, if any, the missing dimension (if any) behaving as "auto" as described above. If the image has neither an intrinsic width nor an intrinsic height, its size is determined as for "contain".

When set to AUTO, the values for widthAsPercentage and heightAsPercentage are ignored.

contain	back to summary
private final boolean contain

cover	back to summary
private final boolean cover

DEFAULT	back to summary
public static final BackgroundSize DEFAULT The default BackgroundSize used by BackgroundImages when an explicit size is not defined. By default, the BackgroundSize is AUTO, AUTO for the width and height, and is neither cover nor contain.

hash	back to summary
private final int hash A cached hash code value

height	back to summary
private final double height

heightAsPercentage	back to summary
private final boolean heightAsPercentage

width	back to summary
private final double width

widthAsPercentage	back to summary
private final boolean widthAsPercentage

Constructor Detail

BackgroundSize	back to summary
public BackgroundSize(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage, boolean contain, boolean cover) Create a new BackgroundSize. Parameters width:double The width. Cannot be less than 0, except for the value of AUTO. height:double The height. Cannot be less than 0, except for the value of AUTO. widthAsPercentage:boolean Whether the width is to be interpreted as a percentage heightAsPercentage:boolean Whether the height is to be interpreted as a percentage contain:boolean Whether the image should be sized to fit within the Region maximally cover:boolean Whether the image should be sized to "cover" the Region

BackgroundSize

back to summary

public BackgroundSize(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage, boolean contain, boolean cover)

Create a new BackgroundSize.

Parameters

width:double: The width. Cannot be less than 0, except for the value of AUTO.
height:double: The height. Cannot be less than 0, except for the value of AUTO.
widthAsPercentage:boolean: Whether the width is to be interpreted as a percentage
heightAsPercentage:boolean: Whether the height is to be interpreted as a percentage
contain:boolean: Whether the image should be sized to fit within the Region maximally
cover:boolean: Whether the image should be sized to "cover" the Region

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

getHeight back to summary

getHeight	back to summary
public final double getHeight() The height of the area within the Region where the associated BackgroundImage should render. If set to AUTO, then `heightAsPercentage` is ignored. This value has no meaning if either `contain` or `cover` are specified. This value cannot be negative, except when set to the value of AUTO. Returns:double the height of the area within the Region where the associated BackgroundImage should render

public final double getHeight()

The height of the area within the Region where the associated BackgroundImage should render. If set to AUTO, then heightAsPercentage is ignored. This value has no meaning if either contain or cover are specified. This value cannot be negative, except when set to the value of AUTO.

Returns:double: the height of the area within the Region where the associated BackgroundImage should render

getWidth back to summary

getWidth	back to summary
public final double getWidth() The width of the area within the Region where the associated BackgroundImage should render. If set to AUTO, then `widthAsPercentage` is ignored. This value has no meaning if either `contain` or `cover` are specified. This value cannot be negative, except when set to the value of AUTO. Returns:double the width of the area within the Region where the associated BackgroundImage should render

public final double getWidth()

The width of the area within the Region where the associated BackgroundImage should render. If set to AUTO, then widthAsPercentage is ignored. This value has no meaning if either contain or cover are specified. This value cannot be negative, except when set to the value of AUTO.

Returns:double: the width of the area within the Region where the associated BackgroundImage should render

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 BackgroundSize interpolate(BackgroundSize 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:BackgroundSize the target value t:double the interpolation factor Returns:BackgroundSize the intermediate value Annotations @Override Exceptions NullPointerException: if `endValue` is `null` Since 24

public BackgroundSize interpolate(BackgroundSize 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:BackgroundSize: the target value
t:double: the interpolation factor

Returns:BackgroundSize

the intermediate value

Annotations

@Override

Exceptions

NullPointerException:: if endValue is null

Since

interpolate	back to summary
private static double interpolate(double start, double end, boolean startIsPercentage, boolean endIsPercentage, double t)

isContain	back to summary
public final boolean isContain() If true, scale the image, while preserving its intrinsic aspect ratio (if any), to the largest size such that both its width and its height can fit inside the background positioning area. Returns:boolean true if the image can fit inside the background positioning area

isContain

back to summary

public final boolean isContain()

If true, scale the image, while preserving its intrinsic aspect ratio (if any), to the largest size such that both its width and its height can fit inside the background positioning area.

Returns:boolean: true if the image can fit inside the background positioning area

isCover	back to summary
public final boolean isCover() If true, scale the image, while preserving its intrinsic aspect ratio (if any), to the smallest size such that both its width and its height can completely cover the background positioning area. Returns:boolean true if image can completely cover the background positioning area

isCover

back to summary

public final boolean isCover()

If true, scale the image, while preserving its intrinsic aspect ratio (if any), to the smallest size such that both its width and its height can completely cover the background positioning area.

Returns:boolean: true if image can completely cover the background positioning area

isHeightAsPercentage back to summary

isHeightAsPercentage	back to summary
public final boolean isHeightAsPercentage() Specifies whether the value contained in `height` should be interpreted as a percentage or as a normal value. Returns:boolean true if height should be interpreted as a percentage

public final boolean isHeightAsPercentage()

Specifies whether the value contained in height should be interpreted as a percentage or as a normal value.

Returns:boolean: true if height should be interpreted as a percentage

isSame	back to summary
private boolean isSame(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage)

isWidthAsPercentage back to summary

isWidthAsPercentage	back to summary
public final boolean isWidthAsPercentage() Specifies whether the value contained in `width` should be interpreted as a percentage or as a normal value. Returns:boolean true if width should be interpreted as a percentage

public final boolean isWidthAsPercentage()

Specifies whether the value contained in width should be interpreted as a percentage or as a normal value.

Returns:boolean: true if width should be interpreted as a percentage

public final Class BackgroundSize

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail