ECF Configuration Wizards

org.eclipse.ecf.ui.configurationWizards

ECF v0.9.4

This extension point allows providers to register wizards for creating and configuration IContainer instances.

<!ELEMENT extension (category | wizard)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>


<!ELEMENT wizard (description?)>

<!ATTLIST wizard

id                   CDATA #REQUIRED

name                 CDATA #REQUIRED

category             CDATA #IMPLIED

class                CDATA #REQUIRED

icon                 CDATA #IMPLIED

containerFactoryName CDATA #REQUIRED>

an element that will be used to create export wizard



<!ELEMENT description (#PCDATA)>

an optional subelement whose body should represent a short description of the export engine functionality.



Implementers of this extension point must specify an extension of the org.eclipse.ecf.ui.configurationWizards extension point.
  

<extension point=

"org.eclipse.ecf.ui.configurationWizards"

>

<wizard class=

"org.my.client.MyClientConfigurationWizard"

containerFactoryName=

"org.my.client"

id=

"my.client.configuration.wizard"

name=

"My Client Configuration Wizard"

icon=

"icons/configuration.png"

>

</wizard>

</extension>

The "class" attribute (required) must have a class that implements the org.eclipse.ecf.ui.IConfigurationWizard interface:
/**
 * Required interface for implementing
 * 

<b>

org.eclipse.ecf.ui.configurationWizards

</b>

extension point. Extensions * for extension point

<b>

org.eclipse.ecf.ui.configurationWizards

</b>

must * provide a class implementing this interface. */ public interface IConfigurationWizard extends IWizard { /** * Initialize the wizard with the workbench and the desired container type * description * * @param workbench * the workbench for the wizard. Will not be null. * @param description * the {@link ContainerTypeDescription} to use to * create/configure the new IContainer instance */ public void init(IWorkbench workbench, ContainerTypeDescription description); /** * Get result of configuration. * * @return ContainerHolder the result of the configuration. If null, the container could not be * created. */ public ContainerHolder getConfigurationResult(); }