Unofficial
"CLDC 1.1
+ MIDP 2.0"
API Reference.
(日本語版)

javax.microedition.lcdui
クラス Display

java.lang.Object
  上位を拡張 javax.microedition.lcdui.Display

public class Display
extends Object

このクラスはシステムのディスプレイや入力装置のマネージャー機能を提供します。 デバイスの特性情報の提供や、ディスプレイに表示する対象のオブジェクトの管理を行います。 このクラス以外にデバイス属性を扱うメソッドが Canvas クラスにも定義されています。

1つの MIDlet に対して1つの Display オブジェクトが必ず存在します。そしてアプリケーションは、getDisplay() メソッドを呼ぶ事により、そのインスタンスへの参照を取得することができます。 アプリケーションは実行中、いつでも getDisplay() メソッドを呼び出すことができます。 getDisplay() の呼び出しによって返される全ての Display オブジェクトは、この間、常に同一です。

一般的なアプリケーションは MIDlet クラスのメソッドの呼び出しに対して以下のような処理を行います:

ディスプレイ装置に表示されるユーザーインタフェース・オブジェクトは Displayable オブジェクト内に存在します。 アプリケーションはいつでもディスプレイ装置およびユーザーインタフェースを提供する1つのオブジェクトを持つことができます。 表示することができるこのオブジェクトを「カレントの表示対象」と呼びます。

Display クラスには表示対象を設定する setCurrent() メソッドと設定されている表示対象を取得する getCurrent() メソッドが用意されています。 アプリケーションは表示対象をコントロールするためにいつでも setCurrent メソッドを呼び出すことができます。 一般にアプリケーションはユーザーのアクションに応じて表示対象を切り替えますが、常にそうであるわけではありません。 例えば Alert の場合、一定時間経過すると表示対象が切り替わります。

アプリケーションの「カレントの表示対象」は物理的なディスプレイ上に描画されないことがあります。 また、キー操作によるユーザー・イベント等についても同様です。 これらは同じデバイス上で同時に動作している他の MIDlet アプリケーションの存在によって発生する可能性があります。

アプリケーションが設定したカレントの表示対象がディスプレイにが表示され、ユーザーによるデバイスへの入力によるイベントがそれに通知される状態をフォアグラウンド状態と呼びます。 アプリケーションがフォアグラウンド状態でなければ、ディスプレイや入力デバイスへのアクセスができない状態となり、この状態をバックグラウンド状態と呼びます。 デバイスに対して個々の MIDlet アプリケーションを割り当てる方法は MID Profile 仕様外であり、アプリケーション管理ソフトと呼ばれる外部のソフトウェアによってコントロールされます。

上で述べたようなバックグラウンド状態であっても、アプリケーションはカレントの表示対象を設定することができます。 バックグラウンド状態のアプリケーションがフォアグラウンド状態になった時に、カレントの表示対象はディスプレイへ表示されます。 このため、バックグラウンド状態のアプリケーションであってもカレントの表示対象を設定することは重要です。 アプリケーションは実際にカレントの表示対象がディスプレイに表示されるか否かを Displayable クラスの isShown() メソッドで確認することができます。 また、Canvas の場合、ディスプレイに表示される場合には showNotify() メソッドが、非表示になる場合には hideNotify() メソッドが呼び出されます。

それぞれの MIDlet アプリケーションは固有のカレントの表示対象を設定することができます。 つまり、その MIDlet アプリケーションがフォアグラウンド・バックグラウンド状態のいずれであっても getCurrent() メソッドによってカレントの表示対処を取得することができる、ということです。 例えばフォアグラウンドのアプリケーション A がカレントの表示対象に B を、バックグラウンドのアプリケーション C がカレントの表示対象に D を設定しているとします。 この状態でアプリケーション A が getCurrent() メソッドを呼び出すと B が、アプリケーション C が getCurrent() メソッドを呼び出すと D を返します。 さらにこの状態でいずれかの MIDlet アプリケーションが setCurrent メソッドでカレントの表示対象を変更したとしても、他方の MIDlet アプリケーションには一切影響しません。

getCurrent() メソッドは null を返すことがあります。 例えば、MIDlet アプリケーションが setCurrent メソッドで最初にカレントの表示対象を設定する前に呼び出した場合に返すことがあります。 getCurrent() メソッドは setCurrent メソッドによって設定されたことのないオブジェクトを返すことはありません。

システム・スクリーン

通常、フォアグラウンドの MIDlet アプリケーションが設定したカレントの表示対象がディスプレイに表示されています。 しかし特定の状況下において、システムはアプリケーションの表示を妨げるようなスクリーンを表示することがあります。 これらのシステムが表示するスクリーンをシステム・スクリーンと呼びます。 システムが Command メニューを表示したり、TextField の文字列をユーザーが編集する場合などにシステム・スクリーンが表示されることがあります。 例えシステム・スクリーンが表示されたとしても、getCurrent() メソッドはシステム・スクリーンではなく、アプリケーションが設定したカレントの表示対象を返します。 システム・スクリーンによってカレントの表示対象がディスプレイのに表示されない状態の場合、その表示対象の isShown() メソッドは false を返します。

システム・スクリーンが Canvas の上に表示される場合、その Canvas クラスの hideNotify() メソッドが呼び出されます。 システム・スクリーンの表示が終了すると showNotify() メソッドを呼び出し、次に paint() メソッドを呼び出して、ディスプレイの表示内容を回復します。 Command を発生させるためにユーザーによってシステム・スクリーンが呼び出された場合、showNotify() メソッドを呼び出した後、登録されている CommandListenercommandAction() メソッドを呼び出します。

このクラスは高レベルなユーザーインタフェースのために有力な前景色と背景色を検索するメソッドを含みます。 これらのメソッドは他の Item のユーザーインタフェースとマッチする CustomItem オブジェクトを作成したり、システムの残りのユーザーインタフェースとマッチする Canvas 内のユーザーインタフェースを作成したりすることの役に立ちます。 実装はそれらのユーザーインタフェースで前景色と背景色を使用することに制限はありません(例えば、実装がベベル(bevel)効果にハイライトと影の色を使用するかもしれません)。しかし、返された色は実装のカラー構成に対して合理的にマッチするものです。 CustomItem を実装するアプリケーションは領域をクリアするために背景色を、テキストと幾何学的なグラフィックス(線、円弧、矩形)を描画するために前景色を使用すべきです。

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

フィールドの概要
static int ALERT
          Alert の要素として使用するイメージ・タイプです。
static int CHOICE_GROUP_ELEMENT
          ChoiceGroup の要素として使用するイメージ・タイプです。
static int COLOR_BACKGROUND
          getColor で使用するためのカラー番号です。
static int COLOR_BORDER
          getColor で使用するためのカラー番号です。
static int COLOR_FOREGROUND
          getColor で使用するためのカラー番号です。
static int COLOR_HIGHLIGHTED_BACKGROUND
          getColor で使用するためのカラー番号です。
static int COLOR_HIGHLIGHTED_BORDER
          getColor で使用するためのカラー番号です。
static int COLOR_HIGHLIGHTED_FOREGROUND
          getColor で使用するためのカラー番号です。
static int LIST_ELEMENT
          List の要素として使用するイメージ・タイプです。
 
メソッドの概要
 void callSerially(Runnable r)
          指定された Runnable オブジェクト rrun() メソッドを、画面の再描画が終了後にそのサイクルの中ですぐに呼び出すように設定します。
 boolean flashBacklight(int duration)
          デバイスのバックライトにフラッシュ効果を要求します。
 int getBestImageHeight(int imageType)
          指定されたイメージ・タイプのために最適なイメージの高さを返します。
 int getBestImageWidth(int imageType)
          指定されたイメージ・タイプのために最適なイメージの幅を返します。
 int getBorderStyle(boolean highlighted)
          コンポーネントの状態(ハイライトあるいは非ハイライト)に依存する境界描画に使用するストローク・スタイルを返します。
 int getColor(int colorSpecifier)
          colorSpecifier に基づく 0x00RRGGBB 形式で、高レベルなユーザーインタフェースのカラー構成から1つの色を返します。
 Displayable getCurrent()
          現在設定されているカレントの表示対象を返します。
static Display getDisplay(MIDlet m)
          渡された MIDlet アプリケーションに対応する Display オブジェクトを返します。
 boolean isColor()
          デバイスがカラー表示をサポートしているか否かを返します。
 int numAlphaLevels()
          この実装がサポートする、アルファ透過レベルの数(アルファ透過段階数)を返します。
 int numColors()
          デバイスがサポートしている色数あるいは階調を返します。
 void setCurrent(Alert alert, Displayable nextDisplayable)
          指定された Alert をカレントの表示対象とし、その表示終了後に nextDisplayable に指定された表示対象をカレントの表示対象とします。
 void setCurrent(Displayable next)
          渡した表示対象をカレントの表示対象としてディスプレイに表示されるように設定します。
 void setCurrentItem(Item item)
          現在この Item を含む Displayable が作成されており、この Item が目に見えるように Displayable をスクロールして、および必要に応じてフォーカスをこの Item に割り当てるという要求を行います。
 boolean vibrate(int duration)
          デバイスのバイブレータ操作を要求します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

LIST_ELEMENT

public static final int LIST_ELEMENT

List の要素として使用するイメージ・タイプです。

LIST_ELEMENT の値は 1 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getBestImageWidth(int imageType), getBestImageHeight(int imageType), 定数フィールド値

CHOICE_GROUP_ELEMENT

public static final int CHOICE_GROUP_ELEMENT

ChoiceGroup の要素として使用するイメージ・タイプです。

CHOICE_GROUP_ELEMENT の値は 2 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getBestImageWidth(int imageType), getBestImageHeight(int imageType), 定数フィールド値

ALERT

public static final int ALERT

Alert の要素として使用するイメージ・タイプです。

ALERT の値は 3 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getBestImageWidth(int imageType), getBestImageHeight(int imageType), 定数フィールド値

COLOR_BACKGROUND

public static final int COLOR_BACKGROUND

getColor で使用するためのカラー番号です。 COLOR_BACKGROUND は背景色を意味します。 背景色と前景色は常に非常に対照的な色でしょう。

COLOR_BACKGROUND の値は 0 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getColor(int), 定数フィールド値

COLOR_FOREGROUND

public static final int COLOR_FOREGROUND

getColor で使用するためのカラー番号です。 COLOR_FOREGROUND はスクリーンにおけるテキスト・キャラクタと簡単なグラフィックスに使用する前景色を意味します。 静的なテキストか編集可能なユーザー・テキストが前景色で描画されるべきです。 前景色と背景色は常に非常に対照的な色でしょう。

COLOR_FOREGROUND の値は 1 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getColor(int), 定数フィールド値

COLOR_HIGHLIGHTED_BACKGROUND

public static final int COLOR_HIGHLIGHTED_BACKGROUND

getColor で使用するためのカラー番号です。 COLOR_HIGHLIGHTED_BACKGROUND はフォーカス、またはフォーカス・ハイライト(その時それは塗りつぶされた長方形として描かれます)のために使用する前景色を意味します。 ハイライトの背景色とハイライトの前景色は常に非常に対照的な色でしょう。

COLOR_HIGHLIGHTED_BACKGROUND の値は 2 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getColor(int), 定数フィールド値

COLOR_HIGHLIGHTED_FOREGROUND

public static final int COLOR_HIGHLIGHTED_FOREGROUND

getColor で使用するためのカラー番号です。 COLOR_HIGHLIGHTED_FOREGROUND はスクリーンにおけるテキスト・キャラクタと簡単なグラフィックスを強調する際に使用する前景色を意味します。 ハイライトの前景色はハイライトの背景色に対して強調されたテキストとグラフィックスを描画する際に使用されるべき色です。 ハイライトの前景色とハイライトの背景色は常に非常に対照的な色でしょう。

COLOR_HIGHLIGHTED_FOREGROUND の値は 3 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getColor(int), 定数フィールド値

COLOR_BORDER

public static final int COLOR_BORDER

getColor で使用するためのカラー番号です。 COLOR_BORDERItem が非ハイライト状態でボックスとの境界を描く目的で使用する色を意味します。 境界色は背景色と共に使用されることが意図されており、常に非常に対照的な色でしょう。 アプリケーションは getBorderStyle() によって返されるストローク・スタイルを使用して境界を描くべきです。

COLOR_BORDER の値は 4 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getColor(int), 定数フィールド値

COLOR_HIGHLIGHTED_BORDER

public static final int COLOR_HIGHLIGHTED_BORDER

getColor で使用するためのカラー番号です。 COLOR_BORDERItem がハイライト状態でボックスとの境界を描く目的で使用する色を意味します。 ハイライトの境界色は背景色(ハイライトの背景色ではない)と共に使用されることが意図されており、常に非常に対照的な色でしょう。 アプリケーションは getBorderStyle() によって返されるストローク・スタイルを使用して境界を描くべきです。

COLOR_HIGHLIGHTED_BORDER の値は 5 です。

導入されたバージョン:
MIDP 2.0
関連項目:
getColor(int), 定数フィールド値
メソッドの詳細

getDisplay

public static Display getDisplay(MIDlet m)

渡された MIDlet アプリケーションに対応する Display オブジェクトを返します。

パラメータ:
m - 対象とする MIDlet アプリケーションのオブジェクトを渡します。
戻り値:
アプリケーションがユーザーインタフェースのために使用することができる Display オブジェクトを返します。
例外:
NullPointerException - MIDlet アプリケーションに null を渡すと throw します。

getColor

public int getColor(int colorSpecifier)

colorSpecifier に基づく 0x00RRGGBB 形式で、高レベルなユーザーインタフェースのカラー構成から1つの色を返します。

パラメータ:
colorSpecifier - 以下の中の1つの事前に定義されたカラー番号を渡します: COLOR_BACKGROUNDCOLOR_FOREGROUNDCOLOR_HIGHLIGHTED_BACKGROUNDCOLOR_HIGHLIGHTED_FOREGROUNDCOLOR_BORDER または COLOR_HIGHLIGHTED_BORDER
戻り値:
0x00RRGGBB 形式の色を返します。
例外:
IllegalArgumentException - 有効なカラー番号でなければ throw します。
導入されたバージョン:
MIDP 2.0

getBorderStyle

public int getBorderStyle(boolean highlighted)

コンポーネントの状態(ハイライトあるいは非ハイライト)に依存する境界描画に使用するストローク・スタイルを返します。 例えば、ハイライトの Item の周辺の境界は Graphics.SOLID ストローク・スタイルで描かれるかもしれませんが、モノクロのシステムではハイライトの Item の周辺の境界は Graphics.DOTTED ストローク・スタイルで描かれるかもしれません。

パラメータ:
highlighted - ハイライト状態のストローク・スタイルを要求する場合は true を、非ハイライト状態のストローク・スタイルを要求する場合は false を渡します。
戻り値:
Graphics.DOTTED または Graphics.SOLID を返します。
導入されたバージョン:
MIDP 2.0

isColor

public boolean isColor()

デバイスがカラー表示をサポートしているか否かを返します。

戻り値:
カラー表示をサポートしている場合は true を、そうでなければ false を返します。

numColors

public int numColors()

デバイスがサポートしている色数あるいは階調を返します。 isColor() メソッドが true を返す場合は色数、false を返す場合は階調です。 モノクロディスプレイの場合は 2 を返します。

戻り値:
色数あるいは階調を返します。

numAlphaLevels

public int numAlphaLevels()

この実装がサポートする、アルファ透過レベルの数(アルファ透過段階数)を返します。 最小の適正な戻り値は 2 で、完全な透明と完全な不透明のみで、ブレンディングをサポートしないことを示します。 アルファ・ブレンディングをサポートする場合は 2 よりも大きな値を返します。 詳しくはアルファ処理を参照してください。

戻り値:
サポートするアルファレベル数を返します。
導入されたバージョン:
MIDP 2.0

getCurrent

public Displayable getCurrent()

現在設定されているカレントの表示対象を返します。 MIDlet がバックグラウンドで動作している場合およびシステム・スクリーンが表示されている場合、返されるカレントの表示対象はディスプレイに表示されていない可能性があります。 カレントの表示対象が実際に表示されているかどうかは Displayable クラスの isShown() メソッドによって取得することができます。

アプリケーションの実行開始後、初めて setCurrent() メソッドによってカレントの表示対象が設定される以前にこのメソッドを呼び出すと null を返すことがあります。

戻り値:
カレントの表示対象を返します。

setCurrent

public void setCurrent(Displayable next)

渡した表示対象をカレントの表示対象としてディスプレイに表示されるように設定します。 変更した結果、直ちにディスプレイへの表示は変更されないことがあります。 次のイベント・デリバリ・メソッドが呼び出される前に変更できることは保証されていませんが、遅延してイベント・デリバリ・メソッドを呼び出す間に変更されることがあります。 このメソッドは実際にディスプレイの表示が変更される前に直ちに呼び出し元へ戻ります。 この許容される遅延のため、このメソッドの呼び出しの直後に getCurrent() メソッドの呼び出し結果が必ずしも同じ値を返すとはいえません。

setCurrent() メソッドの呼び出しはキューとして扱われません。 setCurrent() メソッドの呼び出しによって遅延した表示対象はその後の setCurrent() の呼び出しによって上書きされることがあります。 例えば、カレントの表示対象が S1 の時に

     d.setCurrent(S2);
     d.setCurrent(S3);

と記述した場合、結果として S2 をバイパスして S3 が有効となるかもしれません。

MIDlet アプリケーションが最初に起動した時、カレントの表示対象は設定されていません。 アプリケーションの責任において、常にカレントの表示対象を提供し、ユーザーインタフェースを提供しなければなりません。 従って、アプリケーションは初期化の一部として setCurrent() メソッドを呼び出してカレントの表示対象を設定すべきです。

アプリケーションによってはパラメータに null を渡すことがあるかもしれません。 これには表示対象が無効であることを示す効果はありません。 このためカレントの表示対象は変更されません。 しかし、アプリケーション管理ソフトにとっては MIDlet アプリケーションをバックグラウンドへ移行させることを要求しているヒントとして解釈することもできます。 同様にバックグラウンドのアプリケーションがフォアグラウンドに移行することを要求しているヒントと解釈することもできます。 例えば、

    d.setCurrent(d.getCurrent());

と記述しても、通常はアプリケーションがフォアグラウンドに移行することを要求する効果以外は生じないでしょう。 これらのリクエストはヒントとしてのみ扱われます。 また全てのアプリケーション管理ソフトウェアがアプリケーションがこのメソッドを呼び出すことによってリクエストに応じるというわけではありません。

もしも nextAlert オブジェクトが指定された場合、Alert による表示が終了後、以前に設定されていた表示対象がカレントの表示対象に戻されます。 つまり、setCurrent(Alert, getCurrent()) が呼び出されたような結果が得られます。 既にカレントの表示対象が Alert の場合、結果として例外が throw されることに注意が必要です。 もし、カレントの表示対象が Alert の時にアプリケーションが setCurrent() メソッドを呼び出すと、Alert はディスプレイから削除されて、Alert が設定したタイマー等は全てキャンセルされます。

システム・スクリーンが表示されている最中にアプリケーションが setCurrent() メソッドを呼び出した場合、システム・スクリーンの表示が終了するまでカレントの表示対象の変更は遅延することがあります。 実装は setCurrent() メソッドによる設定を遅延させたとしても、システム・スクリーンの影響を取り消すリクエストのように setCurrent() メソッドの呼び出しを解釈することができます。

パラメータ:
next - カレントの表示対象にするオブジェクトを渡します。

setCurrent

public void setCurrent(Alert alert,
                       Displayable nextDisplayable)

指定された Alert をカレントの表示対象とし、その表示終了後に nextDisplayable に指定された表示対象をカレントの表示対象とします。 このメソッドの呼び出しは Alert がタイマーによるものであったとしても即座に呼び出し元へ戻ります。 nextDisplayableAlert あるいは null であってはなりません。

Alert が撤去される際に Alert にデフォルト・リスナーが設定されている時にだけ、nextDisplayable への自動的な遷移が発生します。 詳細に関しては Alertコマンドとリスナーを参照してください。

上記以外の振る舞いは setCurrent(Displayable) メソッドと同等です。

パラメータ:
alert - 表示する対象の Alert オブジェクトを渡します。
nextDisplayable - Alert の次に表示する対象を渡します。
例外:
NullPointerException - alertnull の場合に throw します。
IllegalArgumentException - nextDisplayableAlert の場合に throw します。
関連項目:
Alert, getCurrent()

setCurrentItem

public void setCurrentItem(Item item)

現在この Item を含む Displayable が作成されており、この Item が目に見えるように Displayable をスクロールして、および必要に応じてフォーカスをこの Item に割り当てるという要求を行います。 最初にまるで setCurrent(Displayable) が呼ばれたかのように Item を含む Displayable をカレントにします。 Item を含む Displayable が既にカレントであるなら、必要に応じてそれをスクロールして要求された Item が目に見えるようにします。 そして実装が入力フォーカスの概念をサポートして、Item が入力フォーカスを受け入れるなら、入力フォーカスが Item に割り当てられます。

このメソッドは Displayable の切り替え、スクロールおよび入力フォーカスの割り当てを待たずに常にすぐに戻ります。

指定された Item がコンテナに含まれないならエラーです。また、ItemAlert の中に含まれるなら、それはエラーです。

パラメータ:
item - 目に見えるようにすべき Item を渡します。
例外:
IllegalStateException - もしも Item がコンテナに所持されていないか、Alert に所持されているならば throw します。
NullPointerException - itemnull ならば throw します。
導入されたバージョン:
MIDP 2.0

callSerially

public void callSerially(Runnable r)

指定された Runnable オブジェクト rrun() メソッドを、画面の再描画が終了後にそのサイクルの中ですぐに呼び出すように設定します。 Canvas クラスのイベント・デリバリで述べているように、カレントの表示対象に設定されている Canvas 上のイベント・デリバリ・メソッドと連続して呼び出されます。 run() メソッドは callSerially(Runnable) メソッドの各呼び出しに応じて正確に呼び出されます。 個々の run() メソッドの呼び出しは callSerially(Runnable) メソッドに要求された順に行われます。

このメソッドの呼び出し時に未決の修復箇所がディスプレイに存在している場合、カレントの表示対象として設定されている Canvas オブジェクトの paint() メソッドが呼び出されます。 また、ダブル・バッファリングが有効な場合は run() メソッドが呼び出される前にバッファの切り替えが行われます。 必要なときに run() メソッドへの呼び出しは行われますが、それらはディスプレイの表示内容の修復サイクル直後に、あるいは次のイベントが通知される前に呼び出すことは保証されません。

このメソッドは任意のスレッドから呼び出すことができます。 run() メソッドの呼び出しはこのメソッドの呼び出しとは無関係に発生します。 このメソッドは r.run() メソッドの呼び出しが戻るまで待ちません。

他のコールバックと同様に r.run() メソッドは迅速に処理を戻さなければなりません。 もし、長時間かかるオペレーションを実行する必要がある場合は r.run() メソッドをきっかけとして他のスレッドで処理を実行すべきです。

このメソッドは再描画サイクルと組み合わせ、アプリケーションによってアニメーションを表示するために使用することができます。 典型的なアプリケーションでは、フレームの表示終了後に次の描画のための次のフレームを用意し、Canvas クラスの repaint() メソッドを呼び出すでしょう。 その後、フレームが実際にディスプレイに表示されるまで、そのアプリケーションは待ちます。 その後、次のフレームのためのセットアップを行います。 次の r.run() メソッドが呼び出され、前のフレームをディスプレイに表示したとアプリケーションに通知します。 この目的のためにこのメソッドを使用している例を以下に示します。

    class Animation extends Canvas implements Runnable {

        void paint(Graphics g) { ... } // カレントのフレームを描画します。

        void startAnimation() {
            // 最初のフレームを準備します。
            repaint();
            callSerially(this);
        }

        void run() { // 前回の repaint 終了後に呼び出されます。
            if ( /* さらにフレームがあるなら */ ) {
                // 次のフレームを準備します。
                repaint();
                callSerially(this);
            }
        }
     }
 

パラメータ:
r - 呼び出したい Runnable オブジェクトを渡します。

flashBacklight

public boolean flashBacklight(int duration)

デバイスのバックライトにフラッシュ効果を要求します。 ユーザーの注意またはゲームのための特別な効果として引き付けるためにフラッシュ効果を使用することを意図しています。 例えば、バックライトを断続的に繰り返すことによりフラッシュ効果を出したり、繰り返して明るくしたり薄暗くしたりします。 戻り値として、アプリケーションがバックライトのフラッシュを制御することができるか否かを返します。

フラッシュ効果は要求された持続時間の間か、または要求された持続時間がゼロ(0)であるならオフになります。 このメソッドはすぐに戻ります。フラッシュ効果が発揮されている間、呼び出しをブロックしてはなりません。

フォアグラウンドに Display がある場合に限り、このメソッドは効果を発揮します。バックグラウンドに Display があるなら、このメソッドは何も動作を実行せずに false を返さなくてはなりません。

デバイスは持続時間を制限したり、変更したりするかもしれません。制御可能なバックライトを装備していないデバイスに関しては、このメソッドの呼び出しは false を返します。

パラメータ:
duration - ミリ秒単位でバックライトをフラッシュする時間、あるいはフラッシュを停止するなら 0 を渡します。
戻り値:
アプリケーションでバックライトを制御できてフォアグラウンドに Display があるなら true を、そうでなければ false を返します。
例外:
IllegalArgumentException - duration が負数の場合に throw します。
導入されたバージョン:
MIDP 2.0

vibrate

public boolean vibrate(int duration)

デバイスのバイブレータ操作を要求します。 ユーザーの注意またはゲームのための特別な効果として引き付けるためにバイブレータを使用することを意図しています。 戻り値として、アプリケーションでバイブレータを制御することができるか否かを返します。

このメソッドは、要求された持続時間の間バイブレータを動作させるか、または要求された持続時間がゼロであるならそれを停止させます。 バイブレータが前の呼び出しによってまだ動いている状態でこのメソッドが呼ばれるなら、要求は新しい持続時間を設定したものと解釈します。 それは元の要求に今回の時間を追加するとは解釈しません。 このメソッドはすぐに戻ります。バイブレータの動作中、呼び出しをブロックしてはなりません。

フォアグラウンドに Display がある場合に限り、このメソッドは効果を発揮します。バックグラウンドに Display があるなら、このメソッドは何も動作を実行せずに false を返さなくてはなりません。

デバイスは持続時間を制限したり、変更したりするかもしれません。制御可能なバイブレータを装備していないデバイスに関しては、このメソッドの呼び出しは false を返します。

パラメータ:
duration - ミリ秒単位でバイブレータを動作させる時間、あるいはバイブレータを停止するなら 0 を渡します。
戻り値:
アプリケーションでバイブレータを制御できてフォアグラウンドに Display があるなら true を、そうでなければ false を返します。
例外:
IllegalArgumentException - duration が負数の場合に throw します。
導入されたバージョン:
MIDP 2.0

getBestImageWidth

public int getBestImageWidth(int imageType)

指定されたイメージ・タイプのために最適なイメージの幅を返します。 イメージ・タイプは LIST_ELEMENTCHOICE_GROUP_ELEMENT、または ALERT のうち1つで指定します。

パラメータ:
imageType - イメージの幅を取得するためのイメージ・タイプを指定します。
戻り値:
指定されたイメージ・タイプのために最適なイメージの幅を返します。もしも最適な幅が存在しなければゼロ(0)を返しますが、負数になることはありません。
例外:
IllegalArgumentException - imageType が不正な値である場合に throw します。
導入されたバージョン:
MIDP 2.0

getBestImageHeight

public int getBestImageHeight(int imageType)

指定されたイメージ・タイプのために最適なイメージの高さを返します。 イメージ・タイプは LIST_ELEMENTCHOICE_GROUP_ELEMENT、または ALERT のうち1つで指定します。

パラメータ:
imageType - イメージの高さを取得するためのイメージ・タイプを指定します。
戻り値:
指定されたイメージ・タイプのために最適なイメージの高さを返します。もしも最適な高さが存在しなければゼロ(0)を返しますが、負数になることはありません。
例外:
IllegalArgumentException - imageType が不正な値である場合に throw します。
導入されたバージョン:
MIDP 2.0

Unofficial
"CLDC 1.1
+ MIDP 2.0"
API Reference.
(日本語版)

公式仕様書原文の著作権表記等(※):

Mobile Information Device Profile Specification ("Specification")
Version: 2.0
Status: FCS
Release: November 5, 2002

Copyright 2002 Sun Microsystems, Inc. and Motorola, Inc.
All rights reserved.
※ただしこの API リファレンスは英語仕様を一語一句正確に翻訳したものではなく、一度私が英語の仕様原文を読んだ上で元の意味と構造をなるべく保つように書き起こしたものです。このため一部は完全に異なる説明となっています。また CLDC 1.1 部分は同仕様の範囲外であるため、まったく参考とはしていません。

※仕様書のライセンス上、問題は無いと考えておりますが、万が一問題があるとお考えの関係者の方がいらっしゃいましたらメールにて連絡をいただけると幸いに存じます(第一言語に日本語、第二言語に英語を希望しますが、返信は基本的に日本語で行います)。

この API リファレンスは仕様書の日本語版という位置づけでは作成していませんし、仕様書ほど厳格でもありません。MUST、SHOULD、MAY などの仕様の条件を強調する文を維持していません(反映すらしていない個所もあります)。仮想マシンおよび MIDP の実装のために使用することは避けてください。そのような用途には必ず公式仕様書原文そのものを用いるべきです。
この API リファレンスに記載されている内容は"さかきけい"が Sun Microsystems, Inc や Motorola, Inc、Java Community Process が公開している各種公式資料を元に、独自に調査・編集したものであり、Sun Microsystems, Inc や Motorola, Inc、Java Community Process 等とは一切関係ありません。したがってこの API リファレンスに関する問い合わせを関係各社等に対して行うことを固く禁じます。
また、記載された内容には既知か否かに関らず誤りが含まれる可能性があり、一切保証はありません。本 API リファレンスを使用した結果、不利益が生じたとしても"さかきけい"は一切の責任を負いません。
許可無く公開/非公開および Internet/Intranet/LAN を問わず他サイトに転載すること、複写および複製すること、ローカル・ファイル等に保存することを禁じます。


Copyright© 2001-2002,2005-2009,2011 by KEI SAKAKI.
ALL RIGHTS RESERVED.
無断転載を禁じます。

Unofficial "CLDC 1.0 + MIDP 1.0" API Reference はこちらです。