| org.eclipse.ui.navigator |
|
Package-level Javadoc
Provides the Common Navigator framework. Services allow clients to contribute
reusable content/label providers and define viewers that use the available content/label
providers.
|
| Java Source File Name | Type | Comment |
| CommonActionProvider.java | Class |
Provides actions from extensions for menu and
org.eclipse.ui.IActionBars contributions.
This abstract class should be extended by clients of the
org.eclipse.ui.navigator.navigatorContent extension point for
top-level and nested actionProvider elements.
CommonActionProvider s may be declared as top-level elements in the
extension point (e.g. |
| CommonDragAdapter.java | Class | Provides an implementation of
DragSourceAdapter which uses the
extensions provided by the associated
INavigatorContentService .
Clients should not need to create an instance of this class unless they are
creating their own custom viewer. |
| CommonDragAdapterAssistant.java | Class | Assist the
CommonDragAdapter by providing new TransferTypes and the
logic to handle setting up the transfer data. |
| CommonDropAdapter.java | Class | Provides an implementation of
PluginDropAdapter which uses the
extensions provided by the associated
INavigatorContentService .
Clients should not need to create an instance of this class unless they are
creating their own custom viewer. |
| CommonDropAdapterAssistant.java | Class |
Used by the
org.eclipse.ui.navigator.navigatorContent/navigatorContent/commonDropAdapter
extension point to carry out pluggable drop operations.
Each
CommonDropAdapterAssistant is contained by single content
extension. |
| CommonNavigator.java | Class |
This class provides the IViewPart for the Common Navigator framework in the
Eclipse workbench. |
| CommonViewer.java | Class | Provides the Tree Viewer for the Common Navigator. |
| CommonViewerSiteFactory.java | Class | Allows clients to create
ICommonViewerSite for a variety of contexts. |
| CommonViewerSorter.java | Class | Provides an implementation of TreeViewerSorter that uses the given parent to determine the
correct sort order based on the defined
org.eclipse.ui.navigator.navigatorContent/navigatorContent/commonSorter elements
available in the set of visible content extensions.
The CommonViewerSorter must be assigned a
INavigatorContentService to drive its sorting
algorithm. |
| ICommonActionConstants.java | Interface | Defines constants for the retargetable actions available in the Common Viewer
context menu. |
| ICommonActionExtensionSite.java | Interface | Provides access to information required for the initialization of
CommonActionProviders. |
| ICommonContentExtensionSite.java | Interface | Provides initialization data for a content extension. |
| ICommonContentProvider.java | Interface | Allows extensions to vary their behavior based on properties in the extension
model and the given memento. |
| ICommonFilterDescriptor.java | Interface | Provides information about a commonFilter extension. |
| ICommonLabelProvider.java | Interface | Allows extensions to vary their behavior based on properties in the extension
model and the given memento.
Clients should refer to the org.eclipse.ui.navigator.navigatorContent
extension point for more information on building a content extension.
Clients should not dispose of any Image Resources that might be shared by
other extensions when their Label Provider is disposed. |
| ICommonMenuConstants.java | Interface | Defines strings used for menu insertion points. |
| ICommonViewerSite.java | Interface | Provides context for extensions including a valid shell, a selection
provider, and a unique identifer corresponding to the abstract viewer behind
the viewer site. |
| ICommonViewerWorkbenchSite.java | Interface | Provides a page, set of action bars, menu registration callback, and active
window. |
| IDescriptionProvider.java | Interface | Label providers (as specified by the labelProvider attribute of the
org.eclipse.ui.navigator.navigatorContent extension point) may
choose to also implement this interface in order to provide text for
the status bar at the bottom of the Eclipse window. |
| IExtensionActivationListener.java | Interface | An extension activation listener is notified whenever the activation state
changese for one or more content extensions. |
| IExtensionStateModel.java | Interface | Allows clients to coordinate state across components that are part of the
same logical extension.
That is, a content provider might vary how it exposes its content based on
the state of a specific property in the model. |
| ILinkHelper.java | Interface |
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. |
| IMementoAware.java | Interface | Clients may use mementos to persist interesting state between sessions. |
| INavigatorActivationService.java | Interface | Determines if an extension is active within the context of a given
viewer and manages the persistence of this information. |
| INavigatorContentDescriptor.java | Interface | The descriptor provides a handle to a content extension. |
| INavigatorContentExtension.java | Interface | The content extension represents the components of a navigatorContent
extension. |
| INavigatorContentService.java | Interface | Manages content extensions for extensible viewers and provides reusable
services for filters, sorting, the activation of content extensions, and DND.
The service can locate the appropriate providers (for contents or labels) for
an element and provide a ready-to-go
ITreeContentProvider and
ILabelProvider for viewers that wish to take advantage of the
org.eclipse.ui.navigator.navigatorContent extensions defined for a
particular viewerId.
Clients should create instances of the this class using the factory (
NavigatorContentServiceFactory ).
Clients may contribute logical extensions using
org.eclipse.ui.navigator.navigatorContent. |
| INavigatorContentServiceListener.java | Interface |
Used by clients who would like to listen for the load event of am
INavigatorContentExtension . |
| INavigatorDnDService.java | Interface | Provides instances of
CommonDragAdapterAssistant and
CommonDropAdapterAssistant for the associated
INavigatorContentService .
Clients should only take note of this Service they are are using the
INavigatorContentService in the context of a viewer which is not or
does not extend
CommonViewer . |
| INavigatorFilterService.java | Interface | Provides support for managing the filters defined for a Common Navigator
viewer.
An INavigatorFilterService manages the available common filters and their
current activation state for a particular INavigatorContentService. |
| INavigatorPipelineService.java | Interface | Performs calculations that are necessary to determine the correct children to
render in the viewer. |
| INavigatorSaveablesService.java | Interface | This interface is not intended to be implemented by clients. |
| INavigatorSorterService.java | Interface | Provides an interface to extensions declared in
org.eclipse.ui.navigator.navigatorContent/commonSorter. |
| INavigatorViewerDescriptor.java | Interface | Provides a basic metadata about the abstract viewer for a particular content
service. |
| IPipelinedTreeContentProvider.java | Interface | A pipelined content provider allows an extension to reshape the contributions
of an upstream content extension.
An "upstream" extension is either:
- the extension overridden by this extension using the
org.eclipse.ui.navigatorContent/navigatorContent/override element, or
- another extension that overrides the same extension this extension
overrides, but with higher priority than this extension.
|
| MenuInsertionPoint.java | Class | A descriptive construct to relay information about a menu insertion point;
including the name of the insertion point and whether the item should be
rendered as a separator or group marker. |
| NavigatorActionService.java | Class |
Provides context menu items and
IActionBars contributions for a particular abstract
viewer. |
| NavigatorContentServiceFactory.java | Class | Provides a factory pattern for creating
INavigatorContentService s
for given viewer ids. |
| PipelinedShapeModification.java | Class | Indicates how a shape modification should be transformed when applied to the
tree. |
| PipelinedViewerUpdate.java | Class | A pipelined viewer update should map requests to refresh or update elements
in the viewer to their correct, modified structure. |
| Priority.java | Class |
Enumeration of the Priority values supported by the Common Navigator. |
| SaveablesProvider.java | Class | Provides
Saveable objects to the common navigator, and allows to map
between elements in the tree and models. |
| WizardActionGroup.java | Class | Populates context menus with shortcut actions for defined wizards. |