Létrehozási varázslók
Azonosító:
org.eclipse.ui.newWizards
Leírás:
Ez a kiterjesztési pont szolgál erőforrás-létrehozási varázsló kiterjesztések bejegyzésére.
A létrehozási varázslók az Új párbeszédablak választási lehetőségeiként
jelennek meg és általában mappák és fájlok létrehozását végzik.
Az Új párbeszédablakban a varázslók kategóriákba vannak szervezve, amelyek
jellemzően egy adott problématartományt tükröznek.
Például egy Java-orientált bedolgozó definiálhat egy "Java" nevű
kategóriát, amely megfelelő az "Osztály" vagy "Csomoag" létrehozási
varázslóknak. A bedolgozó által meghatározott kategóriákra más bedolgozók
is hivatkozhatnak a category attribútum használatával. A nem kategorizált
varázslók, valamint az érvénytelen kategória-útvonallal rendelkező
varázslók az "Egyéb" kategóriába kerülnek.
A varázslók opcionálisan megadhatnak egy description (leírás) részelemet,
amelynek törzse a varázsló rövid szöveges leírását kell, hogy tartalmazza.
Konfigurációs kód:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - a cél kiterjesztési pont teljes képzésű azonosítója
- id - a kiterjesztéspéldány elhagyható azonosítója
- name - a kiterjesztéspéldány elhagyható neve
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - a kategória azonosítására szolgáló egyedi név
- name - a kategóriának a párbeszédablakban használt, lefordítható neve
- parentCategory - egy másik kategória elérési útvonala, ha ez a kategória leszármazottként kerül felvételre
<!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 - a varázsló azonosítására szolgáló egyedi név
- name - a varázslónak a párbeszédablakban használt, lefordítható neve
- icon - egy ikon relatív elérési útvonala, amely a névvel együtt a varázslót ábrázolja a létrehozási párbeszédablakban.
- category - törtvonallal ('/') elválasztott kategóriaazonosítókból álló útvonal. Az útvonal minden egyes szakasz a jelen vagy más bedolgozó által korábban már meghatározott kategória azonosítója kell, hogy legyen. Ha kimarad, a varázsló az "Egyéb" kategóriába kerül.
- class - az org.eclipse.ui.INewWizard felületet megvalósító Java-osztály teljes képzésű neve.
- project - egy elhagyható attribútum, amely azt jelzi, hogy a varázsló IProject erőforrás hoz-e létre. Ezenfelül azt eredményezi, hogy a varázsló megjelenik az Új projekt párbeszédablak egy választási lehetőségeként.
- finalPerspective - egy elhagyható attribútum, amely egy aktiválandó perspektívát azonosít, ha az IProject erőforrás létrehozása befejeződött.
- preferredPerspectives - egy elhagyható attribútum, amely perspektívaazonosítók vesszővel elválasztott listáját tartalmazza. Ha az aktuális perspektíva megtalálható ebben a listában, akkor nem történik perspektívaaktiválás, ha az IProject erőforrás létrehozása befejeződött.
- helpHref - egy súgó URL, amelyik részletesen leírja a varázslót.
A 3.0 óta.
- descriptionImage - a varázsló leírását segítő nagyobb méretű kép.
A 3.0 óta.
- canFinishEarly - a varázsló képes-e a befejezésre anélkül, hogy
oldalakat jelenítene meg a felhasználóknak.
- hasPages - a varázsló biztosít-e oldalakat.
<!ELEMENT description (#PCDATA)>
Egy elhagyható részelem, amelynek törzse rövid szöveges leírását tartalmazza annak, hogy mit fog csinálni a varázsló, ha elindult
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - egy teljes képzésű osztálynév. Ha a munkaterület kijelölésének minden egyes objektuma megvalósítja ezt a felületet, akkor a kijelölés átadásra kerül a varázslónak. Ha nem, üres kijelölés kerül átadásra
- name - egy elhagyható névszűrő. A munkaterület-kijelölés minden egyes objektumának illeszkednie kell a névszűrőhöz, hogy átadásra kerüljön a varázslónak
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
Egy módszer annak deklarálására, hogy a varázsló "elsődleges" a felhasználói felületen. Az elsődleges varázslók ki vannak emelve az Új varázsló párbeszédablakban.
Ne feledje, hogy ezt az elemet nem a bedolgozófejlesztőknek szántuk!
Ez az elem azért létezik, hogy a termékmenedzserek kiemelhessék a termék
egyes varázslóit.
- id - Az elsődlegessé tenni kívánt varázsló azonosítója.
Példák:
Az alábbiakban
bemutatunk egy példát egy létrehozási varázsló beállítására:
<extension point=
"org.eclipse.ui.newWizards"
>
<category
id=
"com.xyz.XYZ"
name=
"XYZ Wizards"
>
</category>
<category
id=
"com.xyz.XYZ.Web"
name=
"Webes varázslók"
parentCategory=
"com.xyz.XYZ"
>
</category>
<wizard
id=
"com.xyz.wizard1"
name=
"XYZ artifact"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<description>
Create a simple XYZ artifact and set initial content
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
API-információk:
A class
attribútum értéke egy, az org.eclipse.ui.INewWizard felületet megvalósító osztály kell, hogy legyen.
Ha a varázsló létrehozása az Új varázsló párbeszédablakból történik,
akkor beszúrásra kerül a meglévő varázslóba.
Ha a varázsló gyorsbillentyűként került indításra (a Fájl/Új menüből, vagy
egy eszköztárgombbal), akkor önállóan jelenik meg egy külön
párbeszédablakban.
Szállított megvalósítás:
A
munkaterület tartalmaz egy sor varázslót az alábbi típusú üres
erőforrások létrehozásához: projekt, mappa és fájl. Ezek a varázslók a
fentivel megegyező mechanizmussal vannak bejegyezve.
További varázslók is megjelenhetnek a telepítési platformtól függően.
Copyright (c) 2002, 2004 IBM Corporation és mások.
Minden jog fenntartva. Jelen program és annak kísérőanyagai a csomaghoz
tartozó, illetve a
http://www.eclipse.org/legal/epl-v10.html
címen is elérhető Eclipse Public License 1.0 verziójának hatálya alatt lettek
közzétéve.