com.nttdocomo.ui
クラス Frame

Object
  com.nttdocomo.ui.Frame

直系の既知のサブクラス:

Canvas, Dialog, Panel

public abstract class Frame

extends Object

アプリケーションの表示面を提供します。 フレーム クラスは、 スクリーンに表示されるオブジェクトが持つべきインタフェースを定めます。

イベントはこのクラスのサブクラスのインスタンスに通知されます。 ただし、表示状態でないフレームのサブクラスのインスタンスには、 イベントは通知されません。

導入されたバージョン:

DoJa-1.0, DoJa-1.5OE

フィールドの概要

static int	SOFT_KEY_1 ソフトキー1 (=0)。
static int	SOFT_KEY_2 ソフトキー2 (=1)。

コンストラクタの概要

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

メソッドの概要

int	getHeight() フレームの高さを取得します。
int	getWidth() フレームの幅を取得します。
void	setBackground(int c) 背景色を設定します。
void	setSoftLabel(int key, String label) ソフトキーのラベル文字列を設定します。
void	setSoftLabelVisible(boolean b) [iアプリオプションAPI] ソフトキーのラベルを表示するかどうかを設定します。

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

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

フィールドの詳細

SOFT_KEY_1

public static final int SOFT_KEY_1

ソフトキー1 (=0)。 ソフトキー1は、左側のソフトキーです。setSoftLabel(int, String)メソッドで ソフトキー1のラベルを設定するときに使用します。 ソフトキーリスナで引数で渡されるソフトキー番号は、この値が使われます。

関連項目:

定数フィールド値

SOFT_KEY_2

public static final int SOFT_KEY_2

ソフトキー2 (=1)。 ソフトキー2は、右側のソフトキーです。setSoftLabel(int, String)メソッドで ソフトキー2のラベルを設定する場合に使用します。 ソフトキーリスナで引数で渡されるソフトキー番号は、この値が使われます。

関連項目:

定数フィールド値

コンストラクタの詳細

Frame

public Frame()

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

メソッドの詳細

getWidth

public final int getWidth()

フレームの幅を取得します。

戻り値:

フレームの幅をピクセル単位で返します。

getHeight

public final int getHeight()

フレームの高さを取得します。

戻り値:

フレームの高さをピクセル単位で返します。

setBackground

public void setBackground(int c)

背景色を設定します。 GraphicsクラスのclearRect メソッドは、ここで設定された色を使用して矩形を塗りつぶします。 デフォルトでは機種依存の色が設定されています。

パラメータ:

c - 背景色を表す整数値を指定します。

例外:

IllegalArgumentException - 引数 c に不正な値が指定された場合に発生します。

関連項目:

Graphics.clearRect(int, int, int, int)

setSoftLabel

public void setSoftLabel(int key,
                         String label)

ソフトキーのラベル文字列を設定します。 設定したラベル文字列は、このフレームがカレントフレームになったときに、 ソフトキーのラベル文字列を表示する位置に自動的に設定されます。 なお、このフレームがカレントフレームのとき、 このメソッドによってラベル文字列を変更した場合は、即時に表示が変更されます。

パラメータ:

key - ラベル文字列を設定するソフトキーの番号を指定します。 SOFT_KEY_1, SOFT_KEY_2 のいずれかを指定します。

label - ラベル文字列を指定します。nullを指定した場合は、ソフトキーのラベル文字列を表示しません。 空文字列("")が指定された場合は、空文字列("")のラベルを表示します。

例外:

IllegalArgumentException - 引数 key に不正な値が指定された場合に発生します。

setSoftLabelVisible

public void setSoftLabelVisible(boolean b) [iアプリオプションAPI]

ソフトキーのラベルを表示するかどうかを設定します。

デフォルトではソフトキーは表示されます。 iアプリはソフトキーの表示・非表示中に関わらずソフトキーイベントを受け取ることが可能です。

現在のソフトキーの表示・非表示の設定と同じ設定でこのメソッドを実行しても無視されます。

待ち受け非活性化中にこのメソッドが呼ばれた場合、 即座には反映されず、活性化時に最新の設定が反映されます。

i アプリの全画面表示をサポートしない端末では、このメソッドは未サポートです。 また、i アプリの全画面表示をサポートする端末では、通常画面にて表示中・ 全画面モードにて表示中に関わらず、このメソッドにてソフトキーの表示・ 非表示を設定することができます。

このメソッドにて設定するソフトキーの表示・非表示は i アプリ内のソフトキーについてです。 FEP 起動、ネイティブで表示するソフトキーについては対象外です。

パラメータ:

b - ソフトキーを表示する場合は true, 表示しない場合は false を指定します。

例外:

UnsupportedOperationException - 端末がこのメソッドをサポートしていない場合に発生します。

導入されたバージョン:

DoJa-5.0 (903i)