モジュール javafx.graphics

パッケージ javafx.scene.layout

クラスBackgroundSize

java.lang.Object

javafx.scene.layout.BackgroundSize

public final class BackgroundSize
extends Object

BackgroundImageによってスタイル設定されるリージョンに対して相対的に、塗りつぶす必要がある領域のサイズを定義します。 値が他のプロパティよりも優先されるプロパティがいくつかあります。 特に、4つの主要なプロパティとしてwidth、height、containおよびcoverがあります。 widthおよびheightの両方はそれぞれ独立していますが、containおよびcoverとは相互作用します。

CSS仕様に基づいて、coverは次のように定義されています。

イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域を完全にカバーできるように、イメージを最小サイズにスケーリングします。

containは次のように定義されています。

イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域内に収まるように、イメージを最大サイズにスケーリングします。

また、widthおよびheightの両方は、使用するサイズを(絶対値または割合で)指定します。 coverおよびcontainの両方がfalseの場合は、これらの2つのプロパティのみが適用されます。 coverおよびcontainの両方がtrueの場合は、coverが使用されます。

widthおよびheightは、イメージの固有サイズを使用するように領域をサイズ設定する必要があることを指定するAUTOに、または判断できない場合は100%に設定することもできます。

導入されたバージョン:

JavaFX 8.0

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static double	AUTO	CSS仕様から: イメージの固有比と他のディメンションのサイズを使用して1つのディメンションが解決される場合は自動の値、これが失敗する場合はイメージの固有サイズを使用し、これが失敗する場合は100%として処理されます。
static BackgroundSize	DEFAULT	サイズが明示的に定義されていない場合に、BackgroundImageで使用されるデフォルトのBackgroundSize。

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

コンストラクタ

コンストラクタ	説明
BackgroundSize(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage, boolean contain, boolean cover)	新しいBackgroundSizeを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	equals(Object o)	このオブジェクトと他のオブジェクトが等しいかどうかを示します。
double	getHeight()	関連付けられているBackgroundImageがレンダリングする必要があるリージョン内の領域の高さ。
double	getWidth()	関連付けられているBackgroundImageがレンダリングする必要があるリージョン内の領域の幅。
int	hashCode()	オブジェクトのハッシュ・コード値を返します。
boolean	isContain()	trueの場合、イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域内に収まるように、イメージを最大サイズにスケーリングします。
boolean	isCover()	trueの場合、イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域を完全にカバーできるようにイメージを最小サイズにスケーリングします。
boolean	isHeightAsPercentage()	heightに含まれる値を割合と標準値のどちらとして解釈するかを指定します。
boolean	isWidthAsPercentage()	widthに含まれる値を割合と標準値のどちらとして解釈するかを指定します。

クラス java.lang.Objectから継承されたメソッド

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

フィールドの詳細

AUTO

public static final double AUTO

CSS仕様から:

イメージの固有比と他のディメンションのサイズを使用して1つのディメンションが解決される場合は自動の値、これが失敗する場合はイメージの固有サイズを使用し、これが失敗する場合は100%として処理されます。

両方の値が自動であるとき、イメージの固有の幅または高さ、あるいはその両方が存在する場合は、それらを使用する必要があり、欠落しているディメンションがある場合、それは前述のとおり自動として動作します。 イメージに固有の幅および高さのどちらもない場合、サイズは、containの場合と同様に決定されます。

AUTOに設定された場合は、widthAsPercentageおよびheightAsPercentageの値は無視されます。

関連項目:

定数フィールド値

DEFAULT

public static final BackgroundSize DEFAULT

サイズが明示的に定義されていない場合に、BackgroundImageで使用されるデフォルトのBackgroundSize。 デフォルトでは、BackgroundSizeはAUTOで、AUTOはwidthおよびheightについてのもので、coverおよびcontainは指定されません。

コンストラクタの詳細

BackgroundSize

public BackgroundSize(double width,
                      double height,
                      boolean widthAsPercentage,
                      boolean heightAsPercentage,
                      boolean contain,
                      boolean cover)

新しいBackgroundSizeを作成します。

パラメータ:

width - 幅。 AUTOの値を除いて、0未満にはできません。

height - 高さ。 AUTOの値を除いて、0未満にはできません。

widthAsPercentage - 幅を割合として解釈するかどうか

heightAsPercentage - 高さを割合として解釈するかどうか

contain - リージョン内に収まるようにイメージのサイズを最大化する必要があるかどうか

cover - リージョンをカバーするようにイメージのサイズを設定する必要があるかどうか

メソッドの詳細

getWidth

public final double getWidth()

関連付けられているBackgroundImageがレンダリングする必要があるリージョン内の領域の幅。 AUTOに設定された場合は、widthAsPercentageは無視されます。 containまたはcoverのいずれかが指定されている場合は、この値は意味を持ちません。 AUTOの値に設定される場合を除いて、この値を負にはできません。

戻り値:

関連するBackgroundImageがレンダリングする領域内の領域の幅

getHeight

public final double getHeight()

関連付けられているBackgroundImageがレンダリングする必要があるリージョン内の領域の高さ。 AUTOに設定された場合は、heightAsPercentageは無視されます。 containまたはcoverのいずれかが指定されている場合は、この値は意味を持ちません。 AUTOの値に設定される場合を除いて、この値を負にはできません。

戻り値:

関連するBackgroundImageがレンダリングする領域内の領域の高さ

isWidthAsPercentage

public final boolean isWidthAsPercentage()

widthに含まれる値を割合と標準値のどちらとして解釈するかを指定します。

戻り値:

widthがパーセンテージとして解釈される場合はtrue

isHeightAsPercentage

public final boolean isHeightAsPercentage()

heightに含まれる値を割合と標準値のどちらとして解釈するかを指定します。

戻り値:

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

isContain

public final boolean isContain()

trueの場合、イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域内に収まるように、イメージを最大サイズにスケーリングします。

戻り値:

イメージがバックグラウンドの位置決め領域内に収まる場合はtrue

isCover

public final boolean isCover()

trueの場合、イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域を完全にカバーできるようにイメージを最小サイズにスケーリングします。

戻り値:

イメージがバックグラウンドの配置領域を完全に覆うことができる場合はtrue

equals

public boolean equals(Object o)

このオブジェクトと他のオブジェクトが等しいかどうかを示します。

equalsメソッドは、null以外のオブジェクト参照での同値関係を実装します。

• 反射性(reflexive): null以外の参照値xについて、x.equals(x)はtrueを返します。
• 対称性(symmetric): null以外の参照値xおよびyについて、y.equals(x)がtrueを返す場合に限り、x.equals(y)はtrueを返します。
• 推移性(transitive): null以外の参照値x、y、およびzについて、x.equals(y)がtrueを返し、y.equals(z)がtrueを返す場合、x.equals(z)はtrueを返します。
• 一貫性(consistent): null以外の参照値xおよびyについて、x.equals(y)の複数の呼出しは、このオブジェクトに対するequalsによる比較で使われた情報が変更されていなければ、一貫してtrueを返すか、一貫してfalseを返します。
• null以外の参照値xについて、x.equals(null)はfalseを返します。

Objectクラスのequalsメソッドは、もっとも比較しやすいオブジェクトの同値関係を実装します。つまり、null以外の参照値xとyについて、このメソッドはxとyが同じオブジェクトを参照する(x == yがtrue)場合にだけtrueを返します。

通常、このメソッドをオーバーライドする場合は、hashCodeメソッドを常にオーバーライドして、等価なオブジェクトは等価なハッシュ・コードを保持する必要があるというhashCodeメソッドの汎用規約に従う必要があることに留意してください。

オーバーライド:

equals 、クラス: Object

パラメータ:

o - 比較対象の参照オブジェクト。

戻り値:

このオブジェクトがobj引数と同じである場合はtrue、それ以外の場合はfalse。

関連項目:

Object.hashCode()、HashMap

hashCode

public int hashCode()

オブジェクトのハッシュ・コード値を返します。 このメソッドは、HashMapによって提供されるハッシュ表などの、ハッシュ表の利点のためにサポートされています。

hashCodeの一般的な規則は次のとおりです。

• Javaアプリケーションの実行中に同じオブジェクトに対して複数回呼び出された場合は常に、このオブジェクトに対するequalsの比較で使用される情報が変更されていなければ、hashCodeメソッドは常に同じ整数を返す必要があります。 ただし、この整数は同じアプリケーションの実行ごとに同じである必要はありません。
• equals(Object)メソッドに従って2つのオブジェクトが等しい場合は、2つの各オブジェクトに対するhashCodeメソッドの呼出しによって同じ整数の結果が生成される必要があります。
• Object.equals(java.lang.Object)メソッドに従って2つのオブジェクトが等しくない場合は、2つの各オブジェクトに対するhashCodeメソッドの呼出しによって異なる整数の結果が生成される必要はありません。 ただし、プログラマは、等しくないオブジェクトに対して異なる整数の結果を生成すると、ハッシュ表のパフォーマンスが向上する可能性があることに注意するようにしてください。

クラスObjectによって定義されたhashCodeメソッドは、可能なかぎり、異なるオブジェクトに対して異なる整数を返します。 (hashCodeは、ある時点におけるオブジェクト・メモリー・アドレスの関数として実装されても実装されなくてもよい。)

オーバーライド:

hashCode 、クラス: Object

戻り値:

このオブジェクトのハッシュ・コード値。

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)