Eclipse Platform
Release 3.2

org.eclipse.ui.navigator
Interface ILinkHelper


public interface ILinkHelper

Provides information to the Common Navigator on how to link selections with active editors and vice versa.

The Common Navigator allows clients to plug-in their own custom logic for linking selections from the Viewer to active editors. This interface is used by the org.eclipse.ui.navigator.linkHelper extension point to gather information and trigger editor activations.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is a guarantee neither that this API will work nor that it will remain the same. Please do not use this API without consulting with the Platform/UI team.

Clients may implement this interface.

Since:
3.2

Method Summary
 void activateEditor(IWorkbenchPage aPage, IStructuredSelection aSelection)
           Activate the correct editor for aSelection.
 IStructuredSelection findSelection(IEditorInput anInput)
           Determine the correct structured selection for the Common Navigator given anInput.
 

Method Detail

findSelection

public IStructuredSelection findSelection(IEditorInput anInput)

Determine the correct structured selection for the Common Navigator given anInput.

Parameters:
anInput - An Editor input
Returns:
A selection to be set against the CommonViewer

activateEditor

public void activateEditor(IWorkbenchPage aPage,
                           IStructuredSelection aSelection)

Activate the correct editor for aSelection.

Parameters:
aPage - A WorkbenchPage to use for editor location and activation
aSelection - The current selection from the CommonViewer

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.