Kreatorzy tworzenia
Identyfikator:
org.eclipse.ui.newWizards
Opis:
Ten punkt rozszerzenia
umożliwia rejestrowanie rozszerzeń kreatorów tworzenia zasobów. Kreatorzy tworzenia są
wyświetlani jako opcje w oknie dialogowym Nowy i zwykle służą do tworzenia folderów i plików.
W oknie dialogowym Nowy kreatorzy są zorganizowani w kategorie, które
odpowiadają zwykle konkretnym obszarom problemowym. Na przykład moduł dodatkowy
związany z językiem Java może definiować kategorię pod nazwą Java, która jest
odpowiednia dla kreatorów tworzenia zasobów typu Klasa lub Pakiet. Do kategorii
zdefiniowanych przez jeden moduł dodatkowy mogą odwoływać się inne moduły przy użyciu
atrybutu category. Kreatorzy bez kategorii, a także kreatorzy z
niepoprawnymi ścieżkami kategorii, są umieszczani w kategorii Inne.
W kreatorach może być opcjonalnie określony podelement opisu, którego treść
powinien stanowić krótki tekst na temat kreatora.
Znaczniki konfiguracji:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA
#IMPLIED
name CDATA #IMPLIED>
- point - pełny identyfikator docelowego punktu rozszerzenia.
- id - opcjonalny identyfikator instancji rozszerzenia.
- name - opcjonalna nazwa instancji rozszerzenia.
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - unikalna nazwa, która może być używana do identyfikowania tej
kategorii.
- name - możliwa do przetłumaczenia nazwa kategorii, która będzie używana w oknie dialogowym.
- parentCategory - ścieżka do innej kategorii, jeśli dana kategoria ma
zostać dodana jako element potomny.
<!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 - unikalna nazwa, która może służyć do identyfikowania tego kreatora.
- name - możliwa do przetłumaczenia nazwa kreatora, która będzie
używana w oknie dialogowym.
- icon - względna ścieżka do ikony, która wraz z nazwą będzie
reprezentować kreatora jako jedną z opcji do wyboru w oknie dialogowym tworzenia.
- category - rozdzielana ukośnikami ("/") ścieżka identyfikatorów
kategorii. Każdy element w ścieżce musi reprezentować poprawny identyfikator
kategorii zdefiniowany wcześniej w tym samym lub innym module dodatkowym. Pominięcie ścieżki spowoduje dodanie kreatora do kategorii "Inne".
- class - pełna nazwa klasy Java implementującej interfejs org.eclipse.ui.INewWizard.
- project - opcjonalny atrybut wskazujący, że kreator utworzy zasób
IProject. Powoduje także wyświetlenie kreatora jako jednej z opcji do wyboru w
oknie dialogowym Nowy projekt.
- finalPerspective - opcjonalny atrybut identyfikujący perspektywę,
którą należy aktywować po utworzeniu zasobu IProject.
- preferredPerspectives - opcjonalny atrybut zawierający oddzieloną
przecinkami listę identyfikatorów perspektyw. Jeśli bieżąca perspektywa
znajduje się na tej liście, po utworzeniu zasobu IProject nie następuje
aktywowanie żadnej perspektywy.
- helpHref - adres URL pomocy, który umożliwia szczegółowe opisanie kreatora.
Dostępne od wersji 3.0.
- descriptionImage - większy obraz, który może pomóc w opisie kreatora.
Dostępne od wersji 3.0.
- canFinishEarly - określa, czy kreator może zakończyć działanie bez wyświetlenia stron użytkownikowi.
- hasPages - określa, czy kreator udostępnia jakiekolwiek strony.
<!ELEMENT description (#PCDATA)>
Opcjonalny podelement, którego treść stanowi krótki opis działania kreatora po uruchomieniu.
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - pełna nazwa klasy. Jeśli każdy obiekt znajdujący się w
wyborze w środowisku roboczym implementuje ten interfejs, wybór zostanie
przekazany do kreatora. W przeciwnym razie zostanie przekazany wybór pusty.
- name - opcjonalny filtr nazw. Każdy obiekt znajdujący się w wyborze
w środowisku roboczym musi pasować do filtru nazw, aby było możliwe przekazanie
go do kreatora.
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
Umożliwia zadeklarowanie kreatora jako podstawowego w interfejsie użytkownika.
Kreator podstawowy jest wyróżniony w oknie dialogowym nowego kreatora. Element
ten nie jest przeznaczony do użycia przez programistów modułów dodatkowych.
Istnieje on po to, aby menedżerowie produktów mogli wyróżnić
pewien zestaw kreatorów na potrzeby swoich produktów.
- id - identyfikator kreatora, który powinien być kreatorem podstawowym.
Przykłady:
Poniżej przedstawiono
przykładową konfigurację kreatora tworzenia:
<extension point=
"org.eclipse.ui.newWizards"
>
<category
id=
"com.xyz.XYZ"
name=
"Kreatorzy XYZ"
>
</category>
<category
id=
"com.xyz.XYZ.Web"
name=
"Kreatorzy WWW"
parentCategory=
"com.xyz.XYZ"
>
</category>
<wizard
id=
"com.xyz.wizard1"
name=
"Artefakt XYZ"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<description>
Utworzenie prostego artefaktu XYZ i ustawianie treści początkowej
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
Informacje o interfejsie API:
Wartość
atrybutu class musi być nazwą klasy implementującej interfejs
org.eclipse.ui.INewWizard. Jeśli kreator jest tworzony z poziomu
nowego kreatora, zostanie wstawiony w istniejącym kreatorze. Jeśli kreator
zostanie uruchomiony jako skrót (przy użyciu komendy Nowy z menu Plik lub
przycisku paska narzędzi), będzie wyświetlany autonomicznie w osobnym oknie dialogowym.
Dostarczana implementacja:
W
środowisku roboczym znajdują się kreatorzy do tworzenia pustych zasobów
następujących typów: projekt, folder i plik. Mechanizm rejestrowania tych
kreatorów jest identyczny z opisanym powyżej. Mogą być także wyświetlani inni
kreatorzy, zależnie od konkretnej instalacji platformy.
Copyright (c) 2002, 2004 IBM Corporation i inne podmioty.
Wszelkie prawa zastrzeżone. Program ten oraz towarzyszące mu materiały są udostępniane na warunkach
licencji EPL (Eclipse Public License), wersja 1.0, dołączonej do nich i
dostępnej pod adresem http://www.eclipse.org/legal/epl-v10.html.