Package org.eclipse.debug.ui

Interface IDetailPane

All Known Subinterfaces:
IDetailPane2, IDetailPane3
public interface IDetailPane
A detail pane is created from a detail pane factory and displays detailed information about a current selection with an SWT Control. Use the org.eclipse.debug.ui.detailFactories extension point to contribute a detail pane factory.

Implementors should implement IDetailPane2 in favor of this interface.

Since:
3.3
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Control
    createControl(Composite parent)
    Creates and returns the main control for this detail pane using the given composite as a parent.
    void
    display(IStructuredSelection selection)
    Displays details for the given selection, possible null.
    void
    dispose()
    Disposes this detail pane.
    String
    getDescription()
    A brief description of this detail pane, or null if none
    String
    getID()
    Returns a unique identifier for this detail pane.
    String
    getName()
    The human readable name of this detail pane.
    void
    init(IWorkbenchPartSite partSite)
    Initializes this detail pane for the given workbench part site.
    boolean
    setFocus()
    Allows this detail pane to give focus to an appropriate control, and returns whether the detail pane accepted focus.

  • Method Details

    • init

      void init(IWorkbenchPartSite partSite)
      Initializes this detail pane for the given workbench part site. This is the first method invoked on a detail pane after instantiation. If this detail pane is being added to a non-view component such as a dialog, the passed workbench part site will be null.
      Parameters:
      partSite - The workbench part site that this detail pane has been created in or null

    • createControl

      Control createControl(Composite parent)
      Creates and returns the main control for this detail pane using the given composite as a parent.
      Parameters:
      parent - The parent composite that UI components should be added to
      Returns:
      The main control for this detail pane

    • dispose

      void dispose()
      Disposes this detail pane. This is the last method invoked on a detail pane and should dispose of all UI components including the main composite returned in createControl().

    • display

      void display(IStructuredSelection selection)
      Displays details for the given selection, possible null. An empty selection or null should clear this detail pane.
      Parameters:
      selection - The selection to be displayed, possibly empty or null

    • setFocus

      boolean setFocus()
      Allows this detail pane to give focus to an appropriate control, and returns whether the detail pane accepted focus. If this detail pane does not want focus, it should return false, allowing the containing view to choose another target for focus.
      Returns:
      whether focus was taken

    • getID

      String getID()
      Returns a unique identifier for this detail pane.
      Returns:
      A unique identifier for this detail pane

    • getName

      String getName()
      The human readable name of this detail pane. This is a short description of the type of details this pane displays that appears in the context menu.
      Returns:
      name of this detail pane

    • getDescription

      String getDescription()
      A brief description of this detail pane, or null if none
      Returns:
      a description of this detail pane, or null if none