org.eclipse.draw2d
Class ToolTipHelper

java.lang.Object
  |
  +--org.eclipse.draw2d.PopUpHelper
        |
        +--org.eclipse.draw2d.ToolTipHelper

public class ToolTipHelper

extends PopUpHelper

This class is used by SWTEventDispatcher as support to display Figure tooltips on a mouse hover event. Tooltips are drawn directly below the cursor unless the display does not allow, in which case the tooltip will be drawn directly above the cursor. Tooltips will be displayed with a LineBorder. The background of the tooltips will be the standard SWT tooltipBackground color unless the Figure's tooltip has set its own background.

Fields inherited from class org.eclipse.draw2d.PopUpHelper

control

Constructor Summary

ToolTipHelper(Control c)
Constructs a ToolTipHelper to be associated with Control c.

Method Summary

void	displayToolTipNear(IFigure hoverSource, IFigure tip, int eventX, int eventY) Sets the LightWeightSystem object's contents to the passed tooltip, and displays the tip.
void	dispose() Dispose of this PopUpHelper object.
protected void	hookShellListeners() Desired popup helper behavior is achieved by writing listeners that manipulate the behavior of the PopUpHelper's Shell.
void	updateToolTip(IFigure figureUnderMouse, IFigure tip, int eventX, int eventY) Displays the hoverSource's tooltip if a tooltip of another source is currently being displayed.

Methods inherited from class org.eclipse.draw2d.PopUpHelper

createLightweightSystem, createShell, getLightweightSystem, getShell, hide, isShowing, setBackgroundColor, setForegroundColor, setShellBounds, show

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToolTipHelper

public ToolTipHelper(Control c)

Constructs a ToolTipHelper to be associated with Control c.

Since:

2.0

Method Detail

displayToolTipNear

public void displayToolTipNear(IFigure hoverSource,
                               IFigure tip,
                               int eventX,
                               int eventY)

Sets the LightWeightSystem object's contents to the passed tooltip, and displays the tip. The tip will be displayed only if the tip source is different than the previously viewed tip source. I.E. The cursor has moved off of the previous tooltip source Figure. Tooltip will be painted directly below the cursor if possible, otherwise it will be painted directly above cursor.

Parameters:

hoverSource - The Figure overwhich the hover event was fired.

tip - The tool tip to be displayed.

eventX - X coordinate of the hover event

eventY - Y coordinate of the hover event

Since:

2.0

dispose

public void dispose()

Description copied from class: PopUpHelper

Dispose of this PopUpHelper object.

Overrides:

dispose in class PopUpHelper

hookShellListeners

protected void hookShellListeners()

Description copied from class: PopUpHelper

Desired popup helper behavior is achieved by writing listeners that manipulate the behavior of the PopUpHelper's Shell. Override this method and add these listeners here.

Overrides:

hookShellListeners in class PopUpHelper

updateToolTip

public void updateToolTip(IFigure figureUnderMouse,
                          IFigure tip,
                          int eventX,
                          int eventY)

Displays the hoverSource's tooltip if a tooltip of another source is currently being displayed.

Parameters:

figureUnderMouse - The Figure overwhich the cursor was when called

tip - The tool tip to be displayed.

eventX - X coordinate of the cursor

eventY - Y coordinate of the cursor

Since:

2.0