| |
org.eclipse.jface.dialogs
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
|
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
|
StatusDialog
(
Shell parent)
Creates an instance of a status dialog. |
|
Methods inherited from class org.eclipse.jface.dialogs.
Dialog
|
applyDialogFont,
buttonPressed,
cancelPressed,
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,
handleShellCloseEvent,
open,
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
|
StatusDialog
public StatusDialog(
Shell parent)
- Creates an instance of a status dialog.
-
Parameters:
-
parent - the parent Shell of the dialog
setStatusLineAboveButtons
public void setStatusLineAboveButtons(boolean aboveButtons)
- Specifies whether status line appears to the left of the buttons
(default) or above them.
-
-
Parameters:
-
aboveButtons - if true status line is placed above buttons; if
false 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 class
Window
-
-
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
calling createContents), then initializes this window's
shell bounds (by calling initializeBounds).
-
-
Overrides:
-
create
in class
Dialog
-
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
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 the createButtonsForButtonBar
framework method to populate it. Subclasses may override.
The returned control's layout data must be an instance of
GridData.
-
-
Overrides:
-
createButtonBar
in class
TrayDialog
-
-
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.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
