org.seasar.uruma.jobs.impl
クラス RcpProgressMonitor

java.lang.Object
  org.seasar.uruma.jobs.impl.RcpProgressMonitor

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

ProgressMonitor

public class RcpProgressMonitor
extends Object
implements ProgressMonitor

RCP 環境における ProgressMonitor の実装クラスです。
本クラスは IProgressMonitor をラップします。

作成者:

y-komori

フィールドの概要

インタフェース org.seasar.uruma.jobs.ProgressMonitor から継承されたフィールド

UNKNOWN

コンストラクタの概要

RcpProgressMonitor(IProgressMonitor monitor)
RcpProgressMonitor を構築します。

メソッドの概要

void	beginTask(String name, int totalWork) メインタスクの開始を通知します。
void	done() メインタスクの終了を通知します。
boolean	isCanceled() タスクがキャンセルされたかどうかを返します。
void	setCanceled(boolean value) キャンセル状態を設定します。
void	setTaskName(String name) タスク名称を設定します。
void	subTask(String name) サブタスクの開始を通知します。
void	worked(int work) 指定された値を、タスクの完了値として通知します。

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

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

コンストラクタの詳細

RcpProgressMonitor

public RcpProgressMonitor(IProgressMonitor monitor)

RcpProgressMonitor を構築します。

パラメータ:

monitor - IProgressMonitor オブジェクト

メソッドの詳細

beginTask

public void beginTask(String name,
                      int totalWork)

インタフェース ProgressMonitor の記述:

メインタスクの開始を通知します。

定義:

インタフェース ProgressMonitor 内の beginTask

パラメータ:

name - メインタスクの名称

totalWork - メインタスクの総量。値が UNKNOWN の場合、総量が不明であることを示します。

done

public void done()

インタフェース ProgressMonitor の記述:

メインタスクの終了を通知します。

定義:

インタフェース ProgressMonitor 内の done

isCanceled

public boolean isCanceled()

インタフェース ProgressMonitor の記述:

タスクがキャンセルされたかどうかを返します。

定義:

インタフェース ProgressMonitor 内の isCanceled

戻り値:

タスクがキャンセルされた場合、true。そうでない場合は false。

関連項目:

ProgressMonitor.setCanceled(boolean)

setCanceled

public void setCanceled(boolean value)

インタフェース ProgressMonitor の記述:

キャンセル状態を設定します。

定義:

インタフェース ProgressMonitor 内の setCanceled

パラメータ:

value - キャンセルが要求されている場合、true。そうでない場合、 false。

関連項目:

ProgressMonitor.isCanceled()

setTaskName

public void setTaskName(String name)

インタフェース ProgressMonitor の記述:

タスク名称を設定します。

定義:

インタフェース ProgressMonitor 内の setTaskName

パラメータ:

name - タスク名称

関連項目:

ProgressMonitor.beginTask(java.lang.String, int)

subTask

public void subTask(String name)

インタフェース ProgressMonitor の記述:

サブタスクの開始を通知します。
サブタスクの利用はオプションですので、必ずしも利用する必要はありません。

定義:

インタフェース ProgressMonitor 内の subTask

パラメータ:

name - サブタスクの名称

worked

public void worked(int work)

インタフェース ProgressMonitor の記述:

指定された値を、タスクの完了値として通知します。

定義:

インタフェース ProgressMonitor 内の worked

パラメータ:

work - 完了したタスク量。(負でない整数)