Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method

java.awt.event

Class MouseEvent

public class MouseEvent extends InputEvent

This event is generated for a mouse event. There are three main categories of mouse events: Regular events include pressing, releasing, and clicking buttons, as well as moving over the boundary of the unobscured portion of a component. Motion events include movement and dragging. Wheel events are covered separately by the subclass MouseWheelEvent.

A mouse event is tied to the unobstructed visible component that the mouse cursor was over at the time of the action. The button that was most recently pressed is the only one that shows up in getModifiers, and is returned by getButton, while all buttons that are down show up in getModifiersEx.

Drag events may be cut short if native drag-and-drop operations steal the event. Likewise, if a mouse drag exceeds the bounds of a window or virtual device, some platforms may clip the path to fit in the bounds of the component.

Since: 1.1

See Also: MouseAdapter MouseListener MouseMotionAdapter MouseMotionListener MouseWheelListener

UNKNOWN: updated to 1.4

Field Summary
static intBUTTON1
This indicates that button 1 changed state.
static intBUTTON2
This indicates that button 2 changed state.
static intBUTTON3
This indicates that button 3 changed state.
static intMOUSE_CLICKED
This event id indicates that the mouse was clicked.
static intMOUSE_DRAGGED
This event id indicates that the mouse was dragged over a component.
static intMOUSE_ENTERED
This event id indicates that the mouse entered a component.
static intMOUSE_EXITED
This event id indicates that the mouse exited a component.
static intMOUSE_FIRST
This is the first id in the range of event ids used by this class.
static intMOUSE_LAST
This is the last id in the range of event ids used by this class.
static intMOUSE_MOVED
This event id indicates that the mouse was moved.
static intMOUSE_PRESSED
This event id indicates that the mouse was pressed.
static intMOUSE_RELEASED
This event id indicates that the mouse was released.
static intMOUSE_WHEEL
This event id indicates that the mouse wheel was rotated.
static intNOBUTTON
This indicates that no button changed state.
Constructor Summary
MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int button)
Initializes a new instance of MouseEvent with the specified information.
MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger)
Initializes a new instance of MouseEvent with the specified information.
Method Summary
intgetButton()
Returns which button, if any, was the most recent to change state.
intgetClickCount()
This method returns the number of mouse clicks associated with this event.
static StringgetMouseModifiersText(int modifiers)
Returns a string describing the modifiers, such as "Shift" or "Ctrl+Button1".
PointgetPoint()
This method returns a Point for the x,y position of the mouse pointer.
intgetX()
This method returns the X coordinate of the mouse position.
intgetY()
This method returns the Y coordinate of the mouse position.
booleanisPopupTrigger()
This method tests whether or not the event is a popup menu trigger.
StringparamString()
Returns a string identifying this event.
voidtranslatePoint(int dx, int dy)
Translates the event coordinates by the specified x and y offsets.

Field Detail

BUTTON1

public static final int BUTTON1
This indicates that button 1 changed state.

Since: 1.4

See Also: getButton

BUTTON2

public static final int BUTTON2
This indicates that button 2 changed state.

Since: 1.4

See Also: getButton

BUTTON3

public static final int BUTTON3
This indicates that button 3 changed state.

Since: 1.4

See Also: getButton

MOUSE_CLICKED

public static final int MOUSE_CLICKED
This event id indicates that the mouse was clicked.

MOUSE_DRAGGED

public static final int MOUSE_DRAGGED
This event id indicates that the mouse was dragged over a component.

MOUSE_ENTERED

public static final int MOUSE_ENTERED
This event id indicates that the mouse entered a component.

MOUSE_EXITED

public static final int MOUSE_EXITED
This event id indicates that the mouse exited a component.

MOUSE_FIRST

public static final int MOUSE_FIRST
This is the first id in the range of event ids used by this class.

MOUSE_LAST

public static final int MOUSE_LAST
This is the last id in the range of event ids used by this class.

MOUSE_MOVED

public static final int MOUSE_MOVED
This event id indicates that the mouse was moved.

MOUSE_PRESSED

public static final int MOUSE_PRESSED
This event id indicates that the mouse was pressed.

MOUSE_RELEASED

public static final int MOUSE_RELEASED
This event id indicates that the mouse was released.

MOUSE_WHEEL

public static final int MOUSE_WHEEL
This event id indicates that the mouse wheel was rotated.

Since: 1.4

NOBUTTON

public static final int NOBUTTON
This indicates that no button changed state.

Since: 1.4

See Also: getButton

Constructor Detail

MouseEvent

public MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int button)
Initializes a new instance of MouseEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the source of the event id the event id when the timestamp of when the event occurred modifiers the modifier keys during the event, in old or new style x the X coordinate of the mouse point y the Y coordinate of the mouse point clickCount the number of mouse clicks for this event popupTrigger true if this event triggers a popup menu button the most recent mouse button to change state

Throws: IllegalArgumentException if source is null or button is invalid

Since: 1.4

MouseEvent

public MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger)
Initializes a new instance of MouseEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the source of the event id the event id when the timestamp of when the event occurred modifiers the modifier keys during the event, in old or new style x the X coordinate of the mouse point y the Y coordinate of the mouse point clickCount the number of mouse clicks for this event popupTrigger true if this event triggers a popup menu

Throws: IllegalArgumentException if source is null

Method Detail

getButton

public int getButton()
Returns which button, if any, was the most recent to change state. This will be one of {@link #NOBUTTON}, {@link #BUTTON1}, {@link #BUTTON2}, or {@link #BUTTON3}.

Returns: the button that changed state

Since: 1.4

getClickCount

public int getClickCount()
This method returns the number of mouse clicks associated with this event.

Returns: the number of mouse clicks for this event

getMouseModifiersText

public static String getMouseModifiersText(int modifiers)
Returns a string describing the modifiers, such as "Shift" or "Ctrl+Button1". XXX Sun claims this can be localized via the awt.properties file - how do we implement that?

Parameters: modifiers the old-style modifiers to convert to text

Returns: a string representation of the modifiers in this bitmask

getPoint

public Point getPoint()
This method returns a Point for the x,y position of the mouse pointer. This is relative to the source component.

Returns: a Point for the event position

getX

public int getX()
This method returns the X coordinate of the mouse position. This is relative to the source component.

Returns: the x coordinate

getY

public int getY()
This method returns the Y coordinate of the mouse position. This is relative to the source component.

Returns: the y coordinate

isPopupTrigger

public boolean isPopupTrigger()
This method tests whether or not the event is a popup menu trigger. This should be checked in both MousePressed and MouseReleased to be cross-platform compatible, as different systems have different popup triggers.

Returns: true if the event is a popup menu trigger

paramString

public String paramString()
Returns a string identifying this event. This is formatted as the field name of the id type, followed by the (x,y) point, the most recent button changed, modifiers (if any), extModifiers (if any), and clickCount.

Returns: a string identifying this event

translatePoint

public void translatePoint(int dx, int dy)
Translates the event coordinates by the specified x and y offsets.

Parameters: dx the value to add to the X coordinate of this event dy the value to add to the Y coordiante of this event

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method