com.docomostar.system
クラス PhoneTheme

Object
  拡張com.docomostar.system.PhoneTheme

public final class PhoneTheme
extends Object

携帯電話のテーマ設定機能を提供するクラスです。

音声発着信時等に表示される画面、及びテレビ電話通話中の代替画像に表示される画面を設定できます。 また、メニューのアイコンを一括で設定できます。

このクラス中で使用されている「静止画」「動画」「アバターデータ」とは具体的には以下のデータを指します。

導入されたバージョン:
Star-1.0

フィールドの概要
static int THEME_AV_CALL_IN
          テレビ電話着信を表すテーマ設定タイプです(=5)。
static int THEME_AV_CALLING [iアプリオプションAPI]
          テレビ電話通話中の代替画像を表すテーマ設定タイプです(=7)。
static int THEME_CALL_IN
          音声着信を表すテーマ設定タイプです(=2)。
static int THEME_CALL_OUT
          音声発信を表すテーマ設定タイプです(=1)。
static int THEME_CHAT_RECEIVED [iアプリオプションAPI]
          チャットメール着信を表すテーマ設定タイプです(=6)。
static int THEME_MESSAGE_RECEIVE
          メールおよび SMS 、メッセージ(R、F)着信を表すテーマ設定タイプです(=4)。
static int THEME_MESSAGE_SEND
          メールおよび SMS 発信を表すテーマ設定タイプです(=3)。
static int THEME_STANDBY
          待ち受け画面を表すテーマ設定タイプです(=0)。
 
メソッドの概要
static void setImageTheme(int target, int id)
           音声発着信時等に表示される静止画や Video トラックのみの動画、アバターデータを設定します。
static void setMenuIcons(int[] path, int[] ids) [iアプリオプションAPI]
           あるメニュー階層下のサブメニューのアイコンを一括設定します。
static void setMovieTheme(int target, int id) [iアプリオプションAPI]
           音声着信時等に再生される動画を設定します。
static void setSoundTheme(int target, int id)
           音声着信時等に再生されるサウンドやAudio トラックのみの動画を設定します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

THEME_STANDBY

public static final int THEME_STANDBY
待ち受け画面を表すテーマ設定タイプです(=0)。
setImageTheme メソッド、 setMovieTheme メソッドの target 引数として使用されます。

関連項目:
定数フィールド値

THEME_CALL_OUT

public static final int THEME_CALL_OUT
音声発信を表すテーマ設定タイプです(=1)。
setImageTheme メソッドのtarget引数として使用されます。

関連項目:
定数フィールド値

THEME_CALL_IN

public static final int THEME_CALL_IN
音声着信を表すテーマ設定タイプです(=2)。
setImageTheme メソッド、 setSoundTheme メソッド、 setMovieTheme メソッドのtarget引数として使用されます。

関連項目:
定数フィールド値

THEME_MESSAGE_SEND

public static final int THEME_MESSAGE_SEND
メールおよび SMS 発信を表すテーマ設定タイプです(=3)。
setImageTheme メソッドのtarget引数として使用されます。

関連項目:
定数フィールド値

THEME_MESSAGE_RECEIVE

public static final int THEME_MESSAGE_RECEIVE
メールおよび SMS 、メッセージ(R、F)着信を表すテーマ設定タイプです(=4)。
setImageTheme メソッド、 setSoundTheme メソッド、 setMovieTheme メソッドのtarget引数として使用されます。

関連項目:
定数フィールド値

THEME_AV_CALL_IN

public static final int THEME_AV_CALL_IN
テレビ電話着信を表すテーマ設定タイプです(=5)。
setSoundTheme メソッド、 setImageTheme メソッド、 setMovieTheme メソッドのtarget引数として使用されます。

関連項目:
定数フィールド値

THEME_CHAT_RECEIVED

public static final int THEME_CHAT_RECEIVED [iアプリオプションAPI]
チャットメール着信を表すテーマ設定タイプです(=6)。
setSoundTheme メソッドの target 引数として使用されます。

関連項目:
定数フィールド値

THEME_AV_CALLING

public static final int THEME_AV_CALLING [iアプリオプションAPI]
テレビ電話通話中の代替画像を表すテーマ設定タイプです(=7)。
setImageTheme メソッドの target 引数として使用されます。

関連項目:
定数フィールド値
メソッドの詳細

setImageTheme

public static void setImageTheme(int target,
                                 int id)
                          throws StoreException

音声発着信時等に表示される静止画や Video トラックのみの動画、アバターデータを設定します。 再配布不可識別子が設定されている静止画や動画やアバターデータについても、 このメソッドでテーマ設定が可能です。
アプリケーションが終了後もこの設定は有効です。 また、アプリケーション削除後もこの設定は有効です。

設定する静止画のエントリ ID は、 ImageStore.addEntry(MediaImage)メソッド、 ImageStore.getId()メソッド、 ImageStore.selectEntryId()メソッド により取得できます。

このメソッドでは、 Video トラックと Audio トラックの両方が含まれた動画は設定できません。 そのような動画を設定するには setMovieTheme(int, int) を利用して下さい。
設定する動画のエントリ ID は MovieStore.addEntry(MediaMovie) メソッド、MovieStore.getId() メソッドにより取得できます。 動画に Video トラックが含まれているかどうか、 Audio トラックが含まれていないかどうかは、 MediaResource.getProperty(String) の引数に、それぞれ MediaMovie.MP4_VIDEOTRACK、 MediaMovie.MP4_AUDIOTRACK を指定することによって調べることができます。

既に音声着信音やテレビ電話着信音に動画(動画の Audio トラック)が設定されている状態でこのメソッドを呼び出すと、 音声着信音やテレビ電話着信音がリセットされる場合があります。 リセットされるケースの詳細は以下の通りです。

音声着信音がリセットされる場合:
  • 既に、音声着信音・音声着信画面に、Audio・Video の両方のトラックが含まれている動画が設定されている状態で、 音声着信画面として、 Video トラックのみの動画や静止画を設定しようとした場合
  • 既に、音声着信音に、Audio トラックのみの動画が設定されている状態で、 音声着信画面として、Video トラックのみの動画を設定しようとした場合
テレビ電話着信音がリセットされる場合:
  • 既に、テレビ電話着信音・テレビ電話着信画面に、Audio・Video の両方のトラックが含まれている動画が設定されている状態で、 テレビ電話着信画面として、 Video トラックのみの動画や静止画を設定しようとした場合
  • 既に、テレビ電話着信音に、 Audio トラックのみの動画が設定されている状態で、 テレビ電話着信画面として Video トラックのみの動画を設定しようとした場合

なお、これらのケースにおいて、 リセットされることに対するユーザ確認は行われません。

設定するアバターデータのエントリ ID は AvatarStore.addEntry(AvatarData) メソッド、 AvatarStore.selectEntryId()メソッドにより取得できます。

引数 target には、 以下のいずれかのテーマ設定タイプを指定することができます。

引数 id に ImageStore のエントリ ID を指定する場合
引数 id に MovieStore のエントリ ID を指定する場合
引数 id に AvatarStore のエントリ ID を指定する場合

上記のテーマ設定タイプの中には、端末によって未サポートのものもあります。 その場合、指定されても何も行われず無視されます。
また、上記以外のテーマ設定タイプを指定した場合、IllegalArgumentException が発生します。

原則として、静止画や動画の、 設定可能な縦/横サイズは、 同等なネイティブ機能で設定可能なサイズと同様です。 また、設定された静止画や動画やアバターデータの具体的な表示方法も、 ネイティブ機能で同様な設定をした場合と同様です。 ただし、 表示可能な画面サイズよりも小さい静止画を指定した場合の表示方法は機種依存です。

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

パラメータ:
target - テーマ設定タイプを指定します。
id - ImageStore または MovieStore 、AvatarStore エントリ ID を指定します。
例外:
IllegalArgumentException -
引数 target の値が不正な場合に発生します。
SecurityException -
パーミッションとしてテーマ設定が許可されているが、 Star アプリ個別のユーザ設定により許可されていない場合に発生します。 実行時のユーザ確認により使用が許可されなかった場合を含みます。
SecurityException -
ネイティブ独自のセキュリティ設定により、 指定された静止画や動画やアバターデータへのアクセスが許可されない場合に発生します。 指定された ID の静止画や動画やアバターデータに UIM 内情報を用いた実行制限がかけられている場合を含みます。
StoreException -
(NOT_FOUND)
指定された ID の静止画や動画やアバターデータが存在しない場合や、 無効な ID (区間 [-256, 0] に属する整数) が指定された場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された対象では指定されたIDの静止画や動画やアバターデータのフォーマットをサポートしていない場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された ID の静止画や動画の縦/横のサイズが、 設定可能な範囲から外れている場合に発生します。 ただし、静止画が指定された場合には、 縦/横サイズが小さすぎることが原因でこの例外が発生することはありません。
MediaException -
(UNSUPPORTED_FORMAT)
指定された静止画や動画やアバターデータのデータサイズが、 設定可能なデータサイズ(bytes)よりも大きい場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された動画が再生可能な Video トラックを含まない場合や、Video トラック以外のトラックが含まれている場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定されたアバターデータの内容(総モデルデータサイズや、モデル数など)が、 端末のサポート範囲を超えている場合に発生します。

setSoundTheme

public static void setSoundTheme(int target,
                                 int id)
                          throws StoreException

音声着信時等に再生されるサウンドやAudio トラックのみの動画を設定します。 番号不通知着信音、公衆電話着信音、転送着信音、 番号指定着信音は変更できません。 アプリケーションが終了後もこの設定は有効です。 また、アプリケーション削除後もこの設定は有効です。

着信音に使用するサウンドデータの ID は、 SoundStore.addEntry(MediaSound) メソッドにより取得できます。

このメソッドでは、 Video トラックと Audio トラックの両方が含まれた動画は設定できません。 そのような動画を設定するには setMovieTheme(int, int) を利用して下さい。
設定する動画のエントリ ID は MovieStore.addEntry(MediaMovie) メソッドにより取得できます。 動画に Audio トラックが含まれているかどうか、 Video トラックが含まれていないかどうかは、 MediaResource.getProperty(String) の引数に、 それぞれ MediaMovie.MP4_AUDIOTRACK、 MediaMovie.MP4_VIDEOTRACK を指定することによって調べることができます。

既に音声着信画面やテレビ電話着信画面に動画(動画の Video トラック)や、 Flash® コンテンツの Video 成分が設定されている状態でこのメソッドを呼び出すと、 音声着信画面やテレビ電話着信画面がリセットされる場合があります。 リセットされるケースの詳細は以下の通りです。

音声着信画面がリセットされる場合:
  • 既に、音声着信音・音声着信画面に、Audio・Video の両方のトラックが含まれている動画が設定されている状態で、 音声着信音として、Audio トラックのみの動画やメロディ(MFi・SMF のこと。 このメソッド中の記述について以下同様。)を設定しようとした場合
  • 既に、音声着信画面に、Video トラックのみの動画や、 Flash® コンテンツの Video 成分が設定されている状態で、 音声着信音として、Audio トラックのみの動画を設定しようとした場合
テレビ電話着信画面がリセットされる場合:
  • 既に、テレビ電話着信音・テレビ電話着信画面に、Audio・Video の両方のトラックが含まれている動画が設定されている状態で、 テレビ電話着信音として、 Audio トラックのみの動画やメロディを設定しようとした場合
  • 既に、テレビ電話着信画面に、Video トラックのみの動画や、 Flash® コンテンツの Video 成分が設定されている状態で、 テレビ電話着信音として、Audio トラックのみの動画を設定しようとした場合

なお、これらのケースにおいて、 リセットされることに対するユーザ確認は行われません。

引数 target には、 以下のいずれかのテーマ設定タイプを指定することができます。

引数 id に SoundStore のエントリ ID を指定する場合
引数 id に MovieStore のエントリ ID を指定する場合

上記のテーマ設定タイプの中には、端末によって未サポートのものもあります。 その場合、指定されても何も行われず無視されます。
また、上記以外のテーマ設定タイプを指定した場合、 IllegalArgumentException が発生します。

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

パラメータ:
target - テーマ設定タイプを指定します。
id - SoundStore または MovieStore のエントリ IDを指定します。
例外:
IllegalArgumentException -
引数 target の値が不正な場合に発生します。
SecurityException -
パーミッションとしてテーマ設定が許可されているが、 Star アプリ個別のユーザ設定により許可されていない場合に発生します。 実行時のユーザ確認により使用が許可されなかった場合を含みます。
SecurityException -
ネイティブ独自のセキュリティ設定により、 指定されたサウンドや動画へのアクセスが許可されない場合に発生します。
指定された ID のサウンドや動画が、 このアプリケーション自身が保存したものではなく、かつ、 そのサウンドに再配布不可識別子が設定されている場合にも発生します。
StoreException -
(NOT_FOUND)
指定された ID のサウンドや動画が存在しない場合や、 無効な ID (区間 [-256, 0] に属する整数) が指定された場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された対象では指定されたIDのサウンドや動画のフォーマットをサポートしていない場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定されたIDのサウンドや動画のデータサイズが、 設定可能なデータサイズ(bytes)よりも大きい場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された動画が再生可能な Audio トラックを含まない場合や、 Audio トラック以外のトラックが含まれている場合に発生します。

setMovieTheme

public static void setMovieTheme(int target,
                                 int id)
                          throws StoreException [iアプリオプションAPI]

音声着信時等に再生される動画を設定します。 アプリケーションが終了後もこの設定は有効です。 また、アプリケーション削除後もこの設定は有効です。

設定される動画は必ず Video トラックと Audio トラックの両方を含んでいなければなりません。 それぞれのトラックが含まれているかどうかは、 MediaResource.getProperty(String) の引数に MediaMovie.MP4_VIDEOTRACK や MediaMovie.MP4_AUDIOTRACK を指定することによって調べることができます。

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

引数 target には、 以下のいずれかのテーマ設定タイプを指定することができます。

上記のテーマ設定タイプの中には、端末によって未サポートのものもあります。 その場合、指定されても何も行われず無視されます。
また、上記以外のテーマ設定タイプを指定した場合、IllegalArgumentException が発生します。

原則として、動画の、設定可能な縦/横サイズは、 同等なネイティブ機能で設定可能なサイズと同様です。 また、設定された動画の具体的な表示方法も、 ネイティブ機能で同様な設定をした場合と同様です。

パラメータ:
target - テーマ設定タイプを指定します。
id - MovieStore のエントリ ID を指定します。
例外:
IllegalArgumentException -
引数 target の値が不正な場合に発生します。
SecurityException -
パーミッションとしてテーマ設定が許可されているが、 Star アプリ個別のユーザ設定により許可されていない場合に発生します。 実行時のユーザ確認により使用が許可されなかった場合を含みます。
SecurityException -
ネイティブ独自のセキュリティ設定により、 指定された動画へのアクセスが許可されない場合に発生します。 指定された ID の動画が、 このアプリケーション自身が保存したものではなく、かつ、 その動画データに再配布不可識別子が設定されている場合にも発生します。
StoreException -
(NOT_FOUND)
指定された ID の動画が存在しない場合や、 無効な ID (区間 [-256, 0] に属する整数) が指定された場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された ID の動画の縦/横のサイズが、 設定可能な範囲から外れている場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された ID の動画のデータサイズが、 設定可能なデータサイズ(bytes)よりも大きい場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
指定された動画が再生可能な Video トラックまたは Audio トラックを含まない場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
音声/テレビ電話着信画面として指定された動画に Text トラックが含まれていた場合に発生します。

setMenuIcons

public static void setMenuIcons(int[] path,
                                int[] ids)
                         throws StoreException [iアプリオプションAPI]

あるメニュー階層下のサブメニューのアイコンを一括設定します。 引数 path によって、アイコンを一括設定したい階層の位置を指定し、 引数 ids に静止画のエントリ ID の配列を指定することによって、 どのメニューアイテムにどのアイコンを設定するかを指定します。 再配布不可識別子が設定されている静止画についても、 このメソッドでメニューアイコンに設定可能です。

[図] トップメニューから、3番目 -- 1番目 -- 2番目 のアイコンを設定する場合 メニュー階層は、 トップメニュー階層をルートとしたツリー構造としてモデル化されており、 各メニュー階層には、その階層内の各メニューアイテムに 0, 1, 2, ... と、 位置番号が割り振られています。 引数 path には、ルートを長さ0の int 配列 (new int[0]) として、アイコンを設定したい階層までのパスを、 位置番号を並べて指定します。 例えば、右図において、トップメニュー (「i-mode」、「Star アプリ」、「メール」、… がある階層) にアイコンを指定したい時には new int[0] を、 色の付いている部分のアイコンを指定したい場合には new int[] {3, 1, 2} を、path として指定することとなります。

引数 ids には、上記のように指定した path 配下にあるメニューアイコンに設定する静止画の配列を、 エントリ ID の配列として指定します。 ids[i] に指定された静止画エントリ ID は、 位置番号 i のアイコン画像として設定されます。 例えば、前掲の図において、色の付いている部分のアイコンを、 0番目から順に、エントリ ID が a, b, c, d, e の静止画としたい場合には、 new int[] {a, b, c, d, e} を、 ids として指定することとなります。 なお、ある階層の、一部のアイコンを設定したくない場合には、 id として -1 を指定して下さい。 -1 が指定された部分のアイコン画像は変化しません。

アイコンの数よりも長い配列を指定した場合には、 余分な要素は単に無視されます。 余分な要素に不正な値が入っていた場合でも例外は発生しません。 アイコンの数よりも短い配列を指定した場合には、 足りない要素には -1 が指定されているものとみなされます。

どの位置にどのメニューアイテムが割り当てられているかは、 機種によって異なります。 別途提供されるメニュー構成図を参照しながら位置番号を設定してください。

このメソッド呼び出しによるメニューアイコン設定は、 基本構造メニューのみに影響します。 メニュー画面に基本構造メニューが設定されていない状態でこのメソッドを実行した場合、 メニュー画面を基本構造メニューに変更した上で、アイコンが設定されます。

このメソッドをサポートしていない実装も存在します。 その場合には、例外 UnsupportedOperationException が発生します。

このメソッドをサポートしている実装では、 少なくともトップメニュー (path = new int[0]) のアイコン画像が設定できることは保証されています。 その他の階層のアイコン画像が設定できるかどうかは機種依存です。

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

パラメータ:
path - アイコンを設定したいメニュー階層へのパスを、 位置番号の配列で指定します。
ids - 各アイコンに設定したい静止画のエントリ ID の配列を指定します。 -1 を指定した部分に対応するアイコンは変化しません。
例外:
UnsupportedOperationException -
端末がこのメソッドをサポートしていない場合に発生します。
NullPointerException -
引数 path または ids に null が指定された場合に発生します。
SecurityException -
パーミッションとしてテーマ設定が許可されているが、 Star アプリ個別のユーザ設定により許可されていない場合に発生します。 実行時のユーザ確認により使用が許可されなかった場合を含みます。
IllegalArgumentException -
引数 path で指定されたメニュー階層が存在しないか、 アイコン設定をサポートしていないメニュー階層である場合に発生します。 path 配列の要素中に負の数が含まれている場合を含みます。
SecurityException -
引数 ids のいずれかの要素に、 ネイティブ独自のセキュリティ設定によりアクセスが禁止されている静止画の ID が指定されていた場合に発生します。 指定された ID の静止画に、 UIM 内情報を用いた実行制限がかけられている場合を含みます。
StoreException -
(NOT_FOUND)
引数 ids のいずれかの要素に、 存在しない静止画のエントリ ID が指定されていた場合や、-1 を除く無効な ID (-256, -255, -254, ..., -3, -2, 0) が指定された場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
引数 ids のいずれかの要素に、 アイコン画像としてサポートしていないフォーマットの静止画のエントリ ID が指定されていた場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
引数 ids のいずれかの要素に、 縦/横サイズが設定可能な範囲から外れているような静止画のエントリ ID が指定されていた場合に発生します。
MediaException -
(UNSUPPORTED_FORMAT)
引数 ids のいずれかの要素に、 設定可能なデータサイズ (bytes) よりも大きな静止画のエントリ ID が指定されていた場合に発生します。


NTT DOCOMO,INC.

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

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

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

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

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