buoy.event

Class ToolTipEvent

Implemented Interfaces:
WidgetEvent

public class ToolTipEvent
extends EventObject
implements WidgetEvent

This event indicates that the user has performed the series of actions which signal that a tool tip should be displayed. Generally, this involves placing the mouse pointer over a Widget and not moving it for a certain amount of time.

For more information on how to display tool tips, see the BToolTip class.

Author:
Peter Eastman

Constructor Summary

ToolTipEvent(Widget source, long when, Point pos, Point tipPos)
Create a ToolTipEvent.

Method Summary

Point
getPoint()
Get the position of the mouse pointer.
Point
getToolTipLocation()
Get the suggested position at which the tool tip should be displayed.
long
getWhen()
Get the time at which the event occurred.
Widget
getWidget()
Get the Widget which generated this event.

Constructor Details

ToolTipEvent

public ToolTipEvent(Widget source,
                    long when,
                    Point pos,
                    Point tipPos)
Create a ToolTipEvent.
Parameters:
source - the Widget which generated this event
when - the time at which the event occurred
pos - the position of the mouse pointer
tipPos - the position at which the tool tip should be displayed

Method Details

getPoint

public Point getPoint()
Get the position of the mouse pointer.

getToolTipLocation

public Point getToolTipLocation()
Get the suggested position at which the tool tip should be displayed.

getWhen

public long getWhen()
Get the time at which the event occurred.

getWidget

public Widget getWidget()
Get the Widget which generated this event.
Specified by:
getWidget in interface WidgetEvent

Written by Peter Eastman.