|
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
OwnerDrawLabelProvider is an abstract implementation of a label provider that handles custom draw.
This class is intended to be subclassed by implementors.
Constructor Summary | |
OwnerDrawLabelProvider()
Create a new instance of the receiver based on a column viewer. |
Method Summary | |
void |
dispose(ColumnViewer viewer,
ViewerColumn column)
Dispose of this label provider which was used with the given column viewer and column. |
protected void |
erase(Event event,
Object element)
Handle the erase event. |
protected void |
initialize(ColumnViewer viewer,
ViewerColumn column)
This implementation of CellLabelProvider.initialize(ColumnViewer, ViewerColumn)
delegates to initialize(ColumnViewer, ViewerColumn, boolean)
with a value of true for enableOwnerDraw .
|
protected void |
initialize(ColumnViewer viewer,
ViewerColumn column,
boolean enableOwnerDraw)
May be called from subclasses that override initialize(ColumnViewer, ViewerColumn) but want to customize
whether owner draw will be enabled. |
protected abstract void |
measure(Event event,
Object element)
Handle the measure event. |
protected abstract void |
paint(Event event,
Object element)
Handle the paint event. |
protected void |
setOwnerDrawEnabled(ColumnViewer viewer,
ViewerColumn column,
boolean enabled)
Enables or disables owner draw for the given viewer and column. |
static void |
setUpOwnerDraw(ColumnViewer viewer)
Deprecated. Since 3.4, the default implementation of CellLabelProvider.initialize(ColumnViewer, ViewerColumn)
in this class will set up the necessary owner draw callbacks
automatically. Calls to this method can be removed. |
void |
update(ViewerCell cell)
Update the label for cell. |
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, dispose, 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 |
Constructor Detail |
public OwnerDrawLabelProvider()
Method Detail |
public static void setUpOwnerDraw(ColumnViewer viewer)
CellLabelProvider.initialize(ColumnViewer, ViewerColumn)
in this class will set up the necessary owner draw callbacks
automatically. Calls to this method can be removed.
viewer
- the viewer the owner draw is set uppublic void dispose(ColumnViewer viewer, ViewerColumn column)
CellLabelProvider
BaseLabelProvider.dispose()
).
dispose
in class CellLabelProvider
viewer
- the viewercolumn
- the column, or null
if a column is not
available.protected void initialize(ColumnViewer viewer, ViewerColumn column)
CellLabelProvider.initialize(ColumnViewer, ViewerColumn)
delegates to 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,
initialize(ColumnViewer, ViewerColumn, boolean)
.
initialize
in class CellLabelProvider
viewer
- the viewercolumn
- the column, or null
if a column is not
available.protected final void initialize(ColumnViewer viewer, ViewerColumn column, boolean enableOwnerDraw)
initialize(ColumnViewer, ViewerColumn)
but want to customize
whether owner draw will be enabled. This method calls
super.initialize(ColumnViewer, ViewerColumn)
, and then
enables or disables owner draw by calling
setOwnerDrawEnabled(ColumnViewer, ViewerColumn, boolean)
.
viewer
- the viewercolumn
- the column, or null
if a column is not
available.enableOwnerDraw
- true
if owner draw should be enabled for the
given viewer and column, false
otherwise.public void update(ViewerCell cell)
CellLabelProvider
update
in class CellLabelProvider
cell
- ViewerCell
protected void erase(Event event, Object element)
SWT.COLOR_LIST_SELECTION
and foregrounds
with SWT.COLOR_LIST_SELECTION_TEXT
. Note that this
implementation causes non-native behavior on some platforms. Subclasses
should override this method and not call the super
implementation.
event
- the erase eventelement
- the model objectSWT.EraseItem
,
SWT.COLOR_LIST_SELECTION
,
SWT.COLOR_LIST_SELECTION_TEXT
protected abstract void measure(Event event, Object element)
event
- the measure eventelement
- the model elementSWT.MeasureItem
protected abstract void paint(Event event, Object element)
event
- the paint eventelement
- the model elementSWT.PaintItem
protected void setOwnerDrawEnabled(ColumnViewer viewer, ViewerColumn column, boolean enabled)
initialize(ColumnViewer, ViewerColumn)
and
dispose(ColumnViewer, ViewerColumn)
but may be called from
subclasses to enable or disable owner draw dynamically.
viewer
- the viewercolumn
- the column, or null
if a column is not
availableenabled
- true
if owner draw should be enabled,
false
otherwise
|
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.