Class GraphicsNodeMouseEvent

java.lang.Object
java.util.EventObject
org.apache.batik.gvt.event.GraphicsNodeEvent
org.apache.batik.gvt.event.GraphicsNodeInputEvent
org.apache.batik.gvt.event.GraphicsNodeMouseEvent
All Implemented Interfaces:
Serializable
public class GraphicsNodeMouseEvent extends GraphicsNodeInputEvent
An event which indicates that a mouse action occurred in a graphics node.
See Also:

  • Field Details

    • MOUSE_CLICKED

      public static final int MOUSE_CLICKED
      The id for the "mouseClicked" event. This MouseEvent occurs when a mouse button is pressed and released.
      See Also:

    • MOUSE_PRESSED

      public static final int MOUSE_PRESSED
      The id for the "mousePressed" event. This MouseEvent occurs when a mouse button is pushed down.
      See Also:

    • MOUSE_RELEASED

      public static final int MOUSE_RELEASED
      The id for the "mouseReleased" event. This MouseEvent occurs when a mouse button is let up.
      See Also:

    • MOUSE_MOVED

      public static final int MOUSE_MOVED
      The id for the "mouseMoved" event. This MouseMotionEvent occurs when the mouse position changes.
      See Also:

    • MOUSE_ENTERED

      public static final int MOUSE_ENTERED
      The id for the "mouseEntered" event. This MouseEvent occurs when the mouse cursor enters a graphics node's area.
      See Also:

    • MOUSE_EXITED

      public static final int MOUSE_EXITED
      The id for the "mouseExited" event. This MouseEvent occurs when the mouse cursor leaves a graphics node's area.
      See Also:

    • MOUSE_DRAGGED

      public static final int MOUSE_DRAGGED
      The id for the "mouseDragged" event. This MouseEvent occurs when the mouse position changes while the "drag" modifier is active (for example, the shift key).
      See Also:

  • Constructor Details

    • GraphicsNodeMouseEvent

      public GraphicsNodeMouseEvent(GraphicsNode source, int id, long when, int modifiers, int lockState, int button, float x, float y, int clientX, int clientY, int screenX, int screenY, int clickCount, GraphicsNode relatedNode)
      Constructs a new graphics node mouse event.
      Parameters:
      source - the graphics node where the event originated
      id - the id of this event
      when - the time the event occurred
      modifiers - the modifier keys down when event occurred
      lockState - the lock keys active when the event occurred
      button - the mouse button that changed state
      x - the mouse x coordinate
      y - the mouse y coordinate
      screenX - the mouse x coordinate relative to the screen
      screenY - the mouse y coordinate relative to the screen
      clickCount - the number of clicks
      relatedNode - the related node
      See Also:

    • GraphicsNodeMouseEvent

      public GraphicsNodeMouseEvent(GraphicsNode source, MouseEvent evt, int button, int lockState)
      Constructs a new graphics node mouse event from an AWT MouseEvent.
      Parameters:
      source - the source where the event originated
      evt - the AWT mouse event which is the source of this GraphicsNodeEvent

  • Method Details

    • getButton

      public int getButton()
      Returns the mouse button that changed state.

    • getX

      public float getX()
      Returns the horizontal x position of the event relative to the source graphics node.
      Returns:
      x a float indicating horizontal position relative to the node

    • getY

      public float getY()
      Returns the vertical y position of the event relative to the source node.
      Returns:
      y a float indicating vertical position relative to the node

    • getClientX

      public float getClientX()
      Returns the horizontal x position of the event relative to the source graphics node.
      Returns:
      x a float indicating horizontal position relative to the node

    • getClientY

      public float getClientY()
      Returns the vertical y position of the event relative to the source node.
      Returns:
      y a float indicating vertical position relative to the node

    • getScreenX

      public int getScreenX()
      Returns the horizontal x position of the event relative to the screen.
      Returns:
      x a float indicating horizontal position relative to the screen

    • getScreenY

      public int getScreenY()
      Returns the vertical y position of the event relative to the screen.
      Returns:
      y a float indicating vertical position relative to the screen

    • getScreenPoint

      public Point getScreenPoint()
      Returns the (x, y) position of the event relative to the screen.
      Returns:
      a Point object containing the x and y coordinates

    • getClientPoint

      public Point getClientPoint()
      Returns the (x, y) position of the event relative to the screen.
      Returns:
      a Point object containing the x and y coordinates

    • getPoint2D

      public Point2D getPoint2D()
      Returns the (x, y) position of the event relative to the source node.
      Returns:
      a Point object containing the x and y coordinates

    • getClickCount

      public int getClickCount()
      Returns the number of mouse clicks associated with this event.
      Returns:
      integer value for the number of clicks

    • getRelatedNode

      public GraphicsNode getRelatedNode()
      Returns the related node for this GraphicsNodeMouseEvent. For a MOUSE_ENTERED event it is the previous node target, for a MOUSE_EXITED event it is the next node target and for a MOUSE_DRAGGED event it is the node under the mouse pointer. Otherwise the value is null.