モジュール javafx.graphics

パッケージ javafx.scene.layout

クラスBackgroundPosition

java.lang.Object

javafx.scene.layout.BackgroundPosition

public class BackgroundPosition
extends Object

Regionの描画領域内のBackgroundImageの位置を表します。

BackgroundImageは、水平軸に沿って左と右のいずれかから、および垂直軸に沿って上と下のいずれかから配置できます。 horizontalSideおよびverticalSideプロパティは、残りのプロパティがどの辺に関係するかを定義します。 horizontalPositionはリージョンの対応する辺からBackgroundImageまでの距離を指定し、horizontalAsPercentageはこれがリテラル値と割合のどちらであるかを示します。 垂直軸に対して相対的なサイズを指定する同様のプロパティがあります。

たとえば、horizontalSideがSide.RIGHT、horizontalPositionが.05、horizontalAsPercentageがtrueのBackgroundPositionがあるとします。 この場合、BackgroundImageの右側は、リージョンの右端からリージョンの幅の5%となります。

導入されたバージョン:

JavaFX 8.0

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static BackgroundPosition	CENTER	BackgroundImageを中央揃えするBackgroundPosition。
static BackgroundPosition	DEFAULT	すべてのBackgroundImageのデフォルトのBackgroundPosition。

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

コンストラクタ

コンストラクタ	説明
BackgroundPosition(Side horizontalSide, double horizontalPosition, boolean horizontalAsPercentage, Side verticalSide, double verticalPosition, boolean verticalAsPercentage)	新しいBackgroundPositionを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
double	getHorizontalPosition()	horizontalSideプロパティによって指定された方向に沿って、リージョンに対して相対的なBackgroundImageの位置を示す値。
Side	getHorizontalSide()	BackgroundImageがアンカーされる、水平軸に沿った側。
double	getVerticalPosition()	verticalSideプロパティによって指定された方向に沿って、リージョンに対して相対的なBackgroundImageの位置を示す値。
Side	getVerticalSide()	BackgroundImageがアンカーされる、垂直軸に沿った側。
boolean	isHorizontalAsPercentage()	horizontalPositionをリテラル数値と割合のどちらとして解釈するかを指定します。
boolean	isVerticalAsPercentage()	verticalPositionをリテラル数値と割合のどちらとして解釈するかを指定します。

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

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

フィールドの詳細

DEFAULT

public static final BackgroundPosition DEFAULT

すべてのBackgroundImageのデフォルトのBackgroundPosition。 デフォルトでは枠がなく、0%として定義され、0%です。 つまり、位置は左上隅にあります。

CENTER

public static final BackgroundPosition CENTER

BackgroundImageを中央揃えするBackgroundPosition。

コンストラクタの詳細

BackgroundPosition

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

新しいBackgroundPositionを作成します。

パラメータ:

horizontalSide - 水平方向で、null、LEFTまたはRIGHTのいずれかである必要があります。 nullの場合、LEFTが使用されます。 TOPまたはBOTTOMが指定されている場合は、IllegalArgumentExceptionがスローされます。

horizontalPosition - 水平位置の値。

horizontalAsPercentage - 水平位置を10進数と割合のどちらとして解釈するか。

verticalSide - 垂直方向で、null、TOPまたはBOTTOMのいずれかである必要があります。 nullの場合、TOPが使用されます。 LEFTまたはRIGHTが指定されている場合は、IllegalArgumentExceptionがスローされます。

verticalPosition - 垂直位置の値。

verticalAsPercentage - 垂直位置を10進数と割合のどちらとして解釈するか。

メソッドの詳細

getHorizontalSide

public final Side getHorizontalSide()

BackgroundImageがアンカーされる、水平軸に沿った側。 これは、LEFTまたはRIGHTのみでnullにはなりません。

戻り値:

BackgroundImageが固定されている水平軸に沿ったサイド

getVerticalSide

public final Side getVerticalSide()

BackgroundImageがアンカーされる、垂直軸に沿った側。 これは、TOPまたはBOTTOMのみでnullにはなりません。

戻り値:

BackgroundImageが固定されている垂直軸に沿った側面

getHorizontalPosition

public final double getHorizontalPosition()

horizontalSideプロパティによって指定された方向に沿って、リージョンに対して相対的なBackgroundImageの位置を示す値。 この値はhorizontalAsPercentageプロパティに応じて、リテラルまたは割合のいずれかになります。 負の値は許容されます。

戻り値:

BackgroundImageの水平位置

getVerticalPosition

public final double getVerticalPosition()

verticalSideプロパティによって指定された方向に沿って、リージョンに対して相対的なBackgroundImageの位置を示す値。 この値はverticalAsPercentageプロパティに応じて、リテラルまたは割合のいずれかになります。 負の値は許容されます。

戻り値:

BackgroundImageの垂直位置

isHorizontalAsPercentage

public final boolean isHorizontalAsPercentage()

horizontalPositionをリテラル数値と割合のどちらとして解釈するかを指定します。

戻り値:

horizontalPositionをパーセンテージとして解釈する必要がある場合はtrue

isVerticalAsPercentage

public final boolean isVerticalAsPercentage()

verticalPositionをリテラル数値と割合のどちらとして解釈するかを指定します。

戻り値:

verticalPositionをパーセンテージとして解釈する必要がある場合はtrue