org.eclipse.ercp.swt.mobile
Class TimedMessageBox

java.lang.Object
  org.eclipse.swt.widgets.Dialog
      org.eclipse.ercp.swt.mobile.TimedMessageBox

public class TimedMessageBox

extends Dialog

A modal window used to shortly inform the user of limited information using a standard style.

A TimedMessageBox is capable of closing itself automatically after a certain period of time. There is no need to define button styles for TimedMessageBox.

Unlike TaskTip, the TimedMessageBox is a modal dialog and execution will be blocked until the dialog is closed after a short period of time. The exact time-out duration is implementation dependent. Applications can not change the period of time.

Styles:

ICON_WORKING: informs that an action was successful

ICON_INFORMATION: informs of a situation that may not require user action

ICON_WARNING: informs of a situation that may require user intervention

ICON_ERROR: informs that a serious situation occurred

Events:

(none)

IMPORTANT: This class is not intended to be subclassed.

Constructor Summary

TimedMessageBox(Shell parent)
Constructs a new instance of this class given only its parent.

TimedMessageBox(Shell parent, int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Image	getImage() Returns the icon object.
java.lang.String	getMessage() Returns the dialog's message, which is a description of the purpose for which it was opened.
void	open() Makes the dialog visible and brings it to the front of the display.
void	setImage(Image image) Sets the receiver's icon to the argument.
void	setMessage(java.lang.String string) Sets the dialog's message, which is a description of the purpose for which it was opened.

Methods inherited from class org.eclipse.swt.widgets.Dialog

checkSubclass, getParent, getStyle, getText, setText

Methods inherited from class java.lang.Object

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

Constructor Detail

TimedMessageBox

public TimedMessageBox(Shell parent)

Constructs a new instance of this class given only its parent.

Parameters:

parent - a shell which will be the parent of the new instance

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent

TimedMessageBox

public TimedMessageBox(Shell parent,
                       int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR 'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a shell which will be the parent of the new instance

style - the style of control to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

Method Detail

getImage

public Image getImage()

Returns the icon object.

Returns:

Image the icon reference. May by null if the implementation does not support custom icons, or has no way to get the image object.

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getMessage

public java.lang.String getMessage()

Returns the dialog's message, which is a description of the purpose for which it was opened. This message will be visible on the dialog while it is open.

Returns:

the message

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

open

public void open()

Makes the dialog visible and brings it to the front of the display.

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the dialog

setImage

public void setImage(Image image)

Sets the receiver's icon to the argument. The argument cannot be null.

Parameters:

image - the image to display on the receiver.

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the image is null
• ERROR_INVALID_ARGUMENT - if the image has been disposed

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setMessage

public void setMessage(java.lang.String string)

Sets the dialog's message, which is a description of the purpose for which it was opened. This message will be visible on the dialog while it is open.

Parameters:

string - the message

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the string is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver