Package org.eclipse.ui.dialogs

Class CheckedTreeSelectionDialog

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.SelectionStatusDialog
org.eclipse.ui.dialogs.CheckedTreeSelectionDialog
All Implemented Interfaces:
IShellProvider
public class CheckedTreeSelectionDialog extends SelectionStatusDialog
A class to select elements out of a tree structure.
Since:
2.0

  • Constructor Details

    • CheckedTreeSelectionDialog

      public CheckedTreeSelectionDialog(Shell parent, ILabelProvider labelProvider, ITreeContentProvider contentProvider)
      Constructs an instance of ElementTreeSelectionDialog.
      Parameters:
      parent - The shell to parent from.
      labelProvider - the label provider to render the entries
      contentProvider - the content provider to evaluate the tree structure

    • CheckedTreeSelectionDialog

      public CheckedTreeSelectionDialog(Shell parent, ILabelProvider labelProvider, ITreeContentProvider contentProvider, boolean allowEmptyTree)
      Constructs an instance of ElementTreeSelectionDialog.
      Parameters:
      parent - The shell to parent from.
      labelProvider - the label provider to render the entries
      contentProvider - the content provider to evaluate the tree structure
      allowEmptyTree - true if an empty tree can be input, false if an empty tree must be treated as an error
      Since:
      3.131

    • CheckedTreeSelectionDialog

      public CheckedTreeSelectionDialog(Shell parent, ILabelProvider labelProvider, ITreeContentProvider contentProvider, int style)
      Constructs an instance of ElementTreeSelectionDialog.
      Parameters:
      parent - The shell to parent from.
      labelProvider - the label provider to render the entries
      contentProvider - the content provider to evaluate the tree structure
      style - the style of the tree
      Since:
      3.105

    • CheckedTreeSelectionDialog

      public CheckedTreeSelectionDialog(Shell parent, ILabelProvider labelProvider, ITreeContentProvider contentProvider, int style, boolean allowEmptyTree)
      Constructs an instance of ElementTreeSelectionDialog.
      Parameters:
      parent - The shell to parent from.
      labelProvider - the label provider to render the entries
      contentProvider - the content provider to evaluate the tree structure
      style - the style of the tree
      allowEmptyTree - true if an empty tree can be input, false if an empty tree must be treated as an error
      Since:
      3.131

  • Method Details

    • setContainerMode

      public void setContainerMode(boolean containerMode)
      If set, the checked /gray state of containers (inner nodes) is derived from the checked state of its leaf nodes.
      Parameters:
      containerMode - The containerMode to set

    • setInitialSelection

      public void setInitialSelection(Object selection)
      Sets the initial selection. Convenience method.
      Parameters:
      selection - the initial selection.

    • setEmptyListMessage

      public void setEmptyListMessage(String message)
      Sets the message to be displayed if the list is empty.
      Parameters:
      message - the message to be displayed.

    • setSorter

      @Deprecated public void setSorter(ViewerSorter sorter)
      Deprecated.
      since 3.3, use setComparator(ViewerComparator) instead
      Sets the sorter used by the tree viewer.
      Parameters:
      sorter - the sorter

    • setStyle

      public void setStyle(int style)
      Set the style used for the creation of the Tree. Changing this will only have an effect up to the time the Tree is created.
      Parameters:
      style - the style of the tree
      Since:
      3.105

    • setComparator

      public void setComparator(ViewerComparator comparator)
      Sets the comparator used by the tree viewer.
      Parameters:
      comparator - the ViewerComparator
      Since:
      3.3

    • addFilter

      public void addFilter(ViewerFilter filter)
      Adds a filter to the tree viewer.
      Parameters:
      filter - a filter.

    • setValidator

      public void setValidator(ISelectionStatusValidator validator)
      Sets an optional validator to check if the selection is valid. The validator is invoked whenever the selection changes.
      Parameters:
      validator - the validator to validate the selection.

    • setInput

      public void setInput(Object input)
      Sets the tree input.
      Parameters:
      input - the tree input.

    • setExpandedElements

      public void setExpandedElements(Object[] elements)
      Expands elements in the tree.
      Parameters:
      elements - The elements that will be expanded.

    • setSize

      public void setSize(int width, int height)
      Sets the size of the tree in unit of characters.
      Parameters:
      width - the width of the tree.
      height - the height of the tree.

    • updateOKStatus

      protected void updateOKStatus()
      Validate the receiver and update the status with the result.

    • open

      public int open()
      Description copied from class: Window
      Opens this window, creating it first if it has not yet been created.

      If this window has been configured to block on open ( setBlockOnOpen), this method waits until the window is closed by the end user, and then it returns the window's return code; otherwise, this method returns immediately. A window's return codes are window-specific, although two standard return codes are predefined: OK and CANCEL.

      Overrides:
      open in class Window
      Returns:
      the return code
      See Also:

    • cancelPressed

      protected void cancelPressed()
      Handles cancel button pressed event.
      Overrides:
      cancelPressed in class Dialog

    • computeResult

      protected void computeResult()
      Description copied from class: SelectionStatusDialog
      Compute the result and return it.
      Specified by:
      computeResult in class SelectionStatusDialog

    • create

      public void create()
      Description copied from class: Window
      Creates this window's widgetry in a new top-level shell.

      The default implementation of this framework method creates this window's shell (by calling createShell), and its controls (by calling createContents), then initializes this window's shell bounds (by calling initializeBounds).

      Overrides:
      create in class SelectionStatusDialog

    • 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

    • createTreeViewer

      protected CheckboxTreeViewer createTreeViewer(Composite parent)
      Creates the tree viewer.
      Parameters:
      parent - the parent composite
      Returns:
      the tree viewer

    • getTreeViewer

      protected CheckboxTreeViewer getTreeViewer()
      Returns the tree viewer.
      Returns:
      the tree viewer

    • createSelectionButtons

      protected Composite createSelectionButtons(Composite composite)
      Adds the selection and deselection buttons to the dialog.
      Parameters:
      composite - the parent composite
      Returns:
      Composite the composite the buttons were created in.