Eclipse Plug-in Developer Guide (Galileo) - MessageDialog (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.dialogs
Class MessageDialog


java.lang.Object
  

org.eclipse.jface.window.Window
      

org.eclipse.jface.dialogs.Dialog
          

org.eclipse.jface.dialogs.IconAndMessageDialog
              
org.eclipse.jface.dialogs.MessageDialog

All Implemented Interfaces:: IShellProvider

Direct Known Subclasses:: MessageDialogWithToggle

public class MessageDialog
extends IconAndMessageDialog
extends IconAndMessageDialog

A dialog for showing messages to the user.

This concrete dialog class can be instantiated as is, or further subclassed as required.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window. Window

Window.IExceptionHandler

Field Summary

static int CONFIRM
          Constant for a simple dialog with the question image and OK/Cancel buttons (value 5).

static int ERROR
          Constant for the error image, or a simple dialog with the error image and a single OK button (value 1).

static int INFORMATION
          Constant for the info image, or a simple dialog with the info image and a single OK button (value 2).

static int NONE
          Constant for no image (value 0).

static int QUESTION
          Constant for the question image, or a simple dialog with the question image and Yes/No buttons (value 3).

static int QUESTION_WITH_CANCEL
          Constant for a simple dialog with the question image and Yes/No/Cancel buttons (value 6).

static int WARNING
          Constant for the warning image, or a simple dialog with the warning image and a single OK button (value 4).

Fields inherited from class org.eclipse.jface.dialogs. IconAndMessageDialog

imageLabel, message, messageLabel

Fields inherited from class org.eclipse.jface.dialogs. Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window. Window

CANCEL, OK

Constructor Summary

MessageDialog ( Shell parentShell, String dialogTitle, Image dialogTitleImage, String dialogMessage, int dialogImageType, String[] dialogButtonLabels, int defaultIndex)
          Create a message dialog.

Method Summary

protected void buttonPressed (int buttonId)
          Notifies that this dialog's button with the given id has been pressed.

protected void configureShell ( Shell shell)
          Configures the given shell in preparation for opening this window in it.

protected Button createButton ( Composite parent, int id, String label, boolean defaultButton)
          Creates a new button with the given id.

protected void createButtonsForButtonBar ( Composite parent)
          Adds buttons to this dialog's button bar.

protected Control createCustomArea ( Composite parent)
          Creates and returns the contents of an area of the dialog which appears below the message and above the button bar.

protected Control createDialogArea ( Composite parent)
          This implementation of the Dialog framework method creates and lays out a composite and calls createMessageArea and createCustomArea to populate it.

protected boolean customShouldTakeFocus ()
          Return whether or not we should apply the workaround where we take focus for the default button or if that should be determined by the dialog.

protected Button getButton (int index)
          Gets a button in this dialog's button bar.

protected String[] getButtonLabels ()
          An accessor for the labels to use on the buttons.

protected int getDefaultButtonIndex ()
          An accessor for the index of the default button in the button array.

Image getImage ()
          Returns the image to display beside the message in this dialog.

protected int getMinimumMessageWidth ()
          Returns the minimum message area width in pixels This determines the minimum width of the dialog.

protected void handleShellCloseEvent ()
          Handle the shell close.

int open ()
          Opens this message dialog, creating it first if it has not yet been created.

static boolean open (int kind, Shell parent, String title, String message, int style)
          Convenience method to open a simple dialog as specified by the kind flag.

static boolean openConfirm ( Shell parent, String title, String message)
          Convenience method to open a simple confirm (OK/Cancel) dialog.

static void openError ( Shell parent, String title, String message)
          Convenience method to open a standard error dialog.

static void openInformation ( Shell parent, String title, String message)
          Convenience method to open a standard information dialog.

static boolean openQuestion ( Shell parent, String title, String message)
          Convenience method to open a simple Yes/No question dialog.

static void openWarning ( Shell parent, String title, String message)
          Convenience method to open a standard warning dialog.

protected void setButtonLabels ( String[] buttonLabels)
          A mutator for the button labels.

protected void setButtons ( Button[] buttons)
          A mutator for the array of buttons in the button bar.

Methods inherited from class org.eclipse.jface.dialogs. IconAndMessageDialog

createButtonBar, createContents, createDialogAndButtonArea, createMessageArea, getErrorImage, getInfoImage, getMessageLabelStyle, getQuestionImage, getWarningImage

Methods inherited from class org.eclipse.jface.dialogs. Dialog

applyDialogFont, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, dialogFontIsDefault, getBlockedHandler, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window. Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang. Object

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

Field Detail

NONE

public static final int NONE

Constant for no image (value 0).

See Also:: MessageDialog(Shell, String, Image, String, int, String[], int), Constant Field Values

ERROR

public static final int ERROR

Constant for the error image, or a simple dialog with the error image and a single OK button (value 1).

See Also:: MessageDialog(Shell, String, Image, String, int, String[], int), open(int, Shell, String, String, int), Constant Field Values

INFORMATION

public static final int INFORMATION

Constant for the info image, or a simple dialog with the info image and a single OK button (value 2).

See Also:: MessageDialog(Shell, String, Image, String, int, String[], int), open(int, Shell, String, String, int), Constant Field Values

QUESTION

public static final int QUESTION

Constant for the question image, or a simple dialog with the question image and Yes/No buttons (value 3).

See Also:: MessageDialog(Shell, String, Image, String, int, String[], int), open(int, Shell, String, String, int), Constant Field Values

WARNING

public static final int WARNING

Constant for the warning image, or a simple dialog with the warning image and a single OK button (value 4).

See Also:: MessageDialog(Shell, String, Image, String, int, String[], int), open(int, Shell, String, String, int), Constant Field Values

CONFIRM

public static final int CONFIRM

Constant for a simple dialog with the question image and OK/Cancel buttons (value 5).

Since:: 3.5
See Also:: open(int, Shell, String, String, int), Constant Field Values

QUESTION_WITH_CANCEL

public static final int QUESTION_WITH_CANCEL

Constant for a simple dialog with the question image and Yes/No/Cancel buttons (value 6).

Since:: 3.5
See Also:: open(int, Shell, String, String, int), Constant Field Values

Constructor Detail

MessageDialog

public MessageDialog(
Shell parentShell,
                     
String dialogTitle,
                     
Image dialogTitleImage,
                     
String dialogMessage,
                     int dialogImageType,
                     
String[] dialogButtonLabels,
                     int defaultIndex)

Create a message dialog. Note that the dialog will have no visual representation (no widgets) until it is told to open.

The labels of the buttons to appear in the button bar are supplied in this constructor as an array. The open method will return the index of the label in this array corresponding to the button that was pressed to close the dialog.

Note: If the dialog was dismissed without pressing a button (ESC key, close box, etc.) then SWT.DEFAULT is returned. Note that the open method blocks.

Parameters:

parentShell - the parent shell

dialogTitle - the dialog title, or null if none

dialogTitleImage - the dialog title image, or null if none

dialogMessage - the dialog message

dialogImageType - one of the following values:

MessageDialog.NONE for a dialog with no image
MessageDialog.ERROR for a dialog with an error image
MessageDialog.INFORMATION for a dialog with an information image
MessageDialog.QUESTION for a dialog with a question image
MessageDialog.WARNING for a dialog with a warning image

dialogButtonLabels - an array of labels for the buttons in the button bar

defaultIndex - the index in the button label array of the default button

Method Detail

buttonPressed

protected void buttonPressed(int buttonId)

Description copied from class: Dialog

Notifies that this dialog's button with the given id has been pressed.

The Dialog implementation of this framework method calls okPressed if the ok button is the pressed, and cancelPressed if the cancel button is the pressed. All other button presses are ignored. Subclasses may override to handle other buttons, but should call super.buttonPressed if the default handling of the ok and cancel buttons is desired.

Overrides:: buttonPressed in class Dialog

Parameters:: buttonId - the id of the button that was pressed (see IDialogConstants.*_ID constants)

configureShell

protected void configureShell(
Shell shell)

Description copied from class: Window

Configures the given shell in preparation for opening this window in it.

The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.

Overrides:: configureShell in class Window

Parameters:: shell - the shell

createButtonsForButtonBar

protected void createButtonsForButtonBar(
Composite parent)

Description copied from class: Dialog

Adds buttons to this dialog's button bar.

The Dialog implementation of this framework method adds standard ok and cancel buttons using the createButton framework method. These standard buttons will be accessible from getCancelButton, and getOKButton. Subclasses may override.

Overrides:: createButtonsForButtonBar in class Dialog

Parameters:: parent - the button bar composite

createCustomArea

protected 
Control createCustomArea(
Composite parent)

Creates and returns the contents of an area of the dialog which appears below the message and above the button bar.

The default implementation of this framework method returns null. Subclasses may override.

Parameters:: parent - parent composite to contain the custom area
Returns:: the custom area control, or null

createDialogArea

protected 
Control createDialogArea(
Composite parent)

This implementation of the Dialog framework method creates and lays out a composite and calls createMessageArea and createCustomArea to populate it. Subclasses should override createCustomArea to add contents below the message.

Overrides:: createDialogArea in class Dialog

Parameters:: parent - the parent composite to contain the dialog area
Returns:: the dialog area control

getButton

protected 
Button getButton(int index)

Gets a button in this dialog's button bar.

Overrides:: getButton in class Dialog

Parameters:: index - the index of the button in the dialog's button bar
Returns:: a button in the dialog's button bar
See Also:: Dialog.createButton(Composite, int, String, boolean)

getMinimumMessageWidth

protected int getMinimumMessageWidth()

Returns the minimum message area width in pixels This determines the minimum width of the dialog.

Subclasses may override.

Returns:: the minimum message area width (in pixels)

handleShellCloseEvent

protected void handleShellCloseEvent()

Handle the shell close. Set the return code to SWT.DEFAULT as there has been no explicit close by the user.

Overrides:: handleShellCloseEvent in class Window

See Also:: Window.handleShellCloseEvent()

open

public int open()

Opens this message dialog, creating it first if it has not yet been created.

This method waits until the dialog is closed by the end user, and then it returns the dialog's return code. The dialog's return code is either the index of the button the user pressed, or SWT.DEFAULT if the dialog has been closed by other means.

Overrides:: open in class Window

Returns:: the return code
See Also:: Window.open()

open

public static boolean open(int kind,
                           
Shell parent,
                           
String title,
                           
String message,
                           int style)

Convenience method to open a simple dialog as specified by the kind flag.

Parameters:: kind - the kind of dialog to open, one of ERROR, INFORMATION, QUESTION, WARNING, CONFIRM, or QUESTION_WITH_CANCEL.; parent - the parent shell of the dialog, or null if none; title - the dialog's title, or null if none; message - the message; style - SWT.NONE for a default dialog, or SWT.SHEET for a dialog with sheet behavior
Returns:: true if the user presses the OK or Yes button, false otherwise
Since:: 3.5

openConfirm

public static boolean openConfirm(
Shell parent,
                                  
String title,
                                  
String message)

Convenience method to open a simple confirm (OK/Cancel) dialog.

Parameters:: parent - the parent shell of the dialog, or null if none; title - the dialog's title, or null if none; message - the message
Returns:: true if the user presses the OK button, false otherwise

openError

public static void openError(
Shell parent,
                             
String title,
                             
String message)

Convenience method to open a standard error dialog.

Parameters:: parent - the parent shell of the dialog, or null if none; title - the dialog's title, or null if none; message - the message

openInformation

public static void openInformation(
Shell parent,
                                   
String title,
                                   
String message)

Convenience method to open a standard information dialog.

Parameters:: parent - the parent shell of the dialog, or null if none; title - the dialog's title, or null if none; message - the message

openQuestion

public static boolean openQuestion(
Shell parent,
                                   
String title,
                                   
String message)

Convenience method to open a simple Yes/No question dialog.

Parameters:: parent - the parent shell of the dialog, or null if none; title - the dialog's title, or null if none; message - the message
Returns:: true if the user presses the Yes button, false otherwise

openWarning

public static void openWarning(
Shell parent,
                               
String title,
                               
String message)

Convenience method to open a standard warning dialog.

Parameters:: parent - the parent shell of the dialog, or null if none; title - the dialog's title, or null if none; message - the message

createButton

protected 
Button createButton(
Composite parent,
                              int id,
                              
String label,
                              boolean defaultButton)

Description copied from class: Dialog

Creates a new button with the given id.

The Dialog implementation of this framework method creates a standard push button, registers it for selection events including button presses, and registers default buttons with its shell. The button id is stored as the button's client data. If the button id is IDialogConstants.CANCEL_ID, the new button will be accessible from getCancelButton(). If the button id is IDialogConstants.OK_ID, the new button will be accesible from getOKButton(). Note that the parent's layout is assumed to be a GridLayout and the number of columns in this layout is incremented. Subclasses may override.

Overrides:: createButton in class Dialog

Parameters:: parent - the parent composite; id - the id of the button (see IDialogConstants.*_ID constants for standard dialog button ids); label - the label from the button; defaultButton - true if the button is to be the default button, and false otherwise
Returns:: the new button
See Also:: Dialog.getCancelButton(), Dialog.getOKButton()

customShouldTakeFocus

protected boolean customShouldTakeFocus()

Return whether or not we should apply the workaround where we take focus for the default button or if that should be determined by the dialog. By default only return true if the custom area is a label or CLabel that cannot take focus.

Returns:: boolean

getImage

public 
Image getImage()

Description copied from class: IconAndMessageDialog

Returns the image to display beside the message in this dialog.

Subclasses may override.

Specified by:: getImage in class IconAndMessageDialog

Returns:: the image to display beside the message

getButtonLabels

protected 
String[] getButtonLabels()

An accessor for the labels to use on the buttons.

Returns:: The button labels to used; never null.

getDefaultButtonIndex

protected int getDefaultButtonIndex()

An accessor for the index of the default button in the button array.

Returns:: The default button index.

setButtons

protected void setButtons(
Button[] buttons)

A mutator for the array of buttons in the button bar.

Parameters:: buttons - The buttons in the button bar; must not be null.

setButtonLabels

protected void setButtonLabels(
String[] buttonLabels)

A mutator for the button labels.

Parameters:: buttonLabels - The button labels to use; must not be null.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

org.eclipse.jface.dialogs Class MessageDialog

NONE

ERROR

INFORMATION

QUESTION

WARNING

CONFIRM

QUESTION_WITH_CANCEL

MessageDialog

buttonPressed

configureShell

createButtonsForButtonBar

createCustomArea

createDialogArea

getButton

getMinimumMessageWidth

handleShellCloseEvent

open

open

openConfirm

openError

openInformation

openQuestion

openWarning

createButton

customShouldTakeFocus

getImage

getButtonLabels

getDefaultButtonIndex

setButtons

setButtonLabels

org.eclipse.jface.dialogs
Class MessageDialog