org.pietschy.command
Class HoverEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.pietschy.command.HoverEvent
All Implemented Interfaces:
java.io.Serializable

public class HoverEvent
extends java.util.EventObject

Fired when the mouse enters and exits a command.

See Also:
CommandManager.addHoverListener(org.pietschy.command.HoverListener), Command.addHoverListener(org.pietschy.command.HoverListener), HoverListener, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
HoverEvent(Command command, Face face, java.awt.Component component)
           
 
Method Summary
 Command getCommand()
          Gets the command associated with the HoverEvent.
 Face getFace()
          Gets the Face associated with the hover event.
 boolean isInWindow(java.awt.Window window)
          Checks if the specified window contains the the on which that raised the hover event.
 
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(Command command,
                  Face face,
                  java.awt.Component component)
Method Detail

getCommand

public Command getCommand()
Gets the command associated with the HoverEvent.

Returns:
the command associated with the HoverEvent.

getFace

public Face getFace()
Gets the Face associated with the hover event.

Returns:
the Face associated with the hover event.

isInWindow

public boolean isInWindow(java.awt.Window window)
Checks if the specified window contains the the on which that raised the hover event.

This method can be used to filter out hover events that are raised on a shared

Parameters:
window - the component.
Returns:
true if the the hovered component is in the same window as the specified component.