javax.microedition.lcdui
クラス Alert

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

public class Alert
extends Screen

このクラスはユーザーに対して情報、警告、エラー等の情報を表示する機能を提供します。 提示する情報は文字列によるメッセージとイメージが指定できます。 表示方法は一定期間の表示後に次に表示するスクリーンに切り替える方法と、期間無制限に表示を行いユーザーのアクションによって次の表示へ移行する方法の２種類あります。

Alert の表示中に MIDlet アプリケーションがメッセージ文字列あるいはイメージを変更した場合、自動的に表示中のメッセージおよびイメージは変更されます。 MIDlet アプリケーションは表示を更新するために処理を記述する必要はありません。

表示する期間は setTimeout(int) メソッドで指定します。 このメソッドに FOREVER を渡すと期間無制限での表示となります。

表示する Alert の種類は AlertType によって指定します。 AlertType には定義済みのオブジェクトが用意されています。

実装によっては Alert を表示する際に、ユーザーの注意を引くために特定の効果音を鳴らす場合があります。 これは AlertType クラスの playSound(Display) メソッドによって提供されます。 詳しくはこのメソッドの説明を参照してください。

Alert は他の Screen と異なり、MIDlet アプリケーションが定義した Command を取り扱うことはできません。 関連するメソッドを呼び出すと IllegalStateException を throw します。

関連項目:

AlertType

FOREVER

public static final int FOREVER

期間無期限で Alert を表示することを示す定数（=-2）です。 この指定を行った場合、ユーザーがアクションを起こすまで Alert は表示されつづけます。

関連項目:

setTimeout(int), 定数フィールド値

Alert

public Alert(String title)

指定されたタイトルを持った空の Alert オブジェクトを構築します。 title に null が指定された場合、タイトルは指定されなかったものとして処理を行います。

このコンストラクタの呼び出しは以下の記述と等価です。

     Alert(title, null, null, null);

パラメータ:

title - 設定するタイトル文字列あるいは null を渡します。

関連項目:

Alert(String, String, Image, AlertType)

Alert

public Alert(String title,
             String alertText,
             Image alertImage,
             AlertType alertType)

指定されたタイトル、メッセージ文字列、イメージおよび AlertType を設定した Alert オブジェクトを構築します。 メッセージ文字列および Image の表示レイアウトは実装に依存します。 デフォルトの表示期間は getDefaultTimeout() が返すのと等価の設定がなされます。

表示する Alert の種類は alertType に渡される AlertType オブジェクトによって決定されます。

alertImage に渡す Image オブジェクトは不変タイプでなければなりません。

各パラメータのオブジェクトには null を指定することができます。 この場合、null が指定されたパラメータを持たないオブジェクトを構築します。

パラメータ:

title - タイトル文字列あるいは null を渡します。

alertText - メッセージ文字列あるいは null を渡します。

alertImage - 表示する Image オブジェクトあるいは null を渡します。

alertType - 構築する Alert の種類を決める AlertType オブジェクトあるいは null 渡します。

例外:

IllegalArgumentException - alertImage に可変タイプの Image オブジェクトが渡された場合に throw します。

関連項目:

AlertType.INFO, AlertType.WARNING, AlertType.ERROR, AlertType.ALARM, AlertType.CONFIRMATION

getDefaultTimeout

public int getDefaultTimeout()

この実装における Alert オブジェクトのデフォルト表示期間をミリ秒単位で返します。 返される値は正数あるいは FOREVER と等価の値です。

戻り値:

デフォルトの表示期間がミリ秒単位で、あるいは FOREVER を返します。

関連項目:

FOREVER, getTimeout(), setTimeout(int)

getTimeout

public int getTimeout()

この Alert オブジェクトに設定されている表示期間をミリ秒単位で返します。 返される値は正数あるいは FOREVER と等価の値です。

戻り値:

設定されている表示期間がミリ秒単位で、あるいは FOREVER を返します。

関連項目:

FOREVER, getDefaultTimeout(), setTimeout(int)

setTimeout

public void setTimeout(int time)

この Alert の表示期間をミリ秒単位で設定します。

表示期間として設定できる値は正数あるいは FOREVER 定数のいずれかです。

パラメータ:

time - 設定する表示期間あるいは FOREVER 定数を渡します。

例外:

IllegalArgumentException - time に正数でなく、FOREVER 定数でもない値を渡した場合に throw します。

関連項目:

FOREVER, getDefaultTimeout(), getTimeout()

getType

public AlertType getType()

設定されているタイプ（AlertType オブジェクト）を返します。 この Alert オブジェクトに AlertType が設定されていない場合は null を返します。

戻り値:

設定されている AlertType オブジェクトあるいは null を返します。

関連項目:

setType(javax.microedition.lcdui.AlertType)

setType

public void setType(AlertType type)

新しいタイプ（AlertType オブジェクト）を設定します。 表示する Alert の種類は type によって渡される AlertType オブジェクトによって決定されます。 現在設定されているタイプを削除する場合は null を渡します。

パラメータ:

type - 設定する AlertType オブジェクトあるいは null を渡します。

関連項目:

getType(), AlertType.INFO, AlertType.WARNING, AlertType.ERROR, AlertType.ALARM, AlertType.CONFIRMATION

getString

public String getString()

設定されているメッセージ文字列を返します。 この Alert オブジェクトにメッセージが設定されていない場合は null を返します。

戻り値:

設定されているメッセージ文字列あるいは null を返します。

setString

public void setString(String str)

表示するメッセージ文字列を設定します。 現在設定されているメッセージ文字列を削除する場合は null を渡します。

パラメータ:

str - 設定するメッセージ文字列あるいは null を渡します。

getImage

public Image getImage()

設定されている Image オブジェクトを返します。 Image オブジェクトが設定されていない場合は null を返します。

戻り値:

設定されている Image オブジェクトあるいは null を返します。

setImage

public void setImage(Image img)

表示する Image オブジェクトを設定します。 現在設定されている Image オブジェクトを削除する場合は null を渡します。

表示する Image オブジェクトは不変タイプでなければなりません。

パラメータ:

img - 表示する Image オブジェクトあるいは null を渡します。

例外:

IllegalArgumentException - img が可変タイプであった場合に throw します。

addCommand

public void addCommand(Command cmd)

Alert クラスはアプリケーションによる Command の設定を受け付けません。 このメソッドを呼び出すと常に IllegalStateException を throw します。

オーバーライド:

クラス Displayable 内の addCommand

パラメータ:

cmd - 設定する Command オブジェクトを渡します。

例外:

IllegalStateException - Alert クラスでは常に throw します。

setCommandListener

public void setCommandListener(CommandListener l)

Alert クラスはアプリケーションによる CommandListener の設定を受け付けません。 このメソッドを呼び出すと常に IllegalStateException を throw します。

オーバーライド:

クラス Displayable 内の setCommandListener

パラメータ:

l - 設定する CommandListener オブジェクトを渡します。

例外:

IllegalStateException - Alert クラスでは常に throw します。