com.docomostar.ui
クラス Frame

Object
  com.docomostar.ui.Frame

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

Canvas, Dialog, FlashPlayerPane, Panel

public abstract class Frame
extends Object

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

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

導入されたバージョン:

Star-1.0

フィールドの概要

static int	ARROW_DOWN 下方向キー (=0x08)。
static int	ARROW_LEFT 左方向キー (=0x01)。
static int	ARROW_RIGHT 右方向キー (=0x04)。
static int	ARROW_UP 上方向キー (=0x02)。
static int	SELECT_KEY 決定キー (=4)。
static int	SOFT_KEY_1 ファンクションキー1 (=0)。
static int	SOFT_KEY_2 ファンクションキー2 (=1)。
static int	SOFT_KEY_3 ファンクションキー3 (=2)。
static int	SOFT_KEY_4 ファンクションキー4 (=3)。

コンストラクタの概要

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

メソッドの概要

int	getHeight() フレームの高さを取得します。
int	getWidth() フレームの幅を取得します。
void	setBackground(int c) 背景色を設定します。
void	setSoftArrowLabel(int key) 上下左右キーの上下左右矢印の表示を設定します。
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のラベルを設定する場合に使用します。 ファンクションキーリスナで引数で渡される ファンクションキー番号は、この値が使われます。

関連項目:

定数フィールド値

SOFT_KEY_3

public static final int SOFT_KEY_3

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

関連項目:

定数フィールド値

SOFT_KEY_4

public static final int SOFT_KEY_4

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

関連項目:

定数フィールド値

SELECT_KEY

public static final int SELECT_KEY

決定キー (=4)。 setSoftLabel(int, String)メソッドで決定キーのラベルを設定する場合に使用します。

関連項目:

定数フィールド値

ARROW_LEFT

public static final int ARROW_LEFT

左方向キー (=0x01)。 setSoftArrowLabel(int) メソッドで左矢印の表示を設定する場合に使用します。

関連項目:

定数フィールド値

ARROW_UP

public static final int ARROW_UP

上方向キー (=0x02)。 setSoftArrowLabel(int) メソッドで上矢印の表示を設定する場合に使用します。

関連項目:

定数フィールド値

ARROW_RIGHT

public static final int ARROW_RIGHT

右方向キー (=0x04)。 setSoftArrowLabel(int) メソッドで右矢印の表示を設定する場合に使用します。

関連項目:

定数フィールド値

ARROW_DOWN

public static final int ARROW_DOWN

下方向キー (=0x08)。 setSoftArrowLabel(int) メソッドで下矢印の表示を設定する場合に使用します。

関連項目:

定数フィールド値

コンストラクタの詳細

Frame

public Frame()

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

メソッドの詳細

getWidth

public final int getWidth()

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

戻り値:

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

getHeight

public final int getHeight()

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

戻り値:

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

setBackground

public void setBackground(int c)

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

パラメータ:

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

関連項目:

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

例外:

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

setSoftLabel

public void setSoftLabel(int key,
                         String label)

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

ミニアプリ実行中においても、 常にこのメソッドにてファンクションキー、決定キーのラベルの文字列を設定できます。 しかし、設定したラベル文字列が実際に画面に反映されるか否かは、 下記表のようにミニアプリの表示状態によって変わります。

	Focused状態 Unfocused状態	Selected 状態
ファンクションキー1	×	○
ファンクションキー2	×	○
ファンクションキー3	×	×
ファンクションキー4	×	×
決定キー	×	○

[凡例] ○：反映される、×：反映されない

パラメータ:

key - ラベル文字列を設定するファンクションキーおよび決定キーの番号を指定します。 SOFT_KEY_1, SOFT_KEY_2, SOFT_KEY_3, SOFT_KEY_4, SELECT_KEY のいずれかを指定します。

label - ラベル文字列を指定します。指定したラベル文字列が表示可能な文字数を超えた場合、超過した部分は無視されます。 nullを指定した場合は、ファンクションキーおよび決定キーのラベル文字列を表示しません。 空文字列("")が指定された場合は、空文字列("")のラベルを表示します。

例外:

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

setSoftLabelVisible

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

ファンクションキー／決定キー／上下左右キーを表示するかどうかを設定します。

引数に true が指定された場合、setSoftLabel(int,String) メソッドで設定したファンクションキー、決定キーのラベルおよび setSoftArrowLabel(int) で設定した上下左右キーの矢印が表示されます。 引数に false が指定された場合、setSoftLabel(int,String) メソッドおよび setSoftArrowLabel(int) メソッドによる設定に関わらず、ファンクションキー／決定キー／上下左右キーは非表示になります。

デフォルトでは、trueが設定されています。 Star アプリはファンクションキーの表示・非表示中に関わらずファンクションキーイベントを受け取ることが可能です。

現在のファンクションキー／決定キー／上下左右キーの表示・非表示の設定と同じ設定でこのメソッドを実行しても無視されます。

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

このメソッドにて設定するファンクションキー／決定キー／上下左右キーの表示・非表示は Star アプリ内のファンクションキー／決定キー／上下左右キーについてです。 FEP 起動、ネイティブで表示するファンクションキー／決定キー／上下左右キーについては対象外です。

パラメータ:

b - ファンクションキー／決定キー／上下左右キーを表示する場合は true, 表示しない場合は false を指定します。

例外:

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

IllegalStateException -
ミニアプリ実行時に呼び出された場合に発生します。

setSoftArrowLabel

public void setSoftArrowLabel(int key)

上下左右キーの上下左右矢印の表示を設定します。

各矢印の表示状態は、引数の各ビットに対応しています。 表示の場合は1、非表示の場合は0です。 未規定のビットは無視されます。
デフォルトでは、全ての方向が非表示です。

このフレームがカレントフレームのとき、 このメソッドによって設定を変更した場合は、即時に表示が変更されます。

setSoftLabelVisible(boolean) メソッドによりファンクションキー／決定キー／上下左右キーを非表示に設定されている場合、このメソッドを呼び出しても上下左右矢印は表示しません。 このとき、このメソッドで設定した上下左右矢印の表示状態は保持しています。

ミニアプリ実行中においても、常にこのメソッドにて上下左右矢印の表示を設定できます。 しかし、設定した矢印表示が実際に画面に反映されるか否かは、 ミニアプリの表示状態によって変わります。 具体的には、ミニアプリが Focused 状態、Unfocused 状態のときには反映されませんが、 Selected 状態のときには反映されます。

パラメータ:

key - 表示する矢印を指定します。 上下左右はそれぞれ、ARROW_UP、ARROW_DOWN、ARROW_LEFT、ARROW_RIGHT で指定します。 複数の矢印を表示する場合、定数フィールド値の論理和を指定します。 例えば上下キーのみを表示する場合は、引数は ARROW_UP | ARROW_DOWN で指定します。