File	Doc	Category	Size	Date	Package
MouseEvent.java	API Doc	Java SE 6 API	33386	Tue Jun 10 00:25:24 BST 2008	java.awt.event

MouseEvent

• java.lang.Object
  • java.util.EventObject
    • java.awt.AWTEvent
      • java.awt.event.ComponentEvent
        • java.awt.event.InputEvent

id  modifiers  button 
MOUSE_PRESSED: BUTTON1_MASK BUTTON1
MOUSE_RELEASED: BUTTON1_MASK BUTTON1
MOUSE_CLICKED: BUTTON1_MASK BUTTON1

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

Fields Summary
public static final int	MOUSE_FIRST The first number in the range of ids used for mouse events.
public static final int	MOUSE_LAST The last number in the range of ids used for mouse events.
public static final int	MOUSE_CLICKED The "mouse clicked" event. This MouseEvent occurs when a mouse button is pressed and released.
public static final int	MOUSE_PRESSED The "mouse pressed" event. This MouseEvent occurs when a mouse button is pushed down.
public static final int	MOUSE_RELEASED The "mouse released" event. This MouseEvent occurs when a mouse button is let up.
public static final int	MOUSE_MOVED The "mouse moved" event. This MouseEvent occurs when the mouse position changes.
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.
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.
public static final int	MOUSE_DRAGGED The "mouse dragged" event. This MouseEvent occurs when the mouse position changes while a mouse button is pressed.
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.
public static final int	NOBUTTON Indicates no mouse buttons; used by {@link #getButton}.
public static final int	BUTTON1 Indicates mouse button #1; used by {@link #getButton}.
public static final int	BUTTON2 Indicates mouse button #2; used by {@link #getButton}.
public static final int	BUTTON3 Indicates mouse button #3; used by {@link #getButton}.
int	x The mouse event's x coordinate. The x value is relative to the component that fired the event.
int	y The mouse event's y coordinate. The y value is relative to the component that fired the event.
private int	xAbs The mouse event's x absolute coordinate. In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system. Otherwise, this coordinate is relative to the coordinate system associated with the Component's GraphicsConfiguration.
private int	yAbs The mouse event's y absolute coordinate. In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system. Otherwise, this coordinate is relative to the coordinate system associated with the Component's GraphicsConfiguration.
int	clickCount Indicates the number of quick consecutive clicks of a mouse button. clickCount will be valid for only three mouse events : 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.
int	button Indicates which, if any, of the mouse buttons has changed state. The only legal values are the following constants: NOBUTTON, BUTTON1, BUTTON2 or BUTTON3.
boolean	popupTrigger A property used to indicate whether a Popup Menu should appear with a certain gestures. If popupTrigger = false, no popup menu should appear. If it is true then a popup menu should appear.
private static final long	serialVersionUID

Constructors Summary
public 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. 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. An invocation of the form MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger, button) behaves in exactly the same way as the invocation {@link #MouseEvent(Component, int, long, int, int, int, int, int, int, boolean, int) MouseEvent}(source, id, when, modifiers, x, y, xAbs, yAbs, clickCount, popupTrigger, button) where xAbs and yAbs defines as source's location on screen plus relative coordinates x and y. xAbs and yAbs are set to zero if the source is not showing. This method throws an IllegalArgumentException if source is null. param source the Component that originated the event param id the integer that identifies the event param when a long int that gives the time the event occurred param 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. param x the horizontal x coordinate for the mouse location param y the vertical y coordinate for the mouse location param clickCount the number of mouse clicks associated with event param popupTrigger a boolean, true if this event is a trigger for a popup menu param button which of the mouse buttons has changed state. NOBUTTON, BUTTON1, BUTTON2 or BUTTON3. throws IllegalArgumentException if an invalid button value is passed in throws IllegalArgumentException if source is null since 1.4 this(source, id, when, modifiers, x, y, 0, 0, clickCount, popupTrigger, button); Point eventLocationOnScreen = new Point(0, 0); try { eventLocationOnScreen = source.getLocationOnScreen(); this.xAbs = eventLocationOnScreen.x + x; this.yAbs = eventLocationOnScreen.y + y; } catch (IllegalComponentStateException e){ this.xAbs = 0; this.yAbs = 0; }
public 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. Note that passing in an invalid id results in unspecified behavior. An invocation of the form MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger) behaves in exactly the same way as the invocation {@link #MouseEvent(Component, int, long, int, int, int, int, int, int, boolean, int) MouseEvent}(source, id, when, modifiers, x, y, xAbs, yAbs, clickCount, popupTrigger, MouseEvent.NOBUTTON) where xAbs and yAbs defines as source's location on screen plus relative coordinates x and y. xAbs and yAbs are set to zero if the source is not showing. This method throws an IllegalArgumentException if source is null. param source the Component that originated the event param id the integer that identifies the event param when a long int that gives the time the event occurred param 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. param x the horizontal x coordinate for the mouse location param y the vertical y coordinate for the mouse location param clickCount the number of mouse clicks associated with event param popupTrigger a boolean, true if this event is a trigger for a popup menu throws IllegalArgumentException if source is null this(source, id, when, modifiers, x, y, clickCount, popupTrigger, NOBUTTON);
public MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger, int button) Constructs a MouseEvent object with the specified source component, type, modifiers, coordinates, absolute 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. Even if inconsistent values for relative and absolute coordinates are passed to the constructor, the mouse event instance is still created and no exception is thrown. This method throws an IllegalArgumentException if source is null. param source the Component that originated the event param id the integer that identifies the event param when a long int that gives the time the event occurred param 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. param x the horizontal x coordinate for the mouse location param y the vertical y coordinate for the mouse location param xAbs the absolute horizontal x coordinate for the mouse location param yAbs the absolute vertical y coordinate for the mouse location param clickCount the number of mouse clicks associated with event param popupTrigger a boolean, true if this event is a trigger for a popup menu param button which of the mouse buttons has changed state. NOBUTTON, BUTTON1, BUTTON2 or BUTTON3. throws IllegalArgumentException if an invalid button value is passed in throws IllegalArgumentException if source is null since 1.6 super(source, id, when, modifiers); this.x = x; this.y = y; this.xAbs = xAbs; this.yAbs = yAbs; this.clickCount = clickCount; this.popupTrigger = popupTrigger; if (button < NOBUTTON || button >BUTTON3) { throw new IllegalArgumentException("Invalid button value"); } this.button = button; if ((getModifiers() != 0) && (getModifiersEx() == 0)) { setNewModifiers(); } else if ((getModifiers() == 0) && (getModifiersEx() != 0 || button != NOBUTTON)) { setOldModifiers(); }

Methods Summary
public int	getButton() Returns which, if any, of the mouse buttons has changed state. return one of the following constants: NOBUTTON, BUTTON1, BUTTON2 or BUTTON3. since 1.4 return button;
public int	getClickCount() Returns the number of mouse clicks associated with this event. return integer value for the number of clicks return clickCount;
public java.awt.Point	getLocationOnScreen() Returns the absolute x, y position of the event. In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, these coordinates are relative to the virtual coordinate system. Otherwise, these coordinates are relative to the coordinate system associated with the Component's GraphicsConfiguration. return a Point object containing the absolute x and y coordinates. see java.awt.GraphicsConfiguration since 1.6 /* ensure that the necessary native libraries are loaded */ NativeLibLoader.loadLibraries(); if (!GraphicsEnvironment.isHeadless()) { initIDs(); } return new Point(xAbs, yAbs);
public static 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. param modifiers a modifier mask describing the modifier keys and mouse buttons that were down during the event return string a text description of the combination of modifier keys and mouse buttons that were down during the event see InputEvent#getModifiersExText(int) since 1.4 StringBuffer buf = new StringBuffer(); if ((modifiers & InputEvent.ALT_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.alt", "Alt")); buf.append("+"); } if ((modifiers & InputEvent.META_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.meta", "Meta")); buf.append("+"); } if ((modifiers & InputEvent.CTRL_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.control", "Ctrl")); buf.append("+"); } if ((modifiers & InputEvent.SHIFT_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.shift", "Shift")); buf.append("+"); } if ((modifiers & InputEvent.ALT_GRAPH_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.altGraph", "Alt Graph")); buf.append("+"); } if ((modifiers & InputEvent.BUTTON1_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.button1", "Button1")); buf.append("+"); } if ((modifiers & InputEvent.BUTTON2_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.button2", "Button2")); buf.append("+"); } if ((modifiers & InputEvent.BUTTON3_MASK) != 0) { buf.append(Toolkit.getProperty("AWT.button3", "Button3")); buf.append("+"); } if (buf.length() > 0) { buf.setLength(buf.length()-1); // remove trailing '+' } return buf.toString();
public java.awt.Point	getPoint() Returns the x,y position of the event relative to the source component. return a Point object containing the x and y coordinates relative to the source component int x; int y; synchronized (this) { x = this.x; y = this.y; } return new Point(x, y);
public int	getX() Returns the horizontal x position of the event relative to the source component. return x an integer indicating horizontal position relative to the component return x;
public int	getXOnScreen() Returns the absolute horizontal x position of the event. In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system. Otherwise, this coordinate is relative to the coordinate system associated with the Component's GraphicsConfiguration. return x an integer indicating absolute horizontal position. see java.awt.GraphicsConfiguration since 1.6 return xAbs;
public int	getY() Returns the vertical y position of the event relative to the source component. return y an integer indicating vertical position relative to the component return y;
public int	getYOnScreen() Returns the absolute vertical y position of the event. In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system. Otherwise, this coordinate is relative to the coordinate system associated with the Component's GraphicsConfiguration. return y an integer indicating absolute vertical position. see java.awt.GraphicsConfiguration since 1.6 return yAbs;
private static native void	initIDs() Initialize JNI field and method IDs for fields that may be accessed from C.
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. return boolean, true if this event is the popup menu trigger for this platform return popupTrigger;
public java.lang.String	paramString() Returns a parameter string identifying this event. This method is useful for event-logging and for debugging. return a string identifying the event and its attributes StringBuffer str = new StringBuffer(80); switch(id) { case MOUSE_PRESSED: str.append("MOUSE_PRESSED"); break; case MOUSE_RELEASED: str.append("MOUSE_RELEASED"); break; case MOUSE_CLICKED: str.append("MOUSE_CLICKED"); break; case MOUSE_ENTERED: str.append("MOUSE_ENTERED"); break; case MOUSE_EXITED: str.append("MOUSE_EXITED"); break; case MOUSE_MOVED: str.append("MOUSE_MOVED"); break; case MOUSE_DRAGGED: str.append("MOUSE_DRAGGED"); break; case MOUSE_WHEEL: str.append("MOUSE_WHEEL"); break; default: str.append("unknown type"); } // (x,y) coordinates str.append(",(").append(x).append(",").append(y).append(")"); str.append(",absolute(").append(xAbs).append(",").append(yAbs).append(")"); str.append(",button=").append(getButton()); if (getModifiers() != 0) { str.append(",modifiers=").append(getMouseModifiersText(modifiers)); } if (getModifiersEx() != 0) { str.append(",extModifiers=").append(getModifiersExText(modifiers)); } str.append(",clickCount=").append(clickCount); return str.toString();
private void	readObject(java.io.ObjectInputStream s) Sets new modifiers by the old ones. serial s.defaultReadObject(); if (getModifiers() != 0 && getModifiersEx() == 0) { setNewModifiers(); }
private void	setNewModifiers() Sets new modifiers by the old ones. Also sets button. if ((modifiers & BUTTON1_MASK) != 0) { modifiers |= BUTTON1_DOWN_MASK; } if ((modifiers & BUTTON2_MASK) != 0) { modifiers |= BUTTON2_DOWN_MASK; } if ((modifiers & BUTTON3_MASK) != 0) { modifiers |= BUTTON3_DOWN_MASK; } if (id == MOUSE_PRESSED || id == MOUSE_RELEASED || id == MOUSE_CLICKED) { if ((modifiers & BUTTON1_MASK) != 0) { button = BUTTON1; modifiers &= ~BUTTON2_MASK & ~BUTTON3_MASK; if (id != MOUSE_PRESSED) { modifiers &= ~BUTTON1_DOWN_MASK; } } else if ((modifiers & BUTTON2_MASK) != 0) { button = BUTTON2; modifiers &= ~BUTTON1_MASK & ~BUTTON3_MASK; if (id != MOUSE_PRESSED) { modifiers &= ~BUTTON2_DOWN_MASK; } } else if ((modifiers & BUTTON3_MASK) != 0) { button = BUTTON3; modifiers &= ~BUTTON1_MASK & ~BUTTON2_MASK; if (id != MOUSE_PRESSED) { modifiers &= ~BUTTON3_DOWN_MASK; } } } if ((modifiers & InputEvent.ALT_MASK) != 0) { modifiers |= InputEvent.ALT_DOWN_MASK; } if ((modifiers & InputEvent.META_MASK) != 0) { modifiers |= InputEvent.META_DOWN_MASK; } if ((modifiers & InputEvent.SHIFT_MASK) != 0) { modifiers |= InputEvent.SHIFT_DOWN_MASK; } if ((modifiers & InputEvent.CTRL_MASK) != 0) { modifiers |= InputEvent.CTRL_DOWN_MASK; } if ((modifiers & InputEvent.ALT_GRAPH_MASK) != 0) { modifiers |= InputEvent.ALT_GRAPH_DOWN_MASK; }
private void	setOldModifiers() Sets old modifiers by the new ones. if (id == MOUSE_PRESSED || id == MOUSE_RELEASED || id == MOUSE_CLICKED) { switch(button) { case BUTTON1: modifiers |= BUTTON1_MASK; break; case BUTTON2: modifiers |= BUTTON2_MASK; break; case BUTTON3: modifiers |= BUTTON3_MASK; break; } } else { if ((modifiers & BUTTON1_DOWN_MASK) != 0) { modifiers |= BUTTON1_MASK; } if ((modifiers & BUTTON2_DOWN_MASK) != 0) { modifiers |= BUTTON2_MASK; } if ((modifiers & BUTTON3_DOWN_MASK) != 0) { modifiers |= BUTTON3_MASK; } } if ((modifiers & ALT_DOWN_MASK) != 0) { modifiers |= ALT_MASK; } if ((modifiers & META_DOWN_MASK) != 0) { modifiers |= META_MASK; } if ((modifiers & SHIFT_DOWN_MASK) != 0) { modifiers |= SHIFT_MASK; } if ((modifiers & CTRL_DOWN_MASK) != 0) { modifiers |= CTRL_MASK; } if ((modifiers & ALT_GRAPH_DOWN_MASK) != 0) { modifiers |= ALT_GRAPH_MASK; }
public synchronized void	translatePoint(int x, int y) Translates the event's coordinates to a new position by adding specified x (horizontal) and y (vertical) offsets. param x the horizontal x value to add to the current x coordinate position param y the vertical y value to add to the current y coordinate position this.x += x; this.y += y;