org.eclipse.ui.dialogs
Class SelectionDialog

java.lang.Object
  |
  +--org.eclipse.jface.window.Window
        |
        +--org.eclipse.jface.dialogs.Dialog
              |
              +--org.eclipse.ui.dialogs.SelectionDialog

Direct Known Subclasses:

ContainerSelectionDialog, FileSelectionDialog, ListSelectionDialog, MarkerResolutionSelectionDialog, ProjectLocationMoveDialog, ProjectLocationSelectionDialog, ResourceSelectionDialog, SelectionStatusDialog

public abstract class SelectionDialog

extends Dialog

The abstract implementation of a selection dialog. It can be primed with initial selections (setElementSelections), and returns the final selection (via getResult) after completion.

Clients may subclass this dialog to inherit its selection facilities.

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

DLG_IMG_ERROR, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Constructor Summary

protected

SelectionDialog(Shell parentShell) Creates a dialog instance.

Method Summary

protected void	configureShell(Shell shell) Configures the given shell in preparation for opening this window in it.
protected void	createButtonsForButtonBar(Composite parent) Adds buttons to this dialog's button bar.
protected Label	createMessageArea(Composite composite) Creates the message area for this dialog.
protected List	getInitialSelections() Returns the initial selection in this selection dialog.
protected String	getMessage() Returns the message for this dialog.
Button	getOkButton() Returns the ok button.
Object[]	getResult() Returns the list of selections made by the user, or null if the selection was canceled.
void	setInitialSelections(Object[] selectedElements) Sets the initial selection in this selection dialog to the given elements.
void	setMessage(String message) Sets the message for this dialog.
protected void	setResult(List newResult) Set the selections made by the user, or null if the selection was canceled.
protected void	setSelectionResult(Object[] newResult) Set the selections made by the user, or null if the selection was canceled.
void	setTitle(String title) Sets the title for this dialog.

Methods inherited from class org.eclipse.jface.dialogs.Dialog

buttonPressed, cancelPressed, constrainShellSize, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createButtonBar, createContents, createDialogArea, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeDialogUnits, okPressed

Methods inherited from class org.eclipse.jface.window.Window

close, create, createShell, getContents, getDefaultImage, getInitialLocation, getInitialSize, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, initializeBounds, open, setBlockOnOpen, setDefaultImage, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SelectionDialog

protected SelectionDialog(Shell parentShell)

Creates a dialog instance. Note that the dialog will have no visual representation (no widgets) until it is told to open.

Parameters:

parentShell - the parent shell

Method Detail

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

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

createMessageArea

protected Label createMessageArea(Composite composite)

Creates the message area for this dialog.

This method is provided to allow subclasses to decide where the message will appear on the screen.

Returns:

the message label

getInitialSelections

protected List getInitialSelections()

Returns the initial selection in this selection dialog.

Returns:

the list of initial selected elements

getMessage

protected String getMessage()

Returns the message for this dialog.

Returns:

the message for this dialog

getOkButton

public Button getOkButton()

Returns the ok button.

Returns:

the ok button or null if the button is not created yet.

getResult

public Object[] getResult()

Returns the list of selections made by the user, or null if the selection was canceled.

Returns:

the array of selected elements, or null if Cancel was pressed

setInitialSelections

public void setInitialSelections(Object[] selectedElements)

Sets the initial selection in this selection dialog to the given elements.

Parameters:

selectedElements - the array of elements to select

setMessage

public void setMessage(String message)

Sets the message for this dialog.

Parameters:

message - the message

setResult

protected void setResult(List newResult)

Set the selections made by the user, or null if the selection was canceled.

setSelectionResult

protected void setSelectionResult(Object[] newResult)

Set the selections made by the user, or null if the selection was canceled.

The selections may accessed using getResult.

Since:

2.0

setTitle

public void setTitle(String title)

Sets the title for this dialog.

Parameters:

title - the title