Package org.eclipse.jdt.ui
Class ProblemsLabelDecorator
java.lang.Object
org.eclipse.jdt.ui.ProblemsLabelDecorator
- All Implemented Interfaces:
IBaseLabelProvider
,ILabelDecorator
,ILightweightLabelDecorator
public class ProblemsLabelDecorator
extends Object
implements ILabelDecorator, 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
.
Important: Although this decorator implements ILightweightLabelDecorator, do not contribute this
class as a decorator to the org.eclipse.ui.decorators
extension. Only use this class in your
own views and label providers.
- Since:
- 2.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This is a specialLabelProviderChangedEvent
carrying additional information whether the event origins from a maker change. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a newProblemsLabelDecorator
.ProblemsLabelDecorator
(org.eclipse.jdt.internal.ui.viewsupport.ImageDescriptorRegistry registry) Note: This constructor is for internal use only. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addListener
(ILabelProviderListener listener) protected int
Computes the adornment flags for the given element.void
decorate
(Object element, IDecoration decoration) decorateImage
(Image image, Object obj) 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
(ILabelProviderListener listener)
-
Constructor Details
-
ProblemsLabelDecorator
public ProblemsLabelDecorator()Creates a newProblemsLabelDecorator
. -
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.- Parameters:
registry
- The registry to use ornull
to use the Java plugin's image registry- Restriction:
- This constructor is not intended to be referenced by clients.
-
-
Method Details
-
decorateText
- Specified by:
decorateText
in interfaceILabelDecorator
-
decorateImage
- Specified by:
decorateImage
in interfaceILabelDecorator
-
computeAdornmentFlags
Computes the adornment flags for the given element.- Parameters:
obj
- the element to compute the flags for- Returns:
- the adornment flags
-
isInside
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:
CoreException
- Exception thrown if element range could not be accessed.- Since:
- 2.1
-
dispose
public void dispose()- Specified by:
dispose
in interfaceIBaseLabelProvider
-
isLabelProperty
- Specified by:
isLabelProperty
in interfaceIBaseLabelProvider
-
addListener
- Specified by:
addListener
in interfaceIBaseLabelProvider
-
removeListener
- Specified by:
removeListener
in interfaceIBaseLabelProvider
-
decorate
- Specified by:
decorate
in interfaceILightweightLabelDecorator
-