IMarkerImageProvider

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> ui >> internal >> [ ide overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.ui.internal.ide.IMarkerImageProvider

SOURCE |

Download org.eclipse.ui.internal.ide.IMarkerImageProvider

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.internal.ide
Interface IMarkerImageProvider

All Known Implementing Classes:: ProblemImageProvider

public interface IMarkerImageProvider

Clients should implement this interface when creating an extension to define images for marker dynamically.

The name of the class should be specified in the extension contributed to the workbench's maker image provider extension point (named "org.eclipse.ui.makerImageProvider"). For example, the plug-in's XML markup might contain:

 <extension point="org.eclipse.ui.makerImageProvider">
      <imageprovider 
		   id="com.example.myplugin.myprofiderID"
         makertype="com.example.myMarkerType"
         icon="icons/basic/view16/myGIF.gif"/>
 </extension>

It can also define the image provider using the tag class instead of icon.

Either the image path specified by the tag icon or the path returned from getImagePath will be used to create the image when the following code is executed:

myMarker.getAdapter(IWorkbenchAdapter).getImageDescriptor(myMarker);

Method Summary

java.lang.String getImagePath(org.eclipse.core.resources.IMarker marker)
Returns the relative path for the image to be used for displaying an marker in the workbench.

Method Detail

getImagePath

public java.lang.String getImagePath(org.eclipse.core.resources.IMarker marker)

Returns the relative path for the image to be used for displaying an marker in the workbench. This path is relative to the plugin location Returns null if there is no appropriate image.