- java.lang.Object
-
- java.util.EventObject
-
- java.awt.AWTEvent
-
- java.awt.event.ComponentEvent
-
- java.awt.event.InputEvent
-
- java.awt.event.MouseEvent
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
MenuDragMouseEvent,MouseWheelEvent
public class MouseEvent extends 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. For lightweight components, such as Swing's components, mouse events are only dispatched to the component if the mouse event type has been enabled on the component. A mouse event type is enabled by adding the appropriate mouse-basedEventListenerto the component (MouseListenerorMouseMotionListener), or by invokingComponent.enableEvents(long)with the appropriate mask parameter (AWTEvent.MOUSE_EVENT_MASKorAWTEvent.MOUSE_MOTION_EVENT_MASK). If the mouse event type has not been enabled on the component, the corresponding mouse events are dispatched to the first ancestor that has enabled the mouse event type.For example, if a
MouseListenerhas been added to a component, orenableEvents(AWTEvent.MOUSE_EVENT_MASK)has been invoked, then all the events defined byMouseListenerare dispatched to the component. On the other hand, if aMouseMotionListenerhas not been added andenableEventshas not been invoked withAWTEvent.MOUSE_MOTION_EVENT_MASK, then mouse motion events are not dispatched to the component. Instead the mouse motion events are dispatched to the first ancestors that has enabled mouse motion events.This low-level event is generated by a component object for:
- Mouse Events
- a mouse button is pressed
- a mouse button is released
- a mouse button is clicked (pressed and released)
- the mouse cursor enters the unobscured part of component's geometry
- the mouse cursor exits the unobscured part of component's geometry
- Mouse Motion Events
- the mouse is moved
- the mouse is dragged
A
MouseEventobject is passed to everyMouseListenerorMouseAdapterobject which is registered to receive the "interesting" mouse events using the component'saddMouseListenermethod. (MouseAdapterobjects implement theMouseListenerinterface.) Each such listener object gets aMouseEventcontaining the mouse event.A
MouseEventobject is also passed to everyMouseMotionListenerorMouseMotionAdapterobject which is registered to receive mouse motion events using the component'saddMouseMotionListenermethod. (MouseMotionAdapterobjects implement theMouseMotionListenerinterface.) Each such listener object gets aMouseEventcontaining 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 usingInputEvent.getModifiers()andInputEvent.getModifiersEx(). The button mask returned byInputEvent.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, useInputEvent.getModifiersEx(). The button which has changed state is returned bygetButton()For example, if the first mouse button is pressed, events are sent in the following order:
id modifiers buttonWhen multiple mouse buttons are pressed, each press, release, and click results in a separate event.MOUSE_PRESSED: BUTTON1_MASK BUTTON1 MOUSE_RELEASED: BUTTON1_MASK BUTTON1 MOUSE_CLICKED: BUTTON1_MASK BUTTON1For 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 buttonIf button 2 is released first, theMOUSE_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 BUTTON2MOUSE_RELEASED/MOUSE_CLICKEDpair forBUTTON2_MASKarrives first, followed by the pair forBUTTON1_MASK.Some extra mouse buttons are added to extend the standard set of buttons represented by the following constants:
BUTTON1,BUTTON2, andBUTTON3. Extra buttons have no assignedBUTTONxconstants as well as their button masks have no assignedBUTTONx_DOWN_MASKconstants. Nevertheless, ordinal numbers starting from 4 may be used as button numbers (button ids). Values obtained by thegetMaskForButton(button)method may be used as button masks.MOUSE_DRAGGEDevents are delivered to theComponentin which the mouse button was pressed until the mouse button is released (regardless of whether the mouse position is within the bounds of theComponent). Due to platform-dependent Drag&Drop implementations,MOUSE_DRAGGEDevents may not be delivered during a native Drag&Drop operation. In a multi-screen environment mouse drag events are delivered to theComponenteven if the mouse position is outside the bounds of theGraphicsConfigurationassociated with thatComponent. However, the reported position for mouse drag events in this case may differ from the actual mouse position:- In a multi-screen environment without a virtual device:
The reported coordinates for mouse drag events are clipped to fit within the bounds of theGraphicsConfigurationassociated with theComponent. - In a multi-screen environment with a virtual device:
The reported coordinates for mouse drag events are clipped to fit within the bounds of the virtual device associated with theComponent.
An unspecified behavior will be caused if the
idparameter of any particularMouseEventinstance is not in the range fromMOUSE_FIRSTtoMOUSE_LAST-1 (MOUSE_WHEELis not acceptable).
-
-
Field Summary
Fields Modifier and Type Field Description static intBUTTON1Indicates mouse button #1; used bygetButton().static intBUTTON2Indicates mouse button #2; used bygetButton().static intBUTTON3Indicates mouse button #3; used bygetButton().static intMOUSE_CLICKEDThe "mouse clicked" event.static intMOUSE_DRAGGEDThe "mouse dragged" event.static intMOUSE_ENTEREDThe "mouse entered" event.static intMOUSE_EXITEDThe "mouse exited" event.static intMOUSE_FIRSTThe first number in the range of ids used for mouse events.static intMOUSE_LASTThe last number in the range of ids used for mouse events.static intMOUSE_MOVEDThe "mouse moved" event.static intMOUSE_PRESSEDThe "mouse pressed" event.static intMOUSE_RELEASEDThe "mouse released" event.static intMOUSE_WHEELThe "mouse wheel" event.static intNOBUTTONIndicates no mouse buttons; used bygetButton().-
Fields declared in 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, META_DOWN_MASK, META_MASK, SHIFT_DOWN_MASK, SHIFT_MASK
-
Fields declared in class java.awt.event.ComponentEvent
COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN
-
Fields declared in class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK
-
Fields declared in class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor Description MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger)Constructs aMouseEventobject with the specified source component, type, modifiers, coordinates, click count, and popupTrigger flag.MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int button)Constructs aMouseEventobject with the specified source component, type, time, modifiers, coordinates, click count, popupTrigger flag, and button number.MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger, int button)Constructs aMouseEventobject with the specified source component, type, time, modifiers, coordinates, absolute coordinates, click count, popupTrigger flag, and button number.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetButton()Returns which, if any, of the mouse buttons has changed state.intgetClickCount()Returns the number of mouse clicks associated with this event.PointgetLocationOnScreen()Returns the absolute x, y position of the event.static StringgetMouseModifiersText(int modifiers)Returns aStringinstance describing the modifier keys and mouse buttons that were down during the event, such as "Shift", or "Ctrl+Shift".PointgetPoint()Returns the x,y position of the event relative to the source component.intgetX()Returns the horizontal x position of the event relative to the source component.intgetXOnScreen()Returns the absolute horizontal x position of the event.intgetY()Returns the vertical y position of the event relative to the source component.intgetYOnScreen()Returns the absolute vertical y position of the event.booleanisPopupTrigger()Returns whether or not this mouse event is the popup menu trigger event for the platform.StringparamString()Returns a parameter string identifying this event.voidtranslatePoint(int x, int y)Translates the event's coordinates to a new position by adding specifiedx(horizontal) andy(vertical) offsets.-
Methods declared in class java.awt.event.InputEvent
consume, getMaskForButton, getModifiers, getModifiersEx, getModifiersExText, getWhen, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown
-
Methods declared in class java.awt.event.ComponentEvent
getComponent
-
Methods declared in class java.util.EventObject
getSource
-
-
-
-
Field Detail
-
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
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
public static final int MOUSE_CLICKED
The "mouse clicked" event. ThisMouseEventoccurs when a mouse button is pressed and released.- See Also:
- Constant Field Values
-
MOUSE_PRESSED
public static final int MOUSE_PRESSED
The "mouse pressed" event. ThisMouseEventoccurs when a mouse button is pushed down.- See Also:
- Constant Field Values
-
MOUSE_RELEASED
public static final int MOUSE_RELEASED
The "mouse released" event. ThisMouseEventoccurs when a mouse button is let up.- See Also:
- Constant Field Values
-
MOUSE_MOVED
public static final int MOUSE_MOVED
The "mouse moved" event. ThisMouseEventoccurs when the mouse position changes.- See Also:
- Constant Field Values
-
MOUSE_ENTERED
public static final int MOUSE_ENTERED
The "mouse entered" event. ThisMouseEventoccurs when the mouse cursor enters the unobscured part of component's geometry.- See Also:
- Constant Field Values
-
MOUSE_EXITED
public static final int MOUSE_EXITED
The "mouse exited" event. ThisMouseEventoccurs when the mouse cursor exits the unobscured part of component's geometry.- See Also:
- Constant Field Values
-
MOUSE_DRAGGED
public static final int MOUSE_DRAGGED
The "mouse dragged" event. ThisMouseEventoccurs when the mouse position changes while a mouse button is pressed.- See Also:
- Constant Field Values
-
MOUSE_WHEEL
public static final int MOUSE_WHEEL
The "mouse wheel" event. This is the onlyMouseWheelEvent. It occurs when a mouse equipped with a wheel has its wheel rotated.- Since:
- 1.4
- See Also:
- Constant Field Values
-
NOBUTTON
public static final int NOBUTTON
Indicates no mouse buttons; used bygetButton().- Since:
- 1.4
- See Also:
- Constant Field Values
-
BUTTON1
public static final int BUTTON1
Indicates mouse button #1; used bygetButton().- Since:
- 1.4
- See Also:
- Constant Field Values
-
BUTTON2
public static final int BUTTON2
Indicates mouse button #2; used bygetButton().- Since:
- 1.4
- See Also:
- Constant Field Values
-
BUTTON3
public static final int BUTTON3
Indicates mouse button #3; used bygetButton().- Since:
- 1.4
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MouseEvent
public MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int button)
Constructs aMouseEventobject with the specified source component, type, time, modifiers, coordinates, click count, popupTrigger flag, and button number.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 invocationMouseEvent(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 anIllegalArgumentExceptionifsourceisnull.- Parameters:
source- TheComponentthat originated the eventid- An integer indicating the type of event. For information on allowable values, see the class description forMouseEventwhen- A long integer that gives the time the event occurred. Passing negative or zero value is not recommendedmodifiers- a modifier mask describing the modifier keys and mouse buttons (for example, shift, ctrl, alt, and meta) that are down during the event. Only extended modifiers are allowed to be used as a value for this parameter (see theInputEvent.getModifiersEx()class for the description of extended modifiers). Passing negative parameter is not recommended. Zero value means that no modifiers were passedx- The horizontal x coordinate for the mouse location. It is allowed to pass negative valuesy- The vertical y coordinate for the mouse location. It is allowed to pass negative valuesclickCount- The number of mouse clicks associated with event. Passing negative value is not recommendedpopupTrigger- A boolean that equalstrueif this event is a trigger for a popup menubutton- An integer that indicates, which of the mouse buttons has changed its state. The following rules are applied to this parameter:- If support for the extended mouse buttons is
disabledby Java then it is allowed to createMouseEventobjects only with the standard buttons:NOBUTTON,BUTTON1,BUTTON2, andBUTTON3. - If support for the extended mouse buttons is
enabledby Java then it is allowed to createMouseEventobjects with the standard buttons. In case the support for extended mouse buttons isenabledby Java, then in addition to the standard buttons,MouseEventobjects can be created using buttons from the range starting from 4 toMouseInfo.getNumberOfButtons()if the mouse has more than three buttons.
- If support for the extended mouse buttons is
- Throws:
IllegalArgumentException- ifbuttonis less than zeroIllegalArgumentException- ifsourceis nullIllegalArgumentException- ifbuttonis greater than BUTTON3 and the support for extended mouse buttons isdisabledby JavaIllegalArgumentException- ifbuttonis greater than thecurrent number of buttonsand the support for extended mouse buttons isenabledby JavaIllegalArgumentException- if an invalidbuttonvalue is passed inIllegalArgumentException- ifsourceis null- Since:
- 1.4
- See Also:
EventObject.getSource(),AWTEvent.getID(),InputEvent.getWhen(),InputEvent.getModifiers(),getX(),getY(),getClickCount(),isPopupTrigger(),getButton()
-
MouseEvent
public MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger)
Constructs aMouseEventobject with the specified source component, type, modifiers, coordinates, click count, and popupTrigger flag. An invocation of the formMouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger)behaves in exactly the same way as the invocationMouseEvent(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 anIllegalArgumentExceptionifsourceisnull.- Parameters:
source- TheComponentthat originated the eventid- An integer indicating the type of event. For information on allowable values, see the class description forMouseEventwhen- A long integer that gives the time the event occurred. Passing negative or zero value is not recommendedmodifiers- a modifier mask describing the modifier keys and mouse buttons (for example, shift, ctrl, alt, and meta) that are down during the event. Only extended modifiers are allowed to be used as a value for this parameter (see theInputEvent.getModifiersEx()class for the description of extended modifiers). Passing negative parameter is not recommended. Zero value means that no modifiers were passedx- The horizontal x coordinate for the mouse location. It is allowed to pass negative valuesy- The vertical y coordinate for the mouse location. It is allowed to pass negative valuesclickCount- The number of mouse clicks associated with event. Passing negative value is not recommendedpopupTrigger- A boolean that equalstrueif this event is a trigger for a popup menu- Throws:
IllegalArgumentException- ifsourceis null- See Also:
EventObject.getSource(),AWTEvent.getID(),InputEvent.getWhen(),InputEvent.getModifiers(),getX(),getY(),getClickCount(),isPopupTrigger()
-
MouseEvent
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 aMouseEventobject with the specified source component, type, time, modifiers, coordinates, absolute coordinates, click count, popupTrigger flag, and button number.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
IllegalArgumentExceptionifsourceisnull.- Parameters:
source- TheComponentthat originated the eventid- An integer indicating the type of event. For information on allowable values, see the class description forMouseEventwhen- A long integer that gives the time the event occurred. Passing negative or zero value is not recommendedmodifiers- a modifier mask describing the modifier keys and mouse buttons (for example, shift, ctrl, alt, and meta) that are down during the event. Only extended modifiers are allowed to be used as a value for this parameter (see theInputEvent.getModifiersEx()class for the description of extended modifiers). Passing negative parameter is not recommended. Zero value means that no modifiers were passedx- The horizontal x coordinate for the mouse location. It is allowed to pass negative valuesy- The vertical y coordinate for the mouse location. It is allowed to pass negative valuesxAbs- The absolute horizontal x coordinate for the mouse location It is allowed to pass negative valuesyAbs- The absolute vertical y coordinate for the mouse location It is allowed to pass negative valuesclickCount- The number of mouse clicks associated with event. Passing negative value is not recommendedpopupTrigger- A boolean that equalstrueif this event is a trigger for a popup menubutton- An integer that indicates, which of the mouse buttons has changed its state. The following rules are applied to this parameter:- If support for the extended mouse buttons is
disabledby Java then it is allowed to createMouseEventobjects only with the standard buttons:NOBUTTON,BUTTON1,BUTTON2, andBUTTON3. - If support for the extended mouse buttons is
enabledby Java then it is allowed to createMouseEventobjects with the standard buttons. In case the support for extended mouse buttons isenabledby Java, then in addition to the standard buttons,MouseEventobjects can be created using buttons from the range starting from 4 toMouseInfo.getNumberOfButtons()if the mouse has more than three buttons.
- If support for the extended mouse buttons is
- Throws:
IllegalArgumentException- ifbuttonis less than zeroIllegalArgumentException- ifsourceis nullIllegalArgumentException- ifbuttonis greater than BUTTON3 and the support for extended mouse buttons isdisabledby JavaIllegalArgumentException- ifbuttonis greater than thecurrent number of buttonsand the support for extended mouse buttons isenabledby JavaIllegalArgumentException- if an invalidbuttonvalue is passed inIllegalArgumentException- ifsourceis null- Since:
- 1.6
- See Also:
EventObject.getSource(),AWTEvent.getID(),InputEvent.getWhen(),InputEvent.getModifiers(),getX(),getY(),getXOnScreen(),getYOnScreen(),getClickCount(),isPopupTrigger(),getButton(),Toolkit.areExtraMouseButtonsEnabled(),MouseInfo.getNumberOfButtons(),InputEvent.getMaskForButton(int)
-
-
Method Detail
-
getLocationOnScreen
public 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.- Returns:
- a
Pointobject containing the absolute x and y coordinates. - Since:
- 1.6
- See Also:
GraphicsConfiguration
-
getXOnScreen
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.- Returns:
- x an integer indicating absolute horizontal position.
- Since:
- 1.6
- See Also:
GraphicsConfiguration
-
getYOnScreen
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.- Returns:
- y an integer indicating absolute vertical position.
- Since:
- 1.6
- See Also:
GraphicsConfiguration
-
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
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
public Point getPoint()
Returns the x,y position of the event relative to the source component.- Returns:
- a
Pointobject containing the x and y coordinates relative to the source component
-
translatePoint
public void translatePoint(int x, int y)Translates the event's coordinates to a new position by adding specifiedx(horizontal) andy(vertical) offsets.- Parameters:
x- the horizontal x value to add to the current x coordinate positiony- the vertical y value to add to the current y coordinate position
-
getClickCount
public int getClickCount()
Returns the number of mouse clicks associated with this event.- Returns:
- integer value for the number of clicks
-
getButton
public int getButton()
Returns which, if any, of the mouse buttons has changed state. The returned value is ranged from 0 to theMouseInfo.getNumberOfButtons()value. The returned value includes at least the following constants:-
NOBUTTON -
BUTTON1 -
BUTTON2 -
BUTTON3
if (anEvent.getButton() == MouseEvent.BUTTON1) {In particular, for a mouse with one, two, or three buttons this method may return the following values:- 0 (
NOBUTTON) - 1 (
BUTTON1) - 2 (
BUTTON2) - 3 (
BUTTON3)
BUTTON3have no constant identifier. So if a mouse with five buttons is installed, this method may return the following values:- 0 (
NOBUTTON) - 1 (
BUTTON1) - 2 (
BUTTON2) - 3 (
BUTTON3) - 4
- 5
Note: If support for extended mouse buttons is
disabledby Java then the AWT event subsystem does not produce mouse events for the extended mouse buttons. So it is not expected that this method returns anything exceptNOBUTTON,BUTTON1,BUTTON2,BUTTON3.- Returns:
- one of the values from 0 to
MouseInfo.getNumberOfButtons()if support for the extended mouse buttons isenabledby Java. That range includesNOBUTTON,BUTTON1,BUTTON2,BUTTON3;
NOBUTTON,BUTTON1,BUTTON2orBUTTON3if support for the extended mouse buttons isdisabledby Java - Since:
- 1.4
- See Also:
Toolkit.areExtraMouseButtonsEnabled(),MouseInfo.getNumberOfButtons(),MouseEvent(Component, int, long, int, int, int, int, int, int, boolean, int),InputEvent.getMaskForButton(int)
-
-
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,
isPopupTriggershould be checked in bothmousePressedandmouseReleasedfor proper cross-platform functionality.- Returns:
- boolean, true if this event is the popup menu trigger for this platform
-
getMouseModifiersText
public static String getMouseModifiersText(int modifiers)
Returns aStringinstance 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 theawt.propertiesfile.Note that the
InputEvent.ALT_MASKandInputEvent.BUTTON2_MASKhave equal values, so the "Alt" string is returned for both modifiers. Likewise, theInputEvent.META_MASKandInputEvent.BUTTON3_MASKhave equal values, so the "Meta" string is returned for both modifiers.Note that passing negative parameter is incorrect, and will cause the returning an unspecified string. Zero parameter means that no modifiers were passed and will cause the returning an empty string.
- Parameters:
modifiers- A modifier mask describing the modifier keys and mouse buttons that were down during the event- Returns:
- string string 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)
-
paramString
public String paramString()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.- Overrides:
paramStringin classComponentEvent- Returns:
- a string identifying the event and its attributes
-
-