#
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`:

- `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>

<!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 (SQUIGGLIES|BOX|UNDERLINE|IBEAM|NONE)

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 -
- 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 -
- overviewRulerPreferenceValue -
- verticalRulerPreferenceValue - The default value for showing in vertical ruler. since: 3.0
- textPreferenceValue -
- highlightPreferenceValue - The default value for highlighting in text. since: 3.0
- contributesToHeader -
- 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.
- 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 -
- 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
- includeOnPreferencePage - Defines whether this annotation type should be configurable via the standard annotation preference page. Default is true.

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