Marker Annotation Specification

Identifier:
org.eclipse.ui.editors.markerAnnotationSpecification

Since:
3.0 (originally named org.eclipse.ui.workbench.texteditor.markerAnnotationSpecification)

Description:
This extension point is used to define presentation properties of markers. Extensions provided for this extension point can be accessed using org.eclipse.ui.texteditor.MarkerAnnotationPreferences. Use org.eclipse.ui.texteditor.AnnotationPreferenceLookup to get the annotation preference for a given annotation.

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:

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

>


<!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"

>



Copyright (c) 2001, 2008 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html