Rozszerzenie elementu ściągawki
Identyfikator:
org.eclipse.ui.cheatsheets.cheatSheetItemExtension
Dostępne od wersji:
3.0
Opis:
Należy skorzystać z tego punktu rozszerzenia, gdy istnieje
potrzeba wstawienia dodatkowego przycisku do kroku w ściągawce. Można dodać
nowy atrybut do znacznika "item" w pliku treści ściągawki, a gdy ta wartość
zostanie odczytana przez środowisko ściągawek, zostanie sprawdzone, czy
istnieje klasa zarejestrowana za pośrednictwem tego punktu rozszerzenia, która
może obsłużyć ten atrybut. Nazwa atrybutu znaleziona w pliku treści
ściągawki jest porównywana z wszystkimi wartościami znalezionymi w atrybucie
"itemAttribute" wszystkich zarejestrowanych implementacji punktu rozszerzenia
cheatsheetItemExtension. W przypadku znalezienia odpowiedniej wartości klasa
podana do obsługi tego atrybutu elementu zostanie załadowana przez środowisko
ściągawek i wywołana w celu obsłużenia atrybutu wskazanego w pliku treści
ściągawki. Po przeanalizowaniu wartości atrybutu elementu klasa pozostanie
dostępna dla środowiska ściągawek. Podczas wyświetlania elementu w widoku
ściągawek klasa zostanie wywołana ponownie w celu obsłużenia komponentów
dodawanych do elementu złożonego. Elementy dodawane do tego elementu złożonego
są wyświetlane w ramach odpowiedniego kroku ściągawki (na bieżąco, obok ikony
pomocy). Są wyświetlane tylko dla tego kroku, który jest opisany przez znacznik
"item" atrybutu pojawiającego się w pliku treści ściągawki. Sugerowane
użycie tego punktu rozszerzenia to dodanie małego przycisku (o wymiarach 16x16)
z elementem graficznym, którego naciśnięcie powoduje otwarcie okna dialogowego.
Znaczniki konfiguracji:
<!ELEMENT extension (itemExtension)*>
<!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 itemExtension EMPTY>
<!ATTLIST itemExtension
itemAttribute CDATA #REQUIRED
class CDATA #REQUIRED>
Za pomocą tego rozszerzenia można dodawać elementy do kroków ściągawki. Można w
ten sposób wstawiać ikony i przyciski umieszczane obok ikony pomocy w ramach
wybranego kroku w ściągawce. Należy podać nazwę atrybutu, który zostanie dodany
do odpowiedniego znacznika ściągawki. Trzeba również określić klasę, która
będzie odpowiadała za analizę wartości atrybutu z pliku treści ściągawki
przy jej ładowaniu. Wartością musi być łańcuch. Podana klasa musi być podklasą
klasy org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
. Po
przeanalizowaniu i załadowaniu pliku treści ściągawki klasa podana w
punkcie rozszerzenia jest ponownie wywoływana za pośrednictwem interfejsu w celu
dodania grafiki lub przycisków do wybranego kroku w ściągawce (na bieżąco, obok
przycisku pomocy).
- itemAttribute - wartość tego atrybutu musi być łańcuchem nazwy
atrybutu, która jest umieszczana w znaczniku "item" w pliku treści
ściągawki. Jeśli ten łańcuch pokrywa się z atrybutem wynikającym z analizy
znacznika "item" w pliku treści ściągawki, podana klasa zostanie załadowana
i wywołana w celu przeanalizowania pełnej wartości atrybutu z użyciem
specyfikacji w3 DOM. Klasa ta zostanie później wywołana w celu dodania
elementów sterujących do elementu złożonego, a dodane komponenty (zwykle
obiekty graficzne lub przyciski) zostaną wyświetlone w odpowiednim kroku
ściągawki dla określonej pozycji (obok ikony pomocy dla tego kroku).
- class - pełna nazwa klasy, która jest podklasą klasy
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
i której zadaniem jest obsługa nieznanych atrybutów w pliku treści ściągawki oraz rozszerzanie jej kroków. Klasa musi być publiczna i mieć publiczny konstruktor
jednoargumentowy, który przyjmuje nazwę atrybutu (typu String
).
Przykłady:
Poniżej przedstawiono przykładową implementację tego punktu rozszerzenia:
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"
>
<itemExtension
itemAttribute=
"xyzButton"
class=
"com.example.HandleParsingAndAddButton"
>
</itemExtension>
</extension>
Poniżej przedstawiono atrybut "item" dla tego rozszerzenia:
<item title=
"XYZ Title"
xyzButton=
"/icon/button.gif"
/>
Należy zauważyć, że wartością atrybutu w znaczniku "item" może być dowolny
element. Dowolność ta wynika z faktu, że klasą odpowiedzialną za analizę tego
atrybutu jest klasa HandleParsingAndAddButton, która w tym przykładzie
analizuje łańcuch /icon/button.gif z atrybutu. Informacje te zostaną następnie
użyte do załadowania obrazu GIF, który posłuży jako ikona nowego
przycisku.
Informacje o interfejsie API:
Szczegółowe informacje na temat
interfejsów API można znaleźć w dokumentacji Javadoc dla klasy
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement.
Dostarczana implementacja:
Aktualnie brak dostępnych
implementacji.
Copyright (c) 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.