Class MouseEvent

public static final int BUTTON1

This indicates that button 1 changed state.

Field Value:

1

Since:

1.4

See Also:

getButton()

public static final int BUTTON2

This indicates that button 2 changed state.

Field Value:

2

Since:

1.4

See Also:

getButton()

public static final int BUTTON3

This indicates that button 3 changed state.

Field Value:

3

Since:

1.4

See Also:

getButton()

public static final int MOUSE_CLICKED

This event id indicates that the mouse was clicked.

Field Value:

500

public static final int MOUSE_DRAGGED

This event id indicates that the mouse was dragged over a component.

Field Value:

506

public static final int MOUSE_ENTERED

This event id indicates that the mouse entered a component.

Field Value:

504

public static final int MOUSE_EXITED

This event id indicates that the mouse exited a component.

Field Value:

505

public static final int MOUSE_FIRST

This is the first id in the range of event ids used by this class.

Field Value:

500

public static final int MOUSE_LAST

This is the last id in the range of event ids used by this class.

Field Value:

507

public static final int MOUSE_MOVED

This event id indicates that the mouse was moved.

Field Value:

503

public static final int MOUSE_PRESSED

This event id indicates that the mouse was pressed.

Field Value:

501

public static final int MOUSE_RELEASED

This event id indicates that the mouse was released.

Field Value:

502

public static final int MOUSE_WHEEL

This event id indicates that the mouse wheel was rotated.

Field Value:

507

Since:

1.4

public static final int NOBUTTON

This indicates that no button changed state.

Field Value:

0

Since:

1.4

See Also:

getButton()

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

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

public MouseEvent(Component source,
                  int id,
                  long when,
                  int modifiers,
                  int x,
                  int y,
                  int absX,
                  int absY,
                  int clickCount,
                  boolean popupTrigger,
                  int button)

Creates a new MouseEvent. This is like the other constructors and adds specific absolute coordinates.

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

absX - the absolute X screen coordinate of this event

absY - the absolute Y screen coordinate of this event

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.6

public int getButton()

Returns which button, if any, was the most recent to change state. This will be one of NOBUTTON, BUTTON1, BUTTON2, or BUTTON3.

Returns:

the button that changed state

Since:

1.4

public int getClickCount()

This method returns the number of mouse clicks associated with this event.

Returns:

the number of mouse clicks for this event

public Point getLocationOnScreen()

Since:

1.6

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

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

public int getX()

This method returns the X coordinate of the mouse position. This is relative to the source component.

Returns:

the x coordinate

public int getXOnScreen()

Since:

1.6

public int getY()

This method returns the Y coordinate of the mouse position. This is relative to the source component.

Returns:

the y coordinate

public int getYOnScreen()

Since:

1.6

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

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.

Overrides:

paramString in interface ComponentEvent

Returns:

a string identifying this event

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