public interface IMenuService extends IServiceWithSources
Provides services related to the menu architecture within the workbench. It can be used to contribute additional items to the menu, tool bar and status line.
This service can be acquired from your service locator:
IMenuService service = (IMenuService) getSite().getService(IMenuService.class);
Modifier and Type | Method and Description |
---|---|
void |
addContributionFactory(AbstractContributionFactory factory)
Contribute and initialize the contribution factory.
|
IEvaluationContext |
getCurrentState()
Get the current state of eclipse as seen by the menu service.
|
void |
populateContributionManager(ContributionManager mgr,
String location)
Populate a
ContributionManager at the specified starting
location with a set of IContributionItems s. |
void |
releaseContributions(ContributionManager mgr)
Before calling dispose() on a ContributionManager populated by the menu
service, you must inform the menu service to release its contributions.
|
void |
removeContributionFactory(AbstractContributionFactory factory)
Remove the contributed factory from the menu service.
|
addSourceProvider, removeSourceProvider
dispose
void addContributionFactory(AbstractContributionFactory factory)
Note: factories should be removed when no longer necessary. If not, they will be removed when the IServiceLocator used to acquire this service is disposed.
factory
- the contribution factory. Must not be null
removeContributionFactory(AbstractContributionFactory)
void removeContributionFactory(AbstractContributionFactory factory)
factory
- the contribution factory to remove. Must not be
null
.void populateContributionManager(ContributionManager mgr, String location)
ContributionManager
at the specified starting
location with a set of IContributionItems
s. It applies
AbstractContributionFactory
s that are stored against the
provided location.mgr
- The ContributionManager to populatelocation
- The starting location to begin populating this contribution
manager. The format is the Menu API URI format.releaseContributions(ContributionManager)
void releaseContributions(ContributionManager mgr)
This will not update the ContributionManager (and any widgets). It will simply remove all menu service references to the contents of this ContributionManager.
mgr
- The manager that was populated by a call to
populateContributionManager(ContributionManager, String)
IEvaluationContext getCurrentState()
ISources
,
IEvaluationService
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.