Class LinkWithEditorContribution

  • All Implemented Interfaces:
    IOutlineContribution

    public abstract class LinkWithEditorContribution
    extends OutlineContribution
    An abstract base class for link-with-editor contributions.

    Contributes link-with-editor behavior, if the outline page supports linking with editor. The activation of the feature is governed by the corresponding preference. Subclasses must implement linking logic in a linking helper.

    • Constructor Detail

      • LinkWithEditorContribution

        public LinkWithEditorContribution()
    • Method Detail

      • init

        public void init​(ICommonOutlinePage outlinePage)
        Description copied from class: OutlineContribution
        Initializes this contribution. This method is called after the outline page's tree viewer has been created.

        This method may be extended by subclasses. Subclasses must call the superclass implementation.

        Specified by:
        init in interface IOutlineContribution
        Overrides:
        init in class OutlineContribution
        Parameters:
        outlinePage - the contribution's outline page (never null)
      • dispose

        public void dispose()
        Description copied from class: OutlineContribution
        Disposes of this contribution. Implementors should clean up any resources associated with this contribution. Note that there is no guarantee that init() has been called. This method has no effect if this contribution has already been disposed.

        This method may be extended by subclasses. Subclasses must call the superclass implementation.

        Specified by:
        dispose in interface IOutlineContribution
        Overrides:
        dispose in class OutlineContribution
      • getLinkingHelper

        protected abstract org.eclipse.ui.OpenAndLinkWithEditorHelper getLinkingHelper()
        Returns a linking helper that will provide link-with-editor logic for the outline page. This method is called once, when this contribution is initializing.
        Returns:
        the linking helper (not null)