IlluminationDisplay (DoJa-4.1 (オプションAPIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

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

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

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

com.nttdocomo.opt.ui
クラス IlluminationDisplay

Object
  com.nttdocomo.opt.ui.IlluminationDisplay

public class IlluminationDisplay
extends Object

端末のイルミネーションを定義します。このクラスでは、以下の操作を提供しています。

端末のネイティブの領域にイルミネーションデータを保存する
端末のネイティブの領域に保存されているイルミネーションデータを取得する
端末のネイティブの領域に保存されているイルミネーションデータをテーマとして設定する

これらの操作で更新されたイルミネーションデータは、 Java アプリケーション終了後も、端末のネイティブアプリケーションによって利用されます。

端末によってサポートされていない場合があります。未サポートの場合、各メソッドが呼び出された時点で UnsupportedOperationException が発生します。

導入されたバージョン:: DoJa-4.1 (902i)

フィールドの概要

static int THEME_PACKAGE
          イルミネーションデータを設定するテーマの種類の 1 つで、全テーマを一括設定することを表します(=0)。

コンストラクタの概要

protected IlluminationDisplay()
          アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの概要

static byte[] getIlluminationDisplay(int illuminationDataId)
           引数で指定した ID のネイティブ領域に保存されているイルミネーションデータを取得します。

static void preview(byte[] illuminationData)
           指定されたイルミネーションデータのプレビューを開始、または停止します。

static void setIlluminationDisplay(int illuminationDataId, byte[] illuminationData)
           指定されたネイティブの領域にイルミネーションデータを保存します。

static void setIlluminationTheme(int target, int illuminationDataId)
           引数で指定した ID のネイティブ領域に格納されているイルミネーションデータを、テーマとして設定します。

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

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

フィールドの詳細

THEME_PACKAGE

public static final int THEME_PACKAGE

イルミネーションデータを設定するテーマの種類の 1 つで、全テーマを一括設定することを表します(=0)。

関連項目:: setIlluminationTheme(int, int), 定数フィールド値

コンストラクタの詳細

IlluminationDisplay

protected IlluminationDisplay()

アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの詳細

setIlluminationDisplay

public static void setIlluminationDisplay(int illuminationDataId,
                                          byte[] illuminationData)

指定されたネイティブの領域にイルミネーションデータを保存します。引数 illuminationData で指定されたイルミネーションデータを、引数 illuminationDataId で指定された領域に保存します。その際にユーザ確認を求められることはありません。

このメソッドの呼び出しの結果、プレインストールデータが上書きされたり、変更されたりすることはありません。プレインストールデータを上書きしようとした場合には、例外が発生します。

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

パラメータ:: illuminationDataId - 保存先の領域を表す ID を指定します。 ID は 1 から始まる整数値で、許される ID の範囲(上限)は端末によって異なります。; illuminationData - 保存するイルミネーションデータを指定します。ここで指定するバイト配列がどのように解釈されるかは機種依存です。
例外:: com.nttdocomo.lang.UnsupportedOperationException - 本機能が未サポートの場合に発生します。; IllegalArgumentException - 引数 illuminationDataId が 0 以下か、端末がサポートする上限を超えている場合に発生します。; NullPointerException - 引数 illuminationData が null の場合に発生します。; SecurityException - ADF に AccessUserInfo キーの指定がないアプリケーションが、このメソッドを呼び出した場合に発生します。; com.nttdocomo.ui.UIException - 引数 illuminationData が、端末が解釈できないデータであった場合に発生します (UNSUPPORTED_FORMAT)。; com.nttdocomo.ui.UIException - プレインストールデータを上書きしようとした場合など、イルミネーションデータが保存できなかった場合に発生します (UNDEFINED)。

preview

public static void preview(byte[] illuminationData)

指定されたイルミネーションデータのプレビューを開始、または停止します。プレビューを開始するには、引数にプレビューしたいイルミネーションデータを指定します。プレビューを停止するには、引数に null を指定します。

既にプレビューが開始されている状態で再度プレビューが開始された場合には、現在のプレビューが停止し、即座に新しく設定されたイルミネーションデータのプレビューが開始します。一方、プレビューが停止されている状態でプレビューの停止が指示された場合には、何も行われません。

ADF に AccessUserInfo キーの指定が必要です。また、このメソッド呼び出しの際にユーザ確認が求められることはありません。

パラメータ:: illuminationData - プレビューするイルミネーションデータを指定します。ここで指定するバイト配列がどのように解釈されるかは機種依存です。 null を指定するとプレビューを停止します。
例外:: com.nttdocomo.lang.UnsupportedOperationException - 本機能が未サポートの場合に発生します。; SecurityException - ADF に AccessUserInfo キーの指定がないアプリケーションが、このメソッドを呼び出した場合に発生します。; com.nttdocomo.ui.UIException - 引数 illuminationData が、端末が解釈できないデータであった場合に発生します (UNSUPPORTED_FORMAT)。

setIlluminationTheme

public static void setIlluminationTheme(int target,
                                        int illuminationDataId)

引数で指定した ID のネイティブ領域に格納されているイルミネーションデータを、テーマとして設定します。

引数 target には設定したいテーマの種類を指定しますが、現在はイルミネーションデータが設定できる全テーマを一括設定する THEME_PACKAGE のみが指定可能です。

設定するイルミネーションデータの種類は、そのデータが保存されている領域の ID をもって指定します。その ID は setIlluminationDisplay(int, byte[]) の第 1 引数や、 getIlluminationDisplay(int) の引数と同一です。

このメソッド呼び出しにより設定されたテーマは、アプリケーション終了後、アプリケーション削除後であっても有効です。

パーミッションとしてテーマ設定が許可されているトラステッド i アプリのみこのメソッドを呼び出すことができます。

パラメータ:: target - イルミネーション設定の対象を指定します。現状は THEME_PACKAGE のみが指定できます。; illuminationDataId - 設定したいイルミネーションデータが保存されている領域の ID を指定します。 ID は 1 から始まる整数値で、許される ID の範囲(上限)は端末によって異なります。
例外:: com.nttdocomo.lang.UnsupportedOperationException - 本機能が未サポートの場合に発生します。; com.nttdocomo.lang.IllegalStateException - このメソッドを呼び出す度にユーザ確認が必要であると設定されているにもかかわらず、待ち受け実行時の非活性化状態で呼び出された場合に発生します。; IllegalArgumentException - 引数 target の値が不正な場合に発生します。; IllegalArgumentException - 引数 illuminationDataId が 0 以下か、端末がサポートする上限を超えている場合に発生します。; SecurityException - パーミッションとしてテーマ設定が許可されているが、 i アプリ個別のユーザ設定により許可されていない場合に発生します。実行時のユーザ確認により使用が許可されなかった場合を含みます。; com.nttdocomo.system.StoreException - 指定された ID の領域にイルミネーションデータが存在しない場合に発生します(NOT_FOUND)。

getIlluminationDisplay

public static byte[] getIlluminationDisplay(int illuminationDataId)
                                     throws com.nttdocomo.system.StoreException

引数で指定した ID のネイティブ領域に保存されているイルミネーションデータを取得します。

取得したいイルミネーションデータの種類は、そのデータが保存されている領域の ID をもって指定します。その ID は setIlluminationDisplay(int, byte[]) の第1引数と同一です。

戻り値として得られるバイト配列の解釈には機種依存ですが、 setIlluminationDisplay(int, byte[]) の第 2 引数と同じ形式であることは保証されています。

プレインストールデータを含む、端末に格納されている全てのイルミネーションデータ (他のアプリケーションから保存されたものも含む) を取得することができますが、プレインストールデータが格納されている ID は機種依存です。