java.util.EventObject
java.awt.AWTEvent
java.awt.event.ComponentEvent
java.awt.event.InputEvent
java.awt.event.MouseEvent
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
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()
and InputEvent.getModifiersEx().
The button mask returned by 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().
The button which has changed state is returned by 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:
GraphicsConfiguration associated with
the Component.
Component.
MouseAdapter,
MouseListener,
MouseMotionAdapter,
MouseMotionListener,
MouseWheelListener,
Tutorial: Writing a Mouse Listener,
Tutorial: Writing a Mouse Motion Listener,
Reference: The Java Class Libraries (update file),
Serialized Form| Field Summary | |
(package private) int |
button
Indicates which, if any, of the mouse buttons has changed state. |
static int |
BUTTON1
Indicates mouse button #1; used by getButton(). |
static int |
BUTTON2
Indicates mouse button #2; used by getButton(). |
static int |
BUTTON3
Indicates mouse button #3; used by getButton(). |
(package private) int |
clickCount
Indicates the number of quick consecutive clicks of a mouse button. |
static int |
MOUSE_CLICKED
The "mouse clicked" event. |
static int |
MOUSE_DRAGGED
The "mouse dragged" event. |
static int |
MOUSE_ENTERED
The "mouse entered" event. |
static int |
MOUSE_EXITED
The "mouse exited" event. |
static int |
MOUSE_FIRST
The first number in the range of ids used for mouse events. |
static int |
MOUSE_LAST
The last number in the range of ids used for mouse events. |
static int |
MOUSE_MOVED
The "mouse moved" event. |
static int |
MOUSE_PRESSED
The "mouse pressed" event. |
static int |
MOUSE_RELEASED
The "mouse released" event. |
static int |
MOUSE_WHEEL
The "mouse wheel" event. |
static int |
NOBUTTON
Indicates no mouse buttons; used by getButton(). |
(package private) boolean |
popupTrigger
A property used to indicate whether a Popup Menu should appear with a certain gestures. |
private static long |
serialVersionUID
|
(package private) int |
x
The mouse event's x coordinate. |
(package private) int |
y
The mouse event's y coordinate. |
| 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, JDK_1_3_MODIFIERS, META_DOWN_MASK, META_MASK, modifiers, SHIFT_DOWN_MASK, SHIFT_MASK, when |
| 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.util.EventObject |
source |
| Constructor Summary | |
MouseEvent(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(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()
Returns which, if any, of the mouse buttons has changed state. |
int |
getClickCount()
Returns the number of mouse clicks associated with this event. |
static 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". |
Point |
getPoint()
Returns the x,y position of the event relative to the source component. |
int |
getX()
Returns the horizontal x position of the event relative to the source component. |
int |
getY()
Returns the vertical y position of the event relative to the source component. |
private static void |
initIDs()
Initialize JNI field and method IDs for fields that may be accessed from C. |
boolean |
isPopupTrigger()
Returns whether or not this mouse event is the popup menu trigger event for the platform. |
String |
paramString()
Returns a parameter string identifying this event. |
private void |
readObject(ObjectInputStream s)
Sets new modifiers by the old ones. |
private void |
setNewModifiers()
Sets new modifiers by the old ones. |
private void |
setOldModifiers()
Sets old modifiers by the new ones. |
void |
translatePoint(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 |
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 |
getID, setSource, 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 |
| Field Detail |
public static final int MOUSE_FIRST
public static final int MOUSE_LAST
public static final int MOUSE_CLICKED
MouseEvent
occurs when a mouse button is pressed and released.
public static final int MOUSE_PRESSED
MouseEvent
occurs when a mouse button is pushed down.
public static final int MOUSE_RELEASED
MouseEvent
occurs when a mouse button is let up.
public static final int MOUSE_MOVED
MouseEvent
occurs when the mouse position changes.
public static final int MOUSE_ENTERED
MouseEvent
occurs when the mouse cursor enters the unobscured part of component's
geometry.
public static final int MOUSE_EXITED
MouseEvent
occurs when the mouse cursor exits the unobscured part of component's
geometry.
public static final int MOUSE_DRAGGED
MouseEvent
occurs when the mouse position changes while a mouse button is pressed.
public static final int MOUSE_WHEEL
MouseWheelEvent.
It occurs when a mouse equipped with a wheel has its wheel rotated.
public static final int NOBUTTON
getButton().
public static final int BUTTON1
getButton().
public static final int BUTTON2
getButton().
public static final int BUTTON3
getButton().
int x
getX()int y
getY()int clickCount
MOUSE_CLICKED,
MOUSE_PRESSED and
MOUSE_RELEASED.
For the above, the clickCount will be at least 1.
For all other events the count will be 0.
getClickCount().int button
NOBUTTON,
BUTTON1,
BUTTON2 or
BUTTON3.
getButton().boolean popupTrigger
popupTrigger = false,
no popup menu should appear. If it is true
then a popup menu should appear.
PopupMenu,
isPopupTrigger()private static final long serialVersionUID
| Constructor Detail |
public MouseEvent(Component source,
int id,
long when,
int modifiers,
int x,
int y,
int clickCount,
boolean popupTrigger,
int button)
MouseEvent object with the
specified source component,
type, modifiers, coordinates, and click count.
Note that passing in an invalid id results in
unspecified behavior.
source - the Component that originated the eventid - the integer that identifies the eventwhen - a long int that gives the time the event occurredmodifiers - 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 locationy - the vertical y coordinate for the mouse locationclickCount - the number of mouse clicks associated with eventpopupTrigger - a boolean, true if this event is a trigger for a
popup menubutton - which of the mouse buttons has changed state.
NOBUTTON,
BUTTON1,
BUTTON2 or
BUTTON3.
IllegalArgumentException - if if an invalid button
value is passed in.
public MouseEvent(Component source,
int id,
long when,
int modifiers,
int x,
int y,
int clickCount,
boolean popupTrigger)
MouseEvent object with the
specified source component,
type, modifiers, coordinates, and click count.
Note that passing in an invalid id results in
unspecified behavior.
source - the Component that originated the eventid - the integer that identifies the eventwhen - a long int that gives the time the event occurredmodifiers - 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 locationy - the vertical y coordinate for the mouse locationclickCount - the number of mouse clicks associated with eventpopupTrigger - a boolean, true if this event is a trigger for a
popup menu| Method Detail |
private static void initIDs()
public int getX()
public int getY()
public Point getPoint()
Point object containing the x and y coordinates
relative to the source component
public void translatePoint(int x,
int y)
x (horizontal) and y
(vertical) offsets.
x - the horizontal x value to add to the current x
coordinate positiony - the vertical y value to add to the current y
coordinate positionpublic int getClickCount()
public int getButton()
NOBUTTON,
BUTTON1,
BUTTON2 or
BUTTON3.public boolean isPopupTrigger()
Note: Popup menus are triggered differently
on different systems. Therefore, isPopupTrigger
should be checked in both mousePressed
and mouseReleased
for proper cross-platform functionality.
public static String getMouseModifiersText(int modifiers)
modifiers - a modifier mask describing the modifier keys and
mouse buttons that were down during the event
public String paramString()
paramString in class ComponentEventprivate void setNewModifiers()
private void setOldModifiers()
private void readObject(ObjectInputStream s)
throws IOException,
ClassNotFoundException
IOException
ClassNotFoundException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||