com.nttdocomo.opt.ui
クラス PhoneResource

Object
  拡張com.nttdocomo.opt.ui.PhoneResource

public class PhoneResource
extends Object

端末のネイティブのストレージにデータを保存するメソッドを定義しているクラスです。 これらのメソッドで更新されたデータは、Java アプリケーションの終了後も 端末のネイティブアプリケーションによって利用されます。

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

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

フィールドの概要
static int INFORMATIONDISPLAY_DATA_TITLE
          ドットエリア情報の種類の1つで、タイトルを表します(=0)。
 
コンストラクタの概要
protected PhoneResource()
           アプリケーションが直接このクラスのインスタンスを生成することはできません。
 
メソッドの概要
static byte[] getInformationDisplayData(int targetId, int dataType)
          端末のLED表示部の点灯パターン等の情報 (ドットエリア情報) を取得します。
static void setInformationDisplay(int targetId, String title, long expire, int repeat, int[][] patterns)
           端末のLED表示部の点灯パターンを登録します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

INFORMATIONDISPLAY_DATA_TITLE

public static final int INFORMATIONDISPLAY_DATA_TITLE
ドットエリア情報の種類の1つで、タイトルを表します(=0)。

この定数は、getInformationDisplayData(int, int) の第2引数に指定します。 メソッドで取得された値は、バイト配列から文字列に変換する必要があります。 なお、バイト配列はデフォルトエンコーディングとします。

導入されたバージョン:
DoJa-4.1 (902iS)
関連項目:
定数フィールド値
コンストラクタの詳細

PhoneResource

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

メソッドの詳細

setInformationDisplay

public static void setInformationDisplay(int targetId,
                                         String title,
                                         long expire,
                                         int repeat,
                                         int[][] patterns)
端末のLED表示部の点灯パターンを登録します。

指定した登録先に、点灯パターン(ドットパターンによるイメージやアニメーション)とそのタイトル、 有効期限、繰り返し回数を登録します。 登録した点灯パターンを端末で表示させるには、 ユーザが端末のメニュー設定からLED表示部へ設定する必要があります。

点灯パターンは複数ページの点灯イメージデータ(点灯に関する複数の設定項目からなるデータ)から構成され、 引数 patterns に二次元配列として指定します。 配列の第一次元が点灯イメージデータのページ番号を、 第二次元がそのページの点灯イメージデータの設定項目を表します。 設定項目については機種依存です。 登録した点灯パターンを端末のLED表示部に設定した場合、 ページ番号順に、点灯イメージデータの設定項目に従った表示が行われます。

引数 targetId には、登録先の ID を指定します。登録先の ID として 1 から 11 を指定した場合、 Java アプリケーションからの登録専用の領域に点灯パターンの登録が行われます。 既に点灯パターンが登録されている ID を指定した場合、 点灯パターンは上書きされます。 このメソッドを呼び出すことにより、ユーザが Java アプリケーション以外から登録していた点灯パターンが上書きまたは変更されることはありません。 なお、登録先の ID として 0 を指定した場合、点灯パターンを登録せず即座にLED表示部に表示させることができます。 登録先の ID として、これら以外の値を指定した場合、不正な値が指定されたとして例外が発生します。

タイトルとは、 ユーザが端末の設定メニューで点灯パターンを選択する際に表示される点灯パターンの名称を表し、 引数 title で指定します。 タイトルに設定可能な長さを超える文字列を指定した場合、 超えた分の文字列は切り捨てられて設定されます。 設定可能な文字列の長さは機種依存です。

有効期限とは、点灯パターンが利用可能な期限を表し、 引数 expire に 1970 年 1 月 1 日午前 0 時 (GMT) との差分[ミリ秒]として指定します。 端末の時刻が有効期限を超えた場合、 その点灯パターンはLED表示部に設定しても、表示されません。 負の値を指定した場合や端末に設定可能な有効期限の範囲を超える値を指定した場合は無期限として設定されます。 設定可能な有効期限の範囲については端末に依存します。 なお、登録先の ID として 0 を指定した場合、 有効期限は無視されます。

繰り返し回数とは、点灯パターンをLED表示部に表示させた時の連続表示回数を表し、 引数 repeat にて指定します。 繰り返し回数に 0 を指定した場合、 点灯パターンは無制限に繰り返し表示されます。 繰り返し回数に設定可能な最大値を超える値を指定した場合、 最大値が設定されます。 最大値は機種依存です。

パラメータ:
targetId - 登録先の ID を指定します。
title - タイトルを指定します。
expire - 有効期限を指定します。
repeat - 繰り返し回数を指定します。
patterns - 点灯パターンを指定します。
例外:
com.nttdocomo.lang.UnsupportedOperationException - 本機能がサポートされていない場合に発生します。
NullPointerException - 引数 title に null が指定された場合に発生します。
NullPointerException - 引数 patterns に null が指定された場合に発生します。
IllegalArgumentException - 引数 repeat が 0 未満の場合に発生します。
IllegalArgumentException - 引数 targetId に不正な値が指定された場合に発生します。
IllegalArgumentException -
引数 title に登録できない文字列が指定された場合に発生します。
com.nttdocomo.ui.UIException - 引数 patterns が null ではなく、不正な配列であった場合に発生します(UNSUPPORTED_FORMAT)。 具体的にどのような場合にこの例外が発生するかは機種依存です。
導入されたバージョン:
DoJa-4.0 (901iS)

getInformationDisplayData

public static byte[] getInformationDisplayData(int targetId,
                                               int dataType)
端末のLED表示部の点灯パターン等の情報 (ドットエリア情報) を取得します。

引数 targetId には、登録先の ID を指定します。 登録先の ID に、 0 以下の値もしくは 11 より大きい値を指定した場合には、 不正な値として例外が発生します。

引数 dataType には、このクラスでドットエリア情報の種類として定義された定数を指定します。 定義されていない値が指定された場合には、不正な値として例外が発生します。

指定した登録先の ID に対するドットエリア情報が登録されていない場合は、 このメソッドは null を返します。

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

パラメータ:
targetId - 登録 ID を指定します。
dataType - ドットエリア情報の種類を指定します。
戻り値:
引数 dataType で指定したドットエリア情報を返します。
例外:
com.nttdocomo.lang.UnsupportedOperationException - 本機能がサポートされていない場合に発生します。
IllegalArgumentException - 引数 targetId に不正な値が指定された場合に発生します。
IllegalArgumentException - 引数 dataType に不正な値が指定された場合に発生します。
SecurityException - ADF に AccessUserInfo キーの指定がないアプリケーションが、 このメソッドを呼び出した場合に発生します。
導入されたバージョン:
DoJa-4.1 (902iS)


NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ(その他に許諾者がある場合は当該許諾者も含めて)の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

「iモード」、「iアプリ/アイアプリ」、「i-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。