Class DelegatingStyledCellLabelProvider
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.viewers.BaseLabelProvider
-
- org.eclipse.jface.viewers.CellLabelProvider
-
- org.eclipse.jface.viewers.OwnerDrawLabelProvider
-
- org.eclipse.jface.viewers.StyledCellLabelProvider
-
- org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider
-
- All Implemented Interfaces:
IBaseLabelProvider,IToolTipProvider
- Direct Known Subclasses:
DecoratingStyledCellLabelProvider
public class DelegatingStyledCellLabelProvider extends StyledCellLabelProvider
ADelegatingStyledCellLabelProvideris aStyledCellLabelProviderthat delegates requests for the styled string and the image to aDelegatingStyledCellLabelProvider.IStyledLabelProvider.Existing label providers can be enhanced by implementing
DelegatingStyledCellLabelProvider.IStyledLabelProviderso they can be used in viewers with styled labels.The
DelegatingStyledCellLabelProvider.IStyledLabelProvidercan optionally implementIColorProviderandIFontProviderto provide foreground and background color and a default font.Since 3.10,
DelegatingStyledCellLabelProvider.IStyledLabelProvidercan optionally implementIToolTipProviderto provide tooltip support.- Since:
- 3.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDelegatingStyledCellLabelProvider.IStyledLabelProviderInterface marking a label provider that provides styled text labels and images.
-
Field Summary
-
Fields inherited from class org.eclipse.jface.viewers.StyledCellLabelProvider
COLORS_ON_SELECTION, NO_FOCUS
-
-
Constructor Summary
Constructors Constructor Description DelegatingStyledCellLabelProvider(DelegatingStyledCellLabelProvider.IStyledLabelProvider labelProvider)Creates aDelegatingStyledCellLabelProviderthat delegates the requests for the styled labels and the images to aDelegatingStyledCellLabelProvider.IStyledLabelProvider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddListener(ILabelProviderListener listener)Adds a listener to this label provider.voiddispose()TheBaseLabelProviderimplementation of thisIBaseLabelProvidermethod clears its internal listener list.ColorgetBackground(Object element)Provides a background color for the given element.FontgetFont(Object element)Provides a font for the given element.ColorgetForeground(Object element)Provides a foreground color for the given element.ImagegetImage(Object element)Returns the image for the label of the given element.DelegatingStyledCellLabelProvider.IStyledLabelProvidergetStyledStringProvider()Returns the styled string provider.protected StyledStringgetStyledText(Object element)Returns the styled text for the label of the given element.StringgetToolTipText(Object element)Get the text displayed in the tool tip for object.booleanisLabelProperty(Object element, String property)TheBaseLabelProviderimplementation of thisIBaseLabelProvidermethod returnstrue.voidremoveListener(ILabelProviderListener listener)Removes a listener to this label provider.voidupdate(ViewerCell cell)Update the label for cell.-
Methods inherited from class org.eclipse.jface.viewers.StyledCellLabelProvider
erase, getColumn, getViewer, initialize, isOwnerDrawEnabled, measure, paint, prepareStyleRange, setOwnerDrawEnabled, styleDecoratedString
-
Methods inherited from class org.eclipse.jface.viewers.OwnerDrawLabelProvider
dispose, initialize, setOwnerDrawEnabled, setUpOwnerDraw
-
Methods inherited from class org.eclipse.jface.viewers.CellLabelProvider
getToolTipBackgroundColor, getToolTipDisplayDelayTime, getToolTipFont, getToolTipForegroundColor, getToolTipImage, getToolTipShift, getToolTipStyle, getToolTipTimeDisplayed, useNativeToolTip
-
Methods inherited from class org.eclipse.jface.viewers.BaseLabelProvider
fireLabelProviderChanged
-
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
-
-
-
Constructor Detail
-
DelegatingStyledCellLabelProvider
public DelegatingStyledCellLabelProvider(DelegatingStyledCellLabelProvider.IStyledLabelProvider labelProvider)
Creates aDelegatingStyledCellLabelProviderthat delegates the requests for the styled labels and the images to aDelegatingStyledCellLabelProvider.IStyledLabelProvider.- Parameters:
labelProvider- the label provider that provides the styled labels and the images
-
-
Method Detail
-
update
public void update(ViewerCell cell)
Description copied from class:CellLabelProviderUpdate the label for cell.- Overrides:
updatein classStyledCellLabelProvider- Parameters:
cell-ViewerCell
-
getForeground
public Color getForeground(Object element)
Provides a foreground color for the given element.- Parameters:
element- the element- Returns:
- the foreground color for the element, or
nullto use the default foreground color
-
getBackground
public Color getBackground(Object element)
Provides a background color for the given element.- Parameters:
element- the element- Returns:
- the background color for the element, or
nullto use the default background color
-
getFont
public Font getFont(Object element)
Provides a font for the given element.- Parameters:
element- the element- Returns:
- the font for the element, or
nullto use the default font
-
getToolTipText
public String getToolTipText(Object element)
Description copied from class:CellLabelProviderGet the text displayed in the tool tip for object.If
CellLabelProvider.getToolTipText(Object)andCellLabelProvider.getToolTipImage(Object)both returnnullthe control is set back to standard behavior- Specified by:
getToolTipTextin interfaceIToolTipProvider- Overrides:
getToolTipTextin classCellLabelProvider- Parameters:
element- the element for which the tool tip is shown- Returns:
- the
Stringornullif there is not text to display
-
getImage
public Image getImage(Object element)
Returns the image for the label of the given element. The image is owned by the label provider and must not be disposed directly. Instead, dispose the label provider when no longer needed.- Parameters:
element- the element for which to provide the label image- Returns:
- the image used to label the element, or
nullif there is no image for the given object
-
getStyledText
protected StyledString getStyledText(Object element)
Returns the styled text for the label of the given element.- Parameters:
element- the element for which to provide the styled label text- Returns:
- the styled text string used to label the element
-
getStyledStringProvider
public DelegatingStyledCellLabelProvider.IStyledLabelProvider getStyledStringProvider()
Returns the styled string provider.- Returns:
- the wrapped label provider
-
addListener
public void addListener(ILabelProviderListener listener)
Description copied from interface:IBaseLabelProviderAdds a listener to this label provider. Has no effect if an identical listener is already registered.Label provider listeners are informed about state changes that affect the rendering of the viewer that uses this label provider.
- Specified by:
addListenerin interfaceIBaseLabelProvider- Overrides:
addListenerin classBaseLabelProvider- Parameters:
listener- a label provider listener
-
removeListener
public void removeListener(ILabelProviderListener listener)
Description copied from interface:IBaseLabelProviderRemoves a listener to this label provider. Has no effect if an identical listener is not registered.- Specified by:
removeListenerin interfaceIBaseLabelProvider- Overrides:
removeListenerin classBaseLabelProvider- Parameters:
listener- a label provider listener
-
isLabelProperty
public boolean isLabelProperty(Object element, String property)
Description copied from class:BaseLabelProviderTheBaseLabelProviderimplementation of thisIBaseLabelProvidermethod returnstrue. Subclasses may override.- Specified by:
isLabelPropertyin interfaceIBaseLabelProvider- Overrides:
isLabelPropertyin classBaseLabelProvider- Parameters:
element- the elementproperty- the property- Returns:
trueif the label would be affected, andfalseif it would be unaffected
-
dispose
public void dispose()
Description copied from class:BaseLabelProviderTheBaseLabelProviderimplementation of thisIBaseLabelProvidermethod clears its internal listener list. Subclasses may extend but should call the super implementation.- Specified by:
disposein interfaceIBaseLabelProvider- Overrides:
disposein classStyledCellLabelProvider
-
-