com.guiseframework.event
Class MouseEnterEvent

java.lang.Object
  java.util.EventObject
      com.globalmentor.event.AbstractEvent
          com.guiseframework.event.AbstractGuiseEvent
              com.guiseframework.event.AbstractInputEvent
                  com.guiseframework.event.AbstractGestureInputEvent
                      com.guiseframework.event.AbstractMouseEvent
                          com.guiseframework.event.MouseEnterEvent

All Implemented Interfaces:

com.globalmentor.event.Event, com.globalmentor.event.TargetedEvent, GestureInputEvent, GuiseEvent, InputEvent, MouseEvent, java.io.Serializable

public class MouseEnterEvent
extends AbstractMouseEvent

An event providing mouse information of a mouse entering a target.

Author:

Garret Wilson

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

MouseEnterEvent(java.lang.Object source, MouseEnterEvent mouseEnterEvent)
Copy constructor that specifies a different source.

MouseEnterEvent(java.lang.Object source, java.lang.Object target, Rectangle targetBounds, Rectangle viewportBounds, Point mousePosition, Key... keys)
Source and target constructor.

MouseEnterEvent(java.lang.Object source, Rectangle targetBounds, Rectangle viewportBounds, Point mousePosition, Key... keys)
Source constructor.

Method Summary

MouseInput

getInput()

Methods inherited from class com.guiseframework.event.AbstractMouseEvent

getMousePosition, getTarget, getTargetBounds, getViewportBounds

Methods inherited from class com.guiseframework.event.AbstractGestureInputEvent

getKeys, hasAltKey, hasControlKey, hasShiftKey

Methods inherited from class com.guiseframework.event.AbstractInputEvent

consume, isConsumed

Methods inherited from class com.guiseframework.event.AbstractGuiseEvent

getSession

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

Methods inherited from interface com.guiseframework.event.GestureInputEvent

getKeys, hasAltKey, hasControlKey, hasShiftKey

Methods inherited from interface com.guiseframework.event.InputEvent

consume, isConsumed

Methods inherited from interface com.guiseframework.event.GuiseEvent

getSession

Methods inherited from interface com.globalmentor.event.Event

getSource

Constructor Detail

MouseEnterEvent

public MouseEnterEvent(java.lang.Object source,
                       Rectangle targetBounds,
                       Rectangle viewportBounds,
                       Point mousePosition,
                       Key... keys)

Source constructor. The target will be set to be the same as the given source.

Parameters:

source - The object on which the event initially occurred.

targetBounds - The absolute bounds of the event target.

viewportBounds - The absolute bounds of the viewport.

mousePosition - The position of the mouse relative to the viewport.

keys - The keys that were pressed when this event was generated.

Throws:

java.lang.NullPointerException - if the given source, target bounds, viewport bounds, mouse position, and/or keys is null.

MouseEnterEvent

public MouseEnterEvent(java.lang.Object source,
                       java.lang.Object target,
                       Rectangle targetBounds,
                       Rectangle viewportBounds,
                       Point mousePosition,
                       Key... keys)

Source and target constructor.

Parameters:

source - The object on which the event initially occurred.

target - The target of the event.

targetBounds - The absolute bounds of the event target.

viewportBounds - The absolute bounds of the viewport.

mousePosition - The position of the mouse relative to the viewport.

keys - The keys that were pressed when this event was generated.

Throws:

java.lang.NullPointerException - if the given source, target, target bounds, viewport bounds, mouse position, and/or keys is null.

MouseEnterEvent

public MouseEnterEvent(java.lang.Object source,
                       MouseEnterEvent mouseEnterEvent)

Copy constructor that specifies a different source.

Parameters:

source - The object on which the event initially occurred.

mouseEnterEvent - The event the properties of which will be copied.

Throws:

java.lang.NullPointerException - if the given source and/or event is null.

Method Detail

getInput

public MouseInput getInput()

Returns:

The input associated with this event, or null if there is no input associated with this event.