Class StatusDialog
- java.lang.Object
-
- org.eclipse.jface.window.Window
-
- org.eclipse.jface.dialogs.Dialog
-
- org.eclipse.jface.dialogs.TrayDialog
-
- org.eclipse.jface.dialogs.StatusDialog
-
- All Implemented Interfaces:
IShellProvider
- Direct Known Subclasses:
TemplatePreferencePage.EditTemplateDialog
public abstract class StatusDialog extends TrayDialog
An abstract base class for dialogs with a status bar and OK/CANCEL buttons. The status message is specified in an IStatus which can be of severity ERROR, WARNING, INFO or OK. The OK button is enabled or disabled depending on the status.- Since:
- 3.1
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
-
-
Field Summary
-
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
Constructors Constructor Description StatusDialog(Shell parent)
Creates an instance of a status dialog.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
configureShell(Shell shell)
Configures the given shell in preparation for opening this window in it.void
create()
Creates this window's widgetry in a new top-level shell.protected Control
createButtonBar(Composite parent)
Creates and returns the contents of this dialog's button bar.protected void
createButtonsForButtonBar(Composite parent)
Adds buttons to this dialog's button bar.IStatus
getStatus()
Returns the last status.void
setImage(Image image)
Sets the image for this dialog.void
setStatusLineAboveButtons(boolean aboveButtons)
Specifies whether status line appears to the left of the buttons (default) or above them.void
setTitle(String title)
Sets the title for this dialog.protected void
updateButtonsEnableState(IStatus status)
Updates the status of the ok button to reflect the given status.protected void
updateStatus(IStatus status)
Update the dialog's status line to reflect the given status.-
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
closeTray, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
-
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createContents, 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, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
-
-
-
-
Constructor Detail
-
StatusDialog
public StatusDialog(Shell parent)
Creates an instance of a status dialog.- Parameters:
parent
- the parent Shell of the dialog
-
-
Method Detail
-
setStatusLineAboveButtons
public void setStatusLineAboveButtons(boolean aboveButtons)
Specifies whether status line appears to the left of the buttons (default) or above them.- Parameters:
aboveButtons
- iftrue
status line is placed above buttons; iffalse
to the right
-
updateStatus
protected void updateStatus(IStatus status)
Update the dialog's status line to reflect the given status. It is safe to call this method before the dialog has been opened.- Parameters:
status
- the status to set
-
getStatus
public IStatus getStatus()
Returns the last status.- Returns:
- IStatus
-
updateButtonsEnableState
protected void updateButtonsEnableState(IStatus status)
Updates the status of the ok button to reflect the given status. Subclasses may override this method to update additional buttons.- Parameters:
status
- the status.
-
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 classWindow
- Parameters:
shell
- the shell
-
create
public void create()
Description copied from class:Window
Creates this window's widgetry in a new top-level shell.The default implementation of this framework method creates this window's shell (by calling
createShell
), and its controls (by callingcreateContents
), then initializes this window's shell bounds (by callinginitializeBounds
).
-
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 thecreateButton
framework method. These standard buttons will be accessible fromgetCancelButton
, andgetOKButton
. Subclasses may override.Note: The common button order is: {other buttons}, OK, Cancel. On some platforms,
Dialog.initializeBounds()
will move the default button to the right.- Overrides:
createButtonsForButtonBar
in classDialog
- Parameters:
parent
- the button bar composite
-
createButtonBar
protected Control createButtonBar(Composite parent)
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 classTrayDialog
- Parameters:
parent
- the parent composite to contain the button bar- Returns:
- the button bar control
-
setTitle
public void setTitle(String title)
Sets the title for this dialog.- Parameters:
title
- the title.
-
setImage
public void setImage(Image image)
Sets the image for this dialog.- Parameters:
image
- the image.
-
-