Průvodci vytvořením
Identifikátor:
org.eclipse.ui.newWizards
Popis:
Tento bod rozšíření se používá k registraci rozšíření průvodců vytvořením prostředků. Průvodci vytvořením se zobrazují jako volby v položce "Nový dialog" a běžně se používají k vytváření složek a souborů.
V položce "Nový dialog" jsou průvodci uspořádáni do kategorií, které obvykle odpovídají doméně konkrétního problému. Například modul plug-in orientovaný na prostředí Java může definovat kategorii s názvem "Java", která je vhodná pro průvodce vytvořením prvků "Třída" nebo "Balíček". Na kategorie definované jedním modulem plug-in mohou odkazovat ostatní moduly plug-in pomocí atributu kategorie (category). Průvodci nezařazení do kategorií a také průvodci s neplatnou cestou ke kategorii skončí v kategorii "Ostatní".
Průvodci mohou volitelně uvádět popisný dílčí prvek, jehož tělo by mělo obsahovat krátký text o průvodci.
Konfigurační markup:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - Úplný identifikátor cílového bodu rozšíření.
- ID - Nepovinný identifikátor instance rozšíření.
- name - Nepovinný název instance rozšíření.
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - Jedinečný název, který může být použit k identifikaci této kategorie.
- name - Přeložitelný název kategorie, který bude použit v dialogovém okně.
- parentCategory - Cesta k jiné (nadřazené) kategorii, pokud se tato kategorie má přidat jako dílčí prvek.
<!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 - Jedinečný název, který lze použít pro identifikaci tohoto průvodce.
- name - Přeložitelný název průvodce, který bude použit v dialogovém okně.
- icon - Relativní cesta ikony, která se použije společně s názvem ke znázornění průvodce
jako jedné z voleb v dialogovém okně vytváření.
- category - Cesta oddělovaná lomítky ('/') k ID kategorie. Každý token v cestě musí představovat platné ID kategorie dříve definované tímto nebo některým jiným modulem plug-in. Pokud tomu tak není, průvodce bude přidán do kategorie "Ostatní".
- class - Úplný název třídy Java, která implementuje org.eclipse.ui.INewWizard.
- project - Volitelný atribut označující, že průvodce vytvoří prostředek IProject.
Také způsobuje to, že se průvodce zobrazí jako volba v "Dialogovém okně Nový projekt".
- finalPerspective - Volitelný atribut označující perspektivu, která se aktivuje při dokončení vytváření prostředku IProject.
- preferredPerspectives - Volitelný atribut určující čárkami oddělený seznam Id perspektivy. Pokud se aktuální perspektiva nachází na tomto seznamu, nedojde při dokončení vytváření prostředku IProject k žádné aktivaci perspektivy.
- helpHref - Adresa url nápovědy, která může tohoto průvodce podrobně popsat.
Od verze 3.0
- descriptionImage - Větší obraz, který může pomoci popsat tohoto průvodce.
Od verze 3.0
- canFinishEarly - Určuje, zda průvodce může skončit, aniž by uživateli zobrazil jakékoli stránky.
- hasPages - Určuje, zda průvodce poskytuje nějaké stránky.
<!ELEMENT description (#PCDATA)>
Volitelný dílčí prvek, jehož tělo obsahuje krátký text, popisující, co průvodce provede při spuštění.
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - Plně kvalifikovaný název třídy. Pokud každý objekt ve výběru pracovní plochy implementuje toto rozhraní, bude výběr předán průvodci. V opačném případě bude předán prázdný výběr.
- name - Volitelný filtr názvů. Každý objekt ve výběru pracovní plochy musí vyhovovat filtru názvů, aby mohl být předán průvodci.
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
Prostředky deklarace, že průvodce je v uživatelském rozhraní jako "primární". Primární průvodce je zvýrazněn v dialogovém okně nového průvodce. Pamatujte, že tento prvek není určen k použití vývojářům modulů plug-in! Tento prvek existuje proto, aby manažeři produktů mohli zvýraznit množinu průvodců pro svoje produkty.
- id - Id průvodce, který by měl být nastaven jako primární.
Příklady:
Následuje příklad konfigurace průvodce vytvořením:
<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 artifact"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<description>
Vytvořit jednoduchý artefakt XYZ a nastavit počáteční obsah
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
Informace rozhraní API:
Hodnota atributu třídy musí reprezentovat třídu, která implementuje org.eclipse.ui.INewWizard.
Pokud je průvodce vytvořen z položky Nový průvodce, bude vložen do stávajícího průvodce.
Pokud je průvodce spuštěn jako zástupce (z nabídky nového souboru nebo tlačítka panelu nástrojů), zobrazí se osamoceně jako samostatné dialogové okno.
Dodaná implementace:
Pracovní plocha se dodává s průvodci pro vytváření prázdných prostředků následujících typů:
projekt, složka a soubor. Tito průvodci jsou registrováni pomocí
stejného mechanizmu, jaký je popsán výše.
Mohou se zobrazit také další průvodci dle konkrétní instalace platformy.
Copyright (c) 2002, 2004 IBM Corporation a další.
Všechna práva vyhrazena.
Tento program a doprovodné materiály jsou zpřístupněny za podmínek licence Eclipse Public License
v1.0, která je součástí této distribuce a je k dispozici na adrese
http://www.eclipse.org/legal/epl-v10.html