Package org.eclipse.swt.widgets

Class MessageBox

java.lang.Object
org.eclipse.swt.widgets.Dialog
org.eclipse.swt.widgets.MessageBox
All Implemented Interfaces:
Adaptable
public class MessageBox extends Dialog
Instances of this class are 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.

Since:
1.2

  • Constructor Details

    • MessageBox

      public MessageBox(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:
      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

    • MessageBox

      public MessageBox(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 dialog to construct
      Throws:
      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 Details

    • getMessage

      public String getMessage()
      Returns the dialog's message, or an empty string if it does not have one. The message is a description of the purpose for which the dialog was opened. This message will be visible in the dialog while it is open.
      Returns:
      the message

    • setMessage

      public void setMessage(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:
      IllegalArgumentException -
      • ERROR_NULL_ARGUMENT - if the string is null

    • setMarkupEnabled

      public void setMarkupEnabled(boolean markupEnabled)
      Controls whether the use of markup in message is enabled. Once the markup in message is enabled it's not possible to disable it.
      Parameters:
      markupEnabled - true to enable the markup in message
      Since:
      3.2

    • open

      public int open()
      Makes the dialog visible and brings it to the front of the display.

      RAP Note: This method is not supported when running the application in JEE_COMPATIBILITY mode. Use Dialog#open(DialogCallback) instead.

      Returns:
      the ID of the button that was selected to dismiss the message box (e.g. SWT.OK, SWT.CANCEL, etc.)
      Throws:
      SWTException -
      • ERROR_WIDGET_DISPOSED - if the dialog has been disposed
      • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the dialog
      UnsupportedOperationException - when running the application in JEE_COMPATIBILITY mode
      See Also:

    • prepareOpen

      protected void prepareOpen()
      Overrides:
      prepareOpen in class Dialog