org.eclipse.ui.navigator
Class CommonActionProviderConfig

java.lang.Object
  org.eclipse.ui.navigator.CommonActionProviderConfig

public final class CommonActionProviderConfig

extends Object

Provides access to information required for the initialization of CommonActionProviders.

See the documentation of the org.eclipse.ui.navigator.navigatorContent extension point and CommonActionProvider for more information on declaring CommonActionProviders.

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.

Since:

3.2

Constructor Summary

CommonActionProviderConfig(String anExtensionId, ICommonViewerSite aCommonViewerSite, INavigatorContentService aContentService, StructuredViewer aStructuredViewer)
Create a config element for the initialization of Common Action Providers.

Method Summary

INavigatorContentService	getContentService()
String	getExtensionId()
IExtensionStateModel	getExtensionStateModel() By default, the extension state model returned is for the associated content extension (if this is NOT a top-level action provider).
StructuredViewer	getStructuredViewer()
ICommonViewerSite	getViewSite()

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonActionProviderConfig

public CommonActionProviderConfig(String anExtensionId,
                                  ICommonViewerSite aCommonViewerSite,
                                  INavigatorContentService aContentService,
                                  StructuredViewer aStructuredViewer)

Create a config element for the initialization of Common Action Providers.

Parameters:

anExtensionId - The unique identifier of the associated content extension or the top-level action provider. May NOT be null.

aCommonViewerSite - The common viewer site may be used to access information about the part for which the instantiated CommonActionProvider will be used. May NOT be null.

aContentService - The associated content service to allow coordination with content extensions via the IExtensionStateModel. Clients may access the content providers and label providers as necessary also to render labels or images in their UI. May NOT be null.

aStructuredViewer - The viewer control that will use the instantiated Common Action Provider. May NOT be null.

Method Detail

getExtensionStateModel

public IExtensionStateModel getExtensionStateModel()

By default, the extension state model returned is for the associated content extension (if this is NOT a top-level action provider). Otherwise, clients may use INavigatorContentService.findStateModel(String) to locate the state model of another content extension.

Returns:

The extension state model of the associated Content Extension (if any) or a state model specifically for this ICommonActionProvider.

See Also:

IExtensionStateModel

getExtensionId

public String getExtensionId()

Returns:

The unique identifier of the associated content extension or the top-level Common Action Provider.

getContentService

public INavigatorContentService getContentService()

Returns:

The associated content service for the instantiated Common Action Provider.

getStructuredViewer

public StructuredViewer getStructuredViewer()

Returns:

The associated structured viewer for the instantiated Common Action Provider.

getViewSite

public ICommonViewerSite getViewSite()

Returns:

The ICommonViewerSite from the CommonViewer.