File Doc Category Size Date Package
AlertType.java API Doc J2ME MIDP 2.0 4724 Thu Nov 07 12:02:26 GMT 2002 javax.microedition.lcdui

AlertType

java.lang.Object

public class AlertType extends Object

The AlertType provides an indication of the nature of alerts. Alerts are used by an application to present various kinds of information to the user. An AlertType may be used to directly signal the user without changing the current Displayable. The playSound method can be used to spontaneously generate a sound to alert the user. For example, a game using a Canvas can use playSound to indicate success or progress. The predefined types are INFO, WARNING, ERROR, ALARM, and CONFIRMATION.

see: Alert
since: MIDP 1.0

Fields Summary
static final int
ALERT_INFO
Information Alert identifier
static final int
ALERT_WARN
Warning Alert identifier
static final int
ALERT_ERR
Error Alert identifier
static final int
ALERT_ALRM
Alarm Alert identifier
static final int
ALERT_CFM
Confirmation Alert identifier
public static final AlertType
INFO
An INFO AlertType typically provides non-threatening information to the user. For example, a simple splash screen might be an INFO AlertType.
public static final AlertType
WARNING
A WARNING AlertType is a hint to warn the user of a potentially dangerous operation. For example, the warning message may contain the message, "Warning: this operation will erase your data."
public static final AlertType
ERROR
An ERROR AlertType is a hint to alert the user to an erroneous operation. For example, an error alert might show the message, "There is not enough room to install the application."
public static final AlertType
ALARM
An ALARM AlertType is a hint to alert the user to an event for which the user has previously requested to be notified. For example, the message might say, "Staff meeting in five minutes."
public static final AlertType
CONFIRMATION
A CONFIRMATION AlertType is a hint to confirm user actions. For example, "Saved!" might be shown to indicate that a Save operation has completed.
private int
type
The type of this AlertType
Constructors Summary
protected AlertType()
Protected constructor for subclasses.
AlertType(int type)
Create a new AlertType given the type identifier
param
type The type of the new AlertType
this.type = type;
Methods Summary
int getType()
Get the type of this AlertType
return
int The typer identifer of this AlertType, one of: ALERT_INFO, ALERT_WARN, ALERT_ERR, ALERT_ALRM, ALERT_CFM
return this.type;
public boolean playSound(Display display)
Alert the user by playing the sound for this AlertType. The AlertType instance is used as a hint by the device to generate an appropriate sound. Instances other than those predefined above may be ignored. The actual sound made by the device, if any, is determined by the device. The device may ignore the request, use the same sound for several AlertTypes or use any other means suitable to alert the user.
param
display to which the AlertType's sound should be played.
return
true if the user was alerted, false otherwise.
throws
NullPointerException if display is null
synchronized (Display.LCDUILock) { return display.playAlertSound(this); }