berry::ExtensionFactory Class Reference

#include <berryExtensionFactory.h>

Inheritance diagram for berry::ExtensionFactory:

Collaboration diagram for berry::ExtensionFactory:

Public Member Functions
	~ExtensionFactory ()
QObject *	Create () override
void	SetInitializationData (const SmartPointer< IConfigurationElement > &config, const QString &propertyName, const Object::Pointer &data) override
Public Member Functions inherited from berry::IExecutableExtensionFactory
virtual	~IExecutableExtensionFactory ()
Public Member Functions inherited from berry::IExecutableExtension
virtual	~IExecutableExtension ()

Static Public Attributes
static const QString	STYLE_PREFERENCE_PAGE
static const QString	PERSPECTIVES_PREFERENCE_PAGE

Detailed Description

Factory for the workbench's public extensions.

This allows the extensions to be made available for use by RCP applications without exposing their concrete implementation classes.

Definition at line 35 of file berryExtensionFactory.h.

Constructor & Destructor Documentation

berry::ExtensionFactory::~ExtensionFactory

(

)

Definition at line 34 of file berryExtensionFactory.cpp.

Member Function Documentation

QObject * berry::ExtensionFactory::Create ( )

overridevirtual

Creates the object referenced by the factory id obtained from the extension data.

Implements berry::IExecutableExtensionFactory.

Definition at line 38 of file berryExtensionFactory.cpp.

References BERRY_STATUS_LOC, berry::IStatus::ERROR_TYPE, PERSPECTIVES_PREFERENCE_PAGE, berry::PlatformUI::PLUGIN_ID(), and STYLE_PREFERENCE_PAGE.

void berry::ExtensionFactory::SetInitializationData ( const SmartPointer< IConfigurationElement > &  config, const QString &  propertyName, const Object::Pointer &  data  )

overridevirtual

This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information. Most executable extensions only make use of the first two call arguments.

Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example

    <action run="com.example.BaseAction"/>

In the above example, this method would be called with a reference to the <action> element (first argument), and "run" as the name of the attribute that defined this executable extension (second argument).

The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.

There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:

(1) by specifying adapter data as part of the implementation class attribute value. The Java class name can be followed by a ":" separator, followed by any adapter data in string form. For example, if the extension point specifies an attribute "run" to contain the name of the extension implementation, an adapter can be configured as

    <action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>

(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become

    <action>
        <<it>run</it> class="com.xyz.ExternalAdapter">
            <parameter name="exec" value="./cmds/util.exe"/>
            <parameter name="opt"  value="3"/>
        </<it>run</it>>
    </action>

Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.

In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:

• null, if no adapter data was supplied
• in case (1), the initialization data string is passed as a String
• in case (2), the initialization data is passed as a Hashtable containing the actual parameter names and values (both Strings)

Parameters

config	the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration properties
propertyName	the name of an attribute of the configuration element used on the createExecutableExtension(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 a String, a Hashtable, or null.

Exceptions

CoreException

if error(s) detected during initialization processing

See also

IConfigurationElement::createExecutableExtension

Implements berry::IExecutableExtension.

Definition at line 60 of file berryExtensionFactory.cpp.

References BERRY_STATUS_LOC, berry::SmartPointer< TObjectType >::Cast(), berry::IStatus::ERROR_TYPE, and berry::PlatformUI::PLUGIN_ID().

Member Data Documentation

const QString berry::ExtensionFactory::PERSPECTIVES_PREFERENCE_PAGE

static

Factory ID for the Perspectives preference page.

Definition at line 53 of file berryExtensionFactory.h.

Referenced by Create().

const QString berry::ExtensionFactory::STYLE_PREFERENCE_PAGE

static

Factory ID for the Appearance preference page.

Definition at line 48 of file berryExtensionFactory.h.

Referenced by Create().

---

The documentation for this class was generated from the following files:

• berryExtensionFactory.h
• berryExtensionFactory.cpp