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オブジェクト。