org.eclipse.ui.navigator
Class CommonNavigator

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.ui.part.WorkbenchPart
          org.eclipse.ui.part.ViewPart
              org.eclipse.ui.navigator.CommonNavigator

All Implemented Interfaces:

IAdaptable, IExecutableExtension, IPersistable, ISetSelectionTarget, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPartOrientation

public class CommonNavigator

extends ViewPart

implements ISetSelectionTarget

This class provides the IViewPart for the Common Navigator framework in the Eclipse workbench. This class also serves as the backbone for navigational viewers. The following types are used by this class to render the Common Navigator:

• CommonViewer: The viewer that renders the extensible tree. Creates and manages the lifecylce of the Navigator Content Service (described below).

• NavigatorActionService: Manages instances of CommonActionProviders provided by individual extensions and content extensions.

• INavigatorContentService: Manages instances of Navigator Content Extensions. Instances are created as needed, and disposed of upon the disposal of the Navigator Content Service.

Clients are not expected to subclass CommonNavigator. Clients that wish to define their own custom extensible navigator view need to specify an instance of the org.eclipse.ui.views extension point:

   
          <extension
          		point="org.eclipse.ui.views">
          	<view
          		name="My Custom View"
          		icon="relative/path/to/icon.gif"
          		category="org.acme.mycategory"
          		class="org.eclipse.ui.navigator.CommonNavigator"
          		id="org.acme.MyCustomNavigatorID">
          	</view>
          </extension> 
    
 

Clients that wish to extend the view menu provided via the org.eclipse.ui.popupMenus extension may specify the the popupMenuId specified by org.eclipse.ui.navigator.viewer (or a nested popupMenu element) of their target viewer as their target menu id.

This class may be instantiated; it is not intended to be subclassed.

Since:

3.2

Field Summary

static int

IS_LINKING_ENABLED_PROPERTY Used to track changes to the isLinkingEnabled() property.

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

CommonNavigator()

Method Summary

protected ActionGroup	createCommonActionGroup() The ActionGroup is used to populate the ActionBars of Common Navigator View Part, and the returned implementation will have an opportunity to fill the ActionBars of the view as soon as it is created.
protected org.eclipse.ui.internal.navigator.CommonNavigatorManager	createCommonManager() The Common Navigator Manager handles the setup of the Common Navigator Menu, manages updates to the ActionBars from CommonActionProvider extensions as the user's selection changes, and also updates the status bar based on the current selection.
protected CommonViewer	createCommonViewer(Composite aParent) Constructs and returns an instance of CommonViewer.
protected DisposeListener	createDisposeListener()
void	createPartControl(Composite aParent) Create the CommonViewer part control and setup the default providers as necessary.
void	dispose() Note: This method is for internal use only.
Object	getAdapter(Class adapter) Returns an object which is an instance of the given class associated with this object.
CommonViewer	getCommonViewer() Provides access to the commonViewer used by the current CommonNavigator.
protected String	getFrameToolTipText(Object anElement) Returns the tool tip text for the given element.
protected IAdaptable	getInitialInput()
NavigatorActionService	getNavigatorActionService()
INavigatorContentService	getNavigatorContentService()
protected void	handleDoubleClick(DoubleClickEvent anEvent) Note: This method is for internal use only.
void	init(IViewSite aSite, IMemento aMemento) Note: This method is for internal use only.
protected void	initListeners(TreeViewer viewer) Adds the listeners to the Common Viewer.
boolean	isLinkingEnabled()
void	saveState(IMemento aMemento) Note: This method is for internal use only.
void	selectReveal(ISelection selection) Set the selection to the Common Navigator tree, and expand nodes if necessary.
void	setFocus() Force the workbench to focus on the Common Navigator tree.
void	setLinkingEnabled(boolean toEnableLinking) Linking is handled by an action which listens for changes to the IS_LINKING_ENABLED_PROPERTY.
protected void	updateTitle() Updates the title text and title tool tip.

Methods inherited from class org.eclipse.ui.part.ViewPart

checkSite, getViewSite, init, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPropertyListener, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Field Detail

IS_LINKING_ENABLED_PROPERTY

public static final int IS_LINKING_ENABLED_PROPERTY

Used to track changes to the isLinkingEnabled() property.

See Also:

Constant Field Values

Constructor Detail

CommonNavigator

public CommonNavigator()

Method Detail

createPartControl

public void createPartControl(Composite aParent)

Create the CommonViewer part control and setup the default providers as necessary.

Specified by:

createPartControl in interface IWorkbenchPart

Specified by:

createPartControl in class WorkbenchPart

See Also:

WorkbenchPart.createPartControl(org.eclipse.swt.widgets.Composite)

dispose

public void dispose()

Note: This method is for internal use only. Clients should not call this method.

This method will be invoked when the DisposeListener is notified of the disposal of the Eclipse view part.

Specified by:

dispose in interface IWorkbenchPart

Overrides:

dispose in class WorkbenchPart

See Also:

WorkbenchPart.dispose()

init

public void init(IViewSite aSite,
                 IMemento aMemento)
          throws PartInitException

Note: This method is for internal use only. Clients should not call this method.

Specified by:

init in interface IViewPart

Overrides:

init in class ViewPart

Throws:

PartInitException

See Also:

ViewPart.init(org.eclipse.ui.IViewSite, org.eclipse.ui.IMemento)

saveState

public void saveState(IMemento aMemento)

Note: This method is for internal use only. Clients should not call this method.

Specified by:

saveState in interface IViewPart

Overrides:

saveState in class ViewPart

See Also:

ViewPart.saveState(org.eclipse.ui.IMemento)

setFocus

public void setFocus()

Force the workbench to focus on the Common Navigator tree.

Specified by:

setFocus in interface IWorkbenchPart

Specified by:

setFocus in class WorkbenchPart

See Also:

WorkbenchPart.setFocus()

selectReveal

public void selectReveal(ISelection selection)

Set the selection to the Common Navigator tree, and expand nodes if necessary. Use caution when invoking this method as it can cause Navigator Content Extensions to load, thus causing plugin activation.

Specified by:

selectReveal in interface ISetSelectionTarget

Parameters:

selection - the new element to select

See Also:

ISetSelectionTarget.selectReveal(org.eclipse.jface.viewers.ISelection)

setLinkingEnabled

public final void setLinkingEnabled(boolean toEnableLinking)

Linking is handled by an action which listens for changes to the IS_LINKING_ENABLED_PROPERTY. Custom implementations that wish to override this functionality, need to override the action used by the default ActionGroup and listen for changes to the above property.

Parameters:

toEnableLinking - True enables linking the current selection with open editors

isLinkingEnabled

public final boolean isLinkingEnabled()

Returns:

Whether linking the current selection with open editors is enabled.

getCommonViewer

public CommonViewer getCommonViewer()

Provides access to the commonViewer used by the current CommonNavigator. The field will not be valid until after init(IViewSite, IMemento) has been called by the Workbench.

Returns:

The (already created) instance of Common Viewer.

getNavigatorContentService

public INavigatorContentService getNavigatorContentService()

Returns:

The Navigator Content Service which populates this instance of Common Navigator

getAdapter

public Object getAdapter(Class adapter)

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface IAdaptable

Overrides:

getAdapter in class WorkbenchPart

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

getNavigatorActionService

public NavigatorActionService getNavigatorActionService()

Returns:

The Navigator Content Service which populates this instance of Common Navigator

createCommonViewer

protected CommonViewer createCommonViewer(Composite aParent)

Constructs and returns an instance of CommonViewer. The ID of the Eclipse view part will be used to create the viewer. The ID is important as some extensions indicate they should only be used with a particular viewer ID.

Parameters:

aParent - A composite parent to contain the Common Viewer

Returns:

An initialized instance of CommonViewer

initListeners

protected void initListeners(TreeViewer viewer)

Adds the listeners to the Common Viewer.

Parameters:

viewer - The viewer

Since:

2.0

handleDoubleClick

protected void handleDoubleClick(DoubleClickEvent anEvent)

Note: This method is for internal use only. Clients should not call this method.

Parameters:

anEvent - Supplied by the DoubleClick listener.

createCommonManager

protected org.eclipse.ui.internal.navigator.CommonNavigatorManager createCommonManager()

The Common Navigator Manager handles the setup of the Common Navigator Menu, manages updates to the ActionBars from CommonActionProvider extensions as the user's selection changes, and also updates the status bar based on the current selection.

Returns:

The Common Navigator Manager class which handles menu population and ActionBars

createCommonActionGroup

protected ActionGroup createCommonActionGroup()

The ActionGroup is used to populate the ActionBars of Common Navigator View Part, and the returned implementation will have an opportunity to fill the ActionBars of the view as soon as it is created. (ActionGroup.fillActionBars(org.eclipse.ui.IActionBars).

The default implementation returns an action group which will add the following actions:

• Link with editor support. Allows the user to toggling linking the current selection with the active editors.

• Collapse all. Collapses all expanded nodes.

• Select Filters. Provides access to the "Select Filters" dialog that allows users to enable/disable filters and also the Content Extension activations.

Returns:

The Action Group to be associated with the Common Navigator View Part.

createDisposeListener

protected DisposeListener createDisposeListener()

Returns:

A listener to track the disposal of the Eclipse view part in order to dispose of the framework state.

getInitialInput

protected IAdaptable getInitialInput()

Returns:

The initial input for the viewer. Defaults to getSite().getPage().getInput()

updateTitle

protected void updateTitle()

Updates the title text and title tool tip. Called whenever the input of the viewer changes.

getFrameToolTipText

protected String getFrameToolTipText(Object anElement)

Returns the tool tip text for the given element. Used as the tool tip text for the current frame, and for the view title tooltip.