Maakwizards

org.eclipse.ui.newWizards

Dit extensiepunt wordt gebruikt om wizardextensies voor het maken van resources te registreren. Maakwizards worden afgebeeld als opties in het dialoogvenster "Nieuw" en worden normaal gebruikt om mappen en bestanden te maken.

Wizards zijn in het dialoogvenster "Nieuw" ondergebracht in categorieën die normaal gesproken gericht zijn op een bepaald probleemgebied. In een Java-georiënteerde plugin kan bijvoorbeeld een categorie met de naam "Java" zijn gedefinieerd die geschikt is voor de maakwizards "Klasse" en "Pakket". Plugins kunnen met het categoriekenmerk verwijzen naar categorieën die in een andere plugin zijn gedefinieerd. Ongecategoriseerde wizards en wizards met een ongeldig categoriepad komen in de categorie "Overig" terecht.

Wizards kunnen optioneel een subelement met een beschrijving bevatten. Het corpus moet dan een korte tekst over de wizard bevatten.

<!ELEMENT extension (category | wizard | primaryWizard)*>

<!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? , selection*)>

<!ATTLIST wizard

id                    CDATA #REQUIRED

name                  CDATA #REQUIRED

icon                  CDATA #IMPLIED

category              CDATA #IMPLIED

class                 CDATA #REQUIRED

project               (true | false)

finalPerspective      CDATA #IMPLIED

preferredPerspectives CDATA #IMPLIED

helpHref              CDATA #IMPLIED

descriptionImage      CDATA #IMPLIED

canFinishEarly        (true | false)

hasPages              (true | false) >


<!ELEMENT description (#PCDATA)>

een optioneel subelement waarvan het corpus een korte tekstbeschrijving bevat over de werking van de wizard



<!ELEMENT selection EMPTY>

<!ATTLIST selection

class CDATA #REQUIRED

name  CDATA #IMPLIED>


<!ELEMENT primaryWizard EMPTY>

<!ATTLIST primaryWizard

id CDATA #REQUIRED>

een manier om te declareren dat de wizard "primair" is in de gebruikersinterface. Een primaire wizard wordt geaccentueerd weergegeven in het dialoogvenster Nieuwe wizard. Let erop dat dit element niet is bedoeld voor pluginontwikkelaars! Het element is bedoeld voor productmanagers die zo nadruk kunnen leggen op een set wizards voor hun product.



Een voorbeeld van de configuratie van een maakwizard:

   

<extension point=

"org.eclipse.ui.newWizards"

>

<category id=

"com.xyz.XYZ"

name=

"XYZ-wizards"

>

</category>

<category id=

"com.xyz.XYZ.Web"

name=

"Web-wizards"

parentCategory=

"com.xyz.XYZ"

>

</category>

<wizard id=

"com.xyz.wizard1"

name=

"XYZ-artefact"

category=

"com.xyz.XYZ/com.xyz.XYZ.Web"

icon=

"./icons/XYZwizard1.gif"

class=

"com.xyz.XYZWizard1"

>

<description>

Een eenvoudig XYZ-artefact maken en begininhoud instellen

</description>

<selection class=

"org.eclipse.core.resources.IResource"

/>

</wizard>

</extension>

De waarde van het kenmerk class moet een klasse zijn die org.eclipse.ui.INewWizard implementeert. Als de wizard is gemaakt in de wizard Nieuw, wordt deze in de bestaande wizard ingevoegd. Als de wizard wordt gestart via een snelkoppeling (menu Nieuw bestand of een knop op de werkbalk), wordt deze afgebeeld als zelfstandig dialoogvenster.

De workbench beschikt over wizards voor het maken van lege resources van het type project, map of bestand. Deze wizards zijn geregistreerd met hetzelfde mechanisme als hierboven is beschreven. Er kunnen ook aanvullende wizards worden afgebeeld. Dit is afhankelijk van het geïnstalleerde platform.