モジュール javafx.graphics
パッケージ javafx.scene.layout

クラスBackgroundSize


  • public final class BackgroundSize
    extends Object
    BackgroundImageによってスタイル設定されるリージョンに対して相対的に、塗りつぶす必要がある領域のサイズを定義します。 値が他のプロパティよりも優先されるプロパティがいくつかあります。 特に、4つの主要なプロパティとしてwidthheightcontainおよび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を作成します。
    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      double getHeight()
      関連付けられているBackgroundImageがレンダリングする必要があるリージョン内の領域の高さ。
      double getWidth()
      関連付けられているBackgroundImageがレンダリングする必要があるリージョン内の領域の幅。
      boolean isContain()
      trueの場合、イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域内に収まるように、イメージを最大サイズにスケーリングします。
      boolean isCover()
      trueの場合、イメージ固有の縦横比がある場合はそれを保持して、その幅と高さの両方が背景配置領域を完全にカバーできるようにイメージを最小サイズにスケーリングします。
      boolean isHeightAsPercentage()
      heightに含まれる値を割合と標準値のどちらとして解釈するかを指定します。
      boolean isWidthAsPercentage()
      widthに含まれる値を割合と標準値のどちらとして解釈するかを指定します。
    • フィールドの詳細

      • 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