- java.lang.Object
-
- javafx.scene.layout.BorderImage
-
public class BorderImage extends Object
あるリージョンのボーダーとしてイメージをレンダリングする方法を記述するプロパティを定義します。 BorderImageにはImageを指定する必要があります(nullにはできません)。repeatX
およびrepeatY
プロパティは、各方向でイメージを繰り返す方法を定義します。slices
プロパティは、リージョン全体に拡大できるようにイメージを区分化する方法を定義し、widths
は、ボーダー・イメージで埋めるリージョンの領域を定義します。 最終的に、outsets
は、ボーダーが拡張するボーダーの端から外側への距離を定義します。 BorderImageのアウトセットはボーダーのアウトセットに影響し、さらにリージョンの境界に影響します。BorderImageは不変であるため、どのキャッシュでも安全に使用でき、複数のリージョンの間で安全に再使用できます。
形状が定義されたリージョンに適用される場合、BorderImageは無視されます。
- 導入されたバージョン:
- JavaFX 8.0
-
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 BorderImage(Image image, BorderWidths widths, Insets insets, BorderWidths slices, boolean filled, BorderRepeat repeatX, BorderRepeat repeatY)
新しいBorderImageを作成します。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 Image
getImage()
使用されるイメージ。Insets
getInsets()
BorderImageの枠は、リージョンの端に対して枠線がどこに位置付けられるかを定義します。BorderRepeat
getRepeatX()
該当する場合に、ボーダー・イメージがリージョンのx軸に沿ってどのように繰り返されるかを示します。BorderRepeat
getRepeatY()
該当する場合に、ボーダー・イメージがリージョンのy軸に沿ってどのように繰り返されるかを示します。BorderWidths
getSlices()
イメージの区分を定義します。BorderWidths
getWidths()
それぞれの辺のボーダーの幅。boolean
isFilled()
中央パッチ(左、右、上および下の区分により定義される)を描画する必要があるかどうかを指定します。
-
-
-
コンストラクタの詳細
-
BorderImage
public BorderImage(Image image, BorderWidths widths, Insets insets, BorderWidths slices, boolean filled, BorderRepeat repeatX, BorderRepeat repeatY)
新しいBorderImageを作成します。 イメージを指定する必要があるか、NullPointerExceptionがスローされます。- パラメータ:
image
- 使用するイメージ。 nullは指定できません。widths
- 各ディメンションのボーダーの幅。 null値はInsets.EMPTYになります。insets
- リージョンに対して相対的にボーダーを配置する枠。 null値はInsets.EMPTYになります。slices
- イメージの区分。 nullの場合、デフォルトはBorderImageSlices.DEFAULTです。filled
- 中央のパッチを描画するかどうかを示すフラグrepeatX
- x方向のボーダー・イメージの繰返し値。 nullの場合、デフォルトはSTRETCHです。repeatY
- y方向のボーダー・イメージの繰返し値。 nullの場合、デフォルトはrepeatXと同じ値になります。
-
-
メソッドの詳細
-
getImage
public final Image getImage()
使用されるイメージ。 nullは不可。 このイメージのロードに失敗した場合は、BorderImage全体がレンダリング時にスキップされ、境界または他の計算には影響しません。- 戻り値:
- 使用するイメージ
-
getRepeatX
public final BorderRepeat getRepeatX()
該当する場合に、ボーダー・イメージがリージョンのx軸に沿ってどのように繰り返されるかを示します。 値を指定しない場合はデフォルト値のSTRETCHになります。- 戻り値:
- ボーダー・イメージが領域のx軸に沿って繰り返されるかどうかを示すBorderRepeat
-
getRepeatY
public final BorderRepeat getRepeatY()
該当する場合に、ボーダー・イメージがリージョンのy軸に沿ってどのように繰り返されるかを示します。 値を指定しない場合はデフォルト値のSTRETCHになります。- 戻り値:
- ボーダー・イメージがその領域のy軸に沿って繰り返されるかどうかを示すBorderRepeat
-
getWidths
public final BorderWidths getWidths()
それぞれの辺のボーダーの幅。 これらは絶対幅またはリージョンのサイズの割合のいずれかとして定義できます。詳細は、BorderWidths
を参照してください。 nullの場合、このデフォルトは、1ピクセル幅となります。- 戻り値:
- 各辺のボーダーのBorderWidth
-
getSlices
public final BorderWidths getSlices()
イメージの区分を定義します。 JavaFXは、各区分がイメージを9パッチに分割する4区分のスキームを使用します。 左上パッチはボーダーの左上隅を定義します。 上部パッチは上部ボーダーを定義し、このパッチを構成するイメージは水平方向に拡大され(、またはrepeatXに定義された内容に従い)、必要なスペース全体に表示されます。 右上パッチは右上隅に適用され、右パッチは垂直方向に拡大され(、またはrepeatYに定義された内容に従い)、必要なスペース全体に表示されます。 その他の場合も同様です。 中央パッチは各ディメンションで拡大されます(またはrepeatX、repeatYに定義された内容に従います)。 デフォルトでは、中央は省略されます(つまり、描画されません)が、filled
プロパティに対してBorderImageSlices値がtrue
の場合は、中央が描画されます。 このプロパティのデフォルト値は、BorderImageSlices.DEFAULTとなり、border-image-sliceは100%となります。- 戻り値:
- イメージのスライスを定義するBorderWidth
- 関連項目:
- border-image-slice
-
isFilled
public final boolean isFilled()
中央パッチ(左、右、上および下の区分により定義される)を描画する必要があるかどうかを指定します。- 戻り値:
- 中央のパッチを描画する必要がある場合はtrue
-
getInsets
public final Insets getInsets()
BorderImageの枠は、リージョンの端に対して枠線がどこに位置付けられるかを定義します。 この値はnullにはなりません。- 戻り値:
- BorderImageのインセット
-
-