|
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.jface.window.ToolTip
org.eclipse.jface.window.DefaultToolTip
org.eclipse.jface.viewers.ColumnViewerToolTipSupport
The ColumnViewerTooltipSupport is the class that provides tool tips for ColumnViewers.
Field Summary |
Fields inherited from class org.eclipse.jface.window.ToolTip |
NO_RECREATE, RECREATE |
Constructor Summary | |
protected |
ColumnViewerToolTipSupport(ColumnViewer viewer,
int style,
boolean manualActivation)
Enable ToolTip support for the viewer by creating an instance from this class. |
Method Summary | |
protected void |
afterHideToolTip(Event event)
This method is called after a tooltip is hidden. |
protected Composite |
createToolTipContentArea(Event event,
Composite parent)
Instead of overwriting this method subclasses should overwrite createViewerToolTipContentArea(Event, ViewerCell, Composite) |
protected Composite |
createViewerToolTipContentArea(Event event,
ViewerCell cell,
Composite parent)
Creates the content area of the tool tip giving access to the cell the tip is shown for. |
static void |
enableFor(ColumnViewer viewer)
Enable ToolTip support for the viewer by creating an instance from this class. |
static void |
enableFor(ColumnViewer viewer,
int style)
Enable ToolTip support for the viewer by creating an instance from this class. |
protected Object |
getToolTipArea(Event event)
This method is called to check for which area the tooltip is created/hidden for. |
protected boolean |
shouldCreateToolTip(Event event)
Should the tooltip displayed because of the given event. |
Methods inherited from class org.eclipse.jface.window.DefaultToolTip |
getBackgroundColor, getBackgroundImage, getFont, getForegroundColor, getImage, getStyle, getText, setBackgroundColor, setBackgroundImage, setFont, setForegroundColor, setImage, setStyle, setText |
Methods inherited from class org.eclipse.jface.window.ToolTip |
activate, deactivate, getData, getLocation, hide, isHideOnMouseDown, isRespectDisplayBounds, isRespectMonitorBounds, setData, setHideDelay, setHideOnMouseDown, setPopupDelay, setRespectDisplayBounds, setRespectMonitorBounds, setShift, show |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ColumnViewerToolTipSupport(ColumnViewer viewer, int style, boolean manualActivation)
CellLabelProvider
.
viewer
- the viewer the support is attached tostyle
- style passed to control tool tip behaviormanualActivation
- true
if the activation is done manually using
ToolTip.show(Point)
Method Detail |
public static void enableFor(ColumnViewer viewer)
CellLabelProvider
.
viewer
- the viewer the support is attached topublic static void enableFor(ColumnViewer viewer, int style)
CellLabelProvider
.
viewer
- the viewer the support is attached tostyle
- style passed to control tool tip behaviorToolTip.RECREATE
,
ToolTip.NO_RECREATE
protected Object getToolTipArea(Event event)
ToolTip
ToolTip.NO_RECREATE
this is used to
decide if the tooltip is hidden recreated.
By the default it is the widget the tooltip is created for but could be any object. To decide if
the area changed the Object.equals(Object)
method is used.
getToolTipArea
in class ToolTip
event
- the event
null
this could be any object describing the area
(e.g. the Control
onto which the tooltip is bound to, a
part of this area e.g. for ColumnViewer
this could be a
ViewerCell
)protected Composite createToolTipContentArea(Event event, Composite parent)
createViewerToolTipContentArea(Event, ViewerCell, Composite)
createToolTipContentArea
in class DefaultToolTip
event
- the event that triggered the activation of the tooltipparent
- the parent of the content area
protected Composite createViewerToolTipContentArea(Event event, ViewerCell cell, Composite parent)
This method is called from
createToolTipContentArea(Event, Composite)
and by default calls
the DefaultToolTip.createToolTipContentArea(Event, Composite)
.
event
- the event that whichcell
- the cell the tool tip is shown forparent
- the parent of the control to create
protected boolean shouldCreateToolTip(Event event)
ToolTip
Subclasses may overwrite this to get custom behavior
shouldCreateToolTip
in class ToolTip
event
- the event
true
if tooltip should be displayedprotected void afterHideToolTip(Event event)
ToolTip
Subclasses may override to clean up requested system resources
afterHideToolTip
in class ToolTip
event
- event triggered the hiding action (may be null
if event wasn't triggered by user actions directly)
|
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.