|
Eclipse Platform Release 3.1 |
|||||||||||
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.StatusDialog
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.
Nested Class Summary |
---|
Nested classes inherited from class org.eclipse.jface.window.Window |
---|
Window.IExceptionHandler |
Field Summary |
---|
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 | |
---|---|
StatusDialog(Shell parent)
Creates an instance of a status dialog. |
Method Summary | |
---|---|
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public StatusDialog(Shell parent)
parent
- the parent Shell of the dialogMethod Detail |
public void setStatusLineAboveButtons(boolean aboveButtons)
aboveButtons
- if true
status line is placed above buttons; if
false
to the rightprotected void updateStatus(IStatus status)
public IStatus getStatus()
protected void updateButtonsEnableState(IStatus status)
status
- the status.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 shellpublic void create()
Window
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
).
create
in class Dialog
protected 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 createButtonBar(Composite parent)
Dialog
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
.
createButtonBar
in class Dialog
parent
- the parent composite to contain the button bar
public void setTitle(String title)
title
- the title.public void setImage(Image image)
image
- the image.
|
Eclipse Platform Release 3.1 |
|||||||||||
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, 2005. All rights reserved.