| <!doctype html public "-//w3c//dtd html 4.0 transitional//en"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Workbench Extension Points</title> |
| </head> |
| <body link="#0000FF" vlink="#800080"> |
| |
| <center> |
| <h1> |
| Resource Markers</h1></center> |
| <b><i>Identifier: </i></b>org.eclipse.core.resources.markers |
| <p><b><i>Description: </i></b>The workspace supports the notion of markers |
| on arbitrary resources. A marker is a kind of metadata (similar to |
| properties) which can be used to tag resources with user information. |
| Markers are optionally persisted by the workspace whenever a workspace |
| save or snapshot is done. |
| <p>Users can define and query for markers of a given type. Marker |
| types are defined in a hierarchy which supports multiple-inheritance. |
| Marker type definitions also specify a number of attributes which must or |
| may be present on a marker of that type as well as whether or not markers |
| of that type should be persisted. |
| <p>The markers extension-point allows marker writers to register their |
| marker types under a symbolic name that is then used from within the workspace |
| to create and query markers. The symbolic name is the id of the marker |
| extension. When defining a marker extension, users are encouraged to include |
| a human-readable value for the "name" attribute which indentifies their |
| marker and potentially may be presented to users. |
| <p><b><i>Configuration Markup:</i></b> |
| <p><tt> <!ELEMENT super EMPTY></tt> |
| <br><tt> <!ATTLIST super</tt> |
| <br><tt> type |
| CDATA #REQUIRED</tt> |
| <br><tt> ></tt> |
| <ul> |
| <li> |
| <b>type -</b> the fully-qualified id of a marker super type (i.e., a marker |
| type defined by another marker extension)</li> |
| </ul> |
| <tt> <!ELEMENT persistent EMPTY></tt> |
| <br><tt> <!ATTLIST persistent</tt> |
| <br><tt> value |
| CDATA #REQUIRED</tt> |
| <br><tt> ></tt> |
| <ul> |
| <li> |
| <b>value</b> - <tt>"true"</tt> or <tt>"false"</tt> indicating whether or |
| not markers of this type should be persisted by the workspace. If |
| the persistent characteristic is not specified, the marker type is <b>not</b> |
| persisted.</li> |
| </ul> |
| <tt> <!ELEMENT attribute EMPTY></tt> |
| <br><tt> <!ATTLIST attribute</tt> |
| <br><tt> name |
| CDATA #REQUIRED</tt> |
| <br><tt> ></tt> |
| <ul> |
| <li> |
| <b>value</b> - the name of an attribute which may be present on markers |
| of this type</li> |
| </ul> |
| <b><i>Examples:</i></b> |
| <p>Following is an example of a marker configuration: |
| <p><tt> <extension id="coolMarker" point="org.eclipse.core.resources.markers" |
| name="Cool Marker"></tt> |
| <br><tt> <persistent value="true"/></tt> |
| <br><tt> <super type="org.eclipse.core.resources.problemmarker"/></tt> |
| <br><tt> <super type="org.eclipse.core.resources.textmarker"/></tt> |
| <br><tt> <attribute name="owner"/></tt> |
| <br><tt> </extension></tt> |
| <p><b><i>API Information</i>:</b><i> </i>All markers, regardless of their |
| type, are instances of <tt>org.eclipse.core.resources.IMarker</tt>. |
| <p><b><i>Supplied Implementation:</i></b> The platform itself has a number |
| of <a href="base_markers.html">pre-defined marker types</a>. Particular |
| product installs may include additional markers as required. |
| <p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2002. All Rights Reserved." BORDER=0 height=12 width=195></a> |
| </body> |
| </html> |
