javax.imageio.event

インタフェースIIOReadProgressListener

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

EventListener

public interface IIOReadProgressListener
extends EventListener

呼出し側にイメージとサムネールの進捗の読込みメソッドを通知する、ImageReader実装で使用されるインタフェースです。

このインタフェースは、imageProgressおよびthumbnailProgressメソッドを介して復号化の進捗に関する一般的な指示を受け取り、imageStarted、imageComplete、thumbnailStarted、およびthumbnailCompleteメソッドを介してイメージ全体の更新が完了したことを示すイベントを受け取ります。たとえば段階的に復号化するときに、ピクセルの更新が発生したことをアプリケーションに通知する場合は、アプリケーションがIIOReadUpdateListenerを提供する必要があります。

関連項目:

IIOReadUpdateListener, ImageReader.addIIOReadProgressListener(javax.imageio.event.IIOReadProgressListener), ImageReader.removeIIOReadProgressListener(javax.imageio.event.IIOReadProgressListener)

メソッドのサマリー

修飾子と型	メソッドと説明
void	imageComplete(ImageReader source) 現在のイメージの読込みオペレーションが完了したことを通知します。
void	imageProgress(ImageReader source, float percentageDone) 関連するImageReaderの、現在のread呼出しのおおよその完了度合いを通知します。
void	imageStarted(ImageReader source, int imageIndex) イメージの読込みオペレーションが始まることを通知します。
void	readAborted(ImageReader source) リーダーのabortメソッドにより読込みが中断されたことを通知します。
void	sequenceComplete(ImageReader source) 読込みオペレーションのシーケンスが完了したことを通知します。
void	sequenceStarted(ImageReader source, int minIndex) 読込みオペレーションのシーケンスが始まることを通知します。
void	thumbnailComplete(ImageReader source) サムネールの読込みオペレーションが完了したことを通知します。
void	thumbnailProgress(ImageReader source, float percentageDone) 関連するImageReader内の、現在のgetThumbnail呼出しのおおよその完了度合いを通知します。
void	thumbnailStarted(ImageReader source, int imageIndex, int thumbnailIndex) サムネールの読込みオペレーションが始まることを通知します。

メソッドの詳細

sequenceStarted

void sequenceStarted(ImageReader source,
                     int minIndex)

読込みオペレーションのシーケンスが始まることを通知します。ImageReader実装は、そのreadAll(Iterator)メソッドからこのメソッドを1回だけ呼び出す必要があります。

パラメータ:

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

minIndex - 読み込まれる最初のイメージのインデックス。

sequenceComplete

void sequenceComplete(ImageReader source)

読込みオペレーションのシーケンスが完了したことを通知します。ImageReader実装は、そのreadAll(Iterator)メソッドからこのメソッドを1回だけ呼び出す必要があります。

パラメータ:

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

imageStarted

void imageStarted(ImageReader source,
                  int imageIndex)

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

パラメータ:

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

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

imageProgress

void imageProgress(ImageReader source,
                   float percentageDone)

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

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

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

パラメータ:

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

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

imageComplete

void imageComplete(ImageReader source)

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

パラメータ:

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

thumbnailStarted

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

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

パラメータ:

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

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

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

thumbnailProgress

void thumbnailProgress(ImageReader source,
                       float percentageDone)

関連するImageReader内の、現在のgetThumbnail呼出しのおおよその完了度合いを通知します。セマンティックスはimageProgressの場合と同じです。

パラメータ:

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

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

thumbnailComplete

void thumbnailComplete(ImageReader source)

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

パラメータ:

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

readAborted

void readAborted(ImageReader source)

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

パラメータ:

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