org.eclipse.rse.core
Class SystemPopupMenuActionContributor

java.lang.Object
  org.eclipse.ui.internal.registry.RegistryReader
      org.eclipse.ui.internal.PluginActionBuilder
          org.eclipse.rse.core.SystemPopupMenuActionContributor

All Implemented Interfaces:

IObjectActionContributor, IObjectContributor

public class SystemPopupMenuActionContributor

extends PluginActionBuilder

implements IObjectActionContributor

This class parses the tag from our org.eclipse.rse.core.PopupMenus extension point.

We modelled our org.eclipse.rse.core.popupMenus extension point after the org.eclipse.ui.popupMenus extension point, so it makes sense to model the code to support it after the Eclipse code to support theirs. To that end, we have to replace the class that parses the tag, because that class does not support subclassing, and change it to:

• Ignore all processing of the objectClass attribute, because we don't have one.
• Add processing for the filter attributes we added: subsystemconfigurationid, namefilter, typecategoryfilter, typefilter, subtypefilter, subsubtypefilter

TODO use overrides list

See Also:

SystemPopupMenuActionContributorManager

Nested Class Summary

Nested classes inherited from class org.eclipse.ui.internal.PluginActionBuilder

PluginActionBuilder.BasicContribution

Field Summary

Fields inherited from class org.eclipse.ui.internal.PluginActionBuilder

cache, currentContribution, targetContributionTag, targetID

Constructor Summary

SystemPopupMenuActionContributor(IConfigurationElement element)
Constructor for SystemPopupMenuActionContributor

Method Summary

protected void	addGroup(IContributionManager mgr, String name) Adds a group to a contribution manager.
boolean	canAdapt()
protected void	contributeGroupMarker(IMenuManager menu, IConfigurationElement element) Creates a named menu group marker from the information in the configuration element.
protected void	contributeMenu(IConfigurationElement menuElement, IMenuManager mng, boolean appendIfMissing) Creates a menu from the information in the menu configuration element and adds it into the provided menu manager.
protected void	contributeMenuAction(ActionDescriptor ad, IMenuManager menu, boolean appendIfMissing) Contributes action from action descriptor into the provided menu manager.
void	contributeObjectActionIdOverrides(List actionIdOverrides) Contribute to the list the action identifiers from other contributions that this contribution wants to override.
boolean	contributeObjectActions(IWorkbenchPart part, IMenuManager menu, ISelectionProvider selProv, List actionIdOverrides) Contributes actions applicable for the current selection.
boolean	contributeObjectActions(IWorkbenchPart part, SystemMenuManager menu, ISelectionProvider selProv, List actionIdOverrides) Contributes actions applicable for the current selection.
boolean	contributeObjectMenus(IMenuManager menu, ISelectionProvider selProv) Contributes menus applicable for the current selection.
boolean	contributeObjectMenus(SystemMenuManager menu, ISelectionProvider selProv) Contributes menus applicable for the current selection.
protected void	contributeSeparator(IMenuManager menu, IConfigurationElement element) Creates a named menu separator from the information in the configuration element.
protected void	contributeToolbarAction(ActionDescriptor ad, IToolBarManager toolbar, boolean appendIfMissing) Contributes action from the action descriptor into the provided tool bar manager.
protected ActionDescriptor	createActionDescriptor(IConfigurationElement element) This factory method returns a new ActionDescriptor for the configuration element.
String	getCategoryFilter() Return what was specified for the typecategoryfilter xml attribute.
String	getNameFilter() Return what was specified for the namefilter xml attribute.
String	getSubSubTypeFilter() Return what was specified for the subsubtypefilter xml attribute.
String	getSubSystemConfigurationCategoryFilter() Return what was specified for the subsystemconfigurationCategory xml attribute.
String	getSubSystemConfigurationId() Return what was specified for the subsystemconfigurationid xml attribute.
String	getSubTypeFilter() Return what was specified for the subtypefilter xml attribute.
String	getSystemTypesFilter() Return what was specified for the systemTypes xml attribute.
String	getTypeFilter() Return what was specified for the typefilter xml attribute.
protected void	insertAfter(IContributionManager mgr, String refId, IContributionItem item) Inserts a contribution item after another named contribution item.
protected void	insertAfter(IContributionManager mgr, String refId, PluginAction action) Inserts an action after another named contribution item.
protected void	insertMenuGroup(IMenuManager menu, AbstractGroupMarker marker) Inserts the separator or group marker into the menu.
boolean	isApplicableTo(Object object) Returns true if the current selection matches all the given filtering criteria.
protected void	readContributions(String id, String tag, String extensionPoint)
protected boolean	readElement(IConfigurationElement element) Implements abstract method to handle the provided XML element in the registry.

Methods inherited from class org.eclipse.ui.internal.PluginActionBuilder

contribute, createContribution, getID, getTargetID

Methods inherited from class org.eclipse.ui.internal.registry.RegistryReader

getClassValue, getDescription, logError, logMissingAttribute, logMissingElement, logUnknownElement, orderExtensions, readElementChildren, readElements, readExtension, readRegistry

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemPopupMenuActionContributor

public SystemPopupMenuActionContributor(IConfigurationElement element)

Constructor for SystemPopupMenuActionContributor

Method Detail

getCategoryFilter

public String getCategoryFilter()

Return what was specified for the typecategoryfilter xml attribute.

getNameFilter

public String getNameFilter()

Return what was specified for the namefilter xml attribute.

getTypeFilter

public String getTypeFilter()

Return what was specified for the typefilter xml attribute.

getSubTypeFilter

public String getSubTypeFilter()

Return what was specified for the subtypefilter xml attribute.

getSubSubTypeFilter

public String getSubSubTypeFilter()

Return what was specified for the subsubtypefilter xml attribute.

getSubSystemConfigurationId

public String getSubSystemConfigurationId()

Return what was specified for the subsystemconfigurationid xml attribute.

getSubSystemConfigurationCategoryFilter

public String getSubSystemConfigurationCategoryFilter()

Return what was specified for the subsystemconfigurationCategory xml attribute.

getSystemTypesFilter

public String getSystemTypesFilter()

Return what was specified for the systemTypes xml attribute.

contributeObjectActions

public boolean contributeObjectActions(IWorkbenchPart part,
                                       SystemMenuManager menu,
                                       ISelectionProvider selProv,
                                       List actionIdOverrides)

Contributes actions applicable for the current selection.

contributeObjectActions

public boolean contributeObjectActions(IWorkbenchPart part,
                                       IMenuManager menu,
                                       ISelectionProvider selProv,
                                       List actionIdOverrides)

Contributes actions applicable for the current selection.

Specified by:

contributeObjectActions in interface IObjectActionContributor

contributeObjectActionIdOverrides

public void contributeObjectActionIdOverrides(List actionIdOverrides)

Contribute to the list the action identifiers from other contributions that this contribution wants to override. Actions of these identifiers will not be contributed.

Specified by:

contributeObjectActionIdOverrides in interface IObjectActionContributor

See Also:

IObjectActionContributor

contributeObjectMenus

public boolean contributeObjectMenus(SystemMenuManager menu,
                                     ISelectionProvider selProv)

Contributes menus applicable for the current selection.

contributeObjectMenus

public boolean contributeObjectMenus(IMenuManager menu,
                                     ISelectionProvider selProv)

Contributes menus applicable for the current selection.

Specified by:

contributeObjectMenus in interface IObjectActionContributor

See Also:

IObjectActionContributor

createActionDescriptor

protected ActionDescriptor createActionDescriptor(IConfigurationElement element)

This factory method returns a new ActionDescriptor for the configuration element.

isApplicableTo

public boolean isApplicableTo(Object object)

Returns true if the current selection matches all the given filtering criteria.

Specified by:

isApplicableTo in interface IObjectContributor

readContributions

protected void readContributions(String id,
                                 String tag,
                                 String extensionPoint)

readElement

protected boolean readElement(IConfigurationElement element)

Implements abstract method to handle the provided XML element in the registry.

canAdapt

public boolean canAdapt()

Specified by:

canAdapt in interface IObjectContributor

contributeMenu

protected void contributeMenu(IConfigurationElement menuElement,
                              IMenuManager mng,
                              boolean appendIfMissing)

Creates a menu from the information in the menu configuration element and adds it into the provided menu manager. If 'appendIfMissing' is true, and menu path slot is not found, it will be created and menu will be added into it. Otherwise, add operation will fail.

contributeMenuAction

protected void contributeMenuAction(ActionDescriptor ad,
                                    IMenuManager menu,
                                    boolean appendIfMissing)

Contributes action from action descriptor into the provided menu manager.

contributeSeparator

protected void contributeSeparator(IMenuManager menu,
                                   IConfigurationElement element)

Creates a named menu separator from the information in the configuration element. If the separator already exists do not create a second.

contributeGroupMarker

protected void contributeGroupMarker(IMenuManager menu,
                                     IConfigurationElement element)

Creates a named menu group marker from the information in the configuration element. If the marker already exists do not create a second.

contributeToolbarAction

protected void contributeToolbarAction(ActionDescriptor ad,
                                       IToolBarManager toolbar,
                                       boolean appendIfMissing)

Contributes action from the action descriptor into the provided tool bar manager.

insertMenuGroup

protected void insertMenuGroup(IMenuManager menu,
                               AbstractGroupMarker marker)

Inserts the separator or group marker into the menu. Subclasses may override.

insertAfter

protected void insertAfter(IContributionManager mgr,
                           String refId,
                           PluginAction action)

Inserts an action after another named contribution item. Subclasses may override.

insertAfter

protected void insertAfter(IContributionManager mgr,
                           String refId,
                           IContributionItem item)

Inserts a contribution item after another named contribution item. Subclasses may override.

addGroup

protected void addGroup(IContributionManager mgr,
                        String name)

Adds a group to a contribution manager. Subclasses may override.