Maakwizards
ID:
org.eclipse.ui.newWizards
Beschrijving:
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.
Configuratiemarkup:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - een volledig gekwalificeerd ID van het doelextensiepunt.
- id - een optioneel ID van de extensie-instance.
- name - een optionele naam van de extensie-instance.
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - een unieke naam die wordt gebruikt om deze categorie te identificeren.
- name - een vertaalbare naam van de categorie die wordt gebruikt in het dialoogvenster.
- parentCategory - een pad naar een andere categorie als deze categorie moet worden toegevoegd als onderliggend item.
<!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) >
- id - een unieke naam die wordt gebruikt om deze wizard te identificeren.
- name - een vertaalbare naam van de wizard die wordt gebruikt in het dialoogvenster.
- icon - een relatief pad naar het pictogram waaraan de wizard samen met de naam kan worden herkend als een van de opties in het dialoogvenster.
- category - een pad met door schuine strepen ('/') gescheiden categorie-ID's. Ieder onderdeel van het pad moet een geldig categorie-ID zijn dat eerder door deze of een andere plugin is gedefinieerd. Als het pad ontbreekt, wordt de wizard ingedeeld bij de categorie "Overig".
- class - de volledig gekwalificeerde naam van een Java-klasse die org.eclipse.team.ui.INewWizard implementeert.
- project - een optioneel kenmerk dat aangeeft dat de wizard een IProject-resource maakt. Zorgt ook dat de wizard als optie wordt weergegeven in het dialoogvenster "Nieuw project".
- finalPerspective - een optioneel kenmerk dat aangeeft welk perspectief moet worden geactiveerd als met maken van de IProject-resource is voltooid.
- preferredPerspectives - een optioneel kenmerk dat naar een lijst met door komma's gescheiden perspectief-ID's verwijst. Als het huidige perspectief in de lijst staat, wordt geen ander perspectief geactiveerd als het maken van de IProject-resource is voltooid.
- helpHref - een Help-URL waarin details over de wizard opgenomen kunnen worden.
Vanaf 3.0
- descriptionImage - een grotere afbeelding waarmee de wizard kunt beschrijven.
Vanaf 3.0
- canFinishEarly - bepaalt of de wizard afgesloten kan worden zonder de pagina's aan de gebruiker te tonen.
- hasPages - bepaalt of de wizard pagina's heeft.
<!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>
- class - een volledig gekwalificeerde klassennaam. Als ieder object in de workbenchselectie deze interface implementeert, wordt de selectie doorgegeven aan de wizard. Als dit niet het geval is, wordt een lege selectie doorgegeven.
- name - een optionele naamfilter. Ieder object in de workbenchselectie moet overeenkomen met de naamfilter om doorgegeven te kunnen worden aan de wizard.
<!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.
- id - het ID van de wizard die primair gemaakt moet worden.
Voorbeelden:
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>
API-informatie:
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.
Verstrekte implementatie:
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.
Copyright (c) 2002, 2005 IBM Corporation en anderen.
Alle rechten voorbehouden. Dit programma en het begeleidende materiaal zijn beschikbaar gesteld onder de voorwaarden van de Eclipse Public License v1.0 die bij deze distributie is geleverd en beschikbaar is op http://www.eclipse.org/legal/epl-v10.html.