Specyfikacja adnotacji znacznika
Identyfikator:
org.eclipse.ui.editors.markerAnnotationSpecification
Dostępne od wersji:
3.0 (oryginalna nazwa: org.eclipse.ui.workbench.texteditor.markerAnnotationSpecification)
Opis:
Ten punkt rozszerzenia
umożliwia definiowanie właściwości prezentowania znaczników. Dostęp do
rozszerzeń udostępnionych na potrzeby tego punktu rozszerzenia umożliwia klasa
org.eclipse.ui.texteditor.MarkerAnnotationPreferences. Aby pobrać
preferencje dotyczące wybranej adnotacji, należy użyć klasy
org.eclipse.ui.texteditor.AnnotationPreferenceLookup.
Należy pamiętać, że rozszerzenie zostanie zwrócone przez metodę
MarkerAnnotationPreferences.getAnnotationPreferences
(a tym samym
uwzględnione na stronach preferencji) tylko pod warunkiem, że poza wymaganym
atrybutem annotationType
zawiera następujące cztery atrybuty:
colorPreferenceKey
colorPreferenceValue
overviewRulerPreferenceKey
textPreferenceKey
Typy preferencji adnotacji, które rozszerzają inną preferencję adnotacji, mogą
zastępować atrybuty już zdefiniowane w nadrzędnej specyfikacji preferencji, ale
nie będą one dostępne na stronie preferencji.
Znaczniki konfiguracji:
<!ELEMENT extension (specification)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT specification EMPTY>
<!ATTLIST specification
annotationType CDATA #REQUIRED
colorPreferenceKey CDATA #IMPLIED
overviewRulerPreferenceKey CDATA #IMPLIED
verticalRulerPreferenceKey CDATA #IMPLIED
textPreferenceKey CDATA #IMPLIED
label CDATA #IMPLIED
highlightPreferenceKey CDATA #IMPLIED
colorPreferenceValue CDATA #IMPLIED
presentationLayer CDATA #IMPLIED
overviewRulerPreferenceValue (true | false)
verticalRulerPreferenceValue (true | false)
textPreferenceValue (true | false)
highlightPreferenceValue (true | false)
contributesToHeader (true | false)
showInNextPrevDropdownToolbarActionKey CDATA #IMPLIED
showInNextPrevDropdownToolbarAction (true | false)
isGoToNextNavigationTargetKey CDATA #IMPLIED
isGoToNextNavigationTarget (true | false)
isGoToPreviousNavigationTargetKey CDATA #IMPLIED
isGoToPreviousNavigationTarget (true | false)
icon CDATA #IMPLIED
symbolicIcon (error|warning|info|task|bookmark)
annotationImageProvider CDATA #IMPLIED
textStylePreferenceKey CDATA #IMPLIED
textStylePreferenceValue (SQUIGGLES|BOX|UNDERLINE|IBEAM|NONE)
includeOnPreferencePage (true | false) "true">
- annotationType - typ adnotacji.
- colorPreferenceKey - klucz preferencji koloru musi być podany,
ponieważ w przeciwnym razie ten typ adnotacji nie znajdzie się na liście
zwracanej przez metodę MarkerAnnotationPreferences.getAnnotationPreferences(),
a tym samym nie będzie wyświetlany w preferencjach.
- overviewRulerPreferenceKey - klucz preferencji linijki przeglądu
musi być podany, ponieważ w przeciwnym razie ten typ adnotacji nie znajdzie się
na liście zwracanej przez metodę MarkerAnnotationPreferences.getAnnotationPreferences(),
a tym samym nie będzie wyświetlany w preferencjach.
- verticalRulerPreferenceKey - klucz preferencji wyświetlania na linijce pionowej.
Dostępne od wersji 3.0.
- textPreferenceKey - klucz preferencji tekstu musi być podany,
ponieważ w przeciwnym razie ten typ adnotacji nie znajdzie się na liście
zwracanej przez metodę MarkerAnnotationPreferences.getAnnotationPreferences(),
a tym samym nie będzie wyświetlany w preferencjach.
- label - etykieta, która ma zostać użyta w interfejsie użytkownika.
- highlightPreferenceKey - klucz preferencji podświetlania w tekście.
Dostępne od wersji 3.0.
- colorPreferenceValue - wartość preferencji koloru musi być podana,
ponieważ w przeciwnym razie ten typ adnotacji nie znajdzie się na liście
zwracanej przez metodę MarkerAnnotationPreferences.getAnnotationPreferences(),
a tym samym nie będzie wyświetlany w preferencjach.
- presentationLayer - wartość domyślna dla warstwy, w której ma zostać narysowana adnotacja znacznika.
- overviewRulerPreferenceValue - wartość domyślna informująca, że dana adnotacja znacznika jest wyświetlana na linijce przeglądu.
- verticalRulerPreferenceValue - domyślna wartość wyświetlania na linijce pionowej.
Dostępne od wersji 3.0.
- textPreferenceValue - wartość domyślna informująca, że dana adnotacja znacznika jest wyświetlana w tekście.
- highlightPreferenceValue - domyślna wartość podświetlania w tekście.
Dostępne od wersji 3.0.
- contributesToHeader - wartość domyślna informująca, że dana adnotacja znacznika dodaje elementy do streszczenia nagłówka linijki przeglądu.
- showInNextPrevDropdownToolbarActionKey - klucz preferencji dotyczący
widoczności w następnej/poprzedniej akcji rozwijanego paska narzędzi.
Dostępne od wersji 3.0.
- showInNextPrevDropdownToolbarAction - domyślna wartość
widoczności w następnej/poprzedniej akcji rozwijanego paska narzędzi.
Dostępne od wersji 3.0.
- isGoToNextNavigationTargetKey - klucz preferencji dotyczący przejścia
do następnego włączenia nawigacji.
Dostępne od wersji 3.0.
- isGoToNextNavigationTarget - domyślna wartość przejścia do
następnego włączenia nawigacji.
Dostępne od wersji 3.0.
- isGoToPreviousNavigationTargetKey - klucz preferencji dotyczący
przejścia do poprzedniego włączenia nawigacji.
Dostępne od wersji 3.0.
- isGoToPreviousNavigationTarget - domyślna wartość przejścia do
poprzedniego włączenia nawigacji.
Dostępne od wersji 3.0.
- icon - ścieżka do ikony, która ma być rysowana dla adnotacji tego typu.
- symbolicIcon - nazwa symboliczna obrazu, który ma reprezentować
adnotację tego typu. Obraz jest stosowany tylko w przypadku, gdy dla danego
typu adnotacji nie określono linijki pionowej. Możliwe wartości: error (błąd),
warning (ostrzeżenie), info (informacja), task (czynność), bookmark (zakładka).
- annotationImageProvider - dostawca opcjonalnego obrazu adnotacji.
- textStylePreferenceKey - klucz preferencji dotyczący właściwości dekoracji tekstu.
Dostępne od wersji 3.0.
- textStylePreferenceValue - domyślna wartość stylu dekoracji dla wyświetlania w tekście.
Dostępne od wersji 3.0.
- includeOnPreferencePage - określa, czy dany typ adnotacji powinien
umożliwiać konfigurację na standardowej stronie preferencji adnotacji. Wartość domyślna to true.
Copyright (c) 2001, 2005 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.