API Overview API Index Package Overview Direct link to this page
JDK 1.6
  java.awt.event. MouseEvent View Source
Author(s)
Carl Quinn 1.56, 07/11/06
Since
1.1
Version
Serial
Hierarchy
 Object
      EventObject
          AWTEvent
              ComponentEvent
                  InputEvent
                      MouseEvent
Implements
Subclasses
Description
public class MouseEvent
  An event which indicates that a mouse action occurred in a component.
Constructors
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.
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.
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.
Methods
Hide/Show inherited methods
public void consume () [Inherited From InputEvent]
Consumes this event so that it will not be processed in the default manner by the source which originated it.
public int getButton ()
  Returns which, if any, of the mouse buttons has changed state.
public int getClickCount ()
  Returns the number of mouse clicks associated with this event.
public Component getComponent () [Inherited From ComponentEvent]
  Returns the originator of the event.
public int getID () [Inherited From AWTEvent]
Returns the event type.
public Point getLocationOnScreen ()
  Returns the absolute x, y position of the event.
public int getModifiers () [Inherited From InputEvent]
Returns the modifier mask for this event.
public int getModifiersEx () [Inherited From InputEvent]
  Returns the extended modifier mask for this event.
publicstatic String getModifiersExText (int modifiers) [Inherited From InputEvent]
  Returns a String describing the extended modifier keys and mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift".
publicstatic 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".
public Point getPoint ()
  Returns the x,y position of the event relative to the source component.
public Object getSource () [Inherited From EventObject]
  The object on which the Event initially occurred.
public long getWhen () [Inherited From InputEvent]
Returns the timestamp of when this event occurred.
public int getX ()
  Returns the horizontal x position of the event relative to the source component.
public int getXOnScreen ()
  Returns the absolute horizontal x position of the event.
public int getY ()
  Returns the vertical y position of the event relative to the source component.
public int getYOnScreen ()
  Returns the absolute vertical y position of the event.
public boolean isAltDown () [Inherited From InputEvent]
Returns whether or not the Alt modifier is down on this event.
public boolean isAltGraphDown () [Inherited From InputEvent]
Returns whether or not the AltGraph modifier is down on this event.
public boolean isConsumed () [Inherited From InputEvent]
  Returns whether or not this event has been consumed.
public boolean isControlDown () [Inherited From InputEvent]
Returns whether or not the Control modifier is down on this event.
public boolean isMetaDown () [Inherited From InputEvent]
Returns whether or not the Meta modifier is down on this event.
public boolean isPopupTrigger ()
  Returns whether or not this mouse event is the popup menu trigger event for the platform.
public boolean isShiftDown () [Inherited From InputEvent]
Returns whether or not the Shift modifier is down on this event.
public String paramString () [Overrides ComponentEvent]
  Returns a parameter string identifying this event.
public void setSource (Object newSource) [Inherited From AWTEvent]
  Retargets an event to a new source.
public String toString () [Inherited From AWTEvent]
Returns a String representation of this object.
publicsynchronized void translatePoint (int x, int y)
  Translates the event's coordinates to a new position by adding specified x (horizontal) and y (vertical) offsets.
Fields
Hide/Show inherited fields
publicfinalstatic long ACTION_EVENT_MASK = "128" [Inherited From AWTEvent]
The event mask for selecting action events.
publicfinalstatic long ADJUSTMENT_EVENT_MASK = "256" [Inherited From AWTEvent]
The event mask for selecting adjustment events.
publicfinalstatic int ALT_DOWN_MASK = "512" [Inherited From InputEvent]
  The Alt key extended modifier constant.
publicfinalstatic int ALT_GRAPH_DOWN_MASK = "8192" [Inherited From InputEvent]
  The AltGraph key extended modifier constant.
publicfinalstatic int ALT_GRAPH_MASK = "32" [Inherited From InputEvent]
The AltGraph key modifier constant.
publicfinalstatic int ALT_MASK = "8" [Inherited From InputEvent]
  The Alt key modifier constant.
pack-private int button
  Indicates which, if any, of the mouse buttons has changed state.
publicfinalstatic int BUTTON1 = "1"
  Indicates mouse button #1; used by MouseEvent.getButton().
publicfinalstatic int BUTTON1_DOWN_MASK = "1024" [Inherited From InputEvent]
  The Mouse Button1 extended modifier constant.
publicfinalstatic int BUTTON1_MASK = "16" [Inherited From InputEvent]
  The Mouse Button1 modifier constant.
publicfinalstatic int BUTTON2 = "2"
  Indicates mouse button #2; used by MouseEvent.getButton().
publicfinalstatic int BUTTON2_DOWN_MASK = "2048" [Inherited From InputEvent]
  The Mouse Button2 extended modifier constant.
publicfinalstatic int BUTTON2_MASK = "8" [Inherited From InputEvent]
  The Mouse Button2 modifier constant.
publicfinalstatic int BUTTON3 = "3"
  Indicates mouse button #3; used by MouseEvent.getButton().
publicfinalstatic int BUTTON3_DOWN_MASK = "4096" [Inherited From InputEvent]
  The Mouse Button3 extended modifier constant.
publicfinalstatic int BUTTON3_MASK = "4" [Inherited From InputEvent]
  The Mouse Button3 modifier constant.
pack-private int clickCount
  Indicates the number of quick consecutive clicks of a mouse button.
publicfinalstatic long COMPONENT_EVENT_MASK = "1" [Inherited From AWTEvent]
The event mask for selecting component events.
publicfinalstatic int COMPONENT_FIRST = "100" [Inherited From ComponentEvent]
The first number in the range of ids used for component events.
publicfinalstatic int COMPONENT_HIDDEN = "103" [Inherited From ComponentEvent]
This event indicates that the component was rendered invisible.
publicfinalstatic int COMPONENT_LAST = "103" [Inherited From ComponentEvent]
The last number in the range of ids used for component events.
publicfinalstatic int COMPONENT_MOVED = "100" [Inherited From ComponentEvent]
This event indicates that the component's position changed.
publicfinalstatic int COMPONENT_RESIZED = "101" [Inherited From ComponentEvent]
This event indicates that the component's size changed.
publicfinalstatic int COMPONENT_SHOWN = "102" [Inherited From ComponentEvent]
This event indicates that the component was made visible.
protected boolean consumed [Inherited From AWTEvent]
  Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not.
publicfinalstatic long CONTAINER_EVENT_MASK = "2" [Inherited From AWTEvent]
The event mask for selecting container events.
publicfinalstatic int CTRL_DOWN_MASK = "128" [Inherited From InputEvent]
  The Control key extended modifier constant.
publicfinalstatic int CTRL_MASK = "2" [Inherited From InputEvent]
  The Control key modifier constant.
pack-privatefinalstatic int FIRST_HIGH_BIT = "16384" [Inherited From InputEvent]
publicfinalstatic long FOCUS_EVENT_MASK = "4" [Inherited From AWTEvent]
The event mask for selecting focus events.
publicfinalstatic long HIERARCHY_BOUNDS_EVENT_MASK = "65536" [Inherited From AWTEvent]
The event mask for selecting hierarchy bounds events.
publicfinalstatic long HIERARCHY_EVENT_MASK = "32768" [Inherited From AWTEvent]
The event mask for selecting hierarchy events.
pack-privatefinalstatic int HIGH_MODIFIERS = "-16384" [Inherited From InputEvent]
protected int id [Inherited From AWTEvent]
  The event's id.
publicfinalstatic long INPUT_METHOD_EVENT_MASK = "2048" [Inherited From AWTEvent]
The event mask for selecting input method events.
publicfinalstatic long INVOCATION_EVENT_MASK = "16384" [Inherited From AWTEvent]
The event mask for selecting invocation events.
publicfinalstatic long ITEM_EVENT_MASK = "512" [Inherited From AWTEvent]
The event mask for selecting item events.
pack-privatefinalstatic int JDK_1_3_MODIFIERS = "63" [Inherited From InputEvent]
publicfinalstatic long KEY_EVENT_MASK = "8" [Inherited From AWTEvent]
The event mask for selecting key events.
publicfinalstatic int META_DOWN_MASK = "256" [Inherited From InputEvent]
  The Meta key extended modifier constant.
publicfinalstatic int META_MASK = "4" [Inherited From InputEvent]
  The Meta key modifier constant.
pack-private int modifiers [Inherited From InputEvent]
  The state of the modifier mask at the time the input event was fired.
publicfinalstatic int MOUSE_CLICKED = "500"
  The "mouse clicked" event.
publicfinalstatic int MOUSE_DRAGGED = "506"
  The "mouse dragged" event.
publicfinalstatic int MOUSE_ENTERED = "504"
  The "mouse entered" event.
publicfinalstatic long MOUSE_EVENT_MASK = "16" [Inherited From AWTEvent]
The event mask for selecting mouse events.
publicfinalstatic int MOUSE_EXITED = "505"
  The "mouse exited" event.
publicfinalstatic int MOUSE_FIRST = "500"
The first number in the range of ids used for mouse events.
publicfinalstatic int MOUSE_LAST = "507"
The last number in the range of ids used for mouse events.
publicfinalstatic long MOUSE_MOTION_EVENT_MASK = "32" [Inherited From AWTEvent]
The event mask for selecting mouse motion events.
publicfinalstatic int MOUSE_MOVED = "503"
  The "mouse moved" event.
publicfinalstatic int MOUSE_PRESSED = "501"
  The "mouse pressed" event.
publicfinalstatic int MOUSE_RELEASED = "502"
  The "mouse released" event.
publicfinalstatic int MOUSE_WHEEL = "507"
  The "mouse wheel" event.
publicfinalstatic long MOUSE_WHEEL_EVENT_MASK = "131072" [Inherited From AWTEvent]
  The event mask for selecting mouse wheel events.
publicfinalstatic int NOBUTTON = "0"
  Indicates no mouse buttons; used by MouseEvent.getButton().
publicfinalstatic long PAINT_EVENT_MASK = "8192" [Inherited From AWTEvent]
The event mask for selecting paint events.
pack-private boolean popupTrigger
  A property used to indicate whether a Popup Menu should appear with a certain gestures.
publicfinalstatic int RESERVED_ID_MAX = "1999" [Inherited From AWTEvent]
  The maximum value for reserved AWT event IDs.
pack-privatefinalstatic long serialVersionUID = "-2482525981698309786" [Inherited From InputEvent]
publicfinalstatic int SHIFT_DOWN_MASK = "64" [Inherited From InputEvent]
  The Shift key extended modifier constant.
publicfinalstatic int SHIFT_MASK = "1" [Inherited From InputEvent]
  The Shift key modifier constant.
protectedtransient Object source [Inherited From EventObject]
The object on which the Event initially occurred.
publicfinalstatic long TEXT_EVENT_MASK = "1024" [Inherited From AWTEvent]
The event mask for selecting text events.
pack-private long when [Inherited From InputEvent]
  The input event's Time stamp in UTC format.
publicfinalstatic long WINDOW_EVENT_MASK = "64" [Inherited From AWTEvent]
The event mask for selecting window events.
publicfinalstatic long WINDOW_FOCUS_EVENT_MASK = "524288" [Inherited From AWTEvent]
  The event mask for selecting window focus events.
publicfinalstatic long WINDOW_STATE_EVENT_MASK = "262144" [Inherited From AWTEvent]
  The event mask for selecting window state events.
pack-private int x
  The mouse event's x coordinate.
pack-private int y
  The mouse event's y coordinate.
Nested Classes
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar