javax.swing
クラス ProgressMonitor

java.lang.Object
  |
  +--javax.swing.ProgressMonitor

public class ProgressMonitor

extends Object

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

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

関連項目:

ProgressMonitorInputStream

コンストラクタの概要

ProgressMonitor(Component parentComponent, Object message, String note, int min, int max)
進捗状況を示すグラフィックオブジェクトを構築します。

メソッドの概要

void	close() 操作が完了したことを示します。
int	getMaximum() 最大値 (進捗値の最高値) を返します。
int	getMillisToDecideToPopup() 進捗モニターを表示するかどうかを決定するまでにこのオブジェクトが待つ時間を返します。
int	getMillisToPopup() ポップアップが表示されるまでの時間を返します。
int	getMinimum() 最小値 (進捗値の最低値) を返します。
String	getNote() 進捗メッセージとともに表示される追加情報を返します。
boolean	isCanceled() ユーザが進捗ダイアログの [取消し (Cancel)] ボタンを押すなどの UI アクションを実行して、この操作をキャンセルした場合に 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

コンストラクタの詳細

ProgressMonitor

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

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

パラメータ:

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

message - 監視している操作をユーザに示すために表示される説明的なメッセージ。これは、操作が進んでも変更されない。値の範囲については、JOptionsPane#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 で設定した値が >= max の場合に自動的に発生しますが、操作が早く終了した場合は、それより早く呼び出されることもあります。

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)] ボタンを押すなどの UI アクションを実行して、この操作をキャンセルした場合に true を返します。

setMillisToDecideToPopup

public void setMillisToDecideToPopup(int millisToDecideToPopup)

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

パラメータ:

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

関連項目:

getMillisToDecideToPopup()

getMillisToDecideToPopup

public int getMillisToDecideToPopup()

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

パラメータ:

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

関連項目:

setMillisToDecideToPopup(int)

setMillisToPopup

public void setMillisToPopup(int millisToPopup)

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

パラメータ:

millisToPopup - ミリ秒単位で時間として指定する int 値

関連項目:

getMillisToPopup()

getMillisToPopup

public int getMillisToPopup()

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

パラメータ:

millisToPopup - ミリ秒単位での時間を表す int 値

関連項目:

setMillisToPopup(int)

setNote

public void setNote(String note)

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

パラメータ:

note - 表示する情報として指定する String

関連項目:

getNote()

getNote

public String getNote()

進捗メッセージとともに表示される追加情報を返します。

戻り値:

表示する情報を表す String

関連項目:

setNote(java.lang.String)