Eclipse Platform
Release 3.3

org.eclipse.jface.viewers
Class ColumnViewerToolTipSupport

java.lang.Object
  extended byorg.eclipse.jface.window.ToolTip
      extended byorg.eclipse.jface.window.DefaultToolTip
          extended byorg.eclipse.jface.viewers.ColumnViewerToolTipSupport

public class ColumnViewerToolTipSupport
extends DefaultToolTip

The ColumnViewerTooltipSupport is the class that provides tool tips for ColumnViewers.

Since:
3.3

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.
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
createToolTipContentArea, 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

ColumnViewerToolTipSupport

protected ColumnViewerToolTipSupport(ColumnViewer viewer,
                                     int style,
                                     boolean manualActivation)
Enable ToolTip support for the viewer by creating an instance from this class. To get all necessary informations this support class consults the CellLabelProvider.

Parameters:
viewer - the viewer the support is attached to
style - style passed to control tool tip behavior
manualActivation - true if the activation is done manually using ToolTip.show(Point)
Method Detail

enableFor

public static void enableFor(ColumnViewer viewer)
Enable ToolTip support for the viewer by creating an instance from this class. To get all necessary informations this support class consults the CellLabelProvider.

Parameters:
viewer - the viewer the support is attached to

enableFor

public static void enableFor(ColumnViewer viewer,
                             int style)
Enable ToolTip support for the viewer by creating an instance from this class. To get all necessary informations this support class consults the CellLabelProvider.

Parameters:
viewer - the viewer the support is attached to
style - style passed to control tool tip behavior
See Also:
ToolTip.RECREATE, ToolTip.NO_RECREATE

getToolTipArea

protected Object getToolTipArea(Event event)
Description copied from class: ToolTip
This method is called to check for which area the tooltip is created/hidden for. In case of 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.

Overrides:
getToolTipArea in class ToolTip
Parameters:
event - the event
Returns:
the area responsible for the tooltip creation or 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)

shouldCreateToolTip

protected final boolean shouldCreateToolTip(Event event)
Description copied from class: ToolTip
Should the tooltip displayed because of the given event.

Subclasses may overwrite this to get custom behaviour

Overrides:
shouldCreateToolTip in class ToolTip
Parameters:
event - the event
Returns:
true if tooltip should be displayed

afterHideToolTip

protected void afterHideToolTip(Event event)
Description copied from class: ToolTip
This method is called after a Tooltip is hidden.

Subclasses may override to clean up requested system resources

Overrides:
afterHideToolTip in class ToolTip
Parameters:
event - event triggered the hiding action (may be null if event wasn't triggered by user actions directly)

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.