Java Doc for CommonNavigator.java in  » IDE-Eclipse » ui » org » eclipse » ui » navigator » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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:

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

• org.eclipse.ui.navigator.NavigatorActionService : Manages instances of org.eclipse.ui.navigator.CommonActionProvider s provided by individual extensions and content extensions.

• org.eclipse.ui.navigator.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> 
 

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

Used to track changes to the CommonNavigator.isLinkingEnabled  property.

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.

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.

Constructs and returns an instance of CommonViewer .

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

Note: This method is for internal use only.

Provides access to the commonViewer used by the current CommonNavigator.

Returns the tool tip text for the given element.

Note: This method is for internal use only.

Note: This method is for internal use only.

Adds the listeners to the Common Viewer.

Note: This method is for internal use only.

Set the selection to the Common Navigator tree, and expand nodes if necessary.

Force the workbench to focus on the Common Navigator tree.

Linking is handled by an action which listens for changes to the CommonNavigator.IS_LINKING_ENABLED_PROPERTY .

Updates the title text and title tool tip.

Used to track changes to the CommonNavigator.isLinkingEnabled  property.

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.

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. The Common Navigator Manager class which handles menu populationand ActionBars

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 An initialized instance of CommonViewer

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

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.

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

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.

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

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

Adds the listeners to the Common Viewer.

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

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.

Force the workbench to focus on the Common Navigator tree.

Linking is handled by an action which listens for changes to the CommonNavigator.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

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