javax.swing

クラスProgressMonitor

java.lang.Object

javax.swing.ProgressMonitor

すべての実装されたインタフェース:

Accessible

public class ProgressMonitor
extends Object
implements Accessible

処理の進捗を監視するクラスです。処理にしばらく時間がかかる場合には、進捗ダイアログが表示されます。作成されたProgressMonitorには、数値範囲と説明的な文字列が与えられます。処理が進むと、setProgressメソッドを呼び出して、[min,max]の範囲でどのくらい処理が進んでいるかを示します。初期状態では、ProgressDialogはありません。最初のmillisToDecideToPopupミリ秒(デフォルトは500)が経過してから、進捗モニターで処理にかかる時間が予測されます。その時間がmillisToPopup (デフォルトは2000ミリ秒、つまり2秒)より長い場合は、ProgressDialogが表示されます。

ダイアログ・ボックスが可視である場合は、setProgressが呼び出されたときに進捗バーが更新されることがあります。setProgressは、常に進捗バーを更新するわけではなく、操作が非常に進んでいる場合にだけ更新します。

例および詳細は、『The Java Tutorial』の「How to Monitor Progress」を参照してください。

関連項目:

ProgressMonitorInputStream

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

ネストされたクラス

修飾子と型	クラスと説明
protected class	ProgressMonitor.AccessibleProgressMonitor AccessibleProgressMonitorは、ProgressMonitorクラスのアクセシビリティ・サポートを実装しています。

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected AccessibleContext	accessibleContext ProgressMonitorのAccessibleContext

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

コンストラクタ

コンストラクタと説明
ProgressMonitor(Component parentComponent, Object message, String note, int min, int max) 進捗状況を示すグラフィック・オブジェクトを構築します。進捗状況は、通常、処理が完了に近づくにつれて矩形のバーを埋めていくことで示します。

メソッドのサマリー

修飾子と型	メソッドと説明
void	close() 処理が完了したことを示します。
AccessibleContext	getAccessibleContext() ProgressMonitorのAccessibleContextを取得します。
int	getMaximum() 最大値(進捗値の最高値)を返します。
int	getMillisToDecideToPopup() 進捗モニターを表示するかどうかを決定するまでにこのオブジェクトが待つ時間を返します。
int	getMillisToPopup() ポップアップが表示されるまでの時間を返します。
int	getMinimum() 最小値(進捗値の最低値)を返します。
String	getNote() 進捗メッセージとともに表示される追加の注記を設定します。
boolean	isCanceled() ユーザーが進捗ダイアログで「取消し(Cancel)」ボタンを押した場合にtrueを返します。
void	setMaximum(int m) 最大値を設定します。
void	setMillisToDecideToPopup(int millisToDecideToPopup) 進捗モニターを表示するかどうかを決定するまでの待ち時間を設定します。
void	setMillisToPopup(int millisToPopup) ポップアップが表示されるまでの時間を設定します。
void	setMinimum(int m) 最小値を設定します。
void	setNote(String note) 進捗メッセージとともに表示される追加の注記を設定します。
void	setProgress(int nv) 監視している処理の進捗状況を示します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

accessibleContext

protected AccessibleContext accessibleContext

ProgressMonitorのAccessibleContext

導入されたバージョン:

1.5

コンストラクタの詳細

ProgressMonitor

public ProgressMonitor(Component parentComponent,
                       Object message,
                       String note,
                       int min,
                       int max)

進捗状況を示すグラフィック・オブジェクトを構築します。進捗状況は、通常、処理が完了に近づくにつれて矩形のバーを埋めていくことで示します。

パラメータ:

parentComponent - ダイアログ・ボックスの親コンポーネント

message - 監視している処理をユーザーに示すために表示される説明用のメッセージ。これは、処理が進んでも変更されない。値の範囲については、JOptionPane.messageのメソッドのメッセージ・パラメータを参照。

note - 処理の状態を説明する短い注。処理が進むと、setNoteを呼び出して、表示されている注を変更できる。たとえば、ファイルのリストを繰返し処理する操作で、処理中のファイル名を表示する場合などに、この注を使用する。初期状態でnoteがnullの場合、ダイアログ・ボックスに注の行はなく、setNoteは無効である

min - 範囲の下限

max - 範囲の上限

関連項目:

JDialog, JOptionPane

メソッドの詳細

setProgress

public void setProgress(int nv)

監視している処理の進捗状況を示します。指定された値が最大値以上の場合、進捗モニターは閉じます。

パラメータ:

nv - 現在の値を指定するint値。このコンポーネントに指定された最大値と最小値の範囲内

関連項目:

setMinimum(int), setMaximum(int), close()

close

public void close()

処理が完了したことを示します。これは、setProgressで設定された値が最大値以上になると自動的に発生しますが、処理が早く終了した場合は、それより早く呼び出されることもあります。

getMinimum

public int getMinimum()

最小値(進捗値の最低値)を返します。

戻り値:

最小値を表すint値

関連項目:

setMinimum(int)

setMinimum

public void setMinimum(int m)

最小値を設定します。

パラメータ:

m - 最小値を指定するint値

関連項目:

getMinimum()

getMaximum

public int getMaximum()

最大値(進捗値の最高値)を返します。

戻り値:

最大値を表すint値

関連項目:

setMaximum(int)

setMaximum

public void setMaximum(int m)

最大値を設定します。

パラメータ:

m - 最大値を指定するint値

関連項目:

getMaximum()

isCanceled

public boolean isCanceled()

ユーザーが進捗ダイアログで「取消し(Cancel)」ボタンを押した場合にtrueを返します。

setMillisToDecideToPopup

public void setMillisToDecideToPopup(int millisToDecideToPopup)

進捗モニターを表示するかどうかを決定するまでの待ち時間を設定します。

パラメータ:

millisToDecideToPopup - 待ち時間を指定するint値(ミリ秒単位)

関連項目:

getMillisToDecideToPopup()

getMillisToDecideToPopup

public int getMillisToDecideToPopup()

進捗モニターを表示するかどうかを決定するまでにこのオブジェクトが待つ時間を返します。

関連項目:

setMillisToDecideToPopup(int)

setMillisToPopup

public void setMillisToPopup(int millisToPopup)

ポップアップが表示されるまでの時間を設定します。予想残り時間がこの時間より短い場合、ポップアップは表示されません。

パラメータ:

millisToPopup - 時間を指定するint値(ミリ秒単位)

関連項目:

getMillisToPopup()

getMillisToPopup

public int getMillisToPopup()

ポップアップが表示されるまでの時間を返します。

関連項目:

setMillisToPopup(int)

setNote

public void setNote(String note)

進捗メッセージとともに表示される追加の注記を設定します。たとえば、複数のファイルをコピーしているときに現在どのファイルがコピーされているかを示すために使用されます。

パラメータ:

note - 表示する注記を指定するString

関連項目:

getNote()

getNote

public String getNote()

進捗メッセージとともに表示される追加の注記を設定します。

戻り値:

表示する注記を指定するString

関連項目:

setNote(java.lang.String)

getAccessibleContext

public AccessibleContext getAccessibleContext()

ProgressMonitorのAccessibleContextを取得します。

定義:

getAccessibleContext、インタフェース: Accessible

戻り値:

ProgressMonitorのAccessibleContext

導入されたバージョン:

1.5