jp.go.aist.dmrc.platform.beans.io
クラス PFImageFileReader

java.lang.Object
  上位を拡張 jp.go.aist.dmrc.platform.beans.io.PFReader
      上位を拡張 jp.go.aist.dmrc.platform.beans.io.PFImageFileReader
すべての実装されたインタフェース:
java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource

public class PFImageFileReader
extends PFReader
implements PFXMLSerializable

Imageをファイルから読み込むためのコンポーネント。

作成されたImageはイメージビューワコンポーネントで表示する。

javax.imageio.ImageIO.read(File)を使用しており、デフォルトで指定できるファイル形式は GIF,JPEG,PNGに限定される。

このコンポーネントから以下のイベントが発生する。

関連項目:
直列化された形式

コンストラクタの概要
PFImageFileReader()
          デフォルトコンストラクタ
 
メソッドの概要
 void calcScale()
          表示画像の最適な倍率(%)を計算して設定する。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.awt.Image getEmptyImage()
          空の画像データを取得する。
 int getHeight()
          画像の高さを取得する。
 PFSingleObject getImageBytes()
          現在保持している画像データ(Image)のバイト列をPFSingleObjectとして返す。
 PFObjectList getReaderFormatNames()
          読込可能な画像ファイル形式のリストを取得する。
 int getScale()
          表示画像の倍率(%)を取得する。
 int getWidth()
          画像の幅を取得する。
 boolean isNull()
           
 void localeUpdated()
          ロケール変更に対応する。
 void read(java.lang.String filename)
          ファイル名を指定して画像を読み込む。
 void readImageBytes(PFSingleObject sobj)
          バイト列を入力として画像を読み込む。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void setImageObeserver(java.awt.Component comp)
          推奨されていません。 setImageObserverに変更
 void setImageObserver(java.awt.Component comp)
          画像のオブザーバを設定する。
 void setScale(int num)
          表示画像の倍率(%)を設定する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス jp.go.aist.dmrc.platform.beans.io.PFReader から継承されたメソッド
addPFDataCreateListener, firePFDataCreated, getComponentID, getComponentKey, getComponentKeys, getComponentPublicName, getComponentString, getCurrentFile, getExceptionIgnoring, getFile, getPFDataCreateListenerList, isAllowPullTransfer, isAllowPushTransfer, isAllowRemoteInvocation, removePFDataCreateListener, setAllowPullTransfer, setAllowPushTransfer, setAllowRemoteInvocation, setComponentID, setComponentKey, setComponentKeys, setComponentPublicName, setExceptionIgnoring, setFile, setFile
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFImageFileReader

public PFImageFileReader()
デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名
関連項目:
PFComponent.getComponentName()

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated
オーバーライド:
クラス PFReader 内の localeUpdated
関連項目:
PFComponent.localeUpdated()

read

public void read(java.lang.String filename)
          throws PFComponentException,
                 PFMethodException,
                 PFRuntimeException
ファイル名を指定して画像を読み込む。 画像が正しく読み込まれた場合にデータ生成イベントが発生する。 イベント内包データは作成されたImageとなる。
javax.imageio.ImageIO.read(File)を使用しており、デフォルトで指定できるファイル形式は BMP,WBMP(以上JRE 1.5以降),GIF,JPEG,PNGに限定される。

パラメータ:
filename - ファイル名
例外:
PFComponentException - ファイル読み込みエラー
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

readImageBytes

public void readImageBytes(PFSingleObject sobj)
                    throws PFComponentException,
                           PFMethodException,
                           PFRuntimeException
バイト列を入力として画像を読み込む。 画像が正しく読み込まれた場合にデータ設定イベントが発生する。 イベント内包データは作成されたImageとなる。

パラメータ:
sobj - 画像データのバイト列
例外:
PFComponentException - バイト列の読み込みエラー
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

getImageBytes

public PFSingleObject getImageBytes()
                             throws PFComponentException
現在保持している画像データ(Image)のバイト列をPFSingleObjectとして返す。

戻り値:
画像データのバイト列(PFSingleObject)
例外:
PFComponentException - 入出力エラー

getEmptyImage

public java.awt.Image getEmptyImage()
空の画像データを取得する。

戻り値:
空の画像データ(Image)

setImageObeserver

public void setImageObeserver(java.awt.Component comp)
推奨されていません。 setImageObserverに変更

画像のオブザーバを設定する。 画像のサイズを取得するために必要。 getWidth/getHeight/calcScale等を呼び出す前に実行する。

パラメータ:
comp - 画像のオブザーバとなるコンポーネント

setImageObserver

public void setImageObserver(java.awt.Component comp)
画像のオブザーバを設定する。 画像のサイズを取得するために必要。 getWidth/getHeight/calcScale等を呼び出す前に実行する。

パラメータ:
comp - 画像のオブザーバとなるコンポーネント

getWidth

public int getWidth()
画像の幅を取得する。 このメソッドを呼ぶ前に画像のオブザーバを設定する必要がある。 オブザーバが設定されていない場合は-1が返る。

戻り値:
画像の幅(int)

getHeight

public int getHeight()
画像の高さを取得する。 このメソッドを呼ぶ前に画像のオブザーバを設定する必要がある。 オブザーバが設定されていない場合は-1が返る。

戻り値:
画像の高さ(int)

calcScale

public void calcScale()
表示画像の最適な倍率(%)を計算して設定する。 このメソッドを呼ぶ前に画像のオブザーバを設定する必要がある。 実際の画像データのサイズと表示するGUIコンポーネント(オブザーバ) のサイズを比較して適切な倍率を計算する。 オブザーバが設定されていない場合は倍率として100が設定される。


getScale

public int getScale()
表示画像の倍率(%)を取得する。

戻り値:
倍率(int)

setScale

public void setScale(int num)
表示画像の倍率(%)を設定する。

パラメータ:
num - 倍率(int)

isNull

public boolean isNull()

getReaderFormatNames

public PFObjectList getReaderFormatNames()
読込可能な画像ファイル形式のリストを取得する。

戻り値:
読込可能な画像ファイル形式名のリスト

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException