org.eclipse.cdt.internal.ui.viewsupport
Class ProblemsLabelDecorator

java.lang.Object
  extended by org.eclipse.cdt.internal.ui.viewsupport.ProblemsLabelDecorator
All Implemented Interfaces:
org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.ILabelDecorator, org.eclipse.jface.viewers.ILightweightLabelDecorator
Direct Known Subclasses:
CNavigatorProblemsLabelDecorator

public class ProblemsLabelDecorator
extends java.lang.Object
implements org.eclipse.jface.viewers.ILabelDecorator, org.eclipse.jface.viewers.ILightweightLabelDecorator

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(ImageDescriptorRegistry registry)
          Note: This constructor is for internal use only.
 
Method Summary
 void addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
           
 void decorate(java.lang.Object element, org.eclipse.jface.viewers.IDecoration decoration)
           
 org.eclipse.swt.graphics.Image decorateImage(org.eclipse.swt.graphics.Image image, java.lang.Object obj)
           
 java.lang.String decorateText(java.lang.String text, java.lang.Object element)
           
 void dispose()
           
 boolean isLabelProperty(java.lang.Object element, java.lang.String property)
           
 void removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProblemsLabelDecorator

public ProblemsLabelDecorator()
Creates a new ProblemsLabelDecorator.


ProblemsLabelDecorator

public ProblemsLabelDecorator(ImageDescriptorRegistry registry)
Note: This constructor is for internal use only. Clients should not call this constructor.

Method Detail

decorateText

public java.lang.String decorateText(java.lang.String text,
                                     java.lang.Object element)
Specified by:
decorateText in interface org.eclipse.jface.viewers.ILabelDecorator

decorateImage

public org.eclipse.swt.graphics.Image decorateImage(org.eclipse.swt.graphics.Image image,
                                                    java.lang.Object obj)
Specified by:
decorateImage in interface org.eclipse.jface.viewers.ILabelDecorator

dispose

public void dispose()
Specified by:
dispose in interface org.eclipse.jface.viewers.IBaseLabelProvider

isLabelProperty

public boolean isLabelProperty(java.lang.Object element,
                               java.lang.String property)
Specified by:
isLabelProperty in interface org.eclipse.jface.viewers.IBaseLabelProvider

addListener

public void addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
Specified by:
addListener in interface org.eclipse.jface.viewers.IBaseLabelProvider

removeListener

public void removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
Specified by:
removeListener in interface org.eclipse.jface.viewers.IBaseLabelProvider

decorate

public void decorate(java.lang.Object element,
                     org.eclipse.jface.viewers.IDecoration decoration)
Specified by:
decorate in interface org.eclipse.jface.viewers.ILightweightLabelDecorator