| |
org.eclipse.ui.dialogs
Class ContainerSelectionDialog
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.ContainerSelectionDialog
-
All Implemented Interfaces:
-
IShellProvider
-
public class ContainerSelectionDialog
- extends
SelectionDialog
A standard selection dialog which solicits a container resource from the user.
The getResult method returns the selected container resource.
This class may be instantiated; it is not intended to be subclassed.
Example:
ContainerSelectionDialog dialog =
new ContainerSelectionDialog(getShell(), initialSelection, allowNewContainerName(), msg);
dialog.open();
Object[] result = dialog.getResult();
-
Restriction:
- This class is not intended to be subclassed by clients.
|
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
|
|
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 void
|
okPressed
()
The ContainerSelectionDialog implementation of this
Dialog method builds a list of the selected resource containers
for later retrieval by the client and closes this dialog. |
void
|
setValidator
(
ISelectionValidator validator)
Sets the validator to use. |
void
|
showClosedProjects
(boolean show)
Set whether or not closed projects should be shown
in the selection dialog. |
|
Methods inherited from class org.eclipse.ui.dialogs.
SelectionDialog
|
createButtonsForButtonBar,
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
|
close,
closeTray,
createButtonBar,
createHelpControl,
getLayout,
getTray,
isDialogHelpAvailable,
isHelpAvailable,
openTray,
setDialogHelpAvailable,
setHelpAvailable
|
|
Methods inherited from class org.eclipse.jface.dialogs.
Dialog
|
applyDialogFont,
buttonPressed,
cancelPressed,
convertHeightInCharsToPixels,
convertHeightInCharsToPixels,
convertHorizontalDLUsToPixels,
convertHorizontalDLUsToPixels,
convertVerticalDLUsToPixels,
convertVerticalDLUsToPixels,
convertWidthInCharsToPixels,
convertWidthInCharsToPixels,
create,
createButton,
createContents,
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,
handleShellCloseEvent,
open,
setBlockOnOpen,
setDefaultImage,
setDefaultImages,
setDefaultModalParent,
setDefaultOrientation,
setExceptionHandler,
setParentShell,
setReturnCode,
setShellStyle,
setWindowManager
|
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
ContainerSelectionDialog
public ContainerSelectionDialog(
Shell parentShell,
IContainer initialRoot,
boolean allowNewContainerName,
String message)
- Creates a resource container selection dialog rooted at the given resource.
All selections are considered valid.
-
Parameters:
-
parentShell - the parent shell -
initialRoot - the initial selection in the tree -
allowNewContainerName - true to enable the user to type in
a new container name, and false to restrict the user to just
selecting from existing ones -
message - the message to be displayed at the top of this dialog, or
null to display a default message
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
SelectionDialog
-
-
Parameters:
-
shell - the shell
createDialogArea
protected
Control createDialogArea(
Composite parent)
-
Description copied from class:
Dialog
- Creates and returns the contents of the upper part of this dialog (above
the button bar).
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;
-
-
Overrides:
-
createDialogArea
in class
Dialog
-
-
Parameters:
-
parent - the parent composite to contain the dialog area
-
Returns:
- the dialog area control
okPressed
protected void okPressed()
- The
ContainerSelectionDialog implementation of this
Dialog method builds a list of the selected resource containers
for later retrieval by the client and closes this dialog.
-
-
Overrides:
-
okPressed
in class
Dialog
-
setValidator
public void setValidator(
ISelectionValidator validator)
- Sets the validator to use.
-
-
Parameters:
-
validator - A selection validator
showClosedProjects
public void showClosedProjects(boolean show)
- Set whether or not closed projects should be shown
in the selection dialog.
-
-
Parameters:
-
show - Whether or not to show closed projects.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
