Oprettelsesguider
Id:
org.eclipse.ui.newWizards
Beskrivelse:
Dette udvidelsespunkt bruges til at registrere oprettelsesguideudvidelser. Oprettelsesguider vises som valgmuligheder i dialogboksen "Ny" og bruges typisk til at oprette foldere og filer.
I dialogboksen "Ny" er guiderne opdelt i kategorier, som normalt afspejler et bestemt problemområde. En Java-orienteret plugin kan f.eks. definere en kategori med navnet "Java", som er egnet til "Class"- eller "Package"-oprettelsesguider. Plugins kan bruge kategoriattributten til at referere til kategorier, som er defineret af andre plugins. Ikke-kategoriserede guider samt guider med ugyldige kategoristier ender i kategorien "Andet".
Guider kan angive et beskrivelsesunderelement, som indeholder en kort tekst om guiden.
Konfigurationskode:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST-udvidelse
point CDATA #REQUIRED
id CDATA #IMPLIED
navn CDATA #IMPLIED>
- point - en fuldstændig id for måludvidelsespunktet.
- id - en valgfri id for udvidelsesforekomsten.
- name - et valgfrit navn på udvidelsesforekomsten.
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - et entydigt navn, der kan bruges til at identificere kategorien.
- name - et konvertérbart navn på kategorien, der skal bruges i dialogboksen.
- parentCategory - en sti til en anden kategori, hvis denne kategori skal tilføjes som en underordnet.
<!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 - et entydigt navn, der kan bruges til at identificere guiden.
- name - et konvertérbart navn på guiden, der skal bruges i dialogboksen.
- icon - en relativ sti til en ikon, der skal bruges sammen med navnet til at repræsentere guiden som en af valgmulighederne i oprettelsesdialogboksen.
- category - en skråstregsadskilt sti ('/') til kategori-id'er. Alle tokens i stien skal repræsentere en gyldig kategori-id, der tidligere er defineret af denne eller en anden plugin. Hvis parameteren udelades, tilføjes guiden til kategorien "Andet".
- class - et fuldstændigt navn på den Java-klasse, der implementerer org.eclipse.ui.INewWizard.
- project - en valgfri attribut, der angiver, at guiden vil oprette en IProject-ressource. Bevirker også, at guiden vises som en valgmulighed i dialogboksen "Nyt projekt".
- finalPerspective - en valgfri attribut, der angiver et perspektiv, som skal aktiveres, når oprettelsen af IProject-ressourcen er afsluttet.
- preferredPerspectives - en valgfri attribut, der angiver en kommasepareret liste over perspektiv-id'er. Hvis det aktuelle perspektiv findes på denne liste, sker der ingen perspektivaktivering, når oprettelsen af IProject-ressourcen er afsluttet.
- helpHref - en URL til hjælp, som kan beskrive guiden i detaljer.
Siden 3.0
- descriptionImage - et større billede, som kan hjælpe med at beskrive guiden.
Siden 3.0
- canFinishEarly - om guiden kan afsluttes uden nogen sinde at vise sider for brugeren.
- hasPages - om guiden leverer sider.
<!ELEMENT description (#PCDATA)>
Et valgfrit underelement, der indeholder en kort tekst, som beskriver, hvad guiden gør, når den startes.
<!ELEMENT selection EMPTY>
<!ATTLIST selection
klasse CDATA #REQUIRED
navn CDATA #IMPLIED>
- class - et fuldstændigt klassenavn. Hvis hvert objekt i arbejdsbænksvalget implementerer denne grænseflade, bliver valget overført til guiden. Ellers overføres et tomt valg.
- name - et valgfrit navnefilter. Hvert objekt i arbejdsbænksvalget skal matche det navnefilter, der skal overføres til guiden.
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
En metode til at erklære, at en guide er den "primære" i brugergrænsefladen. En primær guide er fremhævet i dialogboksen Ny guide. Bemærk, at dette element ikke bruges af pluginudviklere. Elementet findes for at give produktchefer mulighed for at fremhæve et sæt guider til deres produkter.
- id - id'en til en guide, der skal være primær.
Eksempler:
Her er et eksempel på et udvidelsespunkt til konfiguration af en oprettelsesguide:
<udvidelsespunkt=
"org.eclipse.ui.newWizards"
>
<category
id=
"com.xyz.XYZ"
name=
"XYZ-guider"
>
</category>
<category
id=
"com.xyz.XYZ.Web"
name=
"Webguider"
parentCategory=
"com.xyz.XYZ"
>
</category>
<wizard
id=
"com.xyz.wizard1"
name=
"XYZ-artefakt"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<beskrivelse>
Opret en enkel XYZ-artefakt, og angiv startindholdet
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
API-oplysninger:
Værdien af attributten class skal repræsentere et navn på en klasse, der implementerer org.eclipse.ui.INewWizard. Hvis guiden oprettes fra dialogboksen Ny guide, bliver den indsat i den eksisterende guide. Hvis guiden startes som en genvej (fra menuen Fil - Ny eller en knap på værktøjslinjen), vises den enkeltstående som en separat dialogboks.
Leveret implementering:
Arbejdsbænken leveres med guider til oprettelse af tomme ressourcer af følgende typer: projekt, folder og fil. Disse guider er registreret vha. samme mekanisme som beskrevet ovenfor. Der kan også blive vist ekstra guider, afhængigt af den enkelte platformsinstallation.
Copyright (c) 2002, 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html