JavaFX 21.0.2 · javafx.scene.layout.BackgroundPosition

Represents the position of a BackgroundImage within the Region's drawing area.

The BackgroundImage can be positioned either from the left or right side along the horizontal axis, and from either the top or bottom side along the vertical axis. The horizontalSide and verticalSide properties define to which side the remaining properties pertain. The horizontalPosition specifies the distance of the BackgroundImage from the corresponding side of the Region, and horizontalAsPercentage indicates whether this is as a literal value or a percentage. Similar properties exist for specifying the size relative to the vertical axis.

For example, suppose I had a BackgroundPosition with a horizontalSide of Side.RIGHT, a horizontalPosition of .05, and a horizontalAsPercentage of true. In this case, the right side of the BackgroundImage will be 5% of the width of the Region from the Region's right edge.

Field Summary

Modifier and Type	Field and Description
public static final BackgroundPosition	CENTER A BackgroundPosition which will center a BackgroundImage.
public static final BackgroundPosition	DEFAULT The default BackgroundPosition for any BackgroundImage.
private final int	hash A cached has code value.
pack-priv final boolean	horizontalAsPercentage
pack-priv final double	horizontalPosition
pack-priv final Side	horizontalSide
pack-priv final boolean	verticalAsPercentage
pack-priv final double	verticalPosition
pack-priv final Side	verticalSide

Constructor Summary

Access	Constructor and Description
public	BackgroundPosition(Side The horizontal side, must be either null, LEFT, or RIGHT. If null, LEFT will be used. If TOP or BOTTOM is specified, an IllegalArgumentException is thrown. horizontalSide, double The horizontal position value. horizontalPosition, boolean Whether to interpret the horizontal position as a decimal or percentage horizontalAsPercentage, Side The vertical side, must be either null, TOP, or BOTTOM. If null, TOP will be used. If LEFT or RIGHT is specified, an IllegalArgumentException is thrown. verticalSide, double The vertical position value. verticalPosition, boolean Whether to interpret the vertical position as a decimal or percentage verticalAsPercentage) Creates a new BackgroundPosition.

Access

Constructor and Description

public

BackgroundPosition(Side

The horizontal side, must be either null, LEFT, or RIGHT. If null, LEFT will be used. If TOP or BOTTOM is specified, an IllegalArgumentException is thrown.

horizontalSide, double

The horizontal position value.

horizontalPosition, boolean

Whether to interpret the horizontal position as a decimal or percentage

horizontalAsPercentage, Side

The vertical side, must be either null, TOP, or BOTTOM. If null, TOP will be used. If LEFT or RIGHT is specified, an IllegalArgumentException is thrown.

verticalSide, double

The vertical position value.

verticalPosition, boolean

Whether to interpret the vertical position as a decimal or percentage

verticalAsPercentage)

Creates a new BackgroundPosition.

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 horizontal position of the BackgroundImage getHorizontalPosition() The value indicating the position of the BackgroundImage relative to the Region along the side indicated by the `horizontalSide` property.
public final Side	Returns: the Side along the horizontal axis to which the BackgroundImage is anchored getHorizontalSide() The side along the horizontal axis to which the BackgroundImage is anchored.
public final double	Returns: the vertical position of the BackgroundImage getVerticalPosition() The value indicating the position of the BackgroundImage relative to the Region along the side indicated by the `verticalSide` property.
public final Side	Returns: the Side along the vertical axis to which the BackgroundImage is anchored getVerticalSide() The side along the vertical axis to which the BackgroundImage is anchored.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public final boolean	Returns: true if horizontalPosition should be interpreted as a percentage isHorizontalAsPercentage() Specifies whether the `horizontalPosition` should be interpreted as a literal number or as a percentage.
public final boolean	Returns: true if verticalPosition should be interpreted as a percentage isVerticalAsPercentage() Specifies whether the `verticalPosition` should be interpreted as a literal number or as a percentage.

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

Field Detail

CENTER	back to summary
public static final BackgroundPosition CENTER A BackgroundPosition which will center a BackgroundImage.

DEFAULT	back to summary
public static final BackgroundPosition DEFAULT The default BackgroundPosition for any BackgroundImage. The default is to have no insets and to be defined as 0% and 0%. That is, the position is in the top-left corner.

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

horizontalAsPercentage	back to summary
pack-priv final boolean horizontalAsPercentage

horizontalPosition	back to summary
pack-priv final double horizontalPosition

horizontalSide	back to summary
pack-priv final Side horizontalSide

verticalAsPercentage	back to summary
pack-priv final boolean verticalAsPercentage

verticalPosition	back to summary
pack-priv final double verticalPosition

verticalSide	back to summary
pack-priv final Side verticalSide

Constructor Detail

BackgroundPosition	back to summary
public BackgroundPosition(Side horizontalSide, double horizontalPosition, boolean horizontalAsPercentage, Side verticalSide, double verticalPosition, boolean verticalAsPercentage) Creates a new BackgroundPosition. Parameters horizontalSide:Side The horizontal side, must be either null, LEFT, or RIGHT. If null, LEFT will be used. If TOP or BOTTOM is specified, an IllegalArgumentException is thrown. horizontalPosition:double The horizontal position value. horizontalAsPercentage:boolean Whether to interpret the horizontal position as a decimal or percentage verticalSide:Side The vertical side, must be either null, TOP, or BOTTOM. If null, TOP will be used. If LEFT or RIGHT is specified, an IllegalArgumentException is thrown. verticalPosition:double The vertical position value. verticalAsPercentage:boolean Whether to interpret the vertical position as a decimal or percentage

BackgroundPosition

back to summary

public BackgroundPosition(Side horizontalSide, double horizontalPosition, boolean horizontalAsPercentage, Side verticalSide, double verticalPosition, boolean verticalAsPercentage)

Creates a new BackgroundPosition.

Parameters

horizontalSide:Side: The horizontal side, must be either null, LEFT, or RIGHT. If null, LEFT will be used. If TOP or BOTTOM is specified, an IllegalArgumentException is thrown.
horizontalPosition:double: The horizontal position value.
horizontalAsPercentage:boolean: Whether to interpret the horizontal position as a decimal or percentage
verticalSide:Side: The vertical side, must be either null, TOP, or BOTTOM. If null, TOP will be used. If LEFT or RIGHT is specified, an IllegalArgumentException is thrown.
verticalPosition:double: The vertical position value.
verticalAsPercentage:boolean: Whether to interpret the vertical position as a decimal or percentage

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

getHorizontalPosition back to summary

getHorizontalPosition	back to summary
public final double getHorizontalPosition() The value indicating the position of the BackgroundImage relative to the Region along the side indicated by the `horizontalSide` property. This value is either a literal or a percentage, depending on the `horizontalAsPercentage` property. Negative values are acceptable. Returns:double the horizontal position of the BackgroundImage

public final double getHorizontalPosition()

The value indicating the position of the BackgroundImage relative to the Region along the side indicated by the horizontalSide property. This value is either a literal or a percentage, depending on the horizontalAsPercentage property. Negative values are acceptable.

Returns:double: the horizontal position of the BackgroundImage

getHorizontalSide	back to summary
public final Side getHorizontalSide() The side along the horizontal axis to which the BackgroundImage is anchored. This will only be LEFT or RIGHT and never null. Returns:Side the Side along the horizontal axis to which the BackgroundImage is anchored

getHorizontalSide

back to summary

public final Side getHorizontalSide()

The side along the horizontal axis to which the BackgroundImage is anchored. This will only be LEFT or RIGHT and never null.

Returns:Side: the Side along the horizontal axis to which the BackgroundImage is anchored

getVerticalPosition back to summary

getVerticalPosition	back to summary
public final double getVerticalPosition() The value indicating the position of the BackgroundImage relative to the Region along the side indicated by the `verticalSide` property. This value is either a literal or a percentage, depending on the `verticalAsPercentage` property. Negative values are acceptable. Returns:double the vertical position of the BackgroundImage

public final double getVerticalPosition()

The value indicating the position of the BackgroundImage relative to the Region along the side indicated by the verticalSide property. This value is either a literal or a percentage, depending on the verticalAsPercentage property. Negative values are acceptable.

Returns:double: the vertical position of the BackgroundImage

getVerticalSide	back to summary
public final Side getVerticalSide() The side along the vertical axis to which the BackgroundImage is anchored. This will only be TOP or BOTTOM and never null. Returns:Side the Side along the vertical axis to which the BackgroundImage is anchored

getVerticalSide

back to summary

public final Side getVerticalSide()

The side along the vertical axis to which the BackgroundImage is anchored. This will only be TOP or BOTTOM and never null.

Returns:Side: the Side along the vertical axis to which the BackgroundImage is anchored

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

isHorizontalAsPercentage back to summary

isHorizontalAsPercentage	back to summary
public final boolean isHorizontalAsPercentage() Specifies whether the `horizontalPosition` should be interpreted as a literal number or as a percentage. Returns:boolean true if horizontalPosition should be interpreted as a percentage

public final boolean isHorizontalAsPercentage()

Specifies whether the horizontalPosition should be interpreted as a literal number or as a percentage.

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

isVerticalAsPercentage back to summary

isVerticalAsPercentage	back to summary
public final boolean isVerticalAsPercentage() Specifies whether the `verticalPosition` should be interpreted as a literal number or as a percentage. Returns:boolean true if verticalPosition should be interpreted as a percentage

public final boolean isVerticalAsPercentage()

Specifies whether the verticalPosition should be interpreted as a literal number or as a percentage.

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

public Class BackgroundPosition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail