CtProgressMonitor (Irenka End User API)

クラス

使用

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

org.ashikunep.irenka.world
インタフェース CtProgressMonitor

進捗情報に関する受信オブジェクト。

メソッドの概要
`void`	`beginTask(String taskName, int taskSize)` タスクを登録して、開始する。
`void`	`cancel(IrenkaException cause)` このモニタを利用しているのタスクに対してキャンセルを要求する。
`void`	`done()` タスクが完了したことを通知する。
`boolean`	`isCanceled()` このモニタを利用するタスクに、キャンセルを要求されている場合のみ`true`を返す。
`CtProgressMonitor`	`newPartialMonitor(int partialTaskSize)` このモニタの部分モニタを生成して返す。
`CtProgressMonitor`	`newPartialMonitor(int partialTaskSize, PartialProgressMonitorAttribute attribute)` このモニタの部分モニタを生成して返す。
`void`	`subTask(String subTaskName)` 以降に着手するサブタスクの名称を設定する。
`void`	`worked(int completedTaskSize)` タスクが進捗したことを通知する。

インタフェース org.ashikunep.irenka.util.ClientStorageContainer から継承されたメソッド
`getClientStorage, putClientStorage`

メソッドの詳細

void beginTask(String taskName,
               int taskSize)

タスクを登録して、開始する。

void subTask(String subTaskName)

以降に着手するサブタスクの名称を設定する。

void worked(int completedTaskSize)

タスクが進捗したことを通知する。

void done()

タスクが完了したことを通知する。

void cancel(IrenkaException cause)

このモニタを利用しているのタスクに対してキャンセルを要求する。

boolean isCanceled()

このモニタを利用するタスクに、キャンセルを要求されている場合のみtrueを返す。

CtProgressMonitor newPartialMonitor(int partialTaskSize)

このモニタの部分モニタを生成して返す。

CtProgressMonitor newPartialMonitor(int partialTaskSize,
                                    PartialProgressMonitorAttribute attribute)

このモニタの部分モニタを生成して返す。

パラメータ:: partialTaskSize - 生成する部分タスクが、このタスクに占めるタスクの大きさ; attribute - 表示方法に関する属性
戻り値:: 生成した開始されていない部分タスク
例外:: IllegalStateException - このタスクが開始されていない場合