Eclipse JDT
Release 3.0

org.eclipse.jdt.ui
Class ProblemsLabelDecorator

java.lang.Object
  extended byorg.eclipse.jdt.ui.ProblemsLabelDecorator
All Implemented Interfaces:
org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.ILabelDecorator, org.eclipse.jface.viewers.ILightweightLabelDecorator

public class ProblemsLabelDecorator
extends 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.

Since:
2.0

Nested Class Summary
static class ProblemsLabelDecorator.ProblemsLabelChangedEvent
          This is a special LabelProviderChangedEvent carrying additional information whether the event origins 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(org.eclipse.jface.viewers.ILabelProviderListener listener)
           
protected  int computeAdornmentFlags(Object obj)
          Note: This method is for internal use only.
 void decorate(Object element, org.eclipse.jface.viewers.IDecoration decoration)
           
 org.eclipse.swt.graphics.Image decorateImage(org.eclipse.swt.graphics.Image image, Object obj)
           
 String decorateText(String text, Object element)
           
 void dispose()
           
protected  boolean isInside(int pos, ISourceReference sourceElement)
          Tests if a position is inside the source range of an element.
 boolean isLabelProperty(Object element, String property)
           
 void removeListener(org.eclipse.jface.viewers.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 org.eclipse.jface.viewers.ILabelDecorator

decorateImage

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

computeAdornmentFlags

protected int computeAdornmentFlags(Object obj)
Note: This method is for internal use only. Clients should not call this method.


isInside

protected boolean isInside(int pos,
                           ISourceReference sourceElement)
                    throws org.eclipse.core.runtime.CoreException
Tests if a position is inside the source range of an element.

Parameters:
pos - Position to be tested.
sourceElement - Source element (must be a IJavaElement)
Returns:
boolean Return true if position is located inside the source element.
Throws:
org.eclipse.core.runtime.CoreException - Exception thrown if element range could not be accessed.
Since:
2.1

dispose

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

isLabelProperty

public boolean isLabelProperty(Object element,
                               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(Object element,
                     org.eclipse.jface.viewers.IDecoration decoration)
Specified by:
decorate in interface org.eclipse.jface.viewers.ILightweightLabelDecorator

Eclipse JDT
Release 3.0

Copyright (c) IBM Corp. and others 2000, 2004. All Rights Reserved.