|
Eclipse Platform Release 3.2 |
|||||||||
| 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.TrayDialog
org.eclipse.ui.dialogs.SelectionDialog
public abstract class SelectionDialog
The abstract implementation of a selection dialog. It can be primed with
initial selections (setInitialSelections), and returns the
final selection (via getResult) after completion.
Clients may subclass this dialog to inherit its selection facilities.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.jface.window.Window |
|---|
Window.IExceptionHandler |
| Field Summary |
|---|
| 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 | |
|---|---|
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 IDialogSettings |
getDialogBoundsSettings()
Gets the dialog settings that should be used for remembering the bounds of the dialog, according to the dialog bounds strategy. |
protected int |
getDialogBoundsStrategy()
Get the integer constant that describes the strategy for persisting the dialog bounds. |
protected List |
getInitialElementSelections()
Returns the list of initial element selections. |
protected List |
getInitialSelections()
Deprecated. use getInitialElementSelections() instead |
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 |
setDialogBoundsSettings(IDialogSettings settings,
int strategy)
Set the dialog settings that should be used to save the bounds of this dialog. |
void |
setInitialElementSelections(List selectedElements)
Sets the initial selection in this selection dialog to the given elements. |
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.TrayDialog |
|---|
close, closeTray, createButtonBar, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected SelectionDialog(Shell parentShell)
parentShell - the parent shell| Method Detail |
|---|
protected void configureShell(Shell shell)
WindowThe 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 Windowshell - the shellprotected 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 Dialogparent - the button bar compositeprotected Label createMessageArea(Composite composite)
This method is provided to allow subclasses to decide where the message will appear on the screen.
composite - the parent composite
protected List getInitialSelections()
protected List getInitialElementSelections()
protected String getMessage()
public Button getOkButton()
null if the button is not created
yet.public Object[] getResult()
null
if the selection was canceled.
null if Cancel
was pressedpublic void setInitialSelections(Object[] selectedElements)
selectedElements - the array of elements to selectpublic void setInitialElementSelections(List selectedElements)
selectedElements - the List of elements to selectpublic void setMessage(String message)
message - the messageprotected void setResult(List newResult)
null if the
selection was canceled.
newResult - list of selected elements, or null if Cancel
was pressedprotected void setSelectionResult(Object[] newResult)
null if the
selection was canceled.
The selections may accessed using getResult.
newResult - -
the new valuespublic void setTitle(String title)
title - the title
public void setDialogBoundsSettings(IDialogSettings settings,
int strategy)
settings - the IDialogSettings that should be used to store the
bounds of the dialogstrategy - the integer constant specifying how the bounds are saved.
Specified using Dialog.DIALOG_PERSISTLOCATION
and Dialog.DIALOG_PERSISTSIZE.Dialog.getDialogBoundsStrategy(),
Dialog.getDialogBoundsSettings()protected IDialogSettings getDialogBoundsSettings()
setDialogBoundsSettings(IDialogSettings, int).
getDialogBoundsSettings in class Dialognull if the dialog's bounds should not be
stored.Dialog.getDialogBoundsStrategy(),
setDialogBoundsSettings(IDialogSettings, int)protected int getDialogBoundsStrategy()
setDialogBoundsSettings(IDialogSettings, int).
getDialogBoundsStrategy in class DialogDialog.DIALOG_PERSISTLOCATION,
Dialog.DIALOG_PERSISTSIZE,
Dialog.getDialogBoundsSettings(),
setDialogBoundsSettings(IDialogSettings, int)
|
Eclipse Platform Release 3.2 |
|||||||||
| 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, 2006. All rights reserved.