Package org.eclipse.ui.menus
Class ExtensionContributionFactory
java.lang.Object
org.eclipse.ui.menus.AbstractContributionFactory
org.eclipse.ui.menus.ExtensionContributionFactory
- All Implemented Interfaces:
IExecutableExtension
public abstract class ExtensionContributionFactory
extends AbstractContributionFactory
implements IExecutableExtension
Clients who wish to contribute factories via the
org.eclipse.ui.menus extension point should subclass this class
rather than the AbstractContributionFactory as this class provides a
default constructor.
Clients must be aware that the results of getLocation() and
getNamespace() will not be valid until
setInitializationData(IConfigurationElement, String, Object) is
invoked. This will occur before
AbstractContributionFactory.createContributionItems(org.eclipse.ui.services.IServiceLocator, IContributionRoot)
is invoked.
- Since:
- 3.5
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal StringReturn the location as a String.final StringReturn the namespace for this cache.voidsetInitializationData(IConfigurationElement config, String propertyName, Object data) Clients who wish to implement their ownIExecutableExtensionbehaviour must invoke this method prior to any customization they perform.Methods inherited from class org.eclipse.ui.menus.AbstractContributionFactory
createContributionItems
-
Constructor Details
-
ExtensionContributionFactory
public ExtensionContributionFactory()Create an instance of this class.
-
-
Method Details
-
getLocation
Description copied from class:AbstractContributionFactoryReturn the location as a String.- Overrides:
getLocationin classAbstractContributionFactory- Returns:
- the location - never
null.
-
getNamespace
Description copied from class:AbstractContributionFactoryReturn the namespace for this cache. This corresponds to the plug-in that is contributing this factory.- Overrides:
getNamespacein classAbstractContributionFactory- Returns:
- the namespace the namespace of this factory
-
setInitializationData
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException Clients who wish to implement their ownIExecutableExtensionbehaviour must invoke this method prior to any customization they perform.- Specified by:
setInitializationDatain interfaceIExecutableExtension- Parameters:
config- the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration propertiespropertyName- the name of an attribute of the configuration element used on thecreateExecutableExtension(String)call. This argument can be used in the cases where a single configuration element is used to define multiple executable extensions.data- adapter data in the form of aString, aHashtable, ornull.- Throws:
CoreException- so that a subclass may throw this- See Also:
-