java.awt.event
Class MouseEvent

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject 
      extended by java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent 
          extended by java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent 
              extended by java.awt.event.InputEvent sample code for java.awt.event.InputEvent definition code for java.awt.event.InputEvent 
                  extended by java.awt.event.MouseEvent
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable
Direct Known Subclasses:
MenuDragMouseEvent sample code for javax.swing.event.MenuDragMouseEvent definition code for javax.swing.event.MenuDragMouseEvent , MouseWheelEvent sample code for java.awt.event.MouseWheelEvent definition code for java.awt.event.MouseWheelEvent

public class MouseEvent
extends InputEvent sample code for java.awt.event.InputEvent definition code for java.awt.event.InputEvent

An event which indicates that a mouse action occurred in a component. A mouse action is considered to occur in a particular component if and only if the mouse cursor is over the unobscured part of the component's bounds when the action happens. Component bounds can be obscurred by the visible component's children or by a menu or by a top-level window. This event is used both for mouse events (click, enter, exit) and mouse motion events (moves and drags).

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

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

A MouseEvent object is also passed to every MouseMotionListener or MouseMotionAdapter object which is registered to receive mouse motion events using the component's addMouseMotionListener method. (MouseMotionAdapter objects implement the MouseMotionListener interface.) Each such listener object gets a MouseEvent containing the mouse motion event.

When a mouse button is clicked, events are generated and sent to the registered MouseListeners. The state of modal keys can be retrieved using InputEvent.getModifiers() sample code for java.awt.event.InputEvent.getModifiers() definition code for java.awt.event.InputEvent.getModifiers() and InputEvent.getModifiersEx() sample code for java.awt.event.InputEvent.getModifiersEx() definition code for java.awt.event.InputEvent.getModifiersEx() . The button mask returned by InputEvent.getModifiers() sample code for java.awt.event.InputEvent.getModifiers() definition code for java.awt.event.InputEvent.getModifiers() reflects only the button that changed state, not the current state of all buttons. (Note: Due to overlap in the values of ALT_MASK/BUTTON2_MASK and META_MASK/BUTTON3_MASK, this is not always true for mouse events involving modifier keys). To get the state of all buttons and modifier keys, use InputEvent.getModifiersEx() sample code for java.awt.event.InputEvent.getModifiersEx() definition code for java.awt.event.InputEvent.getModifiersEx() . The button which has changed state is returned by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton()

For example, if the first mouse button is pressed, events are sent in the following order:

    id              modifiers    button           
    MOUSE_PRESSED:  BUTTON1_MASK BUTTON1
    MOUSE_RELEASED: BUTTON1_MASK BUTTON1
    MOUSE_CLICKED:  BUTTON1_MASK BUTTON1
 
When multiple mouse buttons are pressed, each press, release, and click results in a separate event.

For example, if the user presses button 1 followed by button 2, and then releases them in the same order, the following sequence of events is generated:

    id              modifiers    button           
    MOUSE_PRESSED:  BUTTON1_MASK BUTTON1
    MOUSE_PRESSED:  BUTTON2_MASK BUTTON2
    MOUSE_RELEASED: BUTTON1_MASK BUTTON1
    MOUSE_CLICKED:  BUTTON1_MASK BUTTON1
    MOUSE_RELEASED: BUTTON2_MASK BUTTON2
    MOUSE_CLICKED:  BUTTON2_MASK BUTTON2
 
If button 2 is released first, the MOUSE_RELEASED/MOUSE_CLICKED pair for BUTTON2_MASK arrives first, followed by the pair for BUTTON1_MASK.

MOUSE_DRAGGED events are delivered to the Component in which the mouse button was pressed until the mouse button is released (regardless of whether the mouse position is within the bounds of the Component). Due to platform-dependent Drag&Drop implementations, MOUSE_DRAGGED events may not be delivered during a native Drag&Drop operation. In a multi-screen environment mouse drag events are delivered to the Component even if the mouse position is outside the bounds of the GraphicsConfiguration associated with that Component. However, the reported position for mouse drag events in this case may differ from the actual mouse position:

Since:
1.1
See Also:
MouseAdapter sample code for java.awt.event.MouseAdapter definition code for java.awt.event.MouseAdapter , MouseListener sample code for java.awt.event.MouseListener definition code for java.awt.event.MouseListener , MouseMotionAdapter sample code for java.awt.event.MouseMotionAdapter definition code for java.awt.event.MouseMotionAdapter , MouseMotionListener sample code for java.awt.event.MouseMotionListener definition code for java.awt.event.MouseMotionListener , MouseWheelListener sample code for java.awt.event.MouseWheelListener definition code for java.awt.event.MouseWheelListener , Tutorial: Writing a Mouse Listener, Tutorial: Writing a Mouse Motion Listener, Reference: The Java Class Libraries (update file), Serialized Form

Field Summary
static int BUTTON1 sample code for java.awt.event.MouseEvent.BUTTON1 definition code for java.awt.event.MouseEvent.BUTTON1
          Indicates mouse button #1; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .
static int BUTTON2 sample code for java.awt.event.MouseEvent.BUTTON2 definition code for java.awt.event.MouseEvent.BUTTON2
          Indicates mouse button #2; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .
static int BUTTON3 sample code for java.awt.event.MouseEvent.BUTTON3 definition code for java.awt.event.MouseEvent.BUTTON3
          Indicates mouse button #3; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .
static int MOUSE_CLICKED sample code for java.awt.event.MouseEvent.MOUSE_CLICKED definition code for java.awt.event.MouseEvent.MOUSE_CLICKED
          The "mouse clicked" event.
static int MOUSE_DRAGGED sample code for java.awt.event.MouseEvent.MOUSE_DRAGGED definition code for java.awt.event.MouseEvent.MOUSE_DRAGGED
          The "mouse dragged" event.
static int MOUSE_ENTERED sample code for java.awt.event.MouseEvent.MOUSE_ENTERED definition code for java.awt.event.MouseEvent.MOUSE_ENTERED
          The "mouse entered" event.
static int MOUSE_EXITED sample code for java.awt.event.MouseEvent.MOUSE_EXITED definition code for java.awt.event.MouseEvent.MOUSE_EXITED
          The "mouse exited" event.
static int MOUSE_FIRST sample code for java.awt.event.MouseEvent.MOUSE_FIRST definition code for java.awt.event.MouseEvent.MOUSE_FIRST
          The first number in the range of ids used for mouse events.
static int MOUSE_LAST sample code for java.awt.event.MouseEvent.MOUSE_LAST definition code for java.awt.event.MouseEvent.MOUSE_LAST
          The last number in the range of ids used for mouse events.
static int MOUSE_MOVED sample code for java.awt.event.MouseEvent.MOUSE_MOVED definition code for java.awt.event.MouseEvent.MOUSE_MOVED
          The "mouse moved" event.
static int MOUSE_PRESSED sample code for java.awt.event.MouseEvent.MOUSE_PRESSED definition code for java.awt.event.MouseEvent.MOUSE_PRESSED
          The "mouse pressed" event.
static int MOUSE_RELEASED sample code for java.awt.event.MouseEvent.MOUSE_RELEASED definition code for java.awt.event.MouseEvent.MOUSE_RELEASED
          The "mouse released" event.
static int MOUSE_WHEEL sample code for java.awt.event.MouseEvent.MOUSE_WHEEL definition code for java.awt.event.MouseEvent.MOUSE_WHEEL
          The "mouse wheel" event.
static int NOBUTTON sample code for java.awt.event.MouseEvent.NOBUTTON definition code for java.awt.event.MouseEvent.NOBUTTON
          Indicates no mouse buttons; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .
 
Fields inherited from class java.awt.event.InputEvent sample code for java.awt.event.InputEvent definition code for java.awt.event.InputEvent
ALT_DOWN_MASK sample code for java.awt.event.InputEvent.ALT_DOWN_MASK definition code for java.awt.event.InputEvent.ALT_DOWN_MASK , ALT_GRAPH_DOWN_MASK sample code for java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK definition code for java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK , ALT_GRAPH_MASK sample code for java.awt.event.InputEvent.ALT_GRAPH_MASK definition code for java.awt.event.InputEvent.ALT_GRAPH_MASK , ALT_MASK sample code for java.awt.event.InputEvent.ALT_MASK definition code for java.awt.event.InputEvent.ALT_MASK , BUTTON1_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON1_DOWN_MASK definition code for java.awt.event.InputEvent.BUTTON1_DOWN_MASK , BUTTON1_MASK sample code for java.awt.event.InputEvent.BUTTON1_MASK definition code for java.awt.event.InputEvent.BUTTON1_MASK , BUTTON2_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON2_DOWN_MASK definition code for java.awt.event.InputEvent.BUTTON2_DOWN_MASK , BUTTON2_MASK sample code for java.awt.event.InputEvent.BUTTON2_MASK definition code for java.awt.event.InputEvent.BUTTON2_MASK , BUTTON3_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON3_DOWN_MASK definition code for java.awt.event.InputEvent.BUTTON3_DOWN_MASK , BUTTON3_MASK sample code for java.awt.event.InputEvent.BUTTON3_MASK definition code for java.awt.event.InputEvent.BUTTON3_MASK , CTRL_DOWN_MASK sample code for java.awt.event.InputEvent.CTRL_DOWN_MASK definition code for java.awt.event.InputEvent.CTRL_DOWN_MASK , CTRL_MASK sample code for java.awt.event.InputEvent.CTRL_MASK definition code for java.awt.event.InputEvent.CTRL_MASK , META_DOWN_MASK sample code for java.awt.event.InputEvent.META_DOWN_MASK definition code for java.awt.event.InputEvent.META_DOWN_MASK , META_MASK sample code for java.awt.event.InputEvent.META_MASK definition code for java.awt.event.InputEvent.META_MASK , SHIFT_DOWN_MASK sample code for java.awt.event.InputEvent.SHIFT_DOWN_MASK definition code for java.awt.event.InputEvent.SHIFT_DOWN_MASK , SHIFT_MASK sample code for java.awt.event.InputEvent.SHIFT_MASK definition code for java.awt.event.InputEvent.SHIFT_MASK
 
Fields inherited from class java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
COMPONENT_FIRST sample code for java.awt.event.ComponentEvent.COMPONENT_FIRST definition code for java.awt.event.ComponentEvent.COMPONENT_FIRST , COMPONENT_HIDDEN sample code for java.awt.event.ComponentEvent.COMPONENT_HIDDEN definition code for java.awt.event.ComponentEvent.COMPONENT_HIDDEN , COMPONENT_LAST sample code for java.awt.event.ComponentEvent.COMPONENT_LAST definition code for java.awt.event.ComponentEvent.COMPONENT_LAST , COMPONENT_MOVED sample code for java.awt.event.ComponentEvent.COMPONENT_MOVED definition code for java.awt.event.ComponentEvent.COMPONENT_MOVED , COMPONENT_RESIZED sample code for java.awt.event.ComponentEvent.COMPONENT_RESIZED definition code for java.awt.event.ComponentEvent.COMPONENT_RESIZED , COMPONENT_SHOWN sample code for java.awt.event.ComponentEvent.COMPONENT_SHOWN definition code for java.awt.event.ComponentEvent.COMPONENT_SHOWN
 
Fields inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
ACTION_EVENT_MASK sample code for java.awt.AWTEvent.ACTION_EVENT_MASK definition code for java.awt.AWTEvent.ACTION_EVENT_MASK , ADJUSTMENT_EVENT_MASK sample code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK definition code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK , COMPONENT_EVENT_MASK sample code for java.awt.AWTEvent.COMPONENT_EVENT_MASK definition code for java.awt.AWTEvent.COMPONENT_EVENT_MASK , consumed sample code for java.awt.AWTEvent.consumed definition code for java.awt.AWTEvent.consumed , CONTAINER_EVENT_MASK sample code for java.awt.AWTEvent.CONTAINER_EVENT_MASK definition code for java.awt.AWTEvent.CONTAINER_EVENT_MASK , FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.FOCUS_EVENT_MASK , HIERARCHY_BOUNDS_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK , HIERARCHY_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK , id sample code for java.awt.AWTEvent.id definition code for java.awt.AWTEvent.id , INPUT_METHOD_EVENT_MASK sample code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK definition code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK , INVOCATION_EVENT_MASK sample code for java.awt.AWTEvent.INVOCATION_EVENT_MASK definition code for java.awt.AWTEvent.INVOCATION_EVENT_MASK , ITEM_EVENT_MASK sample code for java.awt.AWTEvent.ITEM_EVENT_MASK definition code for java.awt.AWTEvent.ITEM_EVENT_MASK , KEY_EVENT_MASK sample code for java.awt.AWTEvent.KEY_EVENT_MASK definition code for java.awt.AWTEvent.KEY_EVENT_MASK , MOUSE_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_EVENT_MASK , MOUSE_MOTION_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK , MOUSE_WHEEL_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK , PAINT_EVENT_MASK sample code for java.awt.AWTEvent.PAINT_EVENT_MASK definition code for java.awt.AWTEvent.PAINT_EVENT_MASK , RESERVED_ID_MAX sample code for java.awt.AWTEvent.RESERVED_ID_MAX definition code for java.awt.AWTEvent.RESERVED_ID_MAX , TEXT_EVENT_MASK sample code for java.awt.AWTEvent.TEXT_EVENT_MASK definition code for java.awt.AWTEvent.TEXT_EVENT_MASK , WINDOW_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_EVENT_MASK , WINDOW_FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK , WINDOW_STATE_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
source sample code for java.util.EventObject.source definition code for java.util.EventObject.source
 
Constructor Summary
MouseEvent sample code for java.awt.event.MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean) definition code for java.awt.event.MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean) (Component sample code for java.awt.Component definition code for java.awt.Component  source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger)
          Constructs a MouseEvent object with the specified source component, type, modifiers, coordinates, and click count.
MouseEvent sample code for java.awt.event.MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean, int) definition code for java.awt.event.MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean, int) (Component sample code for java.awt.Component definition code for java.awt.Component  source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int button)
          Constructs a MouseEvent object with the specified source component, type, modifiers, coordinates, and click count.
 
Method Summary
 int getButton sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() ()
          Returns which, if any, of the mouse buttons has changed state.
 int getClickCount sample code for java.awt.event.MouseEvent.getClickCount() definition code for java.awt.event.MouseEvent.getClickCount() ()
          Returns the number of mouse clicks associated with this event.
static String sample code for java.lang.String definition code for java.lang.String getMouseModifiersText sample code for java.awt.event.MouseEvent.getMouseModifiersText(int) definition code for java.awt.event.MouseEvent.getMouseModifiersText(int) (int modifiers)
          Returns a String describing the modifier keys and mouse buttons that were down during the event, such as "Shift", or "Ctrl+Shift".
 Point sample code for java.awt.Point definition code for java.awt.Point getPoint sample code for java.awt.event.MouseEvent.getPoint() definition code for java.awt.event.MouseEvent.getPoint() ()
          Returns the x,y position of the event relative to the source component.
 int getX sample code for java.awt.event.MouseEvent.getX() definition code for java.awt.event.MouseEvent.getX() ()
          Returns the horizontal x position of the event relative to the source component.
 int getY sample code for java.awt.event.MouseEvent.getY() definition code for java.awt.event.MouseEvent.getY() ()
          Returns the vertical y position of the event relative to the source component.
 boolean isPopupTrigger sample code for java.awt.event.MouseEvent.isPopupTrigger() definition code for java.awt.event.MouseEvent.isPopupTrigger() ()
          Returns whether or not this mouse event is the popup menu trigger event for the platform.
 String sample code for java.lang.String definition code for java.lang.String paramString sample code for java.awt.event.MouseEvent.paramString() definition code for java.awt.event.MouseEvent.paramString() ()
          Returns a parameter string identifying this event.
 void translatePoint sample code for java.awt.event.MouseEvent.translatePoint(int, int) definition code for java.awt.event.MouseEvent.translatePoint(int, int) (int x, int y)
          Translates the event's coordinates to a new position by adding specified x (horizontal) and y (vertical) offsets.
 
Methods inherited from class java.awt.event.InputEvent sample code for java.awt.event.InputEvent definition code for java.awt.event.InputEvent
consume sample code for java.awt.event.InputEvent.consume() definition code for java.awt.event.InputEvent.consume() , getModifiers sample code for java.awt.event.InputEvent.getModifiers() definition code for java.awt.event.InputEvent.getModifiers() , getModifiersEx sample code for java.awt.event.InputEvent.getModifiersEx() definition code for java.awt.event.InputEvent.getModifiersEx() , getModifiersExText sample code for java.awt.event.InputEvent.getModifiersExText(int) definition code for java.awt.event.InputEvent.getModifiersExText(int) , getWhen sample code for java.awt.event.InputEvent.getWhen() definition code for java.awt.event.InputEvent.getWhen() , isAltDown sample code for java.awt.event.InputEvent.isAltDown() definition code for java.awt.event.InputEvent.isAltDown() , isAltGraphDown sample code for java.awt.event.InputEvent.isAltGraphDown() definition code for java.awt.event.InputEvent.isAltGraphDown() , isConsumed sample code for java.awt.event.InputEvent.isConsumed() definition code for java.awt.event.InputEvent.isConsumed() , isControlDown sample code for java.awt.event.InputEvent.isControlDown() definition code for java.awt.event.InputEvent.isControlDown() , isMetaDown sample code for java.awt.event.InputEvent.isMetaDown() definition code for java.awt.event.InputEvent.isMetaDown() , isShiftDown sample code for java.awt.event.InputEvent.isShiftDown() definition code for java.awt.event.InputEvent.isShiftDown()
 
Methods inherited from class java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
getComponent sample code for java.awt.event.ComponentEvent.getComponent() definition code for java.awt.event.ComponentEvent.getComponent()
 
Methods inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
getID sample code for java.awt.AWTEvent.getID() definition code for java.awt.AWTEvent.getID() , setSource sample code for java.awt.AWTEvent.setSource(java.lang.Object) definition code for java.awt.AWTEvent.setSource(java.lang.Object) , toString sample code for java.awt.AWTEvent.toString() definition code for java.awt.AWTEvent.toString()
 
Methods inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
getSource sample code for java.util.EventObject.getSource() definition code for java.util.EventObject.getSource()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

MOUSE_FIRST sample code for java.awt.event.MouseEvent.MOUSE_FIRST

public static final int MOUSE_FIRST
The first number in the range of ids used for mouse events.

See Also:
Constant Field Values

MOUSE_LAST sample code for java.awt.event.MouseEvent.MOUSE_LAST

public static final int MOUSE_LAST
The last number in the range of ids used for mouse events.

See Also:
Constant Field Values

MOUSE_CLICKED sample code for java.awt.event.MouseEvent.MOUSE_CLICKED

public static final int MOUSE_CLICKED
The "mouse clicked" event. This MouseEvent occurs when a mouse button is pressed and released.

See Also:
Constant Field Values

MOUSE_PRESSED sample code for java.awt.event.MouseEvent.MOUSE_PRESSED

public static final int MOUSE_PRESSED
The "mouse pressed" event. This MouseEvent occurs when a mouse button is pushed down.

See Also:
Constant Field Values

MOUSE_RELEASED sample code for java.awt.event.MouseEvent.MOUSE_RELEASED

public static final int MOUSE_RELEASED
The "mouse released" event. This MouseEvent occurs when a mouse button is let up.

See Also:
Constant Field Values

MOUSE_MOVED sample code for java.awt.event.MouseEvent.MOUSE_MOVED

public static final int MOUSE_MOVED
The "mouse moved" event. This MouseEvent occurs when the mouse position changes.

See Also:
Constant Field Values

MOUSE_ENTERED sample code for java.awt.event.MouseEvent.MOUSE_ENTERED

public static final int MOUSE_ENTERED
The "mouse entered" event. This MouseEvent occurs when the mouse cursor enters the unobscured part of component's geometry.

See Also:
Constant Field Values

MOUSE_EXITED sample code for java.awt.event.MouseEvent.MOUSE_EXITED

public static final int MOUSE_EXITED
The "mouse exited" event. This MouseEvent occurs when the mouse cursor exits the unobscured part of component's geometry.

See Also:
Constant Field Values

MOUSE_DRAGGED sample code for java.awt.event.MouseEvent.MOUSE_DRAGGED

public static final int MOUSE_DRAGGED
The "mouse dragged" event. This MouseEvent occurs when the mouse position changes while a mouse button is pressed.

See Also:
Constant Field Values

MOUSE_WHEEL sample code for java.awt.event.MouseEvent.MOUSE_WHEEL

public static final int MOUSE_WHEEL
The "mouse wheel" event. This is the only MouseWheelEvent. It occurs when a mouse equipped with a wheel has its wheel rotated.

Since:
1.4
See Also:
Constant Field Values

NOBUTTON sample code for java.awt.event.MouseEvent.NOBUTTON

public static final int NOBUTTON
Indicates no mouse buttons; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .

Since:
1.4
See Also:
Constant Field Values

BUTTON1 sample code for java.awt.event.MouseEvent.BUTTON1

public static final int BUTTON1
Indicates mouse button #1; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .

Since:
1.4
See Also:
Constant Field Values

BUTTON2 sample code for java.awt.event.MouseEvent.BUTTON2

public static final int BUTTON2
Indicates mouse button #2; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .

Since:
1.4
See Also:
Constant Field Values

BUTTON3 sample code for java.awt.event.MouseEvent.BUTTON3

public static final int BUTTON3
Indicates mouse button #3; used by getButton() sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton() .

Since:
1.4
See Also:
Constant Field Values
Constructor Detail

MouseEvent sample code for java.awt.event.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean, int) definition code for java.awt.event.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean, int)

public MouseEvent(Component sample code for java.awt.Component definition code for java.awt.Component  source,
                  int id,
                  long when,
                  int modifiers,
                  int x,
                  int y,
                  int clickCount,
                  boolean popupTrigger,
                  int button)
Constructs a MouseEvent object with the specified source component, type, modifiers, coordinates, and click count.

Note that passing in an invalid id results in unspecified behavior. Creating an invalid event (such as by using more than one of the old _MASKs, or modifier/button values which don't match) results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

Parameters:
source - the Component that originated the event
id - the integer that identifies the event
when - a long int that gives the time the event occurred
modifiers - the modifier keys down during event (e.g. shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred.
x - the horizontal x coordinate for the mouse location
y - the vertical y coordinate for the mouse location
clickCount - the number of mouse clicks associated with event
popupTrigger - a boolean, true if this event is a trigger for a popup menu
button - which of the mouse buttons has changed state. NOBUTTON, BUTTON1, BUTTON2 or BUTTON3.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if an invalid button value is passed in
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null
Since:
1.4

MouseEvent sample code for java.awt.event.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean) definition code for java.awt.event.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean)

public MouseEvent(Component sample code for java.awt.Component definition code for java.awt.Component  source,
                  int id,
                  long when,
                  int modifiers,
                  int x,
                  int y,
                  int clickCount,
                  boolean popupTrigger)
Constructs a MouseEvent object with the specified source component, type, modifiers, coordinates, and click count.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

Parameters:
source - the Component that originated the event
id - the integer that identifies the event
when - a long int that gives the time the event occurred
modifiers - the modifier keys down during event (e.g. shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred.
x - the horizontal x coordinate for the mouse location
y - the vertical y coordinate for the mouse location
clickCount - the number of mouse clicks associated with event
popupTrigger - a boolean, true if this event is a trigger for a popup menu
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null
Method Detail

getX sample code for java.awt.event.MouseEvent.getX() definition code for java.awt.event.MouseEvent.getX()

public int getX()
Returns the horizontal x position of the event relative to the source component.

Returns:
x an integer indicating horizontal position relative to the component

getY sample code for java.awt.event.MouseEvent.getY() definition code for java.awt.event.MouseEvent.getY()

public int getY()
Returns the vertical y position of the event relative to the source component.

Returns:
y an integer indicating vertical position relative to the component

getPoint sample code for java.awt.event.MouseEvent.getPoint() definition code for java.awt.event.MouseEvent.getPoint()

public Point sample code for java.awt.Point definition code for java.awt.Point  getPoint()
Returns the x,y position of the event relative to the source component.

Returns:
a Point object containing the x and y coordinates relative to the source component

translatePoint sample code for java.awt.event.MouseEvent.translatePoint(int, int) definition code for java.awt.event.MouseEvent.translatePoint(int, int)

public void translatePoint(int x,
                           int y)
Translates the event's coordinates to a new position by adding specified x (horizontal) and y (vertical) offsets.

Parameters:
x - the horizontal x value to add to the current x coordinate position
y - the vertical y value to add to the current y coordinate position

getClickCount sample code for java.awt.event.MouseEvent.getClickCount() definition code for java.awt.event.MouseEvent.getClickCount()

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

Returns:
integer value for the number of clicks

getButton sample code for java.awt.event.MouseEvent.getButton() definition code for java.awt.event.MouseEvent.getButton()

public int getButton()
Returns which, if any, of the mouse buttons has changed state.

Returns:
one of the following constants: NOBUTTON, BUTTON1, BUTTON2 or BUTTON3.
Since:
1.4

isPopupTrigger sample code for java.awt.event.MouseEvent.isPopupTrigger() definition code for java.awt.event.MouseEvent.isPopupTrigger()

public boolean isPopupTrigger()
Returns whether or not this mouse event is the popup menu trigger event for the platform.

Note: Popup menus are triggered differently on different systems. Therefore, isPopupTrigger should be checked in both mousePressed and mouseReleased for proper cross-platform functionality.

Returns:
boolean, true if this event is the popup menu trigger for this platform

getMouseModifiersText sample code for java.awt.event.MouseEvent.getMouseModifiersText(int) definition code for java.awt.event.MouseEvent.getMouseModifiersText(int)

public static String sample code for java.lang.String definition code for java.lang.String  getMouseModifiersText(int modifiers)
Returns a String describing the modifier keys and mouse buttons that were down during the event, such as "Shift", or "Ctrl+Shift". These strings can be localized by changing the awt.properties file.

Note that InputEvent.ALT_MASK and InputEvent.BUTTON2_MASK have the same value, so the string "Alt" is returned for both modifiers. Likewise, InputEvent.META_MASK and InputEvent.BUTTON3_MASK have the same value, so the string "Meta" is returned for both modifiers.

Parameters:
modifiers - a modifier mask describing the modifier keys and mouse buttons that were down during the event
Returns:
string a text description of the combination of modifier keys and mouse buttons that were down during the event
Since:
1.4
See Also:
InputEvent.getModifiersExText(int) sample code for java.awt.event.InputEvent.getModifiersExText(int) definition code for java.awt.event.InputEvent.getModifiersExText(int)

paramString sample code for java.awt.event.MouseEvent.paramString() definition code for java.awt.event.MouseEvent.paramString()

public String sample code for java.lang.String definition code for java.lang.String  paramString()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Overrides:
paramString sample code for java.awt.event.ComponentEvent.paramString() definition code for java.awt.event.ComponentEvent.paramString() in class ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
Returns:
a string identifying the event and its attributes