Marker Updaters

Identifier:
org.eclipse.ui.editors.markerUpdaters

Since:
3.0 (originally named org.eclipse.ui.markerUpdaters)

Description:
This extension point is used for registering marker update strategies with marker annotation models. A resource that is opened in a text editor is associated with a marker annotation model. For each marker attached to the resource this model manages a position that is updated with each change applied to the text in the editor. If the resource is saved, the text in the editor and the position managed for a marker are passed over to the registered marker update strategies. These strategies can then update the marker's attributes based on the text and the position. Marker update strategies are requested to implement the interface org.eclipse.ui.texteditor.IMarkerUpdater. The update strategies can be registered either for a particular marker type or all marker types. The latter by omitting any marker type in the extension.

Configuration Markup:

<!ELEMENT extension (updater+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT updater (required-updater*)>

<!ATTLIST updater

id         CDATA #REQUIRED

markerType IDREF #IMPLIED

class      CDATA #REQUIRED>


<!ELEMENT required-updater EMPTY>

<!ATTLIST required-updater

id IDREF #REQUIRED>


Examples:

<extension point= "org.eclipse.ui.editors.markerUpdaters"> 
    <updater 
        id="org.eclipse.jdt.ui.markerUpdaters.JavaSearchMarkerUpdater" 
        class="org.eclipse.jdt.internal.ui.search.JavaSearchMarkerUpdater" 
        markerType="org.eclipse.search.searchmarker"> 
        <required-updater id="org.eclipse.ui.texteditor.BasicMarkerUpdater"/> 
    </updater>
</extension> 

This example registers org.eclipse.jdt.internal.ui.search.JavaSearchMarkerUpdater as a marker updater for all markers of the type org.eclipse.search.searchmarker including all its derived types. This marker updater requires BasicMarkerUpdater to execute first.


<extension point= "org.eclipse.ui.editors.markerUpdaters"> 
    <updater 
        id="org.eclipse.ui.texteditor.BasicMarkerUpdater" 
        class="org.eclipse.ui.texteditor.BasicMarkerUpdater"> 
    </updater> 
</extension> 

This example registers org.eclipse.ui.texteditor.BasicMarkerUpdater as a marker updater independent from the type of the marker. This marker updater does not require any other updater to run first.

API Information:
Registered marker updaters have to implement the interface org.eclipse.ui.texteditor.IMarkerUpdater.


Copyright (c) 2001, 2014 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