javax.imageio.metadata
インタフェース IIOMetadataController

public interface IIOMetadataController

GUI を使用してユーザから値を取得するか、またはほかの手段によって、IIOMetadata オブジェクトの設定値を判定できるオブジェクトにより実装されるインタフェースです。このインタフェースは、コントローラを呼び出す汎用 activate メソッドを指定するだけであり、コントーラが値を取得する方法については考慮しません (つまり、コントローラが GUI を使用するか、一連の値を計算するだけかどうかは、このインタフェースには関係ありません)。

activate メソッド内で、コントローラは、XML DOM ツリーまたはプラグイン固有のインタフェースを使って、IIOMetadata オブジェクトの設定値を照会して初期値を取得し、何らかの方法で値を変更します。次に、setFromTree または mergeTree メソッド、あるいはプラグイン固有のインタフェースを使用って IIOMetadata オブジェクトの設定値を変更します。一般に、アプリケーションは、activate メソッドが true を返す場合、IIOMetadata オブジェクトは書き込み操作に使用する準備ができていると想定する場合があります。

ベンダーは、特定のプラグイン用に定義する IIOMetadata サブクラスの GUI を提供する場合があります。これらは、対応する IIOMetadata サブクラスのデフォルトのコントローラとして設定することができます。

または、データベースルックアップやコマンド行の解析などのアルゴリズム処理は、コントローラとして使用でき、その場合、activate メソッドは単に設定値を参照または計算し、IIOMetadata のメソッドを呼び出してその状態を設定して、true を返します。

関連項目:

IIOMetadata.setController(javax.imageio.metadata.IIOMetadataController), IIOMetadata.getController(), IIOMetadata.getDefaultController(), IIOMetadata.hasController(), IIOMetadata.activateController()

メソッドの概要

boolean

activate(IIOMetadata metadata) コントローラをアクティブにします。

メソッドの詳細

activate

public boolean activate(IIOMetadata metadata)

コントローラをアクティブにします。true が返される場合は、IIOMetadata オブジェクトの設定値はすべて書き込み操作に使用する準備ができています。false が返される場合は、IIOMetadata オブジェクトの設定値は影響を受けません (つまり、ユーザにより操作が取り消されました)。

パラメータ:

metadata - 変更される IIOMetadata オブジェクト

戻り値:

IIOMetadata が変更された場合は true、そうでない場合は false

例外:

IllegalArgumentException - metadata が null であるか、正しいクラスのインスタンスでない場合