Package 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.

  • Constructor Details

    • 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

  • Method Details

    • 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.