ImageStore (DoJa 3.5 (APIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.nttdocomo.system
クラス ImageStore

Object
  |
  +--com.nttdocomo.system.ImageStore

public final class ImageStore
extends Object

携帯電話のネイティブの画像データ管理機能にアクセスする手段を提供します。

画像データの取得および新規登録機能を提供します。ネイティブデータへのアクセス機能の基本については、 XObjectクラスの説明を参照してください。

selectEntry メソッドを実行することにより、ネイティブのユーザインタフェースを介して、端末に登録されている画像データの一覧から画像データのエントリを取得することができます。取得されたエントリには、 IDが設定されています。エントリからは画像をメディアイメージオブジェクトとして取り出したり、画像のファイルイメージを取り出すためのInputStreamを取得することができます。また、エントリIDを指定して、 getEntry(int)メソッドによりユーザ操作によらずにエントリを取得することもできます。

画像データを新規に登録するためには、 addEntryメソッドにメディアイメージを渡します。登録はネイティブのユーザインタフェースを介して行われ、 addEntryメソッドは戻り値として登録されたエントリのIDを返します。このエントリIDを使用して getEntry(int)メソッドによりエントリを取得したり、 PhoneSystem.setImageTheme メソッドにより、そのエントリの画像を待ち受け画像などに設定することができます。

導入されたバージョン:: DoJa-3.0

メソッドの概要

static int addEntry(MediaImage image)
          ユーザ操作により画像データを新規登録します。

static ImageStore getEntry(int id)
          画像データのエントリを取得します。

int getId()
          画像データのエントリIDを取得します。

MediaImage getImage()
          画像データのエントリのイメージをメディアイメージとして取得します。

java.io.InputStream getInputStream()
          画像データのエントリのイメージをファイルイメージとして取り出すための入力ストリームを取得します。

static ImageStore selectEntry()
          ユーザ操作により画像データのエントリを取得します。

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

selectEntry

public static ImageStore selectEntry()
                              throws InterruptedOperationException

ユーザ操作により画像データのエントリを取得します。

取得されたエントリには、 IDが設定されています。エントリからは画像をメディアイメージオブジェクトとして取り出したり、画像のファイルイメージを取り出すためのInputStreamを取得することができます。

ADFにAccessUserInfoキーの指定が必要です。このメソッドを呼び出すとサスペンドします。

戻り値:: 取得した画像データのエントリを返します。ユーザが選択操作をキャンセルするとnullを返します。また、選択可能なエントリが存在しない場合にもnullを返します。
例外:: IllegalStateException - ダウンロード即起動アプリがこのメソッドを呼び出した場合に発生します。; IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。; SecurityException - ADFにAccessUserInfoキーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。; SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、画像データのエントリを取得できない場合に発生します。; InterruptedOperationException - 競合条件などにより、選択操作が異常終了した場合に発生します。

getEntry

public static ImageStore getEntry(int id)
                           throws StoreException

画像データのエントリを取得します。

ADFにAccessUserInfoキーの指定が必要です。

パラメータ:: id - 取得する画像データのエントリIDを指定します。
戻り値:: 取得した画像データのエントリを返します。
例外:: IllegalStateException - ダウンロード即起動アプリがこのメソッドを呼び出した場合に発生します。; SecurityException - ADFにAccessUserInfoキーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。; SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、画像データのエントリを取得できない場合に発生します。
[DoJa-3.5] UIM内情報を用いた実行制限がかけられている場合や、画像データに再配布不可識別が設定されている場合も含みます。; StoreException - 指定されたIDの画像エントリが存在しない場合に発生します (NOT_FOUND)。

addEntry

public static int addEntry(MediaImage image)
                    throws InterruptedOperationException

ユーザ操作により画像データを新規登録します。

ADFにAccessUserInfoキーの指定が必要です。このメソッドを呼び出すとサスペンドします。

パラメータ:: image - 登録する画像のメディアイメージを指定します。
戻り値:: 登録されたエントリのIDを返します。ユーザが登録操作をキャンセルした場合、-1 を返します。
例外:: IllegalStateException - ダウンロード即起動アプリがこのメソッドを呼び出した場合に発生します。; IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。; NullPointerException - 引数 image が null の場合に発生します。; UIException - 指定されているメディアイメージが use 状態でない場合に発生します (ILLEGAL_STATE)。; SecurityException - ADFにAccessUserInfoキーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。; SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、画像データを登録できない場合に発生します。; InterruptedOperationException - 競合条件などにより、登録操作が異常終了した場合に発生します。

getId

public int getId()

画像データのエントリIDを取得します。

戻り値:: 画像データのエントリIDを返します。

getImage

public MediaImage getImage()

画像データのエントリのイメージをメディアイメージとして取得します。

取得されたメディアイメージは、disposeもuseもされていない状態です。常に同じメディアイメージオブジェクトを返します。

戻り値:: メディアイメージを返します。

getInputStream

public java.io.InputStream getInputStream()

画像データのエントリのイメージをファイルイメージとして取り出すための入力ストリームを取得します。
このメソッドを呼び出すたびに異なる入力ストリームを返します。

戻り値:: 画像のファイルイメージを取り出すための入力ストリームを返します。

概要