edu.umd.cs.piccolox.pswing
Class PSwingMouseEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          java.awt.event.ComponentEvent
              java.awt.event.InputEvent
                  java.awt.event.MouseEvent
                      edu.umd.cs.piccolox.pswing.PSwingMouseEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PSwingMouseMotionEvent

public class PSwingMouseEvent
extends java.awt.event.MouseEvent
implements java.io.Serializable

PMouseEvent is an event which indicates that a mouse action occurred in a node.

This low-level event is generated by a node object for:

• Mouse Events
  • a mouse button is pressed
  • a mouse button is released
  • a mouse button is clicked (pressed and released)
  • the mouse cursor enters a node
  • the mouse cursor exits a node

  A PMouseEvent object is passed to every PMouseListener or PMouseAdapter object which registered to receive the "interesting" mouse events using the component's addMouseListener method. (PMouseAdapter objects implement the PMouseListener interface.) Each such listener object gets a PMouseEvent containing the mouse event.

  Warning: Serialized objects of this class will not be compatible with future Piccolo releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Piccolo. A future release of Piccolo will provide support for long term persistence.

  Author:

  Benjamin B. Bederson, Sam R. Reid, Lance E. Good

  See Also:

  Serialized Form

  Field Summary

  Fields inherited from class java.awt.event.MouseEvent

  BUTTON1, BUTTON2, BUTTON3, MOUSE_CLICKED, MOUSE_DRAGGED, MOUSE_ENTERED, MOUSE_EXITED, MOUSE_FIRST, MOUSE_LAST, MOUSE_MOVED, MOUSE_PRESSED, MOUSE_RELEASED, MOUSE_WHEEL, NOBUTTON

  Fields inherited from class java.awt.event.InputEvent

  ALT_DOWN_MASK, ALT_GRAPH_DOWN_MASK, ALT_GRAPH_MASK, ALT_MASK, BUTTON1_DOWN_MASK, BUTTON1_MASK, BUTTON2_DOWN_MASK, BUTTON2_MASK, BUTTON3_DOWN_MASK, BUTTON3_MASK, CTRL_DOWN_MASK, CTRL_MASK, META_DOWN_MASK, META_MASK, SHIFT_DOWN_MASK, SHIFT_MASK

  Fields inherited from class java.awt.event.ComponentEvent

  COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN

  Fields inherited from class java.awt.AWTEvent

  ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

  Fields inherited from class java.util.EventObject

  source

  Constructor Summary

  protected

  PSwingMouseEvent(int id, java.awt.event.MouseEvent e, PInputEvent event) Constructs a new PMouse event from a Java MouseEvent.

  Method Summary

  static PSwingMouseEvent	createMouseEvent(int id, java.awt.event.MouseEvent e, PInputEvent pEvent) Creates and returns a new PMouse event from a Java MouseEvent.
  void	dispatchTo(java.lang.Object listener) Calls appropriate method on the listener based on this events ID.
  PNode	getCurrentNode() Get the current node that is under the cursor.
  PPickPath	getCurrentPath() Get the path from the PCanvas down to the visual component currently under the mouse.This may give a different result then getGrabPath() durring a MOUSE_DRAGGED or MOUSE_RELEASED operation.
  PNode	getGrabNode() Determine the node the event originated at.
  PPickPath	getGrabPath() Return the path from the PCanvas down to the currently grabbed object.
  int	getID() Determine the event type.
  java.awt.geom.Point2D	getLocalPoint() Returns the x,y position of the event in the local coordinate system of the node the event occurred on.
  double	getLocalX() Returns the horizontal x position of the event in the local coordinate system of the node the event occurred on.
  double	getLocalY() Returns the vertical y position of the event in the local coordinate system of the node the event occurred on.
  PNode	getNode() Determine the node the event originated at.
  PPickPath	getPath() Determine the path the event took from the PCanvas down to the visual component.
  void	setSource(java.lang.Object aSource) Set the souce of this event.

  Methods inherited from class java.awt.event.MouseEvent

  getButton, getClickCount, getLocationOnScreen, getMouseModifiersText, getPoint, getX, getXOnScreen, getY, getYOnScreen, isPopupTrigger, paramString, translatePoint

  Methods inherited from class java.awt.event.InputEvent

  consume, getModifiers, getModifiersEx, getModifiersExText, getWhen, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown

  Methods inherited from class java.awt.event.ComponentEvent

  getComponent

  Methods inherited from class java.awt.AWTEvent

  toString

  Methods inherited from class java.util.EventObject

  getSource

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  PSwingMouseEvent

  protected PSwingMouseEvent(int id,
                             java.awt.event.MouseEvent e,
                             PInputEvent event)

  Constructs a new PMouse event from a Java MouseEvent.

  Parameters:

  id - The event type (MOUSE_PRESSED, MOUSE_RELEASED, MOUSE_CLICKED, MOUSE_ENTERED, MOUSE_EXITED)

  e - The original Java mouse event when in MOUSE_RELEASED events.

  Method Detail

  createMouseEvent

  public static PSwingMouseEvent createMouseEvent(int id,
                                                  java.awt.event.MouseEvent e,
                                                  PInputEvent pEvent)

  Creates and returns a new PMouse event from a Java MouseEvent.

  Parameters:

  id - The event type (MOUSE_PRESSED, MOUSE_RELEASED, MOUSE_CLICKED, MOUSE_ENTERED, MOUSE_EXITED, MOUSE_MOVED, MOUSE_DRAGGED)

  e - The original Java mouse event when in MOUSE_DRAGGED and MOUSE_RELEASED events.

  getLocalPoint

  public java.awt.geom.Point2D getLocalPoint()

  Returns the x,y position of the event in the local coordinate system of the node the event occurred on.

  Returns:

  a Point2D object containing the x and y coordinates local to the node.

  getLocalX

  public double getLocalX()

  Returns the horizontal x position of the event in the local coordinate system of the node the event occurred on.

  Returns:

  x a double indicating horizontal position local to the node.

  getLocalY

  public double getLocalY()

  Returns the vertical y position of the event in the local coordinate system of the node the event occurred on.

  Returns:

  y a double indicating vertical position local to the node.

  getID

  public int getID()

  Determine the event type.

  Overrides:

  getID in class java.awt.AWTEvent

  Returns:

  the id

  getNode

  public PNode getNode()

  Determine the node the event originated at. If an event percolates up the tree and is handled by an event listener higher up in the tree than the original node that generated the event, this returns the original node. For mouse drag and release events, this is the node that the original matching press event went to - in other words, the event is 'grabbed' by the originating node.

  Returns:

  the node

  getPath

  public PPickPath getPath()

  Determine the path the event took from the PCanvas down to the visual component.

  Returns:

  the path

  getGrabNode

  public PNode getGrabNode()

  Determine the node the event originated at. If an event percolates up the tree and is handled by an event listener higher up in the tree than the original node that generated the event, this returns the original node. For mouse drag and release events, this is the node that the original matching press event went to - in other words, the event is 'grabbed' by the originating node.

  Returns:

  the node

  getGrabPath

  public PPickPath getGrabPath()

  Return the path from the PCanvas down to the currently grabbed object.

  Returns:

  the path

  getCurrentNode

  public PNode getCurrentNode()

  Get the current node that is under the cursor. This may return a different result then getGrabNode() when in a MOUSE_RELEASED or MOUSE_DRAGGED event.

  Returns:

  the current node.

  getCurrentPath

  public PPickPath getCurrentPath()

  Get the path from the PCanvas down to the visual component currently under the mouse.This may give a different result then getGrabPath() durring a MOUSE_DRAGGED or MOUSE_RELEASED operation.

  Returns:

  the current path.

  dispatchTo

  public void dispatchTo(java.lang.Object listener)

  Calls appropriate method on the listener based on this events ID.

  Parameters:

  listener - the MouseListener or MouseMotionListener to dispatch to.

  setSource

  public void setSource(java.lang.Object aSource)

  Set the souce of this event. As the event is fired up the tree the source of the event will keep changing to reflect the scenegraph object that is firing the event.

  Overrides:

  setSource in class java.awt.AWTEvent

  Parameters:

  aSource -