标记注释规范
标识:
org.eclipse.ui.editors.markerAnnotationSpecification
起始版本:
3.0(原来命名为 org.eclipse.ui.workbench.texteditor.markerAnnotationSpecification)
描述:
此扩展点用来定义标记的表示属性。可使用
org.eclipse.ui.texteditor.MarkerAnnotationPreferences
来访问为此扩展点提供的扩展。使用 org.eclipse.ui.texteditor.AnnotationPreferenceLookup
来获取给定注释的注释首选项。
注意,仅当 MarkerAnnotationPreferences.getAnnotationPreferences
包含下列四个属性(除必需的 annotationType
之外)时,才会从中返回扩展(并因此包括在首选项页面中):
colorPreferenceKey
colorPreferenceValue
overviewRulerPreferenceKey
textPreferenceKey
扩展另一注释首选项的注释首选项类型被允许覆盖父代首选项规范中已经定义的属性,但不能从首选项页面中访问这些属性。
配置标记:
<!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 - 注释类型。
- colorPreferenceKey - 必须提供颜色首选项键,否则此注释类型将不会包括在 MarkerAnnotationPreferences.getAnnotationPreferences()
中返回的列表中并因此不会显示在首选项中。
- overviewRulerPreferenceKey - 必须提供概述标尺首选项键,否则此注释类型将不会包括在 MarkerAnnotationPreferences.getAnnotationPreferences()
中返回的列表中并因此不会显示在首选项中。
- verticalRulerPreferenceKey - 用于显示在垂直标尺中的首选项键。
起始版本:3.0
- textPreferenceKey - 必须提供文本首选项键,否则此注释类型将不会包括在 MarkerAnnotationPreferences.getAnnotationPreferences()
中返回的列表中并因此不会显示在首选项中。
- label - 要在用户界面中使用的标注。
- highlightPreferenceKey - 用于在文本中突出显示的首选项键。起始版本:3.0
- colorPreferenceValue - 必须提供颜色首选项值,否则此注释类型将不会包括在 MarkerAnnotationPreferences.getAnnotationPreferences()
返回的列表中并因此不会显示在首选项中。
- presentationLayer - 将显示标记注释的层的缺省值。
- overviewRulerPreferenceValue - 这个缺省值指定是否在概述标尺中绘制此标记注释。
- verticalRulerPreferenceValue - 用于显示在垂直标尺中的缺省值。起始版本:3.0
- textPreferenceValue - 这个缺省值指定是否在文本中绘制此标记注释。
- highlightPreferenceValue - 用于在文本中突出显示的缺省值。起始版本:3.0
- contributesToHeader - 这个缺省值指定是否将此标记注释添加到概述标尺的头摘要中。
- showInNextPrevDropdownToolbarActionKey - 表示下一个/上一个下拉工具栏操作中的可视性的首选项键。起始版本:3.0
- showInNextPrevDropdownToolbarAction - 表示下一个/上一个下拉工具栏操作中的可视性的缺省值。起始版本:3.0
- isGoToNextNavigationTargetKey - 表示进入下一项导航支持的首选项键。起始版本:3.0
- isGoToNextNavigationTarget - 表示进入下一项导航支持的缺省值。起始版本:3.0
- isGoToPreviousNavigationTargetKey - 表示进入上一项导航支持的首选项键。起始版本:3.0
- isGoToPreviousNavigationTarget - 表示进入上一项导航支持的缺省值。起始版本:3.0
- icon - 指向要对此注释类型的注释绘制的图标的路径。
- symbolicIcon - 应该为表示此注释类型的注释而绘制的图像的符号名称。仅当未对此注释类型指定任何垂直标尺图标时才使用该图像。可能的值包括:“error”、“warning”、“info”、“task”和“bookmark”。
- annotationImageProvider - 可选的注释图像提供者。必须实现
- textStylePreferenceKey - 表示文本修饰属性的首选项键。起始版本:3.0
- textStylePreferenceValue - 表示“显示为文本”修饰样式的缺省值。起始版本:3.0
- includeOnPreferencePage - 定义此注释类型是否应该可通过标准注释首选项页面进行配置。缺省值是 true。
Copyright (c) 2001, 2005 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