Package org.eclipse.jface.dialogs
Class IconAndMessageDialog
java.lang.Object
org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.IconAndMessageDialog
- All Implemented Interfaces:
IShellProvider
- Direct Known Subclasses:
ErrorDialog
,MessageDialog
,PlainMessageDialog
,ProgressMonitorDialog
The IconAndMessageDialog is the abstract superclass of dialogs that have an
icon and a message as the first two widgets. In this dialog the icon and
message are direct children of the shell in order that they can be read by
accessibility tools more easily.
Note: Clients are expected to call createMessageArea(Composite)
,
otherwise neither the icon nor the message will appear.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
-
Field Summary
Modifier and TypeFieldDescriptionprotected Label
Return the label for the image.protected String
Message (a localized string).protected Label
Message label is the label the message is shown on.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, resizeHasOccurred
-
Constructor Summary
ConstructorDescriptionIconAndMessageDialog
(Shell parentShell) Constructor for IconAndMessageDialog. -
Method Summary
Modifier and TypeMethodDescriptionprotected Control
createButtonBar
(Composite parent) Creates and returns the contents of this dialog's button bar.protected Control
createContents
(Composite parent) TheDialog
implementation of thisWindow
method creates and lays out the top level composite for the dialog, and determines the appropriate horizontal and vertical dialog units based on the font size.protected void
createDialogAndButtonArea
(Composite parent) Create the dialog area and the button bar for the receiver.protected Control
createMessageArea
(Composite composite) Create the area the message will be shown in.protected int
Get the number of columns in the layout of the Shell of the dialog.Return theImage
to be used when displaying an error.protected abstract Image
getImage()
Returns the image to display beside the message in this dialog.Return theImage
to be used when displaying information.protected int
Returns the style for the message label.Return theImage
to be used when displaying a question.Return theImage
to be used when displaying a warning.Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonsForButtonBar, createDialogArea, dialogFontIsDefault, getBlockedHandler, getButton, 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, configureShell, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
-
Field Details
-
message
Message (a localized string). -
messageLabel
Message label is the label the message is shown on. -
imageLabel
Return the label for the image.
-
-
Constructor Details
-
IconAndMessageDialog
Constructor for IconAndMessageDialog.- Parameters:
parentShell
- the parent shell, ornull
to create a top-level shell
-
-
Method Details
-
createMessageArea
Create the area the message will be shown in.The parent composite is assumed to use GridLayout as its layout manager, since the parent is typically the composite created in
Dialog.createDialogArea(org.eclipse.swt.widgets.Composite)
.Note: Clients are expected to call this method, otherwise neither the icon nor the message will appear.
- Parameters:
composite
- The composite to parent from.- Returns:
- Control
-
getMessageLabelStyle
protected int getMessageLabelStyle()Returns the style for the message label.- Returns:
- the style for the message label
- Since:
- 3.0
-
createButtonBar
Description copied from class:Dialog
Creates and returns the contents of this dialog's button bar.The
Dialog
implementation of this framework method lays out a button bar and calls thecreateButtonsForButtonBar
framework method to populate it. Subclasses may override.The returned control's layout data must be an instance of
GridData
.- Overrides:
createButtonBar
in classDialog
- Parameters:
parent
- the parent composite to contain the button bar- Returns:
- the button bar control
-
getImage
Returns the image to display beside the message in this dialog.Subclasses may override.
- Returns:
- the image to display beside the message
- Since:
- 2.0
-
createContents
Description copied from class:Dialog
TheDialog
implementation of thisWindow
method creates and lays out the top level composite for the dialog, and determines the appropriate horizontal and vertical dialog units based on the font size. It then calls thecreateDialogArea
andcreateButtonBar
methods to create the dialog area and button bar, respectively. OverridingcreateDialogArea
andcreateButtonBar
are recommended rather than overriding this method.- Overrides:
createContents
in classDialog
- Parameters:
parent
- the parent composite for the controls in this window. The type of layout used is determined by getLayout()- Returns:
- the control that will be returned by subsequent calls to getContents()
-
getColumnCount
protected int getColumnCount()Get the number of columns in the layout of the Shell of the dialog.- Returns:
- int
- Since:
- 3.22
-
createDialogAndButtonArea
Create the dialog area and the button bar for the receiver.- Parameters:
parent
- the parent composite
-
getErrorImage
Return theImage
to be used when displaying an error.- Returns:
- image the error image
-
getWarningImage
Return theImage
to be used when displaying a warning.- Returns:
- image the warning image
-
getInfoImage
Return theImage
to be used when displaying information.- Returns:
- image the information image
-
getQuestionImage
Return theImage
to be used when displaying a question.- Returns:
- image the question image
-