|
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
org.eclipse.ui.dialogs.ListSelectionDialog
public class ListSelectionDialog
A standard dialog which solicits a list of selections from the user.
This class is configured with an arbitrary data model represented by content
and label provider objects. The getResult method returns the
selected elements.
This class may be instantiated; it is not intended to be subclassed.
Example:
ListSelectionDialog dlg =
new ListSelectionDialog(
getShell(),
input,
new BaseWorkbenchContentProvider(),
new WorkbenchLabelProvider(),
"Select the resources to save:");
dlg.setInitialSelections(dirtyEditors);
dlg.setTitle("Save Resources");
dlg.open();
| 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 | |
|---|---|
ListSelectionDialog(Shell parentShell,
Object input,
IStructuredContentProvider contentProvider,
ILabelProvider labelProvider,
String message)
Creates a list selection dialog. |
|
| Method Summary | |
|---|---|
protected void |
configureShell(Shell shell)
Configures the given shell in preparation for opening this window in it. |
protected Control |
createDialogArea(Composite parent)
Creates and returns the contents of the upper part of this dialog (above the button bar). |
protected CheckboxTableViewer |
getViewer()
Returns the viewer used to show the list. |
protected void |
okPressed()
The ListSelectionDialog implementation of this
Dialog method builds a list of the selected elements for later
retrieval by the client and closes this dialog. |
| Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog |
|---|
createButtonsForButtonBar, createMessageArea, getDialogBoundsSettings, getDialogBoundsStrategy, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, setDialogBoundsSettings, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle |
| 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 |
|---|
public ListSelectionDialog(Shell parentShell,
Object input,
IStructuredContentProvider contentProvider,
ILabelProvider labelProvider,
String message)
parentShell - the parent shellinput - the root element to populate this dialog withcontentProvider - the content provider for navigating the modellabelProvider - the label provider for displaying model elementsmessage - the message to be displayed at the top of this dialog, or
null to display a default message| 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 SelectionDialogshell - the shellprotected Control createDialogArea(Composite parent)
Dialog
The Dialog implementation of this framework method creates
and returns a new Composite with standard margins and
spacing.
The returned control's layout data must be an instance of
GridData. This method must not modify the parent's
layout.
Subclasses must override this method but may call super as
in the following example:
Composite composite = (Composite) super.createDialogArea(parent); //add controls to composite as necessary return composite;
createDialogArea in class Dialogparent - the parent composite to contain the dialog area
protected CheckboxTableViewer getViewer()
null if not yet createdprotected void okPressed()
ListSelectionDialog implementation of this
Dialog method builds a list of the selected elements for later
retrieval by the client and closes this dialog.
okPressed in class Dialog
|
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.