public class DelegatingStyledCellLabelProvider extends StyledCellLabelProvider
DelegatingStyledCellLabelProvider is a
StyledCellLabelProvider that delegates requests for the styled string
and the image to a
DelegatingStyledCellLabelProvider.IStyledLabelProvider.
Existing label providers can be enhanced by implementing
DelegatingStyledCellLabelProvider.IStyledLabelProvider so they can be
used in viewers with styled labels.
The DelegatingStyledCellLabelProvider.IStyledLabelProvider can
optionally implement IColorProvider and IFontProvider to
provide foreground and background color and a default font.
Since 3.10, DelegatingStyledCellLabelProvider.IStyledLabelProvider
can optionally implement IToolTipProvider to provide tooltip
support.
| Modifier and Type | Class and Description |
|---|---|
static interface |
DelegatingStyledCellLabelProvider.IStyledLabelProvider
Interface marking a label provider that provides styled text labels and
images.
|
COLORS_ON_SELECTION, NO_FOCUS| Constructor and Description |
|---|
DelegatingStyledCellLabelProvider(DelegatingStyledCellLabelProvider.IStyledLabelProvider labelProvider)
Creates a
DelegatingStyledCellLabelProvider that delegates the
requests for the styled labels and the images to a
DelegatingStyledCellLabelProvider.IStyledLabelProvider. |
| Modifier and Type | Method and Description |
|---|---|
void |
addListener(ILabelProviderListener listener)
Adds a listener to this label provider.
|
void |
dispose()
The
BaseLabelProvider implementation of this
IBaseLabelProvider method clears its internal listener list. |
Color |
getBackground(Object element)
Provides a background color for the given element.
|
Font |
getFont(Object element)
Provides a font for the given element.
|
Color |
getForeground(Object element)
Provides a foreground color for the given element.
|
Image |
getImage(Object element)
Returns the image for the label of the given element.
|
DelegatingStyledCellLabelProvider.IStyledLabelProvider |
getStyledStringProvider()
Returns the styled string provider.
|
protected StyledString |
getStyledText(Object element)
Returns the styled text for the label of the given element.
|
String |
getToolTipText(Object element)
Get the text displayed in the tool tip for object.
|
boolean |
isLabelProperty(Object element,
String property)
The
BaseLabelProvider implementation of this
IBaseLabelProvider method returns true. |
void |
removeListener(ILabelProviderListener listener)
Removes a listener to this label provider.
|
void |
update(ViewerCell cell)
Update the label for cell.
|
erase, getColumn, getViewer, initialize, isOwnerDrawEnabled, measure, paint, prepareStyleRange, setOwnerDrawEnabled, styleDecoratedStringdispose, initialize, setOwnerDrawEnabled, setUpOwnerDrawgetToolTipBackgroundColor, getToolTipDisplayDelayTime, getToolTipFont, getToolTipForegroundColor, getToolTipImage, getToolTipShift, getToolTipStyle, getToolTipTimeDisplayed, useNativeToolTipfireLabelProviderChangedaddListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectpublic DelegatingStyledCellLabelProvider(DelegatingStyledCellLabelProvider.IStyledLabelProvider labelProvider)
DelegatingStyledCellLabelProvider that delegates the
requests for the styled labels and the images to a
DelegatingStyledCellLabelProvider.IStyledLabelProvider.labelProvider - the label provider that provides the styled labels and the
imagespublic void update(ViewerCell cell)
CellLabelProviderupdate in class StyledCellLabelProvidercell - ViewerCellpublic Color getForeground(Object element)
element - the elementnull to
use the default foreground colorpublic Color getBackground(Object element)
element - the elementnull to
use the default background colorpublic Font getFont(Object element)
element - the elementnull to use the
default fontpublic String getToolTipText(Object element)
CellLabelProvider
If CellLabelProvider.getToolTipText(Object) and
CellLabelProvider.getToolTipImage(Object) both return null the
control is set back to standard behavior
getToolTipText in interface IToolTipProvidergetToolTipText in class CellLabelProviderelement - the element for which the tool tip is shownString or null if there is not text to
displaypublic Image getImage(Object element)
element - the element for which to provide the label imagenull if
there is no image for the given objectprotected StyledString getStyledText(Object element)
element - the element for which to provide the styled label textpublic DelegatingStyledCellLabelProvider.IStyledLabelProvider getStyledStringProvider()
public void addListener(ILabelProviderListener listener)
IBaseLabelProviderLabel provider listeners are informed about state changes that affect the rendering of the viewer that uses this label provider.
addListener in interface IBaseLabelProvideraddListener in class BaseLabelProviderlistener - a label provider listenerpublic void removeListener(ILabelProviderListener listener)
IBaseLabelProviderremoveListener in interface IBaseLabelProviderremoveListener in class BaseLabelProviderlistener - a label provider listenerpublic boolean isLabelProperty(Object element, String property)
BaseLabelProviderBaseLabelProvider implementation of this
IBaseLabelProvider method returns true. Subclasses may
override.isLabelProperty in interface IBaseLabelProviderisLabelProperty in class BaseLabelProviderelement - the elementproperty - the propertytrue if the label would be affected,
and false if it would be unaffectedpublic void dispose()
BaseLabelProviderBaseLabelProvider implementation of this
IBaseLabelProvider method clears its internal listener list.
Subclasses may extend but should call the super implementation.dispose in interface IBaseLabelProviderdispose in class StyledCellLabelProvider
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.