prajna.gui

Class HoverEvent

java.lang.Object

java.util.EventObject

prajna.gui.HoverEvent

All Implemented Interfaces:

java.io.Serializable

public class HoverEvent
extends java.util.EventObject

HoverEvent can be used to signal when an object is hovered over by the mouse, or when the hovering stops. It is similar to FocusEvents and ItemSelectionEvents.

Author:

Edward Swing

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
HoverEvent(java.lang.Object eventSource, java.lang.Object triggerItem, boolean hoverOver) Construct a new HoverEvent, with the specified source, item and hover state.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getItem() Get the item which triggered this HoverEvent
boolean	isHovering() Return whether the mouse is currently hovering over the item

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HoverEvent

public HoverEvent(java.lang.Object eventSource,
          java.lang.Object triggerItem,
          boolean hoverOver)

Construct a new HoverEvent, with the specified source, item and hover state.

Parameters:

eventSource - The source object which triggered this event. Typically a Component

triggerItem - Item which triggered the HoverEvent. This can be an object displayed on the component, for instance.

hoverOver - The hover state. Set to TRUE to indicate that the mouse is currently hovering over the item, or FALSE if the mouse has moved off of the item.

Method Detail

getItem

public java.lang.Object getItem()

Get the item which triggered this HoverEvent

Returns:

the triggering item

isHovering

public boolean isHovering()

Return whether the mouse is currently hovering over the item

Returns:

whether the item is being hovered over