|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.IconAndMessageDialog
org.eclipse.jface.dialogs.MessageDialog
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 inherited from class org.eclipse.jface.window.Window |
Window.IExceptionHandler |
Field Summary | |
static int |
ERROR
Constant for a dialog with an error image (value 1). |
static int |
INFORMATION
Constant for a dialog with an info image (value 2). |
static int |
NONE
Constant for a dialog with no image (value 0). |
static int |
QUESTION
Constant for a dialog with a question image (value 3). |
static int |
WARNING
Constant for a dialog with a warning image (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, dialogArea, DLG_IMG_ERROR, 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. |
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.window.Window |
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getInitialLocation, getInitialSize, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int NONE
public static final int ERROR
public static final int INFORMATION
public static final int QUESTION
public static final int WARNING
Constructor Detail |
public MessageDialog(Shell parentShell, String dialogTitle, Image dialogTitleImage, String dialogMessage, int dialogImageType, String[] dialogButtonLabels, int defaultIndex)
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. If the dialog was dismissed without pressing
a button (ESC, etc.) then -1 is returned. Note that the open
method blocks.
parentShell
- the parent shelldialogTitle
- the dialog title, or null
if nonedialogTitleImage
- the dialog title image, or null
if nonedialogMessage
- the dialog messagedialogImageType
- one of the following values:
MessageDialog.NONE
for a dialog with no
imageMessageDialog.ERROR
for a dialog with an
error imageMessageDialog.INFORMATION
for a dialog
with an information imageMessageDialog.QUESTION
for a dialog with a
question imageMessageDialog.WARNING
for a dialog with a
warning imagedialogButtonLabels
- an array of labels for the buttons in the button bardefaultIndex
- the index in the button label array of the default buttonMethod Detail |
protected void buttonPressed(int buttonId)
Dialog
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.
buttonPressed
in class Dialog
buttonId
- the id of the button that was pressed (see
IDialogConstants.*_ID
constants)protected void configureShell(Shell shell)
Window
The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.
configureShell
in class Window
shell
- the shellprotected void createButtonsForButtonBar(Composite parent)
Dialog
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.
createButtonsForButtonBar
in class Dialog
parent
- the button bar compositeprotected Control createCustomArea(Composite parent)
The default implementation of this framework method returns
null
. Subclasses may override.
parent
- parent composite to contain the custom area
null
protected Control createDialogArea(Composite parent)
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.
createDialogArea
in class Dialog
parent
- the parent composite to contain the dialog area
protected Button getButton(int index)
getButton
in class Dialog
index
- the index of the button in the dialog's button bar
Dialog.createButton(Composite, int, String, boolean)
protected int getMinimumMessageWidth()
Subclasses may override.
protected void handleShellCloseEvent()
SWT.DEFAULT
as there has been no explicit close by the user.
handleShellCloseEvent
in class Window
Window.handleShellCloseEvent()
public static boolean openConfirm(Shell parent, String title, String message)
parent
- the parent shell of the dialog, or null
if nonetitle
- the dialog's title, or null
if nonemessage
- the message
true
if the user presses the OK button,
false
otherwisepublic static void openError(Shell parent, String title, String message)
parent
- the parent shell of the dialog, or null
if nonetitle
- the dialog's title, or null
if nonemessage
- the messagepublic static void openInformation(Shell parent, String title, String message)
parent
- the parent shell of the dialog, or null
if nonetitle
- the dialog's title, or null
if nonemessage
- the messagepublic static boolean openQuestion(Shell parent, String title, String message)
parent
- the parent shell of the dialog, or null
if nonetitle
- the dialog's title, or null
if nonemessage
- the message
true
if the user presses the OK button,
false
otherwisepublic static void openWarning(Shell parent, String title, String message)
parent
- the parent shell of the dialog, or null
if nonetitle
- the dialog's title, or null
if nonemessage
- the messageprotected Button createButton(Composite parent, int id, String label, boolean defaultButton)
Dialog
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.
createButton
in class Dialog
parent
- the parent compositeid
- the id of the button (see IDialogConstants.*_ID
constants for standard dialog button ids)label
- the label from the buttondefaultButton
- true
if the button is to be the default button,
and false
otherwise
Dialog.getCancelButton()
,
Dialog.getOKButton()
protected boolean customShouldTakeFocus()
public Image getImage()
IconAndMessageDialog
Subclasses may override.
getImage
in class IconAndMessageDialog
protected String[] getButtonLabels()
null
.protected int getDefaultButtonIndex()
protected void setButtons(Button[] buttons)
buttons
- The buttons in the button bar; must not be null
.protected void setButtonLabels(String[] buttonLabels)
buttonLabels
- The button labels to use; must not be null
.
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.