Eclipse Platform
Release 3.0

Uses of Interface
org.eclipse.core.runtime.IConfigurationElement

Packages that use IConfigurationElement
org.eclipse.core.expressions Application programming interfaces for the expression language.  
org.eclipse.core.resources Provides basic support for managing a workspace and its resources.  
org.eclipse.core.runtime Provides core support for plug-ins and the plug-in registry.  
org.eclipse.core.runtime.content Provides core support for content types.  
org.eclipse.help.ui.browser Provides an implementation of IWorkbenchWindowActionDelegate for opening a URL in a browser.  
org.eclipse.team.ui.synchronize Contains the team synchronization presentation framework and support for the Synchronize View. 
org.eclipse.ui Application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.  
org.eclipse.ui.part Classes for the creation of workbench parts that integrate with the Eclipse Platform User Interface.  
org.eclipse.ui.texteditor Provides a framework for text editors obeying to the desktop rules.  
org.eclipse.ui.texteditor.quickdiff Provides interfaces to for the org.eclipse.ui.editors.quickDiffReferenceProvider extension point and adds an action to enable quick diff display for an editor. 
org.eclipse.ui.themes Application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.  
org.eclipse.ui.wizards.newresource Provides the standard wizards for creating files, folders, and projects in the workspace. 
 

Uses of IConfigurationElement in org.eclipse.core.expressions
 

Methods in org.eclipse.core.expressions with parameters of type IConfigurationElement
 Expression ExpressionConverter.perform(IConfigurationElement root)
          Converts the tree of configuration elements represented by the given root element and returns a corresponding expression tree.
abstract  Expression ElementHandler.create(ExpressionConverter converter, IConfigurationElement config)
          Creates the corresponding expression for the given configuration element.
protected  void ElementHandler.processChildren(ExpressionConverter converter, IConfigurationElement element, org.eclipse.core.internal.expressions.CompositeExpression expression)
          Converts the children of the given configuration element and adds them to the given composite expression.
 

Uses of IConfigurationElement in org.eclipse.core.resources
 

Methods in org.eclipse.core.resources with parameters of type IConfigurationElement
 void IncrementalProjectBuilder.setInitializationData(IConfigurationElement config, String propertyName, Object data)
          Sets initialization data for this builder.
 

Uses of IConfigurationElement in org.eclipse.core.runtime
 

Methods in org.eclipse.core.runtime that return IConfigurationElement
 IConfigurationElement[] IPluginRegistry.getConfigurationElementsFor(String extensionPointId)
          Deprecated. Replaced by IExtensionRegistry.getConfigurationElementsFor(String).
 IConfigurationElement[] IPluginRegistry.getConfigurationElementsFor(String pluginId, String extensionPointName)
          Deprecated. Replaced by IExtensionRegistry.getConfigurationElementsFor(String, String).
 IConfigurationElement[] IPluginRegistry.getConfigurationElementsFor(String pluginId, String extensionPointName, String extensionId)
          Deprecated. Replaced by IExtensionRegistry.getConfigurationElementsFor(String, String, String).
 IConfigurationElement[] IConfigurationElement.getChildren()
          Returns all configuration elements that are children of this configuration element.
 IConfigurationElement[] IConfigurationElement.getChildren(String name)
          Returns all child configuration elements with the given name.
 IConfigurationElement[] IExtension.getConfigurationElements()
          Returns all configuration elements declared by this extension.
 IConfigurationElement[] IExtensionPoint.getConfigurationElements()
          Returns all configuration elements from all extensions configured into this extension point.
 IConfigurationElement[] IExtensionRegistry.getConfigurationElementsFor(String extensionPointId)
          Returns all configuration elements from all extensions configured into the identified extension point.
 IConfigurationElement[] IExtensionRegistry.getConfigurationElementsFor(String namespace, String extensionPointName)
          Returns all configuration elements from all extensions configured into the identified extension point.
 IConfigurationElement[] IExtensionRegistry.getConfigurationElementsFor(String namespace, String extensionPointName, String extensionId)
          Returns all configuration elements from the identified extension.
 

Methods in org.eclipse.core.runtime with parameters of type IConfigurationElement
 void IExecutableExtension.setInitializationData(IConfigurationElement config, String propertyName, Object data)
          This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information.
 

Uses of IConfigurationElement in org.eclipse.core.runtime.content
 

Methods in org.eclipse.core.runtime.content with parameters of type IConfigurationElement
 void BinarySignatureDescriber.setInitializationData(IConfigurationElement config, String propertyName, Object data)
           
 void XMLRootElementContentDescriber.setInitializationData(IConfigurationElement config, String propertyName, Object data)
           
 

Uses of IConfigurationElement in org.eclipse.help.ui.browser
 

Methods in org.eclipse.help.ui.browser with parameters of type IConfigurationElement
 void LaunchURL.setInitializationData(IConfigurationElement config, String propertyName, Object data)
           
 

Uses of IConfigurationElement in org.eclipse.team.ui.synchronize
 

Fields in org.eclipse.team.ui.synchronize declared as IConfigurationElement
protected  IConfigurationElement AbstractSynchronizeParticipant.configElement
           
 

Methods in org.eclipse.team.ui.synchronize with parameters of type IConfigurationElement
 void AbstractSynchronizeParticipant.setInitializationData(IConfigurationElement config, String propertyName, Object data)
           
 

Uses of IConfigurationElement in org.eclipse.ui
 

Constructors in org.eclipse.ui with parameters of type IConfigurationElement
SelectionEnabler(IConfigurationElement configElement)
          Create a new instance of the receiver.
 

Uses of IConfigurationElement in org.eclipse.ui.part
 

Methods in org.eclipse.ui.part that return IConfigurationElement
protected  IConfigurationElement IntroPart.getConfigurationElement()
          Returns the configuration element for this part.
protected  IConfigurationElement WorkbenchPart.getConfigurationElement()
          Returns the configuration element for this part.
protected  IConfigurationElement IntroPart.getConfigurationElement()
          Returns the configuration element for this part.
protected  IConfigurationElement WorkbenchPart.getConfigurationElement()
          Returns the configuration element for this part.
 

Methods in org.eclipse.ui.part with parameters of type IConfigurationElement
 void EditorPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
           
 void ViewPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
           
 void IntroPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
          The IntroPart implementation of this IExecutableExtension records the configuration element in and internal state variable (accessible via getConfigElement).
 void WorkbenchPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
          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>
         <run class="com.xyz.ExternalAdapter">
             <parameter name="exec" value="./cmds/util.exe"/>
             <parameter name="opt"  value="3"/>
         </run>
     </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)

The WorkbenchPart implementation of this IExecutableExtension records the configuration element in and internal state variable (accessible via getConfigElement).
 void EditorPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
           
 void ViewPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
           
 void IntroPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
          The IntroPart implementation of this IExecutableExtension records the configuration element in and internal state variable (accessible via getConfigElement).
 void WorkbenchPart.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
          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>
         <run class="com.xyz.ExternalAdapter">
             <parameter name="exec" value="./cmds/util.exe"/>
             <parameter name="opt"  value="3"/>
         </run>
     </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)

The WorkbenchPart implementation of this IExecutableExtension records the configuration element in and internal state variable (accessible via getConfigElement).
 

Uses of IConfigurationElement in org.eclipse.ui.texteditor
 

Fields in org.eclipse.ui.texteditor declared as IConfigurationElement
 IConfigurationElement AnnotationPreference.fConfigurationElement
          The configuration element from which to create the annotation image provider.
 

Methods in org.eclipse.ui.texteditor that return IConfigurationElement
abstract  IConfigurationElement ConfigurationElementSorter.getConfigurationElement(Object object)
          Returns the configuration element for the given object.
 

Methods in org.eclipse.ui.texteditor with parameters of type IConfigurationElement
 void AnnotationPreference.setAnnotationImageProviderData(IConfigurationElement configurationElement, String annotationImageProviderAttribute)
          Sets the data needed to create the annotation image provider.
 

Uses of IConfigurationElement in org.eclipse.ui.texteditor.quickdiff
 

Constructors in org.eclipse.ui.texteditor.quickdiff with parameters of type IConfigurationElement
ReferenceProviderDescriptor(IConfigurationElement element)
          Creates a new descriptor for element.
 

Uses of IConfigurationElement in org.eclipse.ui.themes
 

Methods in org.eclipse.ui.themes with parameters of type IConfigurationElement
 void RGBBlendColorFactory.setInitializationData(IConfigurationElement config, String propertyName, Object data)
          This executable extension requires parameters to be explicitly declared via the second method described in the IExecutableExtension documentation.
 

Uses of IConfigurationElement in org.eclipse.ui.wizards.newresource
 

Methods in org.eclipse.ui.wizards.newresource with parameters of type IConfigurationElement
 void BasicNewProjectResourceWizard.setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
          Stores the configuration element for the wizard.
static void BasicNewProjectResourceWizard.updatePerspective(IConfigurationElement configElement)
          Updates the perspective based on the current settings in the Workbench/Perspectives preference page.
 


Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.