BasicProgressBarUI (Java Platform SE 7)

java.lang.Object
- javax.swing.plaf.ComponentUI
- - javax.swing.plaf.ProgressBarUI
  - - javax.swing.plaf.basic.BasicProgressBarUI

直系の既知のサブクラス:

MetalProgressBarUI, SynthProgressBarUI
```
public class BasicProgressBarUI
extends ProgressBarUI
```
ProgressBarUI の基本 Look & Feel 実装です。

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`class`	`BasicProgressBarUI.ChangeHandler` このクラスは、「protected」内部クラスとして扱うようにしてください。

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`protected Rectangle`	`boxRect` ペイントされる (getBox によって返された) バウンシングボックスの位置とサイズを保持するために使用します。
`protected ChangeListener`	`changeListener`
`protected JProgressBar`	`progressBar`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

BasicProgressBarUI()

コンストラクタ
コンストラクタと説明
`BasicProgressBarUI()`

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`static ComponentUI`	`createUI(JComponent x)`
`protected int`	`getAmountFull(Insets b, int width, int height)` モデルから集めた完了パーセント情報に基づいて、塗りつぶすべき進捗バーの量を決定します。
`protected int`	`getAnimationIndex()` 現在のアニメーションフレームのインデックスを取得します。
`int`	`getBaseline(JComponent c, int width, int height)` ベースラインを返します。
`Component.BaselineResizeBehavior`	`getBaselineResizeBehavior(JComponent c)` サイズの変化に合わせてコンポーネントのベースラインがどのように変化するかを示す列挙を返します。
`protected Rectangle`	`getBox(Rectangle r)` 現在のアニメーションインデックス用にペイントされるバウンシングボックスの位置とサイズを `r` に格納し、`r` を返します。
`protected int`	`getBoxLength(int availableLength, int otherDimension)` ペイントされる「バウンシングボックス」の長さを返します。
`protected int`	`getCellLength()` 進捗バーにレンダリングされる個々のセルおよび単位の幅 (HORIZONTAL の場合) または高さ (VERTICAL の場合) を返します。
`protected int`	`getCellSpacing()` 進捗バーにある各セルおよび単位の間隔を返します。
`protected int`	`getFrameCount()` 不確定モードの JProgressBar で使用される完全なアニメーションループのためのフレーム数を返します。
`Dimension`	`getMaximumSize(JComponent c)` 指定されたコンポーネントの、Look & Feel に適した最大サイズを返します。
`Dimension`	`getMinimumSize(JComponent c)` このコンポーネントの最小サイズは 10 です。
`protected Dimension`	`getPreferredInnerHorizontal()`
`protected Dimension`	`getPreferredInnerVertical()`
`Dimension`	`getPreferredSize(JComponent c)` 指定されたコンポーネントの、Look & Feel に適した推奨サイズを返します。
`protected Color`	`getSelectionBackground()` selectionBackground は、進捗バーの塗りつぶされていない領域をペイントするときのテキストの色です。
`protected Color`	`getSelectionForeground()` selectionForeground は、進捗バーの塗りつぶされた領域をペイントするときのテキストの色です。
`protected Point`	`getStringPlacement(Graphics g, String progressString, int x, int y, int width, int height)` 進捗文字列のペイント位置を指定します。
`protected void`	`incrementAnimationIndex()` 現在のアニメーションフレームのインデックスを次の有効値に設定します (進捗バーが再ペイントされます)。
`protected void`	`installDefaults()`
`protected void`	`installListeners()`
`void`	`installUI(JComponent c)` 指定されたコンポーネントを Look & Feel に応じて適切に構成します。
`void`	`paint(Graphics g, JComponent c)` ペイントを 2 つのメソッド paintDeterminate または paintIndeterminate のどちらかに委譲します。
`protected void`	`paintDeterminate(Graphics g, JComponent c)` ほぼすべての確定モードのリニアな進捗バーで正しく動作する、汎用の paint メソッドです。
`protected void`	`paintIndeterminate(Graphics g, JComponent c)` すべてのリニアなバウンシングボックス進捗バーで正しく動作する、汎用の paint メソッドです。
`protected void`	`paintString(Graphics g, int x, int y, int width, int height, int amountFull, Insets b)`
`protected void`	`setAnimationIndex(int newValue)` 現在のアニメーションフレームのインデックスを指定された値に設定し、進捗バーをペイントし直すよう要求します。
`protected void`	`setCellLength(int cellLen)`
`protected void`	`setCellSpacing(int cellSpace)`
`protected void`	`startAnimationTimer()` アニメーションスレッドを起動します (必要に応じて作成して初期化します)。
`protected void`	`stopAnimationTimer()` アニメーションスレッドを停止します。
`protected void`	`uninstallDefaults()`
`protected void`	`uninstallListeners()` このオブジェクトがインストールしたすべてのリスナーを削除します。
`void`	`uninstallUI(JComponent c)` `installUI` 時に、指定されたコンポーネントに対して行われた構成を取り消します。

クラス javax.swing.plaf.ComponentUI から継承されたメソッド
contains, getAccessibleChild, getAccessibleChildrenCount, update

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - progressBar
```
protected JProgressBar progressBar
```
  - changeListener
```
protected ChangeListener changeListener
```
  - boxRect
```
protected Rectangle boxRect
```
    ペイントされる (getBox によって返された) バウンシングボックスの位置とサイズを保持するために使用します。
    
    導入されたバージョン:
    
    1.5
- コンストラクタの詳細
  - BasicProgressBarUI
```
public BasicProgressBarUI()
```
- メソッドの詳細
  - createUI
```
public static ComponentUI createUI(JComponent x)
```
  - installUI
```
public void installUI(JComponent c)
```
    クラスからコピーされた説明: ComponentUI
    指定されたコンポーネントを Look & Feel に応じて適切に構成します。このメソッドは、ComponentUI インスタンスが、指定されたコンポーネントの UI 委譲としてインストールされているときに呼び出されます。このメソッドは、次を含む Look & Feel 用のコンポーネントを完全に構成するべきです。
    1. カラー、フォント、ボーダー、アイコン、不透明さなどのデフォルトプロパティー値をコンポーネントにインストールする。可能な場合は常に、クライアントプログラムによって初期化されたプロパティーの値をオーバーライドするべきではない。
    2. 必要に応じて、コンポーネントに LayoutManager をインストールする。
    3. 必要なサブコンポーネントを作成して、コンポーネントに追加する。
    4. イベントリスナーを作成して、コンポーネントにインストールする。
    5. コンポーネントのプロパティーの変更を適切に検出し、応答するために、PropertyChangeListener を作成してコンポーネントにインストールする。
    6. キーボード UI (ニーモニック、トラバーサルなど) を、コンポーネントにインストールする。
    7. 適切なインスタンスのデータを初期化する。
    オーバーライド:
    
    installUI、クラス: ComponentUI
    
    パラメータ:
    c - UI 委譲がインストールされるコンポーネント
    関連項目:
    ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()
  - uninstallUI
```
public void uninstallUI(JComponent c)
```
    クラスからコピーされた説明: ComponentUI
    installUI 時に、指定されたコンポーネントに対して行われた構成を取り消します。このメソッドは、この UIComponent インスタンスが、指定されたコンポーネントの UI 委譲として削除されているときに呼び出されます。このメソッドは、installUI によって実行された構成を元に戻すべきです。この場合、JComponent インスタンスをクリーンな状態 (余分なリスナーや、Look & Feel 固有のプロパティーオブジェクトが残らないように) にするよう十分注意してください。手順には次のものが含まれるべきです。
    1. UI として設定されたすべてのボーダーを、コンポーネントから削除する。
    2. UI として設定されたすべてのレイアウトマネージャーを、コンポーネントから削除する。
    3. UI として追加されたすべてのサブコンポーネントを、コンポーネントから削除する。
    4. UI として追加されたすべてのイベント/プロパティーリスナーを、コンポーネントから削除する。
    5. UI としてインストールされたすべてのキーボード UI を、コンポーネントから削除する。
    6. GC の対象になるように、割り当てられたすべてのインスタンスデータオブジェクトを null に設定する。
    オーバーライド:
    
    uninstallUI、クラス: ComponentUI
    
    パラメータ:
    c - この UI 委譲が削除されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある
    関連項目:
    ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()
  - installDefaults
```
protected void installDefaults()
```
  - uninstallDefaults
```
protected void uninstallDefaults()
```
  - installListeners
```
protected void installListeners()
```
  - startAnimationTimer
```
protected void startAnimationTimer()
```
    アニメーションスレッドを起動します (必要に応じて作成して初期化します)。このメソッドは、不確定モードの進捗バーがアニメーションを開始するべきときに呼び出されます。これには次のような理由があります。
    - 進捗バーが確定モードで、表示可能になった
    - 進捗バーが表示可能で、確定モードになった
    - 進捗バーが表示可能で、確定モードであり、この UI がインストールされている
    独自のアニメーションスレッドを実装する場合は、このメソッドをオーバーライドする必要があります。
    導入されたバージョン:
    
    1.4
    
    関連項目:
    stopAnimationTimer()
  - stopAnimationTimer
```
protected void stopAnimationTimer()
```
    アニメーションスレッドを停止します。このメソッドは、不確定モードのアニメーションを停止するべきときに呼び出されます。これには次のような理由があります。
    - 進捗バーが確定モードに変わる
    - 進捗バーが表示可能階層に含まれなくなった
    - この UI がアンインストールされた
    独自のアニメーションスレッドを実装する場合は、このメソッドをオーバーライドする必要があります。
    導入されたバージョン:
    
    1.4
    
    関連項目:
    startAnimationTimer()
  - uninstallListeners
```
protected void uninstallListeners()
```
    このオブジェクトがインストールしたすべてのリスナーを削除します。
  - getBaseline
```
public int getBaseline(JComponent c,
              int width,
              int height)
```
    ベースラインを返します。
    
    オーバーライド:
    
    getBaseline、クラス: ComponentUI
    
    パラメータ:
    c - ベースラインが要求される JComponent
    width - ベースラインを取得する幅
    height - ベースラインを取得する高さ
    
    戻り値:
    ベースラインまたは 0 より小さい値 (適切なベースラインがないことを示す)
    
    例外:
    
    NullPointerException - c が null である場合
    
    IllegalArgumentException - 幅または高さが 0 より小さい場合
    導入されたバージョン:
    
    1.6
    
    関連項目:
    JComponent.getBaseline(int, int)
  - getBaselineResizeBehavior
```
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
```
    サイズの変化に合わせてコンポーネントのベースラインがどのように変化するかを示す列挙を返します。
    
    オーバーライド:
    
    getBaselineResizeBehavior、クラス: ComponentUI
    
    パラメータ:
    c - ベースラインのサイズ変更の動作を返す JComponent
    
    戻り値:
    コンポーネントサイズの変化に合わせてベースラインがどのように変化するかを示す列挙
    
    例外:
    
    NullPointerException - c が null である場合
    導入されたバージョン:
    
    1.6
    
    関連項目:
    JComponent.getBaseline(int, int)
  - getPreferredInnerHorizontal
```
protected Dimension getPreferredInnerHorizontal()
```
  - getPreferredInnerVertical
```
protected Dimension getPreferredInnerVertical()
```
  - getSelectionForeground
```
protected Color getSelectionForeground()
```
    selectionForeground は、進捗バーの塗りつぶされた領域をペイントするときのテキストの色です。
  - getSelectionBackground
```
protected Color getSelectionBackground()
```
    selectionBackground は、進捗バーの塗りつぶされていない領域をペイントするときのテキストの色です。
  - getCellLength
```
protected int getCellLength()
```
    進捗バーにレンダリングされる個々のセルおよび単位の幅 (HORIZONTAL の場合) または高さ (VERTICAL の場合) を返します。ただし、テキストのレンダリングの簡略化、および表示上の美しさの観点から、進捗文字列がレンダリングされている間はこの関数は 1 を返します。
    
    戻り値:
    セルの間隔を表す値
    関連項目:
    setCellLength(int), JProgressBar.isStringPainted()
  - setCellLength
```
protected void setCellLength(int cellLen)
```
  - getCellSpacing
```
protected int getCellSpacing()
```
    進捗バーにある各セルおよび単位の間隔を返します。ただし、テキストのレンダリングの簡略化、および表示上の美しさの観点から、進捗文字列がレンダリングされている間はこの関数は 0 を返します。
    
    戻り値:
    セルの間隔を表す値
    関連項目:
    setCellSpacing(int), JProgressBar.isStringPainted()
  - setCellSpacing
```
protected void setCellSpacing(int cellSpace)
```
  - getAmountFull
```
protected int getAmountFull(Insets b,
                int width,
                int height)
```
    モデルから集めた完了パーセント情報に基づいて、塗りつぶすべき進捗バーの量を決定します。これは共通操作なので、抽象化されています。進捗バーがリニアであると想定しています。すなわち、円形の進捗インジケータを作成する場合は、このメソッドをオーバーライドすることをお勧めします。
  - paint
```
public void paint(Graphics g,
         JComponent c)
```
    ペイントを 2 つのメソッド paintDeterminate または paintIndeterminate のどちらかに委譲します。
    
    オーバーライド:
    
    paint、クラス: ComponentUI
    
    パラメータ:
    g - ペイント対象の Graphics コンテキスト
    c - ペイントされるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある
    関連項目:
    ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)
  - getBox
```
protected Rectangle getBox(Rectangle r)
```
    現在のアニメーションインデックス用にペイントされるバウンシングボックスの位置とサイズを r に格納し、r を返します。paintIndeterminate のこのクラスの実装で実行されるペイントに追加するサブクラスは - たとえば、バウンシングボックスの周りにアウトラインを描画するために - このメソッドを使用してペイントされたばかりのバウンシングボックスの位置を取得できます。このメソッドをオーバーライドすることにより、paintIndeterminate を実装し直さなくても、バウンシングボックスのサイズと位置を完全に制御できます。
    
    パラメータ:
    r - 変更される Rectangle のインスタンス、null も可
    
    戻り値:
    ボックスが描画されない場合は null。そうでない場合は渡された矩形 (null 以外の場合)、または新しい矩形
    導入されたバージョン:
    
    1.4
    
    関連項目:
    setAnimationIndex(int)
  - getBoxLength
```
protected int getBoxLength(int availableLength,
               int otherDimension)
```
    ペイントされる「バウンシングボックス」の長さを返します。このメソッドは、ボックスの幅 (進捗バーが水平方向の場合) または高さ (進捗バーが垂直方向の場合) を取得するために、paintIndeterminate のデフォルト実装によって呼び出されます。例:
    boxRect.width = getBoxLength(componentInnards.width, componentInnards.height);
    パラメータ:
    availableLength - 入っていくバウンシングボックスに利用できるスペースの量。たとえば、水平方向の進捗バーでは、進捗バーの内部の幅 (コンポーネント幅からボーダーを引いた値)
    otherDimension - 水平方向の進捗バーでは、進捗バーの内部の高さ。この値は、戻り値を制限または決定するために使用できる
    
    戻り値:
    大きさが決定されるボックスのサイズ。availableLength 以下である必要がある
    導入されたバージョン:
    
    1.5
    
    関連項目:
    SwingUtilities.calculateInnerArea(javax.swing.JComponent, java.awt.Rectangle)
  - paintIndeterminate
```
protected void paintIndeterminate(Graphics g,
                      JComponent c)
```
    すべてのリニアなバウンシングボックス進捗バーで正しく動作する、汎用の paint メソッドです。別の種類の進捗バーを作成している場合は、このメソッドをオーバーライドしてください。
    
    導入されたバージョン:
    
    1.4
    
    関連項目:
    paintDeterminate(java.awt.Graphics, javax.swing.JComponent)
  - paintDeterminate
```
protected void paintDeterminate(Graphics g,
                    JComponent c)
```
    ほぼすべての確定モードのリニアな進捗バーで正しく動作する、汎用の paint メソッドです。デフォルトのテーブルにいくつかの値を設定するだけで、進捗バーのペイントが問題なく動作するようになります。当然のことですが、円形または半円形の進捗バーを作成する場合には、このメソッドをオーバーライドしてください。
    
    導入されたバージョン:
    
    1.4
    
    関連項目:
    paintIndeterminate(java.awt.Graphics, javax.swing.JComponent)
  - paintString
```
protected void paintString(Graphics g,
               int x,
               int y,
               int width,
               int height,
               int amountFull,
               Insets b)
```
  - getStringPlacement
```
protected Point getStringPlacement(Graphics g,
                       String progressString,
                       int x,
                       int y,
                       int width,
                       int height)
```
    進捗文字列のペイント位置を指定します。この実装は、進捗バーの中央 (x および y の両方) に文字列を配置します。進捗文字列を右、左、上、または下に配置する場合、あるいは何らかの理由で少し動かす場合は、このメソッドをオーバーライドしてください。
  - getPreferredSize
```
public Dimension getPreferredSize(JComponent c)
```
    クラスからコピーされた説明: ComponentUI
    
    指定されたコンポーネントの、Look & Feel に適した推奨サイズを返します。null が返された場合、適切なサイズは代わりにコンポーネントのレイアウトマネージャーによって計算されます (これは、特定のレイアウトマネージャーをインストールしてあるコンポーネントの場合に推奨する方法です)。このメソッドのデフォルト実装は null を返します。
    
    オーバーライド:
    
    getPreferredSize、クラス: ComponentUI
    
    パラメータ:
    c - 推奨サイズが照会されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある
    関連項目:
    JComponent.getPreferredSize(), LayoutManager.preferredLayoutSize(java.awt.Container)
  - getMinimumSize
```
public Dimension getMinimumSize(JComponent c)
```
    このコンポーネントの最小サイズは 10 です。10 パーセントごとに 1 ピクセル以上が必要なためです。
    
    オーバーライド:
    
    getMinimumSize、クラス: ComponentUI
    
    パラメータ:
    c - 最小サイズが照会されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある
    
    戻り値:
    Dimension オブジェクトまたは null
    関連項目:
    JComponent.getMinimumSize(), LayoutManager.minimumLayoutSize(java.awt.Container), ComponentUI.getPreferredSize(javax.swing.JComponent)
  - getMaximumSize
```
public Dimension getMaximumSize(JComponent c)
```
    クラスからコピーされた説明: ComponentUI
    
    指定されたコンポーネントの、Look & Feel に適した最大サイズを返します。null が返された場合、最大サイズは代わりにコンポーネントのレイアウトマネージャーによって計算されます (これは、特定のレイアウトマネージャーをインストールしてあるコンポーネントの場合に推奨する方法です)。このメソッドのデフォルト実装は getPreferredSize を呼び出して、その値を返します。
    
    オーバーライド:
    
    getMaximumSize、クラス: ComponentUI
    
    パラメータ:
    c - 最大サイズが照会されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある
    
    戻り値:
    Dimension オブジェクトまたは null
    関連項目:
    JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container)
  - getAnimationIndex
```
protected int getAnimationIndex()
```
    現在のアニメーションフレームのインデックスを取得します。
    
    導入されたバージョン:
    
    1.4
  - getFrameCount
```
protected final int getFrameCount()
```
    不確定モードの JProgressBar で使用される完全なアニメーションループのためのフレーム数を返します。進捗状況チャンクは、全体をループする間、一方の端からもう一方の端への移動を繰り返します。この視覚的な動作は、ほかの Look & Feel のサブクラスによって変更できます。
    
    戻り値:
    フレーム数
    導入されたバージョン:
    
    1.6
  - setAnimationIndex
```
protected void setAnimationIndex(int newValue)
```
    現在のアニメーションフレームのインデックスを指定された値に設定し、進捗バーをペイントし直すよう要求します。デフォルトのペイントコードを使用しないサブクラスは、このメソッドをオーバーライドして、repaint メソッドの起動方法を変更する必要がある場合があります。
    
    パラメータ:
    newValue - 新しいアニメーションインデックス。この値はチェックされない
    導入されたバージョン:
    
    1.4
    
    関連項目:
    incrementAnimationIndex()
  - incrementAnimationIndex
```
protected void incrementAnimationIndex()
```
    現在のアニメーションフレームのインデックスを次の有効値に設定します (進捗バーが再ペイントされます)。次の有効値は、デフォルトでは、現在のアニメーションインデックスに 1 を足したものです。新しい値が大きすぎる場合、このメソッドはインデックスを 0 に設定します。インデックスが特定の進捗バーインスタンスに必要なフレーム数を超えないようにするには、サブクラスがこのメソッドをオーバーライドする必要がある場合があります。このメソッドは、X ミリ秒ごとに、デフォルトアニメーションスレッドにより起動されます (X は「ProgressBar.repaintInterval」の UI デフォルトによって指定されます)。
    
    導入されたバージョン:
    
    1.4
    
    関連項目:
    setAnimationIndex(int)

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス BasicProgressBarUI

ネストされたクラスのサマリー

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラス javax.swing.plaf.ComponentUI から継承されたメソッド

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

フィールドの詳細

progressBar

changeListener

boxRect

コンストラクタの詳細

BasicProgressBarUI

メソッドの詳細

createUI

installUI

uninstallUI

installDefaults

uninstallDefaults

installListeners

startAnimationTimer

stopAnimationTimer

uninstallListeners

getBaseline

getBaselineResizeBehavior

getPreferredInnerHorizontal

getPreferredInnerVertical

getSelectionForeground

getSelectionBackground

getCellLength

setCellLength

getCellSpacing

setCellSpacing

getAmountFull

paint

getBox

getBoxLength

paintIndeterminate

paintDeterminate

paintString

getStringPlacement

getPreferredSize

getMinimumSize

getMaximumSize

getAnimationIndex

getFrameCount

setAnimationIndex

incrementAnimationIndex