Marker Annotation Specification

Identifier:

Since:

Description:

Note that an extension will only be returned from MarkerAnnotationPreferences.getAnnotationPreferences (and thus included in the preference pages) if it contains the following four attributes in addition to the required annotationType:

• colorPreferenceKey
• colorPreferenceValue
• overviewRulerPreferenceKey
• textPreferenceKey

Annotation preference types that extend another annotation preference are allowed to overwrite attributes already defined in a parent preference specification, but these will not be accessible from the preference page.

Configuration Markup:

<!ELEMENT extension (specification+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

• point - a fully qualified identifier of the target extension point
• id - an optional identifier of the extension instance
• name - an optional name of the extension instance

<!ELEMENT specification EMPTY>

<!ATTLIST specification

annotationType                         IDREF #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

quickFixIcon                           CDATA #IMPLIED

symbolicIcon                           (error|warning|info|task|bookmark)

annotationImageProvider                CDATA #IMPLIED

textStylePreferenceKey                 CDATA #IMPLIED

textStylePreferenceValue               (BOX|DASHED_BOX|IBEAM|NONE|PROBLEM_UNDERLINE|SQUIGGLES|UNDERLINE)

includeOnPreferencePage                (true | false) "true">

• annotationType - the annotation type
• colorPreferenceKey - the color preference key must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences
• overviewRulerPreferenceKey - the overview ruler preference key must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences
• verticalRulerPreferenceKey - the preference key for the show in vertical ruler preference. since: 3.0
• textPreferenceKey - the text preference key must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences
• label - the label to be used in the UI
• highlightPreferenceKey - the preference key for highlighting in text. since: 3.0
• colorPreferenceValue - the color preference value must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences
• presentationLayer - the default value for the layer in which the marker annotation will be drawn. Annotations are considered being located at layers and will be painted starting with layer 0 upwards. Thus an annotation at layer 5 will be drawn on top of all co-located annotations at the layers 4 - 0.
• overviewRulerPreferenceValue - the default value telling whether this marker annotation is shown in the overview ruler
• verticalRulerPreferenceValue - the default value for showing in vertical ruler. since: 3.0
• textPreferenceValue - the default value telling whether this marker annotation is shown in the text
• highlightPreferenceValue - the default value for highlighting in text. since: 3.0
• contributesToHeader - the default value telling whether this marker annotation contributes to the overview ruler's header summary
• showInNextPrevDropdownToolbarActionKey - the preference key for the visibility in the next/previous drop down toolbar action. since: 3.0
• showInNextPrevDropdownToolbarAction - the default value for the visibility in the next/previous drop down toolbar action. since: 3.0
• isGoToNextNavigationTargetKey - the preference key for go to next navigation enablement. since: 3.0
• isGoToNextNavigationTarget - the default value for go to next navigation enablement. since: 3.0
• isGoToPreviousNavigationTargetKey - the preference key for go to previous navigation enablement. since: 3.0
• isGoToPreviousNavigationTarget - the default value for go to previous navigation enablement. since: 3.0
• icon - the path to the icon to be drawn for annotations of this annotation type. This icon will not be used if a Quick Fix is available and the "quickFixIcon" attribute has been specified.
• quickFixIcon - the path to the quick fix icon to be drawn for annotations that have a quick fix. since: 3.2
• symbolicIcon - the symbolic name of the image that should be drawn to represent annotation of this annotation type. The image is only used when there is no vertical ruler icon specified for this annotation type. Possible values are: "error", "warning", "info", "task", "bookmark".
• annotationImageProvider - the optional annotation image provider that implements org.eclipse.ui.texteditor.IAnnotationImageProvider
• textStylePreferenceKey - the preference key for the text decoration property. since: 3.0
• textStylePreferenceValue - the default value for the "show in text" decoration style. since: 3.0 (DASHED_BOX since 3.3, PROBLEM_UNDERLINE: since 3.4)
• includeOnPreferencePage - defines whether this annotation type should be configurable via the standard annotation preference page. Default is true.

Copyright (c) 2001, 2016 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0