Package org.eclipse.ui.dialogs

Class ListDialog

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.ListDialog
All Implemented Interfaces:
IShellProvider
public class ListDialog extends SelectionDialog
A dialog that prompts for one element out of a list of elements. Uses IStructuredContentProvider to provide the elements and ILabelProvider to provide their labels.
Since:
2.1

  • Constructor Details

    • ListDialog

      public ListDialog(Shell parent)
      Create a new instance of the receiver with parent shell of parent.
      Parameters:
      parent - the parent shell

  • Method Details

    • setInput

      public void setInput(Object input)
      Parameters:
      input - The input for the list.

    • setContentProvider

      public void setContentProvider(IStructuredContentProvider sp)
      Parameters:
      sp - The content provider for the list.

    • setLabelProvider

      public void setLabelProvider(ILabelProvider lp)
      Parameters:
      lp - The labelProvider for the list.

    • setAddCancelButton

      public void setAddCancelButton(boolean addCancelButton)
      Parameters:
      addCancelButton - if true there will be a cancel button.

    • getTableViewer

      public TableViewer getTableViewer()
      Returns:
      the TableViewer for the receiver.

    • createButtonsForButtonBar

      protected void createButtonsForButtonBar(Composite parent)
      Description copied from class: Dialog
      Adds buttons to this dialog's button bar.

      The Dialog implementation of this framework method adds standard ok and cancel buttons using the createButton framework method. These standard buttons will be accessible from getCancelButton, and getOKButton. 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:
      createButtonsForButtonBar in class SelectionDialog
      Parameters:
      parent - the button bar composite

    • createDialogArea

      protected Control createDialogArea(Composite container)
      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:
      container - the parent composite to contain the dialog area
      Returns:
      the dialog area control

    • getTableStyle

      protected int getTableStyle()
      Return the style flags for the table viewer.
      Returns:
      int

    • okPressed

      protected void okPressed()
      Description copied from class: Dialog
      Notifies that the ok button of this dialog has been pressed.

      The Dialog implementation of this framework method sets this dialog's return code to Window.OK and closes the dialog. Subclasses may override.

      Overrides:
      okPressed in class Dialog

    • getHeightInChars

      public int getHeightInChars()
      Returns the initial height of the dialog in number of characters.
      Returns:
      the initial height of the dialog in number of characters

    • getWidthInChars

      public int getWidthInChars()
      Returns the initial width of the dialog in number of characters.
      Returns:
      the initial width of the dialog in number of characters

    • setHeightInChars

      public void setHeightInChars(int heightInChars)
      Sets the initial height of the dialog in number of characters.
      Parameters:
      heightInChars - the initialheight of the dialog in number of characters

    • setWidthInChars

      public void setWidthInChars(int widthInChars)
      Sets the initial width of the dialog in number of characters.
      Parameters:
      widthInChars - the initial width of the dialog in number of characters