org.eclipse.jdt.ui
Class ProblemsLabelDecorator

java.lang.Object
  |
  +--org.eclipse.jdt.ui.ProblemsLabelDecorator

All Implemented Interfaces:

IBaseLabelProvider, ILabelDecorator

public class ProblemsLabelDecorator

extends Object

implements ILabelDecorator

LabelDecorator that decorates an element's image with error and warning overlays that represent the severity of markers attached to the element's underlying resource. To see a problem decoration for a marker, the marker needs to be a subtype of IMarker.PROBLEM.

Note: Only images for elements in Java projects are currently updated on marker changes.

Since:

2.0

Nested Class Summary

static class

ProblemsLabelDecorator.ProblemsLabelChangedEvent This is a special LabelProviderChangedEvent carring additional information whether the event orgins from a maker change.

Constructor Summary

ProblemsLabelDecorator()
Creates a new ProblemsLabelDecorator.

ProblemsLabelDecorator(org.eclipse.jdt.internal.ui.viewsupport.ImageDescriptorRegistry registry)
Note: This constructor is for internal use only.

Method Summary

void	addListener(ILabelProviderListener listener)
Image	decorateImage(Image image, Object obj)
String	decorateText(String text, Object element)
void	dispose()
boolean	isLabelProperty(Object element, String property)
void	removeListener(ILabelProviderListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProblemsLabelDecorator

public ProblemsLabelDecorator()

Creates a new ProblemsLabelDecorator.

ProblemsLabelDecorator

public ProblemsLabelDecorator(org.eclipse.jdt.internal.ui.viewsupport.ImageDescriptorRegistry registry)

Note: This constructor is for internal use only. Clients should not call this constructor.

Method Detail

decorateText

public String decorateText(String text,
                           Object element)

Specified by:

decorateText in interface ILabelDecorator

decorateImage

public Image decorateImage(Image image,
                           Object obj)

Specified by:

decorateImage in interface ILabelDecorator

dispose

public void dispose()

Specified by:

dispose in interface IBaseLabelProvider

isLabelProperty

public boolean isLabelProperty(Object element,
                               String property)

Specified by:

isLabelProperty in interface IBaseLabelProvider

addListener

public void addListener(ILabelProviderListener listener)

Specified by:

addListener in interface IBaseLabelProvider

removeListener

public void removeListener(ILabelProviderListener listener)

Specified by:

removeListener in interface IBaseLabelProvider