Class ListSelectionDialog
- java.lang.Object
-
- org.eclipse.jface.window.Window
-
- org.eclipse.jface.dialogs.Dialog
-
- org.eclipse.jface.dialogs.TrayDialog
-
- org.eclipse.ui.dialogs.SelectionDialog
-
- org.eclipse.ui.dialogs.ListSelectionDialog
-
- All Implemented Interfaces:
IShellProvider
- Direct Known Subclasses:
YesNoCancelListSelectionDialog
public class ListSelectionDialog extends SelectionDialog
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. ThegetResultmethod 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();- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListSelectionDialog.BuilderThe Builder to createListSelectionDialoginstances.-
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, resizeHasOccurred
-
-
Constructor Summary
Constructors Constructor Description ListSelectionDialog(Shell parentShell, Object input, IStructuredContentProvider contentProvider, ILabelProvider labelProvider, String message)Deprecated.since 3.123; useof(Object)instead:ListSelectionDialog.of(input).contentProvider(contentProvider).labelProvider(labelProvider).message(message).create(parentShell)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidconfigureShell(Shell shell)Configures the given shell in preparation for opening this window in it.protected voidcreateButtonsForButtonBar(Composite parent)Adds buttons to this dialog's button bar.protected ControlcreateContents(Composite parent)TheDialogimplementation of thisWindowmethod creates and lays out the top level composite for the dialog, and determines the appropriate horizontal and vertical dialog units based on the font size.protected ControlcreateDialogArea(Composite parent)Creates and returns the contents of the upper part of this dialog (above the button bar).booleangetCheckboxValue()protected CheckboxTableViewergetViewer()Returns the viewer used to show the list.static ListSelectionDialog.Builderof(Object input)Creates a newListSelectionDialogListSelectionDialog.Builderfor the given input.protected voidokPressed()TheListSelectionDialogimplementation of thisDialogmethod 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
createMessageArea, getDialogBoundsSettings, getDialogBoundsStrategy, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, isResizable, setDialogBoundsSettings, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle
-
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
closeTray, createButtonBar, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
-
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
-
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
-
-
-
-
Constructor Detail
-
ListSelectionDialog
@Deprecated public ListSelectionDialog(Shell parentShell, Object input, IStructuredContentProvider contentProvider, ILabelProvider labelProvider, String message)
Deprecated.since 3.123; useof(Object)instead:ListSelectionDialog.of(input).contentProvider(contentProvider).labelProvider(labelProvider).message(message).create(parentShell)Creates a list selection dialog.- Parameters:
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, ornullto display a default message
-
-
Method Detail
-
of
public static ListSelectionDialog.Builder of(Object input)
Creates a newListSelectionDialogListSelectionDialog.Builderfor the given input.Example:
ListSelectionDialog dialog = ListSelectionDialog.of(input).title(title).message(message).create(shell);
- Parameters:
input- the root element to populate this dialog with- Returns:
- a new
ListSelectionDialog.Builderinstance - Since:
- 3.123
-
configureShell
protected void configureShell(Shell shell)
Description copied from class:WindowConfigures 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:
configureShellin classSelectionDialog- Parameters:
shell- the shell
-
createContents
protected Control createContents(Composite parent)
Description copied from class:DialogTheDialogimplementation of thisWindowmethod creates and lays out the top level composite for the dialog, and determines the appropriate horizontal and vertical dialog units based on the font size. It then calls thecreateDialogAreaandcreateButtonBarmethods to create the dialog area and button bar, respectively. OverridingcreateDialogAreaandcreateButtonBarare recommended rather than overriding this method.- Overrides:
createContentsin classDialog- Parameters:
parent- the parent composite for the controls in this window. The type of layout used is determined by getLayout()- Returns:
- the control that will be returned by subsequent calls to getContents()
-
createDialogArea
protected Control createDialogArea(Composite parent)
Description copied from class:DialogCreates and returns the contents of the upper part of this dialog (above the button bar).The
Dialogimplementation of this framework method creates and returns a newCompositewith 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
superas in the following example:Composite composite = (Composite) super.createDialogArea(parent); //add controls to composite as necessary return composite;
- Overrides:
createDialogAreain classDialog- Parameters:
parent- the parent composite to contain the dialog area- Returns:
- the dialog area control
-
createButtonsForButtonBar
protected void createButtonsForButtonBar(Composite parent)
Description copied from class:DialogAdds buttons to this dialog's button bar.The
Dialogimplementation of this framework method adds standard ok and cancel buttons using thecreateButtonframework method. These standard buttons will be accessible fromgetCancelButton, andgetOKButton. Subclasses may override.Note: The common button order is: {other buttons}, OK, Cancel. On some platforms,
Dialog.initializeBounds()will move the default button to the right.- Overrides:
createButtonsForButtonBarin classSelectionDialog- Parameters:
parent- the button bar composite
-
getViewer
protected CheckboxTableViewer getViewer()
Returns the viewer used to show the list.- Returns:
- the viewer, or
nullif not yet created
-
getCheckboxValue
public boolean getCheckboxValue()
- Returns:
- the current or, if the dialog has been closed, the last value of the
optional check box;
falsewhen there is no optional check box and no default value has been set - Since:
- 3.123
-
-