Module javafx.graphics

Package javafx.scene.layout

Class BackgroundImage

java.lang.Object

javafx.scene.layout.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 Summary

Constructors

Constructor	Description
BackgroundImage(Image image, BackgroundRepeat repeatX, BackgroundRepeat repeatY, BackgroundPosition position, BackgroundSize size)	Creates a new BackgroundImage.

Method Summary

Modifier and Type	Method	Description
final Image	getImage()	The image to be used.
final BackgroundPosition	getPosition()	The position of this BackgroundImage relative to the Region.
final BackgroundRepeat	getRepeatX()	Indicates in what manner (if at all) the background image is to be repeated along the x-axis of the region.
final BackgroundRepeat	getRepeatY()	Indicates in what manner (if at all) the background image is to be repeated along the y-axis of the region.
final BackgroundSize	getSize()	The size of this image relative to the Region.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

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