Module javafx.graphics
Package javafx.scene.layout

Class BackgroundImage


  • public final class BackgroundImage
extends Object
    Defines properties describing how to render an image as the background to some Region. A BackgroundImage must have an Image specified (it cannot be null). The repeatX and repeatY properties define how the image is to be repeated in each direction. The position property defines how to position the image on the Region while the size property defines the size of the image on the Region. For example, the size might be defined with cover = true, meaning the image should be stretched to cover the entire rendering surface of the Region.

    Because the BackgroundImage is immutable, it can safely be used in any cache, and can safely be reused among multiple Regions.

    Since:
    JavaFX 8.0

    • Constructor Detail

      • BackgroundImage

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

    • Method Detail

      • getImage

        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:
        the image to be used

      • getRepeatX

        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:
        the BackgroundRepeat that indicates if the background image is to be repeated along the x-axis of the region

      • getRepeatY

        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:
        the BackgroundRepeat that indicates if the background image is to be repeated along the y-axis of the region

      • getPosition

        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:
        the position of this BackgroundImage relative to the Region

      • getSize

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

      • 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)