|
Eclipse Platform Release 3.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.jface.window.Window org.eclipse.jface.dialogs.Dialog org.eclipse.ui.dialogs.SelectionDialog org.eclipse.ui.dialogs.SelectionStatusDialog
An abstract base class for dialogs with a status bar and ok/cancel buttons. The status message must be passed over as StatusInfo object and can be an error, warning 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 | |
SelectionStatusDialog(Shell parent)
Creates an instance of a SelectionStatusDialog. |
Method Summary | |
protected abstract void | computeResult()
Compute the result and return it. |
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. |
Object | getFirstResult()
Returns the first element from the list of results. |
protected void | okPressed()
Notifies that the ok button of this dialog has been pressed. |
void | setImage(Image image)
Sets the image for this dialog. |
protected void | setResult(int position,
Object element)
Sets a result element at the given position. |
void | setStatusLineAboveButtons(boolean aboveButtons)
Controls whether status line appears to the left of the buttons (default) or above them. |
protected void | updateButtonsEnableState(IStatus status)
Update 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.ui.dialogs.SelectionDialog |
createButtonsForButtonBar, createMessageArea, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle |
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, handleShellCloseEvent, 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 |
Constructor Detail |
public SelectionStatusDialog(Shell parent)
Method Detail |
public void setStatusLineAboveButtons(boolean aboveButtons)
public void setImage(Image image)
public Object getFirstResult()
protected void setResult(int position, Object element)
protected abstract void computeResult()
protected void configureShell(Shell shell)
The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.
protected void updateStatus(IStatus status)
protected void updateButtonsEnableState(IStatus status)
protected void okPressed()
The Dialog implementation of this framework method sets this dialog's return code to Window.OK and closes the dialog. Subclasses may override.
public void create()
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).
protected Control createButtonBar(Composite parent)
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.
|
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.