モジュール javafx.controls
パッケージ javafx.scene.control

クラスScrollPane

  • すべての実装されたインタフェース:
    Styleable, EventTarget, Skinnable

    @DefaultProperty("content")
public class ScrollPane
extends Control
    コンテンツのスクロールおよびクリップされるビューポートを提供するコントロール。 これにより、ユーザーは直接(パン)またはスクロール・バーを使用してコンテンツをスクロールできます。 ScrollPaneでは、スクロール・バーがいつ表示されるようにするか(常に表示する、表示しない、必要なときのみ、のいずれか)を決定する、スクロール・バー・ポリシーを指定できます。 スクロール・バー・ポリシーは、水平スクロール・バーと垂直スクロール・バーに対して独立して指定できます。

    ScrollPaneにより、アプリケーションでは水平方向および垂直方向にコンテンツを配置するための現在値、最小値および最大値を設定できます。 これらの値は、格納されているノードのlayoutBoundsに均等にマップされます。

    ScrollPaneレイアウト計算は、スクロール・ノードのboundsInParent (視覚境界)ではなく、layoutBoundsに基づいています。 アプリケーションでスクロールをノードの視覚境界に基づくようにする場合(コンテンツのスケーリングなど)、スクロール・ノードをグループにラップする必要があります。

    ScrollPaneは、focusTraversableをfalseに設定します。

    この例では、Rectangleが含まれているScrollPaneを作成します。 

    
 import javafx.scene.control.ScrollPane;
 import javafx.scene.shape.Rectangle;

 Rectangle rect = new Rectangle(200, 200, Color.RED);
 ScrollPane s1 = new ScrollPane();
 s1.setPrefSize(120, 120);
 s1.setContent(rect);
    導入されたバージョン:
    JavaFX 2.0

    • プロパティの詳細

      • hvalue

        public final DoubleProperty hvalueProperty
        ScrollPaneの現在の水平方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にhminからhmaxまでの範囲内に収まる必要があります。 hvalueがhminと等しい場合、格納されているノードはlayoutBounds minXが表示されるように配置されます。 hvalueがhmaxと等しい場合、格納されているノードはlayoutBounds maxXが表示されるように配置されます。 hvalueがhminからhmaxまでにある場合、格納されているノードはlayoutBounds minXからlayoutBounds maxXまでに均等に配置されます。
        関連項目:
        getHvalue()、setHvalue(double)

      • vvalue

        public final DoubleProperty vvalueProperty
        ScrollPaneの現在の垂直方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にvminからvmaxまでの範囲内に収まる必要があります。 vvalueがvminと等しい場合、格納されているノードはlayoutBounds minYが表示されるように配置されます。 vvalueがvmaxと等しい場合、格納されているノードはlayoutBounds maxYが表示されるように配置されます。 vvalueがvminからvmaxまでにある場合、格納されているノードはlayoutBounds minYからlayoutBounds maxYまでに均等に配置されます。
        関連項目:
        getVvalue()、setVvalue(double)

      • fitToWidth

        public final BooleanProperty fitToWidthProperty
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの幅に一致するようにノードのサイズが変更されたままになります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。
        関連項目:
        isFitToWidth()、setFitToWidth(boolean)

      • fitToHeight

        public final BooleanProperty fitToHeightProperty
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの高さに一致するようにノードのサイズが変更された状態になります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。
        関連項目:
        isFitToHeight()、setFitToHeight(boolean)

      • pannable

        public final BooleanProperty pannableProperty
        マウスを使用してユーザーがビューポートをパンできるかどうかを指定します。 マウス・イベントがScrollPaneに達した場合(つまり、格納されているノードまたはその子のいずれかによってマウス・イベントがブロックされていない場合)、pannableを参照して、イベントをパンに使用するかどうかを決定します。
        関連項目:
        isPannable()、setPannable(boolean)

      • prefViewportWidth

        public final DoubleProperty prefViewportWidthProperty
        ScrollPaneビューポートの優先幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。 ScrollPaneの幅全体は、ViewportWidthに余白を加えたものになります。
        関連項目:
        getPrefViewportWidth()、setPrefViewportWidth(double)

      • prefViewportHeight

        public final DoubleProperty prefViewportHeightProperty
        ScrollPaneビューポートの優先高を指定します。 これは、コンテンツ・ノードが使用可能な高さです。 ScrollPaneの高さ全体は、ViewportHeightに余白を加えたものになります。
        関連項目:
        getPrefViewportHeight()、setPrefViewportHeight(double)

      • minViewportWidth

        public final DoubleProperty minViewportWidthProperty
        ScrollPaneビューポートの最小幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        getMinViewportWidth()、setMinViewportWidth(double)

      • minViewportHeight

        public final DoubleProperty minViewportHeightProperty
        ScrollPaneビューポートの最小の高さを指定します。 これは、コンテンツ・ノードが使用可能な高さです。
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        getMinViewportHeight()、setMinViewportHeight(double)

    • コンストラクタの詳細

      • ScrollPane

        public ScrollPane​()
        新しいScrollPaneを作成します。

      • ScrollPane

        public ScrollPane​(Node content)
        新しいScrollPaneを作成します。
        パラメータ:
        content - ScrollPaneの初期コンテンツ
        導入されたバージョン:
        JavaFX 8.0

    • メソッドの詳細

      • setHbarPolicy

        public final void setHbarPolicy​(ScrollPane.ScrollBarPolicy value)
        プロパティhbarPolicyの値を設定します。
        プロパティの説明:
        水平スクロール・バーを表示するためのポリシーを指定します。

      • getHbarPolicy

        public final ScrollPane.ScrollBarPolicy getHbarPolicy​()
        プロパティhbarPolicyの値を取得します。
        プロパティの説明:
        水平スクロール・バーを表示するためのポリシーを指定します。

      • setVbarPolicy

        public final void setVbarPolicy​(ScrollPane.ScrollBarPolicy value)
        プロパティvbarPolicyの値を設定します。
        プロパティの説明:
        垂直スクロール・バーを表示するためのポリシーを指定します。

      • getVbarPolicy

        public final ScrollPane.ScrollBarPolicy getVbarPolicy​()
        プロパティvbarPolicyの値を取得します。
        プロパティの説明:
        垂直スクロール・バーを表示するためのポリシーを指定します。

      • setContent

        public final void setContent​(Node value)
        プロパティcontentの値を設定します。
        プロパティの説明:
        このScrollPaneのコンテンツとして使用されるノード。

      • getContent

        public final Node getContent​()
        プロパティcontentの値を取得します。
        プロパティの説明:
        このScrollPaneのコンテンツとして使用されるノード。

      • setHvalue

        public final void setHvalue​(double value)
        プロパティhvalueの値を設定します。
        プロパティの説明:
        ScrollPaneの現在の水平方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にhminからhmaxまでの範囲内に収まる必要があります。 hvalueがhminと等しい場合、格納されているノードはlayoutBounds minXが表示されるように配置されます。 hvalueがhmaxと等しい場合、格納されているノードはlayoutBounds maxXが表示されるように配置されます。 hvalueがhminからhmaxまでにある場合、格納されているノードはlayoutBounds minXからlayoutBounds maxXまでに均等に配置されます。

      • getHvalue

        public final double getHvalue​()
        プロパティhvalueの値を取得します。
        プロパティの説明:
        ScrollPaneの現在の水平方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にhminからhmaxまでの範囲内に収まる必要があります。 hvalueがhminと等しい場合、格納されているノードはlayoutBounds minXが表示されるように配置されます。 hvalueがhmaxと等しい場合、格納されているノードはlayoutBounds maxXが表示されるように配置されます。 hvalueがhminからhmaxまでにある場合、格納されているノードはlayoutBounds minXからlayoutBounds maxXまでに均等に配置されます。

      • hvalueProperty

        public final DoubleProperty hvalueProperty​()
        ScrollPaneの現在の水平方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にhminからhmaxまでの範囲内に収まる必要があります。 hvalueがhminと等しい場合、格納されているノードはlayoutBounds minXが表示されるように配置されます。 hvalueがhmaxと等しい場合、格納されているノードはlayoutBounds maxXが表示されるように配置されます。 hvalueがhminからhmaxまでにある場合、格納されているノードはlayoutBounds minXからlayoutBounds maxXまでに均等に配置されます。
        関連項目:
        getHvalue()、setHvalue(double)

      • setVvalue

        public final void setVvalue​(double value)
        プロパティvvalueの値を設定します。
        プロパティの説明:
        ScrollPaneの現在の垂直方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にvminからvmaxまでの範囲内に収まる必要があります。 vvalueがvminと等しい場合、格納されているノードはlayoutBounds minYが表示されるように配置されます。 vvalueがvmaxと等しい場合、格納されているノードはlayoutBounds maxYが表示されるように配置されます。 vvalueがvminからvmaxまでにある場合、格納されているノードはlayoutBounds minYからlayoutBounds maxYまでに均等に配置されます。

      • getVvalue

        public final double getVvalue​()
        プロパティvvalueの値を取得します。
        プロパティの説明:
        ScrollPaneの現在の垂直方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にvminからvmaxまでの範囲内に収まる必要があります。 vvalueがvminと等しい場合、格納されているノードはlayoutBounds minYが表示されるように配置されます。 vvalueがvmaxと等しい場合、格納されているノードはlayoutBounds maxYが表示されるように配置されます。 vvalueがvminからvmaxまでにある場合、格納されているノードはlayoutBounds minYからlayoutBounds maxYまでに均等に配置されます。

      • vvalueProperty

        public final DoubleProperty vvalueProperty​()
        ScrollPaneの現在の垂直方向のスクロール位置。 この値は、プログラムでビューをスクロールするためにアプリケーションによって設定される場合があります。 ビューポートをユーザーがスクロールまたはパンするたびに、ScrollPaneによってこの値が更新されます。 この値は、常にvminからvmaxまでの範囲内に収まる必要があります。 vvalueがvminと等しい場合、格納されているノードはlayoutBounds minYが表示されるように配置されます。 vvalueがvmaxと等しい場合、格納されているノードはlayoutBounds maxYが表示されるように配置されます。 vvalueがvminからvmaxまでにある場合、格納されているノードはlayoutBounds minYからlayoutBounds maxYまでに均等に配置されます。
        関連項目:
        getVvalue()、setVvalue(double)

      • setHmin

        public final void setHmin​(double value)
        プロパティhminの値を設定します。
        プロパティの説明:
        このScrollPaneで許容される最小hvalue。 デフォルト値は0です。

      • getHmin

        public final double getHmin​()
        プロパティhminの値を取得します。
        プロパティの説明:
        このScrollPaneで許容される最小hvalue。 デフォルト値は0です。

      • setVmin

        public final void setVmin​(double value)
        プロパティvminの値を設定します。
        プロパティの説明:
        このScrollPaneで許容される最小vvalue。 デフォルト値は0です。

      • getVmin

        public final double getVmin​()
        プロパティvminの値を取得します。
        プロパティの説明:
        このScrollPaneで許容される最小vvalue。 デフォルト値は0です。

      • setHmax

        public final void setHmax​(double value)
        プロパティhmaxの値を設定します。
        プロパティの説明:
        このScrollPaneで許容される最大hvalue。 デフォルト値は1です。

      • getHmax

        public final double getHmax​()
        プロパティhmaxの値を取得します。
        プロパティの説明:
        このScrollPaneで許容される最大hvalue。 デフォルト値は1です。

      • setVmax

        public final void setVmax​(double value)
        プロパティvmaxの値を設定します。
        プロパティの説明:
        このScrollPaneで許容される最大vvalue。 デフォルト値は1です。

      • getVmax

        public final double getVmax​()
        プロパティvmaxの値を取得します。
        プロパティの説明:
        このScrollPaneで許容される最大vvalue。 デフォルト値は1です。

      • setFitToWidth

        public final void setFitToWidth​(boolean value)
        プロパティfitToWidthの値を設定します。
        プロパティの説明:
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの幅に一致するようにノードのサイズが変更されたままになります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。

      • isFitToWidth

        public final boolean isFitToWidth​()
        プロパティfitToWidthの値を取得します。
        プロパティの説明:
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの幅に一致するようにノードのサイズが変更されたままになります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。

      • fitToWidthProperty

        public final BooleanProperty fitToWidthProperty​()
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの幅に一致するようにノードのサイズが変更されたままになります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。
        関連項目:
        isFitToWidth()、setFitToWidth(boolean)

      • setFitToHeight

        public final void setFitToHeight​(boolean value)
        プロパティfitToHeightの値を設定します。
        プロパティの説明:
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの高さに一致するようにノードのサイズが変更された状態になります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。

      • isFitToHeight

        public final boolean isFitToHeight​()
        プロパティfitToHeightの値を取得します。
        プロパティの説明:
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの高さに一致するようにノードのサイズが変更された状態になります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。

      • fitToHeightProperty

        public final BooleanProperty fitToHeightProperty​()
        trueかつ格納されているノードがサイズ変更可能な場合は、ScrollPaneのビューポートの高さに一致するようにノードのサイズが変更された状態になります。 格納されているノードがサイズ変更可能でない場合、この値は無視されます。
        関連項目:
        isFitToHeight()、setFitToHeight(boolean)

      • setPannable

        public final void setPannable​(boolean value)
        プロパティpannableの値を設定します。
        プロパティの説明:
        マウスを使用してユーザーがビューポートをパンできるかどうかを指定します。 マウス・イベントがScrollPaneに達した場合(つまり、格納されているノードまたはその子のいずれかによってマウス・イベントがブロックされていない場合)、pannableを参照して、イベントをパンに使用するかどうかを決定します。

      • isPannable

        public final boolean isPannable​()
        プロパティpannableの値を取得します。
        プロパティの説明:
        マウスを使用してユーザーがビューポートをパンできるかどうかを指定します。 マウス・イベントがScrollPaneに達した場合(つまり、格納されているノードまたはその子のいずれかによってマウス・イベントがブロックされていない場合)、pannableを参照して、イベントをパンに使用するかどうかを決定します。

      • pannableProperty

        public final BooleanProperty pannableProperty​()
        マウスを使用してユーザーがビューポートをパンできるかどうかを指定します。 マウス・イベントがScrollPaneに達した場合(つまり、格納されているノードまたはその子のいずれかによってマウス・イベントがブロックされていない場合)、pannableを参照して、イベントをパンに使用するかどうかを決定します。
        関連項目:
        isPannable()、setPannable(boolean)

      • setPrefViewportWidth

        public final void setPrefViewportWidth​(double value)
        プロパティprefViewportWidthの値を設定します。
        プロパティの説明:
        ScrollPaneビューポートの優先幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。 ScrollPaneの幅全体は、ViewportWidthに余白を加えたものになります。

      • getPrefViewportWidth

        public final double getPrefViewportWidth​()
        プロパティprefViewportWidthの値を取得します。
        プロパティの説明:
        ScrollPaneビューポートの優先幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。 ScrollPaneの幅全体は、ViewportWidthに余白を加えたものになります。

      • prefViewportWidthProperty

        public final DoubleProperty prefViewportWidthProperty​()
        ScrollPaneビューポートの優先幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。 ScrollPaneの幅全体は、ViewportWidthに余白を加えたものになります。
        関連項目:
        getPrefViewportWidth()、setPrefViewportWidth(double)

      • setPrefViewportHeight

        public final void setPrefViewportHeight​(double value)
        プロパティprefViewportHeightの値を設定します。
        プロパティの説明:
        ScrollPaneビューポートの優先高を指定します。 これは、コンテンツ・ノードが使用可能な高さです。 ScrollPaneの高さ全体は、ViewportHeightに余白を加えたものになります。

      • getPrefViewportHeight

        public final double getPrefViewportHeight​()
        プロパティprefViewportHeightの値を取得します。
        プロパティの説明:
        ScrollPaneビューポートの優先高を指定します。 これは、コンテンツ・ノードが使用可能な高さです。 ScrollPaneの高さ全体は、ViewportHeightに余白を加えたものになります。

      • prefViewportHeightProperty

        public final DoubleProperty prefViewportHeightProperty​()
        ScrollPaneビューポートの優先高を指定します。 これは、コンテンツ・ノードが使用可能な高さです。 ScrollPaneの高さ全体は、ViewportHeightに余白を加えたものになります。
        関連項目:
        getPrefViewportHeight()、setPrefViewportHeight(double)

      • setMinViewportWidth

        public final void setMinViewportWidth​(double value)
        プロパティminViewportWidthの値を設定します。
        プロパティの説明:
        ScrollPaneビューポートの最小幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。
        導入されたバージョン:
        JavaFX 8u40

      • getMinViewportWidth

        public final double getMinViewportWidth​()
        プロパティminViewportWidthの値を取得します。
        プロパティの説明:
        ScrollPaneビューポートの最小幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。
        導入されたバージョン:
        JavaFX 8u40

      • minViewportWidthProperty

        public final DoubleProperty minViewportWidthProperty​()
        ScrollPaneビューポートの最小幅を指定します。 これは、コンテンツ・ノードが使用可能な幅です。
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        getMinViewportWidth()、setMinViewportWidth(double)

      • setMinViewportHeight

        public final void setMinViewportHeight​(double value)
        プロパティminViewportHeightの値を設定します。
        プロパティの説明:
        ScrollPaneビューポートの最小の高さを指定します。 これは、コンテンツ・ノードが使用可能な高さです。
        導入されたバージョン:
        JavaFX 8u40

      • getMinViewportHeight

        public final double getMinViewportHeight​()
        プロパティminViewportHeightの値を取得します。
        プロパティの説明:
        ScrollPaneビューポートの最小の高さを指定します。 これは、コンテンツ・ノードが使用可能な高さです。
        導入されたバージョン:
        JavaFX 8u40

      • minViewportHeightProperty

        public final DoubleProperty minViewportHeightProperty​()
        ScrollPaneビューポートの最小の高さを指定します。 これは、コンテンツ・ノードが使用可能な高さです。
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        getMinViewportHeight()、setMinViewportHeight(double)

      • setViewportBounds

        public final void setViewportBounds​(Bounds value)
        プロパティviewportBoundsの値を設定します。
        プロパティの説明:
        ScrollPaneビューポートの実際の境界。 これは、コンテンツ・ノードの境界です。

      • getViewportBounds

        public final Bounds getViewportBounds​()
        プロパティviewportBoundsの値を取得します。
        プロパティの説明:
        ScrollPaneビューポートの実際の境界。 これは、コンテンツ・ノードの境界です。

      • createDefaultSkin

        protected Skin<?> createDefaultSkin​()
        このコントロールのデフォルト・スキンの新しいインスタンスを作成します。 これは、CSS -fx-skinを介してスキンが提供されていない場合にコントロール用のスキンを作成するために、または setSkin(...)を使用してサブクラスで明示的に設定するために呼び出されます。
        オーバーライド:
        createDefaultSkin 、クラス: Control
        戻り値:
        このコントロールのデフォルト・スキンの新しいインスタンス。 nullの場合、コントロールにはスキンがありません(Cssで提供されている場合を除く)。

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData​()
        戻り値:
        このクラスに関連付けられたCssMetaData。スーパークラスのCssMetaDataを含むことがあります。
        導入されたバージョン:
        JavaFX 8.0

      • getControlCssMetaData

        public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData​()
        オーバーライド:
        getControlCssMetaData 、クラス: Control
        戻り値:
        コントロールのCSSでスタイル設定可能なプロパティの変更不可能なリスト
        導入されたバージョン:
        JavaFX 8.0

      • getInitialFocusTraversable

        protected Boolean getInitialFocusTraversable​()
        このコントロールの初期フォーカス・トラバーサブル状態を返します。これは、JavaFX CSSエンジンが初期値を正しく設定するために使用します。 このメソッドはオーバーライドされます。既定のUIコントロールでは、フォーカス・トラバーサルがtrueに設定されていますが、このコントロールには適切ではありません。
        オーバーライド:
        クラスControlのgetInitialFocusTraversable
        戻り値:
        このコントロールの最初のフォーカス・トラバーサル状態
        導入されたバージョン:
        9

      • queryAccessibleAttribute

        public Object queryAccessibleAttribute​(AccessibleAttribute attribute,
                                       Object... parameters)
        このメソッドは、属性の値をリクエストするためにアシスティブ・テクノロジによって呼び出されます。

        このメソッドは一般に、特定の役割に必要な属性を実装するためにサブクラスによってオーバーライドされます。
        特定の属性が処理されない場合は、スーパークラスの実装を呼び出す必要があります。

        オーバーライド:
        queryAccessibleAttribute、クラス: Control
        パラメータ:
        attribute - リクエストされた属性
        parameters - オプションのパラメータ・リスト
        戻り値:
        リクエストされた属性の値
        関連項目:
        AccessibleAttribute