モジュール javafx.graphics

パッケージ javafx.scene.layout

クラスBackgroundImage

java.lang.Object

javafx.scene.layout.BackgroundImage

public final class BackgroundImage
extends Object

あるRegionに背景としてイメージをレンダリングする方法を記述するプロパティを定義します。 BackgroundImageにはImageを指定する必要があります(nullにはできません)。 repeatXおよびrepeatYプロパティは、各方向でイメージを繰り返す方法を定義します。 positionプロパティはリージョンにイメージを配置する方法を定義し、sizeプロパティはリージョンのイメージのサイズを定義します。 たとえば、sizeがcover = trueに定義されている場合は、リージョンのレンダリング面全体をカバーするようにイメージを拡大する必要があることを意味します。

BackgroundImageは不変であるため、どのキャッシュでも安全に使用でき、複数のリージョンの間で安全に再使用できます。

導入されたバージョン:

JavaFX 8.0

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
BackgroundImage(Image image, BackgroundRepeat repeatX, BackgroundRepeat repeatY, BackgroundPosition position, BackgroundSize size)	新しいBackgroundImageを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
Image	getImage()	使用されるイメージ。
BackgroundPosition	getPosition()	リージョンに対して相対的なこのBackgroundImageの位置。
BackgroundRepeat	getRepeatX()	該当する場合に、背景イメージがリージョンのx軸に沿ってどのように繰り返されるかを示します。
BackgroundRepeat	getRepeatY()	該当する場合に、背景イメージがリージョンのy軸に沿ってどのように繰り返されるかを示します。
BackgroundSize	getSize()	リージョンに対して相対的なこのイメージのサイズ。

クラス java.lang.Objectで宣言されたメソッド

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

コンストラクタの詳細

BackgroundImage

public BackgroundImage(Image image,
                       BackgroundRepeat repeatX,
                       BackgroundRepeat repeatY,
                       BackgroundPosition position,
                       BackgroundSize size)

新しいBackgroundImageを作成します。 imageを指定する必要があります。

パラメータ:

image - 使用するイメージ。 nullを指定することはできません。

repeatX - x軸に対するBackgroundRepeat。 nullの場合、この値のデフォルトはREPEATです。

repeatY - y軸に対するBackgroundRepeat。 nullの場合、この値のデフォルトはREPEATです。

position - 使用するBackgroundPosition。 nullの場合、デフォルトはBackgroundPosition.DEFAULTです。

size - BackgroundSize。 nullの場合、デフォルトはBackgroundSize.DEFAULTです。

メソッドの詳細

getImage

public final Image getImage()

使用されるイメージ。 nullは不可。 このイメージのロードに失敗した場合は、BackgroundImage全体がレンダリング時にスキップされます。

戻り値:

使用するイメージ

getRepeatX

public final BackgroundRepeat getRepeatX()

該当する場合に、背景イメージがリージョンのx軸に沿ってどのように繰り返されるかを示します。 nullは不可。

戻り値:

バックグラウンド・イメージが領域のx軸に沿って繰り返されるかどうかを示すBackgroundRepeat

getRepeatY

public final BackgroundRepeat getRepeatY()

該当する場合に、背景イメージがリージョンのy軸に沿ってどのように繰り返されるかを示します。 nullは不可。

戻り値:

バックグラウンド・イメージが領域のy軸に沿って繰り返されるかどうかを示すBackgroundRepeat

getPosition

public final BackgroundPosition getPosition()

リージョンに対して相対的なこのBackgroundImageの位置。 リージョンの背景領域外のすべての位置はクリップされることに注意してください。

戻り値:

Regionに対するこのBackgroundImageの位置

getSize

public final BackgroundSize getSize()

リージョンに対して相対的なこのイメージのサイズ。

戻り値:

Regionに対するこのイメージのサイズ