モジュール java.desktop
パッケージ javax.swing

クラスJScrollBar

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JScrollBar
すべての実装されたインタフェース:
Adjustable, ImageObserver, MenuContainer, Serializable, Accessible
直系の既知のサブクラス:
JScrollPane.ScrollBar
@JavaBean(defaultProperty="UI",
          description="A component that helps determine the visible content range of an area.")
public class JScrollBar
extends JComponent
implements Adjustable, Accessible
スクロール・バーの実装です。 ユーザーはスクロール・バーのノブを移動して表示するコンテンツ領域を決めます。 プログラムは、通常、スクロール・バーの終端が表示可能コンテンツの終端または100%になるように表示を調整します。 スクロール・バーの先端は表示可能コンテンツの先端または0%になります。 そのような境界内でのノブの位置は対応する表示可能コンテンツのパーセンテージに変換されます。

通常、スクロール・バー内でのノブの位置が変更されると、基になるビュー内でのJViewPortの位置に対して変更が行われ、JViewPortのコンテンツが変更されます。

警告: Swingはスレッドに対して安全ではありません。 詳細は、「Swing's Threading Policy」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後のSwingリリースと互換ではなくなる予定です。 現在の直列化のサポートは、短期間の格納や、同じバージョンのSwingを実行するアプリケーション間のRMIに適しています。 1.4以降、すべてのJavaBeans™用の長期間の格納サポートがjava.beansパッケージに追加されています。 XMLEncoderを参照してください。

導入されたバージョン:
1.2
関連項目:
JScrollPane

  • フィールド詳細

  • コンストラクタの詳細

    • JScrollBar

      public JScrollBar​(int orientation, int value, int extent, int min, int max)
      方向、値、長さ、最小値、最大値を指定してスクロール・バーを作成します。 「長さ」とは、表示可能領域のサイズのことです。 「可視量」とも呼ばれます。

      ノート: setBlockIncrementを使うと、「ブロック」増分値をビューの長さより少し小さいサイズに設定できます。 その場合、ユーザーがノブを隣の位置に移動すると、元のコンテンツの1行または2行がビューに残ります。

      パラメータ:
      orientation - JScrollBarの向き
      value - 現在の値を指定する整数値
      extent - 値が「ジャンプ」できる量を指定する整数値
      min - 最小値を指定する整数値
      max - 最大値を指定する整数値
      例外:
      IllegalArgumentException - 方向がVERTICAL、HORIZONTALのどちらでもない場合
      関連項目:
      setOrientation(int), setValue(int), setVisibleAmount(int), setMinimum(int), setMaximum(int)

    • JScrollBar

      public JScrollBar​(int orientation)
      方向と次の初期値を指定してスクロール・バーを作成します。 
       minimum = 0
 maximum = 100
 value = 0
 extent = 10
      パラメータ:
      orientation - JScrollBarの向き

    • JScrollBar

      public JScrollBar()
      次の初期値を指定して垂直スクロール・バーを作成します。 
       minimum = 0
 maximum = 100
 value = 0
 extent = 10

  • メソッドの詳細

    • setUI

      @BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel")public void setUI​(ScrollBarUI ui)
      このコンポーネントをレンダリングするL&Fオブジェクトを設定します。
      パラメータ:
      ui - ScrollBarUI L&Fオブジェクト
      導入されたバージョン:
      1.4
      関連項目:
      UIDefaults.getUI(javax.swing.JComponent)

    • getUI

      public ScrollBarUI getUI()
      このコンポーネントのルック・アンド・フィールを実装する委譲オブジェクトを返します。
      オーバーライド:
      クラスJComponentのgetUI
      戻り値:
      スクロール・バーの現在のUI。
      関連項目:
      JComponent.setUI(javax.swing.plaf.ComponentUI)

    • updateUI

      public void updateUI()
      JComponent.updateUIをオーバーライドします。
      オーバーライド:
      updateUI 、クラス:  JComponent
      関連項目:
      JComponent.updateUI()

    • getUIClassID

      @BeanProperty(bound=false) public String getUIClassID()
      このコンポーネントのLookAndFeelクラスの名前を返します。
      オーバーライド:
      getUIClassID 、クラス:  JComponent
      戻り値:
      文字列"ScrollBarUI"
      関連項目:
      JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

    • getOrientation

      public int getOrientation()
      コンポーネントの方向(水平または垂直)を返します。
      定義:
      getOrientation 、インタフェース: Adjustable
      戻り値:
      HORIZONTALまたはVERTICAL
      関連項目:
      setOrientation(int), Adjustable.getOrientation()

    • setOrientation

      @BeanProperty(preferred=true, visualUpdate=true, enumerationValues={"JScrollBar.VERTICAL","JScrollBar.HORIZONTAL"}, description="The scrollbar\'s orientation.")public void setOrientation​(int orientation)
      スクロール・バーの方向を水平または垂直に設定します。
      パラメータ:
      orientation - JScrollBarの向き
      例外:
      IllegalArgumentException - 方向がVERTICAL、HORIZONTALのどちらでもない場合
      関連項目:
      getOrientation()

    • getModel

      public BoundedRangeModel getModel()
      最小値、最大値、値、長さという、スクロール・バーの4つの基本プロパティを処理するデータ・モデルを返します。
      戻り値:
      データ・モデル
      関連項目:
      setModel(javax.swing.BoundedRangeModel)

    • setModel

      @BeanProperty(expert=true, description="The scrollbar\'s BoundedRangeModel.")public void setModel​(BoundedRangeModel newModel)
      最小値、最大値、値、長さという、スクロール・バーの4つの基本プロパティを処理するデータ・モデルを設定します。
      パラメータ:
      newModel - 新しいモデル
      関連項目:
      getModel()

    • getUnitIncrement

      public int getUnitIncrement​(int direction)
      ユニット・アップ/ダウン要求に対応するスクロール・バーの値を変更する量を返します。 通常ScrollBarUIの実装は、ユーザーがスクロール・バーの上矢印または下矢印をクリックして、その結果を使ってスクロール・バーの値を更新したときにこのメソッドを呼び出します。 サブクラスは、このメソッドをオーバーライドして値をコンピュートします。たとえば、表内のテキストの(変数の高さ)行または行を1行スクロールするために必要な変更などです。

      JScrollPaneコンポーネントは、このメソッドをオーバーライドし、ビュー・ポートのScrollableビューがあればそれに委譲するスクロール・バーを作成します(デフォルト)。 Scrollableインタフェースは、このメソッドのより特殊なバージョンを提供します。

      カスタム・スクロール動作を提供する一部のルック・アンド・フィール実装では、このプロパティは無視されます。

      パラメータ:
      direction - アップの場合は -1、ダウンの場合は1
      戻り値:
      unitIncrementプロパティの値
      関連項目:
      setUnitIncrement(int), setValue(int), Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)

    • setUnitIncrement

      @BeanProperty(preferred=true, description="The scrollbar\'s unit increment.")public void setUnitIncrement​(int unitIncrement)
      unitIncrementプロパティを設定します。

      引数がInteger.MIN_VALUEの値と等しい場合、ほとんどのルック・アンド・フィール実装では右/下へのスクロールは提供されません。

      カスタム・スクロール動作を提供する一部のルック・アンド・フィール実装では、このプロパティは無視されます。

      定義:
      setUnitIncrement 、インタフェース: Adjustable
      パラメータ:
      unitIncrement - ユニット増分値
      関連項目:
      getUnitIncrement(int)

    • getBlockIncrement

      public int getBlockIncrement​(int direction)
      ブロック(通常は「ページ」)アップ/ダウン要求に対応するスクロール・バーの値を変更する量を返します。 通常、ScrollBarUIの実装では、ユーザーがスクロール・バーの外をクリックすると、このメソッドが呼び出されます。"knob"は、上下に大きくスクロールできます。 サブクラスは、このメソッドをオーバーライドして値をコンピュートします。たとえば、テキスト・ドキュメント内の1つの段落をスクロールするために必要な変更です。

      JScrollPaneコンポーネントは、このメソッドをオーバーライドし、ビュー・ポートのScrollableビューがあればそれに委譲するスクロール・バーを作成します(デフォルト)。 Scrollableインタフェースは、このメソッドのより特殊なバージョンを提供します。

      カスタム・スクロール動作を提供する一部のルック・アンド・フィール実装では、このプロパティは無視されます。

      パラメータ:
      direction - アップの場合は -1、ダウンの場合は1
      戻り値:
      blockIncrementプロパティの値
      関連項目:
      setBlockIncrement(int), setValue(int), Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)

    • setBlockIncrement

      @BeanProperty(preferred=true, description="The scrollbar\'s block increment.")public void setBlockIncrement​(int blockIncrement)
      blockIncrementプロパティを設定します。

      引数がInteger.MIN_VALUEの値と等しい場合、ほとんどのルック・アンド・フィール実装では右/下へのスクロールは提供されません。

      カスタム・スクロール動作を提供する一部のルック・アンド・フィール実装では、このプロパティは無視されます。

      定義:
      setBlockIncrement 、インタフェース: Adjustable
      パラメータ:
      blockIncrement - ブロック増分値
      関連項目:
      getBlockIncrement()

    • getUnitIncrement

      public int getUnitIncrement()
      java.awt.Scrollbarとの下位互換性のために提供されるメソッドです。
      定義:
      getUnitIncrement 、インタフェース: Adjustable
      戻り値:
      調整可能なオブジェクトのユニット増分値
      関連項目:
      Adjustable.getUnitIncrement(), getUnitIncrement(int)

    • getBlockIncrement

      public int getBlockIncrement()
      java.awt.Scrollbarとの下位互換性のために提供されるメソッドです。
      定義:
      getBlockIncrement 、インタフェース: Adjustable
      戻り値:
      調整可能なオブジェクトのブロック増分値
      関連項目:
      Adjustable.getBlockIncrement(), getBlockIncrement(int)

    • getValue

      public int getValue()
      スクロール・バーの値を返します。
      定義:
      getValue 、インタフェース: Adjustable
      戻り値:
      モデルの値プロパティ
      関連項目:
      setValue(int)

    • setValue

      @BeanProperty(bound=false, preferred=true, description="The scrollbar\'s current value.")public void setValue​(int value)
      スクロール・バーの値を設定します。 このメソッドはモデルに値を転送するだけです。
      定義:
      setValue 、インタフェース: Adjustable
      パラメータ:
      value - 現在の値。範囲はminimumからmaximum - visibleAmountまで
      関連項目:
      getValue(), BoundedRangeModel.setValue(int)

    • getVisibleAmount

      public int getVisibleAmount()
      スクロール・バーの長さ、つまり「visibleAmount」を返します。 多くのスクロール・バーのルック・アンド・フィールの実装で、スクロール・バーの「ノブ」または「サム」のサイズはスクロール・バーの長さに比例します。
      定義:
      getVisibleAmount 、インタフェース: Adjustable
      戻り値:
      モデルのextentプロパティの値
      関連項目:
      setVisibleAmount(int)

    • setVisibleAmount

      @BeanProperty(bound=false, preferred=true, description="The amount of the view that is currently visible.")public void setVisibleAmount​(int extent)
      モデルの長さプロパティを設定します。
      定義:
      setVisibleAmount 、インタフェース: Adjustable
      パラメータ:
      extent - インジケータの長さ
      関連項目:
      getVisibleAmount(), BoundedRangeModel.setExtent(int)

    • getMinimum

      public int getMinimum()
      スクロール・バーによってサポートされている最小値を返します(通常は0)。
      定義:
      getMinimum 、インタフェース: Adjustable
      戻り値:
      モデルの最小値プロパティの値
      関連項目:
      setMinimum(int)

    • setMinimum

      @BeanProperty(bound=false, preferred=true, description="The scrollbar\'s minimum value.")public void setMinimum​(int minimum)
      モデルの最小値プロパティを設定します。
      定義:
      setMinimum 、インタフェース: Adjustable
      パラメータ:
      minimum - 最小値
      関連項目:
      getMinimum(), BoundedRangeModel.setMinimum(int)

    • getMaximum

      public int getMaximum()
      スクロール・バーの最大値は、最大値 - 長さになります。
      定義:
      getMaximum 、インタフェース: Adjustable
      戻り値:
      モデルの最大値プロパティの値
      関連項目:
      setMaximum(int)

    • setMaximum

      @BeanProperty(bound=false, preferred=true, description="The scrollbar\'s maximum value.")public void setMaximum​(int maximum)
      モデルの最大値プロパティを設定します。 スクロール・バーの値は、最大値 - 長さまでしか設定できません。
      定義:
      setMaximum 、インタフェース: Adjustable
      パラメータ:
      maximum - 最大値
      関連項目:
      getMaximum(), BoundedRangeModel.setMaximum(int)

    • getValueIsAdjusting

      public boolean getValueIsAdjusting()
      スクロール・バーのノブがドラッグされている場合にtrueを返します。
      戻り値:
      モデルのvalueIsAdjustingプロパティの値
      関連項目:
      setValueIsAdjusting(boolean)

    • setValueIsAdjusting

      @BeanProperty(bound=false, expert=true, description="True if the scrollbar thumb is being dragged.")public void setValueIsAdjusting​(boolean b)
      モデルのvalueIsAdjustingプロパティを設定します。 スクロール・バーのルック・アンド・フィールの実装は、ノブのドラッグが開始されるとこのプロパティをtrueに設定し、ドラッグが終了するとfalseに設定します。 valueIsAdjustingがtrueの場合、スクロールバー・モデルはChangeEventを生成しません。
      パラメータ:
      b - true次回のvalueプロパティの変更がシリーズの一部である場合
      関連項目:
      getValueIsAdjusting(), BoundedRangeModel.setValueIsAdjusting(boolean)

    • setValues

      public void setValues​(int newValue, int newExtent, int newMin, int newMax)
      引数が次の通常の制約に従うように強制したあとで、4つのBoundedRangeModelプロパティを設定します。 
       minimum ≤ value ≤ value+extent ≤ maximum
      パラメータ:
      newValue - 現在の値を指定する整数値
      newExtent - 値が「ジャンプ」できる量を指定する整数値
      newMin - 最小値を指定する整数値
      newMax - 最大値を指定する整数値
      関連項目:
      BoundedRangeModel.setRangeProperties(int, int, int, int, boolean), setValue(int), setVisibleAmount(int), setMinimum(int), setMaximum(int)

    • addAdjustmentListener

      public void addAdjustmentListener​(AdjustmentListener l)
      AdjustmentListenerを追加します。 調整リスナーは、スクロール・バーのモデルが変更されるたびに通知を受けます。 調整イベントはjava.awt.Scrollbarとの下位互換性のために提供されています。

      AdjustmentEvent型のプロパティは、常にAdjustmentEvent.TRACKのプレースホルダー値を持ちます。 BoundedRangeModelの値を変更するには、値プロパティ、つまりmodel.setValue(123)を設定するだけです。 たとえばブロック・デクリメントであるなど、変更の原因についての情報は提供されません。 ここでは、変更の原点の追加は試みません。

      定義:
      addAdjustmentListener 、インタフェース: Adjustable
      パラメータ:
      l - 追加するAdjustmentListener
      関連項目:
      removeAdjustmentListener(java.awt.event.AdjustmentListener), BoundedRangeModel.addChangeListener(javax.swing.event.ChangeListener)

    • removeAdjustmentListener

      public void removeAdjustmentListener​(AdjustmentListener l)
      AdjustmentEventリスナーを削除します。
      定義:
      removeAdjustmentListener 、インタフェース: Adjustable
      パラメータ:
      l - 削除するAdjustmentListener
      関連項目:
      addAdjustmentListener(java.awt.event.AdjustmentListener)

    • getAdjustmentListeners

      @BeanProperty(bound=false) public AdjustmentListener[] getAdjustmentListeners()
      addAdjustmentListener()を使用してこのJScrollBarに追加されるすべてのAdjustmentListenerの配列を返します。
      戻り値:
      追加されたすべてのAdjustmentListener。リスナーが追加されていない場合は空の配列
      導入されたバージョン:
      1.4

    • fireAdjustmentValueChanged

      protected void fireAdjustmentValueChanged​(int id, int type, int value)
      スクロール・バーのモデルが変更されたことをリスナーに通知します。
      パラメータ:
      id - イベントのタイプを示す整数
      type - 調整型を示す整数。
      value - 調整の現在の値
      関連項目:
      addAdjustmentListener(java.awt.event.AdjustmentListener), EventListenerList

    • getMinimumSize

      public Dimension getMinimumSize()
      スクロール・バーはスクロール軸に沿った方向では自由にサイズ変更できますが、もう一方の軸の方向のサイズは固定になります。
      オーバーライド:
      getMinimumSize 、クラス:  JComponent
      戻り値:
      minimumSizeプロパティの値
      関連項目:
      JComponent.setMinimumSize(java.awt.Dimension), ComponentUI

    • getMaximumSize

      public Dimension getMaximumSize()
      スクロール・バーはスクロール軸に沿った方向では自由にサイズ変更できますが、もう一方の軸の方向のサイズは固定になります。
      オーバーライド:
      getMaximumSize 、クラス:  JComponent
      戻り値:
      maximumSizeプロパティの値
      関連項目:
      JComponent.setMaximumSize(java.awt.Dimension), ComponentUI

    • setEnabled

      public void setEnabled​(boolean x)
      コンポーネントを使用可能にして、ノブの位置が変更できるようにします。 使用可能でない場合は、ノブの位置は変更できません。
      オーバーライド:
      setEnabled 、クラス:  JComponent
      パラメータ:
      x - boolean値。trueの場合はコンポーネントは使用可能で、falseの場合は使用不可
      関連項目:
      Component.isEnabled(), Component.isLightweight()

    • paramString

      protected String paramString()
      このJScrollBarの文字列表現を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる可能性があります。 返される文字列は空でもかまいませんが、nullにはできません。
      オーバーライド:
      paramString 、クラス:  JComponent
      戻り値:
      このJScrollBarの文字列表現。

    • getAccessibleContext

      @BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
      このJScrollBarに関連付けられたAccessibleContextを取得します。 JScrollBarの場合、AccessibleContextはAccessibleJScrollBarの形式を取ります。 必要に応じて新規のAccessibleJScrollBarインスタンスが作成されます。
      定義:
      getAccessibleContext、インタフェース: Accessible
      オーバーライド:
      getAccessibleContext、クラス: Component
      戻り値:
      このJScrollBarのAccessibleContextとして機能するAccessibleJScrollBar