モジュール 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を作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	equals(Object o)	このオブジェクトと他のオブジェクトが等しいかどうかを示します。
Image	getImage()	使用されるイメージ。
BackgroundPosition	getPosition()	リージョンに対して相対的なこのBackgroundImageの位置。
BackgroundRepeat	getRepeatX()	該当する場合に、背景イメージがリージョンのx軸に沿ってどのように繰り返されるかを示します。
BackgroundRepeat	getRepeatY()	該当する場合に、背景イメージがリージョンのy軸に沿ってどのように繰り返されるかを示します。
BackgroundSize	getSize()	リージョンに対して相対的なこのイメージのサイズ。
int	hashCode()	オブジェクトのハッシュ・コード値を返します。

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

clone、finalize、getClass、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に対するこのイメージのサイズ

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)