org.eclipse.cdt.internal.ui.dialogs
Class SelectionStatusDialog

java.lang.Object
  extended by org.eclipse.jface.window.Window
      extended by org.eclipse.jface.dialogs.Dialog
          extended by org.eclipse.jface.dialogs.TrayDialog
              extended by org.eclipse.ui.dialogs.SelectionDialog
                  extended by org.eclipse.cdt.internal.ui.dialogs.SelectionStatusDialog
All Implemented Interfaces:
org.eclipse.jface.window.IShellProvider
Direct Known Subclasses:
AbstractElementListSelectionDialog

public abstract class SelectionStatusDialog
extends org.eclipse.ui.dialogs.SelectionDialog

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 / disabled depending on the status.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
org.eclipse.jface.window.Window.IExceptionHandler
 
Field Summary
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, 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
SelectionStatusDialog(org.eclipse.swt.widgets.Shell parent)
           
 
Method Summary
 void create()
           
 java.lang.Object getPrimaryResult()
          Returns the first element from the list of results.
 void setImage(org.eclipse.swt.graphics.Image image)
          Sets the image for this dialog.
 void setInitialSelection(java.lang.Object element)
          Sets the initial selection to the given element.
 void setInitialSelections(java.lang.Object[] selectedElements)
           
 void setStatusLineAboveButtons(boolean aboveButtons)
          Controls whether status line appears to the left of the buttons (default) or above them.
 
Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog
getOkButton, getResult, setDialogBoundsSettings, setInitialElementSelections, setMessage, setTitle
 
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
close, closeTray, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getBlockedHandler, getImage, setBlockedHandler, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
getDefaultImage, getDefaultImages, getDefaultOrientation, getReturnCode, getShell, getWindowManager, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setWindowManager
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SelectionStatusDialog

public SelectionStatusDialog(org.eclipse.swt.widgets.Shell parent)
Method Detail

create

public void create()
Overrides:
create in class org.eclipse.jface.dialogs.Dialog

getPrimaryResult

public java.lang.Object getPrimaryResult()
Returns the first element from the list of results. Returns null if no element has been selected.

Returns:
the first result element if one exists. Otherwise null is returned.

setImage

public void setImage(org.eclipse.swt.graphics.Image image)
Sets the image for this dialog.

Parameters:
image - the dialog's image

setInitialSelection

public void setInitialSelection(java.lang.Object element)
Sets the initial selection to the given element.


setInitialSelections

public void setInitialSelections(java.lang.Object[] selectedElements)
Overrides:
setInitialSelections in class org.eclipse.ui.dialogs.SelectionDialog

setStatusLineAboveButtons

public void setStatusLineAboveButtons(boolean aboveButtons)
Controls 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