|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gmf.runtime.common.core.service.AbstractProvider
org.eclipse.gmf.runtime.common.ui.services.action.contributionitem.AbstractContributionItemProvider
public abstract class AbstractContributionItemProvider
An abstract implementation of the IContributionItemProvider interface This provider performs the contribution by reading its XML contribution descriptor and parsing it in the correct format.
Contribution item providers wishing "not" to read an XML-based descriptor
but rather performs the contribution totally programatically should not
subclass this class but rather implement the IContributionItemProvider
interface directly.
Constructor Summary | |
---|---|
AbstractContributionItemProvider()
|
Method Summary | |
---|---|
void |
contributeToActionBars(IActionBars actionBars,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
|
void |
contributeToPopupMenu(IMenuManager popupMenu,
IWorkbenchPart workbenchPart)
|
protected IAction |
createAction(java.lang.String actionId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Creates the action with the given id. |
protected ActionGroup |
createActionGroup(java.lang.String actionGroupId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Creates the action group for the given id. |
protected IContributionItem |
createCustomContributionItem(java.lang.String customId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Creates the custom contribution with the given id. |
protected IMenuManager |
createMenuManager(java.lang.String menuId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Creates the menu manager with the given id. |
void |
disposeContributions(org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
|
protected IAction |
getAction(java.lang.String actionId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Returns the action with the given id that is created for the given part id. |
protected IAction |
getAction(java.lang.String actionId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor,
org.eclipse.gmf.runtime.common.ui.util.IPartSelector partSelector)
Returns the action with the given id that is created for the given part id. |
protected IAction |
getActionFromRegistry(java.lang.String actionId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor,
ActionRegistry registry)
This method put in order to override the action registry caching. |
protected ActionGroup |
getActionGroup(java.lang.String actionGroupId,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Returns the ActionGroup with the given id that is created for the given part id An ActionGroup is created once and cached for each unique part's id |
protected java.lang.Object |
getSelectedObject(org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Gets the first object in the selection in the workbench part described by partDescriptor . |
protected IStructuredSelection |
getStructuredSelection(org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
Gets the structured selection from the workbench part described by partDescriptor . |
boolean |
provides(IOperation operation)
Indicates whether this provider provides the specified operation. |
void |
setContributionDescriptor(org.eclipse.gmf.runtime.common.ui.services.action.internal.contributionitem.ProviderContributionDescriptor descriptor)
|
void |
updateActionBars(IActionBars actionBars,
org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
|
Methods inherited from class org.eclipse.gmf.runtime.common.core.service.AbstractProvider |
---|
addProviderChangeListener, fireProviderChange, removeProviderChangeListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider |
---|
addProviderChangeListener, removeProviderChangeListener |
Constructor Detail |
---|
public AbstractContributionItemProvider()
Method Detail |
---|
protected IStructuredSelection getStructuredSelection(org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
partDescriptor
.
partDescriptor
- the part descriptor
protected java.lang.Object getSelectedObject(org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
partDescriptor
.
partDescriptor
- the part descriptor
public final void setContributionDescriptor(org.eclipse.gmf.runtime.common.ui.services.action.internal.contributionitem.ProviderContributionDescriptor descriptor)
setContributionDescriptor
in interface org.eclipse.gmf.runtime.common.ui.services.action.internal.contributionitem.IContributionDescriptorReader
public final void contributeToActionBars(IActionBars actionBars, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
contributeToActionBars
in interface org.eclipse.gmf.runtime.common.ui.services.action.internal.contributionitem.IContributionItemProvider
public final void updateActionBars(IActionBars actionBars, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
updateActionBars
in interface org.eclipse.gmf.runtime.common.ui.services.action.internal.contributionitem.IContributionItemProvider
public final void contributeToPopupMenu(IMenuManager popupMenu, IWorkbenchPart workbenchPart)
contributeToPopupMenu
in interface org.eclipse.gmf.runtime.common.ui.services.action.internal.contributionitem.IContributionItemProvider
public final void disposeContributions(org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
disposeContributions
in interface org.eclipse.gmf.runtime.common.ui.services.action.internal.contributionitem.IContributionItemProvider
public final boolean provides(IOperation operation)
IProvider
Providers generally cast the operation to a service specific
IOperation
-derived class in order to determine whether they
support the request.
provides
in interface IProvider
operation
- The operation in question.
true
if this provider provides the operation;
false
otherwise.protected final IAction getAction(java.lang.String actionId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
actionId
- The request action idpartDescriptor
- The workbench part descriptor
protected final IAction getAction(java.lang.String actionId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor, org.eclipse.gmf.runtime.common.ui.util.IPartSelector partSelector)
The part selector is used is when the new action is an
AbstractActionHandler
to determine whether or not the
action is applicable to a given selected part. If the part is not
applicable, the action will not be refreshed when selection changes in
the part.
actionId
- The request action idpartDescriptor
- The workbench part descriptorpartSelector
- The part selector
protected final ActionGroup getActionGroup(java.lang.String actionGroupId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
actionGroupId
- The request action group idpartDescriptor
- The workbench part descriptor
protected IAction getActionFromRegistry(java.lang.String actionId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor, ActionRegistry registry)
actionId
- the action idpartDescriptor
- the part descriptorregistry
- the action registry
actionId
retrieved from the action
registry
.protected IAction createAction(java.lang.String actionId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
actionId
- The action idpartDescriptor
- The workbench part descriptor
protected ActionGroup createActionGroup(java.lang.String actionGroupId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
actionGroupId
- The action group idpartDescriptor
- The workbench part descriptor
protected IMenuManager createMenuManager(java.lang.String menuId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
menuId
- The menu manager idpartDescriptor
- The workbench part descriptor
protected IContributionItem createCustomContributionItem(java.lang.String customId, org.eclipse.gmf.runtime.common.ui.util.IWorkbenchPartDescriptor partDescriptor)
customId
- The custom contribution idpartDescriptor
- The workbench part descriptor
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.