javax.microedition.lcdui
クラス Displayable

java.lang.Object
  javax.microedition.lcdui.Displayable

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

Canvas, Screen

public abstract class Displayable
extends Object

ディスプレイに表示することができる能力をもつクラスです。 Displayable オブジェクトはコマンドやリスナーの管理を行う機能を持っています。 ディスプレイへの表示内容およびユーザーインタフェースとの相互作用はサブクラスによって定義されます。

タイトル文字列は改行を含むことができます。 タイトル文字列の表示はそれに従って改行しなければなりません。 例えば、一行のみをタイトルに使用可能であり、文字列が改行を含んでいるなら、改行までのキャラクタだけを表示します。

別の定義がサブクラスによって指定されない場合、新たに作成された Displayable オブジェクトのデフォルト状態は以下の通りです：

• それは Display に表示されません。
• この Displayable に関連するいかなる Ticker も存在しません。
• タイトルは null です。
• どのような Command も提供されません。
  そして
• どのような CommandListener も提供されません。

導入されたバージョン:

MIDP 1.0

getTitle

public String getTitle()

Displayable のタイトルを取得します。 タイトルが設定されていなければ null を返します。

戻り値:

タイトルのインスタンス、あるいはタイトルがなければ null を返します。

導入されたバージョン:

MIDP 2.0

関連項目:

setTitle(java.lang.String)

setTitle

public void setTitle(String s)

Displayable にタイトルを設定します。 null が指定された場合はタイトルを削除します。

Displayable が実際にディスプレイに表示されているなら、更新することが可能になり次第すぐに実装は表示を更新すべきです。

タイトルの存在は Displayable の内容が使用可能な領域のサイズに影響することがあります。 実行時のタイトル・テキストの追加、削除、または設定が動的に内容領域のサイズを変更するかもしれません。 Canvas クラスを使用するとき、これに気づいていることはとても重要です。 使用可能な領域が変化すると、sizeChanged() を呼び出してアプリケーションに通知します。

パラメータ:

s - 新しいタイトル、またはタイトルがない場合は null を渡します。

導入されたバージョン:

MIDP 2.0

関連項目:

getTitle()

setTicker

public void setTicker(Ticker ticker)

以前の全ての Ticker と置き換えて、この Displayable で使用するための Ticker を設定します。 null が指定された場合は Ticker を削除します。 同じ Ticker をアプリケーションの中の複数の Displayable オブジェクトによって共有することができます。 複数の異なる Displayable オブジェクト上に同じ Ticker オブジェクトがある状態で setTicker() を呼ぶことによって、これを行います。 Displayable が実際にディスプレイに表示されているなら、実装は表示の更新が可能になり次第すぐにそれを実施すべきです。

Ticker の存在は Displayable の内容が使用可能な領域のサイズに影響することがあります。 実行時の Ticker の追加、削除、または設定が動的に内容領域のサイズを変更するかもしれません。 Canvas クラスを使用するとき、これに気づいていることはとても重要です。 使用可能な領域が変化すると、sizeChanged() を呼び出してアプリケーションに通知します。

パラメータ:

ticker - このスクリーンで使用する Ticker オブジェクトを渡します。

導入されたバージョン:

MIDP 2.0

関連項目:

getTicker()

getTicker

public Ticker getTicker()

この Displayable で使用している Ticker を取得します。

戻り値:

使用している Ticker オブジェクト、または Ticker が使用されていなければ null を返します。

導入されたバージョン:

MIDP 2.0

関連項目:

setTicker(javax.microedition.lcdui.Ticker)

isShown

public boolean isShown()

この表示対象がディスプレイに表示されているか否かを返します。 以下の条件を全て満たす場合に表示されると判定します。

• MIDlet アプリケーションがフォアグラウンドで動作している。
• カレントの表示対象に設定されている。
• システム・スクリーンが表示されていない。

戻り値:

表示されている場合は true を、そうでなければ false を返します。

addCommand

public void addCommand(Command cmd)

Command をこの表示対象に追加します。 そのコマンドを実装はソフト・ボタンに割り当てるかもしれないし、メニューに割り当てるかもしれません。 追加対象のコマンドが既にこの表示対象に存在している場合（オブジェクトを比較した結果が一致するものがある場合）は何も処理を行いません。 表示対象がディスプレイに実際に表示されており、コマンドの追加が表示内容に変化を生じさせる場合、実装は直ちに表示内容を更新すべきです。

パラメータ:

cmd - 追加するコマンドを渡します。

例外:

NullPointerException - cmd に null が渡された場合に throw します。

removeCommand

public void removeCommand(Command cmd)

この表示対象から Command を削除します。 削除対象のコマンドがこの表示対象に存在していない場合は何も処理を行いません。 表示対象がディスプレイに実際に表示されており、コマンドの削除が表示内容に変化を生じさせる場合、実装は直ちに表示内容を更新すべきです。 cmd が null ならばこのメソッドは何もしません。

パラメータ:

cmd - 削除するコマンドを渡します。

setCommandListener

public void setCommandListener(CommandListener l)

Command を受け取るリスナーを設定します。 以前にリスナーが設定されていた場合、新しいリスナーと置き換えます。 リスナーとして null を渡すと、登録されているリスナーを削除します。

パラメータ:

l - 登録するリスナーあるいは null を渡します。

getWidth

public int getWidth()

アプリケーションで使用可能な表示可能領域の幅をピクセル数で取得します。 返す値は特定の Displayable サブクラスに最適です。 この値は、デバイスがどのように表示を行うかに依存していて、タイトル、Ticker、または Command の存在に影響されるかもしれません。 Displayable がまだ表示されていなくても、このメソッドは常に適切な結果を返します。

戻り値:

アプリケーションで使用可能な領域の幅を返します。

導入されたバージョン:

MIDP 2.0

getHeight

public int getHeight()

アプリケーションで使用可能な表示可能領域の高さをピクセル数で取得します。 返す値は特定の Displayable サブクラスに最適です。 この値は、デバイスがどのように表示を行うかに依存していて、タイトル、Ticker、または Command の存在に影響されるかもしれません。 Displayable がまだ表示されていなくても、このメソッドは常に適切な結果を返します。

戻り値:

アプリケーションで使用可能な領域の高さを返します。

導入されたバージョン:

MIDP 2.0

sizeChanged

protected void sizeChanged(int w,
                           int h)

Displayable の使用可能な領域が変更された時に実装はこのメソッドを呼び出します。 "使用可能な領域"は Form の Item や Canvas 内のグラフィックスのようなアプリケーションの内容によって占有することができる表示領域です。 それはタイトル、Ticker、Command ラベル、スクロール・バー、システム・ステータス領域などによって占有されるスペースを含みません。 サイズの変化は、これらの表示機能のどれかの追加、削除、または内容が変更された結果、発生します。

Displayable が初めて表示される前にこのメソッドは少なくとも一度呼び出されます。 それが表示されている時に Displayable のサイズが変化すると sizeChanged は呼び出されるでしょう。 それが表示されていない時に Displayable のサイズが変化するなら、sizeChanged の呼び出しは延期されるかもしれません。 Displayable が表示されていない時にサイズが変化したなら、Displayable がもう一度表示される時に sizeChanged は少なくとも１度呼び出されるでしょう。

Displayable でのこのメソッドのデフォルト実装と、この仕様に基づき定義されたそのサブクラスのデフォルト実装は空であるに違いありません。 このメソッドは、唯一アプリケーションでオーバーライドされることを意図しています。 アプリケーションは Displayable の直接のサブクラスを作成することは禁止されていますが、このメソッドは Displayable で定義されています。 これは、アプリケーションが Canvas と Form のサブクラスでそれをオーバーライドすることができるように、ここで定義されます。 Canvas サブクラスがそれらのグラフィックスをあわせたり、Form が使用可能な表示領域内にそれらの内容にあわせて Item サイズとレイアウト指示を変更したりするためにこれが役立ちます。

パラメータ:

w - 使用可能な領域の新しい幅のピクセル数が渡されます。

h - 使用可能な領域の新しい高さのピクセル数が渡されます。

導入されたバージョン:

MIDP 2.0