Module javafx.graphics
Package javafx.scene.layout

Class BackgroundPosition


  • public class BackgroundPosition
extends Object
    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.

    Since:
    JavaFX 8.0

    • Field Detail

      • DEFAULT

        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.

      • CENTER

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

    • Constructor Detail

      • BackgroundPosition

        public BackgroundPosition​(Side horizontalSide,
                          double horizontalPosition,
                          boolean horizontalAsPercentage,
                          Side verticalSide,
                          double verticalPosition,
                          boolean verticalAsPercentage)
        Creates a new BackgroundPosition.
        Parameters:
        horizontalSide - 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 - The horizontal position value.
        horizontalAsPercentage - Whether to interpret the horizontal position as a decimal or percentage
        verticalSide - 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 - The vertical position value.
        verticalAsPercentage - Whether to interpret the vertical position as a decimal or percentage

    • Method Detail

      • getHorizontalSide

        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:
        the Side along the horizontal axis to which the BackgroundImage is anchored

      • getVerticalSide

        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:
        the Side along the vertical axis to which the BackgroundImage is anchored

      • getHorizontalPosition

        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:
        the horizontal position of the BackgroundImage

      • getVerticalPosition

        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:
        the vertical position of the BackgroundImage

      • isHorizontalAsPercentage

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

      • isVerticalAsPercentage

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

      • equals

        public boolean equals​(Object o)
        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.

        The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

        Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

        Overrides:
        equals in class Object
        Parameters:
        o - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        Object.hashCode(), HashMap

      • hashCode

        public int hashCode​()
        Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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 Object.equals(java.lang.Object) 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.

        As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

        Overrides:
        hashCode in class Object
        Returns:
        a hash code value for this object.
        See Also:
        Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)