javax.imageio.event

インタフェース IIOWriteProgressListener

すべてのスーパーインタフェース:

EventListener

public interface IIOWriteProgressListener
extends EventListener

呼び出し側にイメージの進捗の書き込みメソッドを通知する、ImageWriter 実装で使用されるインタフェースです。

関連項目:

ImageWriter.write(javax.imageio.metadata.IIOMetadata, javax.imageio.IIOImage, javax.imageio.ImageWriteParam)

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	imageComplete(ImageWriter source) イメージの書き込みオペレーションが完了したことを通知します。
void	imageProgress(ImageWriter source, float percentageDone) 関連する ImageWriter 内の、現在の write 呼び出しのおおよその完了度合いを通知します。
void	imageStarted(ImageWriter source, int imageIndex) イメージの書き込みオペレーションが始まることを通知します。
void	thumbnailComplete(ImageWriter source) サムネールの書き込みオペレーションが完了したことを通知します。
void	thumbnailProgress(ImageWriter source, float percentageDone) 関連する ImageWriter 内の、現在のサムネール書き込みのおおよその完了度合いを通知します。
void	thumbnailStarted(ImageWriter source, int imageIndex, int thumbnailIndex) サムネールの書き込みオペレーションが始まることを通知します。
void	writeAborted(ImageWriter source) ライターの abort メソッドにより書き込みが中断されたことを通知します。

メソッドの詳細

imageStarted

void imageStarted(ImageWriter source,
                int imageIndex)

イメージの書き込みオペレーションが始まることを通知します。ImageWriter 実装はすべて、イメージの書き込みオペレーションの開始時にこのメソッドを 1 回だけ呼び出す必要があります。

パラメータ:

source - このメソッドを呼び出す ImageWriter オブジェクト。

imageIndex - 入力ファイルまたはストリーム内に含まれる、書き込まれるイメージのインデックス。

imageProgress

void imageProgress(ImageWriter source,
                 float percentageDone)

関連する ImageWriter 内の、現在の write 呼び出しのおおよその完了度合いを通知します。

完了の度合いは、書き込まれているイメージを示すインデックスと、現在のイメージが出力された量を示す 0.0F から 100.0F までのパーセント値で表現されます。パーセントは完了までの残り時間について計算するのが理想的ですが、通常は復号化されたピクセルや使用された入力ストリームの一部などの明確なメトリックスを使用するほうが実際的です。いずれにしても、指定された読み込みオペレーション中のこのメソッドの一連の呼び出しにより、パーセント値が単調に増加していくようにする必要があります。0 と 100 の正確な値は、ほかのメソッドから呼び出される側で推測できるので、指定する必要はありません。

特定の ImageWriter 実装は、それぞれ必要な頻度でこのメソッドを呼び出すことができます。経験値では、約 5 パーセントきざみとなるように呼び出します。

パラメータ:

source - このメソッドを呼び出す ImageWriter オブジェクト。

percentageDone - 完了した復号化のおおよそのパーセント値。

imageComplete

void imageComplete(ImageWriter source)

イメージの書き込みオペレーションが完了したことを通知します。ImageWriter 実装はすべて、イメージの書き込みオペレーションが完了するごとにこのメソッドを 1 回だけ呼び出す必要があります。

パラメータ:

source - このメソッドを呼び出す ImageWriter オブジェクト。

thumbnailStarted

void thumbnailStarted(ImageWriter source,
                    int imageIndex,
                    int thumbnailIndex)

サムネールの書き込みオペレーションが始まることを通知します。ImageWriter 実装はすべて、サムネールの書き込みオペレーションの開始時にこのメソッドを 1 回だけ呼び出す必要があります。

パラメータ:

source - このメソッドを呼び出す ImageWrite オブジェクト。

imageIndex - 入力ファイルまたはストリーム内に含まれる、書き込まれるイメージのインデックス。

thumbnailIndex - 書き込まれるサムネールのインデックス。

thumbnailProgress

void thumbnailProgress(ImageWriter source,
                     float percentageDone)

関連する ImageWriter 内の、現在のサムネール書き込みのおおよその完了度合いを通知します。セマンティクスは imageProgress の場合と同じです。

パラメータ:

source - このメソッドを呼び出す ImageWriter オブジェクト。

percentageDone - 完了した復号化のおおよそのパーセント値。

thumbnailComplete

void thumbnailComplete(ImageWriter source)

サムネールの書き込みオペレーションが完了したことを通知します。ImageWriter 実装はすべて、サムネールの書き込みオペレーションが完了するごとにこのメソッドを 1 回だけ呼び出す必要があります。

パラメータ:

source - このメソッドを呼び出す ImageWriter オブジェクト。

writeAborted

void writeAborted(ImageWriter source)

ライターの abort メソッドにより書き込みが中断されたことを通知します。これ以外の通知は行われません。

パラメータ:

source - このメソッドを呼び出す ImageWriter オブジェクト。