buoy.event
Class ToolTipEvent

java.lang.Object
  java.util.EventObject
      buoy.event.ToolTipEvent

All Implemented Interfaces:

WidgetEvent, java.io.Serializable

public class ToolTipEvent
extends java.util.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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

java.awt.Point	getPoint() Get the position of the mouse pointer.
java.awt.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.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolTipEvent

public ToolTipEvent(Widget source,
                    long when,
                    java.awt.Point pos,
                    java.awt.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 Detail

getWidget

public Widget getWidget()

Get the Widget which generated this event.

Specified by:

getWidget in interface WidgetEvent

getWhen

public long getWhen()

Get the time at which the event occurred.

getPoint

public java.awt.Point getPoint()

Get the position of the mouse pointer.

getToolTipLocation

public java.awt.Point getToolTipLocation()

Get the suggested position at which the tool tip should be displayed.