org.eclipse.swt.widgets
Class MessageBox
java.lang.Object
|
+--org.eclipse.swt.widgets.Dialog
|
+--org.eclipse.swt.widgets.MessageBox
- public class MessageBox
- extends Dialog
Unsafe: Instances of this class are used used to inform or warn the user.
- Styles:
- ICON_ERROR, ICON_INFORMATION, ICON_QUESTION, ICON_WARNING, ICON_WORKING
- OK, OK | CANCEL
- YES | NO, YES | NO | CANCEL
- RETRY | CANCEL
- ABORT | RETRY | IGNORE
- Events:
- (none)
Note: Only one of the styles ICON_ERROR, ICON_INFORMATION, ICON_QUESTION,
ICON_WARNING and ICON_WORKING may be specified.
IMPORTANT: This class is intended to be subclassed only
within the SWT implementation.
Field Summary
Fields inherited from class org.eclipse.swt.widgets.Dialog
Constructor Summary
MessageBox(Shell parent)
Enabled: Constructs a new instance of this class given only its
parent.
MessageBox(Shell parent,
int style)
Enabled: Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.
Method Summary
(package private) static int
checkStyle(int style)
String
getMessage()
Enabled: Returns the dialog's message, which is a description of
the purpose for which it was opened.
int
open()
Enabled: Makes the dialog visible and brings it to the front
of the display.
void
setMessage(String string)
Enabled: 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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
message
String message
Constructor Detail
MessageBox
public MessageBox(Shell parent)
- Enabled: Constructs a new instance of this class given only its
parent.
Note: Currently, null can be passed in for the parent.
This has the effect of creating the dialog on the currently active
display if there is one. If there is no current display, the
dialog is created on a "default" display. Passing in null as
the parent is not considered to be good coding style,
and may not be supported in a future release of SWT.
- Parameters:
parent - a shell which will be the parent of the new instance
MessageBox
public MessageBox(Shell parent,
int style)
- Enabled: 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.
Note: Currently, null can be passed in for the parent.
This has the effect of creating the dialog on the currently active
display if there is one. If there is no current display, the
dialog is created on a "default" display. Passing in null as
the parent is not considered to be good coding style,
and may not be supported in a future release of SWT.
- Parameters:
parent - a shell which will be the parent of the new instance
Method Detail
checkStyle
static int checkStyle(int style)
-
getMessage
public String getMessage()
- Enabled: 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
open
public int open()
- Enabled: Makes the dialog visible and brings it to the front
of the display.
- Returns:
- the ID of the button that was selected to dismiss the
message box (e.g. SWT.OK, SWT.CANCEL, etc...)
setMessage
public void setMessage(String string)
- Enabled: 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