|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
A StyledCellLabelProvider
supports styled labels by using owner
draw.
Besides the styles in labels, the label provider preserves native viewer behavior:
For providing the label's styles, create a subclass and overwrite
update(ViewerCell)
to
return set all information needed to render a element. Use
ViewerCell.setStyleRanges(StyleRange[])
to set style ranges
on the label.
The current version of the StyledCellLabelProvider
will ignore all font settings on
StyleRange
. Different fonts would make labels wider, and the native
selection drawing could not be reused.
NOTE: This API is experimental and may be deleted or changed before 3.4 is released.
Field Summary | |
static int |
COLORS_ON_SELECTION
Style constant for indicating that the styled colors are to be applied even it the viewer's item is selected. |
static int |
NO_FOCUS
Style constant for indicating to draw the focus if requested by the owner draw event. |
Constructor Summary | |
StyledCellLabelProvider()
Creates a new StyledCellLabelProvider. |
|
StyledCellLabelProvider(int style)
Creates a new StyledCellLabelProvider. |
Method Summary | |
void |
dispose()
The BaseLabelProvider implementation of this
IBaseLabelProvider method clears its internal listener list.
|
protected void |
erase(Event event,
Object element)
Handle the erase event. |
protected ViewerColumn |
getColumn()
Returns the column on which this label provider is installed on or null if the
label provider is not installed. |
protected ColumnViewer |
getViewer()
Returns the viewer on which this label provider is installed on or null if the
label provider is not installed. |
void |
initialize(ColumnViewer viewer,
ViewerColumn column)
This implementation of CellLabelProvider.initialize(ColumnViewer, ViewerColumn)
delegates to OwnerDrawLabelProvider.initialize(ColumnViewer, ViewerColumn, boolean)
with a value of true for enableOwnerDraw .
|
boolean |
isOwnerDrawEnabled()
Returns true is the owner draw rendering is enabled for this label provider.
|
protected void |
measure(Event event,
Object element)
Handle the measure event. |
protected void |
paint(Event event,
Object element)
Handle the paint event. |
protected StyleRange |
prepareStyleRange(StyleRange styleRange,
boolean applyColors)
Prepares the given style range before it is applied to the label. |
void |
setOwnerDrawEnabled(boolean enabled)
Specifies whether owner draw rendering is enabled for this label provider. |
void |
update(ViewerCell cell)
Update the label for cell. |
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, getToolTipText, getToolTipTimeDisplayed, useNativeToolTip |
Methods inherited from class org.eclipse.jface.viewers.BaseLabelProvider |
addListener, fireLabelProviderChanged, isLabelProperty, removeListener |
Methods inherited from class org.eclipse.core.commands.common.EventManager |
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int COLORS_ON_SELECTION
public static final int NO_FOCUS
Constructor Detail |
public StyledCellLabelProvider()
public StyledCellLabelProvider(int style)
style
- the style bitsCOLORS_ON_SELECTION
,
NO_FOCUS
Method Detail |
public boolean isOwnerDrawEnabled()
true
is the owner draw rendering is enabled for this label provider.
By default owner draw rendering is enabled. If owner draw rendering is disabled, rending is
done by the viewer and no styled ranges (see ViewerCell.getStyleRanges()
)
are drawn.
true
is the rendering of styles is enabled.public void setOwnerDrawEnabled(boolean enabled)
ViewerCell.getStyleRanges()
) are drawn.
It is the caller's responsibility to also call
StructuredViewer.refresh()
or similar methods to update the
underlying widget.
enabled
- specifies if owner draw rendering is enabledprotected final ColumnViewer getViewer()
null
if the
label provider is not installed.
null
if the
label provider is not installed.protected final ViewerColumn getColumn()
null
if the
label provider is not installed.
null
if the
label provider is not installed.public void initialize(ColumnViewer viewer, ViewerColumn column)
OwnerDrawLabelProvider
CellLabelProvider.initialize(ColumnViewer, ViewerColumn)
delegates to OwnerDrawLabelProvider.initialize(ColumnViewer, ViewerColumn, boolean)
with a value of true
for enableOwnerDraw
.
Subclasses may override this method but should either call the super
implementation or, alternatively,
OwnerDrawLabelProvider.initialize(ColumnViewer, ViewerColumn, boolean)
.
initialize
in class OwnerDrawLabelProvider
public void dispose()
BaseLabelProvider
BaseLabelProvider
implementation of this
IBaseLabelProvider
method clears its internal listener list.
Subclasses may extend but should call the super implementation.
dispose
in interface IBaseLabelProvider
dispose
in class BaseLabelProvider
public void update(ViewerCell cell)
CellLabelProvider
update
in class OwnerDrawLabelProvider
protected StyleRange prepareStyleRange(StyleRange styleRange, boolean applyColors)
StyledCellLabelProvider
will also ignore all font settings on the
style range. Clients can override.
styleRange
- the style range to prepare. the style range element must not be modifiedapplyColors
- specifies if colors should be applied.
protected void erase(Event event, Object element)
erase
in class OwnerDrawLabelProvider
event
- the erase eventelement
- the model objectSWT.EraseItem
protected void measure(Event event, Object element)
OwnerDrawLabelProvider
measure
in class OwnerDrawLabelProvider
event
- the measure eventelement
- the model elementSWT.MeasureItem
protected void paint(Event event, Object element)
OwnerDrawLabelProvider
paint
in class OwnerDrawLabelProvider
event
- the paint eventelement
- the model elementSWT.PaintItem
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.