Package org.eclipse.jface.dialogs

Class AbstractSelectionDialog<T>

java.lang.Object
org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.TrayDialog
org.eclipse.jface.dialogs.AbstractSelectionDialog<T>
Type Parameters:
T - which declares the type of the elements in the AbstractSelectionDialog.
All Implemented Interfaces:
IShellProvider
public abstract class AbstractSelectionDialog<T> extends TrayDialog
The abstract implementation of a selection dialog. It can be primed with initial selections (setInitialSelection), and returns the final selection (via getResult) after completion.

Clients may subclass this dialog to inherit its selection facilities.

Since:
3.11

  • Constructor Details

    • AbstractSelectionDialog

      protected AbstractSelectionDialog(Shell parentShell)
      Creates a dialog instance.
      Parameters:
      parentShell - the parent shell

  • 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 Window
      Parameters:
      shell - the shell

    • createMessageArea

      protected Label createMessageArea(Composite composite)
      Creates the message area for this dialog.

      This method is provided to allow subclasses to decide where the message will appear on the screen.

      Parameters:
      composite - the parent composite
      Returns:
      the message label

    • getInitialSelection

      protected List<T> getInitialSelection()
      Returns the collection of initial element selections.
      Returns:
      Collection

    • getMessage

      protected String getMessage()
      Returns the message for this dialog.
      Returns:
      the message for this dialog

    • getResult

      public Collection<T> getResult()
      Returns the collection of selections made by the user.
      Returns:
      the collection of selected elements, or Collections.emptyList() if no result was set

    • getFirstResult

      public Optional<T> getFirstResult()
      Returns an java.util.Optional<T> containing the first element from the collection of selections made by the user. Returns Optional.empty() if no element has been selected.
      Returns:
      an java.util.Optional<T> containing the first result element if one exists. Otherwise Optional.empty() is returned.
      Since:
      3.16

    • setInitialSelection

      public void setInitialSelection(T... selectedElements)
      Sets the initial selection in this selection dialog to the given elements.
      Parameters:
      selectedElements - the elements to select

    • setInitialSelection

      public void setInitialSelection(Collection<T> selectedElements)
      Sets the initial selection in this selection dialog to the given elements.
      Parameters:
      selectedElements - the List of elements to select

    • setMessage

      public void setMessage(String message)
      Sets the message for this dialog.
      Parameters:
      message - the message

    • setResult

      protected void setResult(Collection<T> newUserSelection)
      Set the selections made by the user.

      The result may be accessed using getResult.

      Parameters:
      newUserSelection - collection of selected elements

    • setResult

      protected void setResult(T... newUserSelection)
      Set the selections made by the user.

      The result may be accessed using getResult.

      Parameters:
      newUserSelection - - the new values

    • setResult

      protected void setResult(ISelection selection, Class<T> target)
      Set the selections obtained from a viewer.
      Parameters:
      selection - selection obtained from a viewer
      target - target type to check for instanceof
      Since:
      3.16

    • setTitle

      public void setTitle(String title)
      Sets the title for this dialog.
      Parameters:
      title - the title

    • setDialogBoundsSettings

      public void setDialogBoundsSettings(IDialogSettings settings, int strategy)
      Set the dialog settings that should be used to save the bounds of this dialog. This method is provided so that clients that directly use SelectionDialogs without subclassing them may specify how the bounds of the dialog are to be saved.
      Parameters:
      settings - the IDialogSettings that should be used to store the bounds of the dialog
      strategy - the integer constant specifying how the bounds are saved. Specified using Dialog.DIALOG_PERSISTLOCATION and Dialog.DIALOG_PERSISTSIZE.
      Since:
      3.2
      See Also:

    • getDialogBoundsSettings

      protected IDialogSettings getDialogBoundsSettings()
      Description copied from class: Dialog
      Gets the dialog settings that should be used for remembering the bounds of of the dialog, according to the dialog bounds strategy.
      Overrides:
      getDialogBoundsSettings in class Dialog
      Returns:
      settings the dialog settings used to store the dialog's location and/or size, or null if the dialog's bounds should never be stored.
      See Also:

    • getDialogBoundsStrategy

      protected int getDialogBoundsStrategy()
      Description copied from class: Dialog
      Get the integer constant that describes the strategy for persisting the dialog bounds. This strategy is ignored if the implementer does not also specify the dialog settings for storing the bounds in Dialog.getDialogBoundsSettings().
      Overrides:
      getDialogBoundsStrategy in class Dialog
      Returns:
      the constant describing the strategy for persisting the dialog bounds.
      See Also:

    • isResizable

      protected boolean isResizable()
      Description copied from class: Dialog
      Returns a boolean indicating whether the dialog should be considered resizable when the shell style is initially set.

      This method is used to ensure that all style bits appropriate for resizable dialogs are added to the shell style. Individual dialogs may always set the shell style to ensure that a dialog is resizable, but using this method ensures that resizable dialogs will be created with the same set of style bits.

      Style bits will never be removed based on the return value of this method. For example, if a dialog returns false, but also sets a style bit for a SWT.RESIZE border, the style bit will be honored.

      Overrides:
      isResizable in class Dialog
      Returns:
      a boolean indicating whether the dialog is resizable and should have the default style bits for resizable dialogs