MouseWheelEvent JDK 1.6)

Constructors

public MouseWheelEvent (Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int scrollType, int scrollAmount, int wheelRotation)

Constructs a MouseWheelEvent object with the specified source component, type, modifiers, coordinates, scroll type, scroll amount, and wheel rotation.

Absolute coordinates xAbs and yAbs are set to source's location on screen plus relative coordinates x and y. xAbs and yAbs are set to zero if the source is not showing.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
Parameters:
- source - the Component that originated the event
- id - the integer that identifies the event
- when - a long that gives the time the event occurred
- modifiers - the modifier keys down during event (shift, ctrl, alt, meta)
- x - the horizontal x coordinate for the mouse location
- y - the vertical y coordinate for the mouse location
- clickCount - the number of mouse clicks associated with event
- popupTrigger - a boolean, true if this event is a trigger for a popup-menu
- scrollType - the type of scrolling which should take place in response to this event; valid values are WHEEL_UNIT_SCROLL and WHEEL_BLOCK_SCROLL
- scrollAmount - for scrollType WHEEL_UNIT_SCROLL, the number of units to be scrolled
- wheelRotation - the amount that the mouse wheel was rotated (the number of "clicks")
Throws:
- IllegalArgumentException - if source is null
See Also: MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean), MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int),

public MouseWheelEvent (Component source, int id, long when, int modifiers, int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger, int scrollType, int scrollAmount, int wheelRotation)

Constructs a MouseWheelEvent object with the specified source component, type, modifiers, coordinates, absolute coordinates, scroll type, scroll amount, and wheel rotation.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

Even if inconsistent values for relative and absolute coordinates are passed to the constructor, the MouseWheelEvent instance is still created and no exception is thrown.
Parameters:
- source - the Component that originated the event
- id - the integer that identifies the event
- when - a long that gives the time the event occurred
- modifiers - the modifier keys down during event (shift, ctrl, alt, meta)
- x - the horizontal x coordinate for the mouse location
- y - the vertical y coordinate for the mouse location
- xAbs - the absolute horizontal x coordinate for the mouse location
- yAbs - the absolute vertical y coordinate for the mouse location
- clickCount - the number of mouse clicks associated with event
- popupTrigger - a boolean, true if this event is a trigger for a popup-menu
- scrollType - the type of scrolling which should take place in response to this event; valid values are WHEEL_UNIT_SCROLL and WHEEL_BLOCK_SCROLL
- scrollAmount - for scrollType WHEEL_UNIT_SCROLL, the number of units to be scrolled
- wheelRotation - the amount that the mouse wheel was rotated (the number of "clicks")
Throws:
- IllegalArgumentException - if source is null
Since: 1.6
See Also: MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean), MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int),

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 () [Inherited From MouseEvent]

Returns which, if any, of the mouse buttons has changed state.

Returns which, if any, of the mouse buttons has changed state.
Returns: one of the following constants: NOBUTTON, BUTTON1, BUTTON2 or BUTTON3.
Since: 1.4

public int getClickCount () [Inherited From MouseEvent]

Returns the number of mouse clicks associated with this event.

public Component getComponent () [Inherited From ComponentEvent]

Returns the originator of the event.

Returns the originator of the event.
Returns: the Component object that originated the event, or null if the object is not a Component.

public int getID () [Inherited From AWTEvent]

Returns the event type.

public Point getLocationOnScreen () [Inherited From MouseEvent]

Returns the absolute x, y position of the event.

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 Point object containing the absolute x and y coordinates.
Since: 1.6
See Also: GraphicsConfiguration,

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.

Returns the extended modifier mask for this event. Extended modifiers represent the state of all modal keys, such as ALT, CTRL, META, and the mouse buttons just after the event occurred

For 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:

    MOUSE_PRESSED:  BUTTON1_DOWN_MASK
    MOUSE_PRESSED:  BUTTON1_DOWN_MASK | BUTTON2_DOWN_MASK
    MOUSE_RELEASED: BUTTON2_DOWN_MASK
    MOUSE_CLICKED:  BUTTON2_DOWN_MASK
    MOUSE_RELEASED: 
    MOUSE_CLICKED:

It is not recommended to compare the return value of this method using == because new modifiers can be added in the future. For example, the appropriate way to check that SHIFT and BUTTON1 are down, but CTRL is up is demonstrated by the following code:

    int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
    int offmask = CTRL_DOWN_MASK;
    if ((event.getModifiersEx() & (onmask | offmask)) == onmask) {
        ...
    }

The above code will work even if new modifiers are added.
Since: 1.4

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) [Inherited From MouseEvent]

Returns a String describing the modifier keys and mouse buttons that were down during the event, such as "Shift", or "Ctrl+Shift".

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.
Returns: string a text description of the combination of modifier keys and mouse buttons that were down during the event
Parameters:
- modifiers - a modifier mask describing the modifier keys and mouse buttons that were down during the event
Since: 1.4
See Also: InputEvent.getModifiersExText(int),

public Point getPoint () [Inherited From MouseEvent]

Returns the x,y position of the event relative to the source component.

Returns the x,y position of the event relative to the source component.
Returns: a Point object containing the x and y coordinates relative to the source component

public int getScrollAmount ()

Returns the number of units that should be scrolled per click of mouse wheel rotation.

Returns the number of units that should be scrolled per
click of mouse wheel rotation.
Only valid if getScrollType returns
MouseWheelEvent.WHEEL_UNIT_SCROLL
Returns: number of units to scroll, or an undefined value if getScrollType returns MouseWheelEvent.WHEEL_BLOCK_SCROLL
See Also: MouseWheelEvent.getScrollType(),

public int getScrollType ()

Returns the type of scrolling that should take place in response to this event.

public Object getSource () [Inherited From EventObject]

The object on which the Event initially occurred.

public int getUnitsToScroll ()

This is a convenience method to aid in the implementation of the common-case MouseWheelListener - to scroll a ScrollPane or JScrollPane by an amount which conforms to the platform settings.

This is a convenience method to aid in the implementation of the common-case MouseWheelListener - to scroll a ScrollPane or JScrollPane by an amount which conforms to the platform settings. (Note, however, that ScrollPane and JScrollPane already have this functionality built in.)

This method returns the number of units to scroll when scroll type is MouseWheelEvent.WHEEL_UNIT_SCROLL, and should only be called if getScrollType returns MouseWheelEvent.WHEEL_UNIT_SCROLL.

Direction of scroll, amount of wheel movement, and platform settings for wheel scrolling are all accounted for. This method does not and cannot take into account value of the Adjustable/Scrollable unit increment, as this will vary among scrolling components.

A simplified example of how this method might be used in a listener:

 
  mouseWheelMoved(MouseWheelEvent event) {
      ScrollPane sp = getScrollPaneFromSomewhere(); 
      Adjustable adj = sp.getVAdjustable()
      if (MouseWheelEvent.getScrollType() == WHEEL_UNIT_SCROLL) {
          int totalScrollAmount =
              event.getUnitsToScroll() *
              adj.getUnitIncrement();
          adj.setValue(adj.getValue() + totalScrollAmount);
      }
  }

Returns: the number of units to scroll based on the direction and amount of mouse wheel rotation, and on the wheel scrolling settings of the native platform
See Also: MouseWheelEvent.getScrollType(), MouseWheelEvent.getScrollAmount(), MouseWheelListener, Adjustable, Adjustable.getUnitIncrement(), Scrollable, Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int), ScrollPane, ScrollPane.setWheelScrollingEnabled(boolean), JScrollPane, JScrollPane.setWheelScrollingEnabled(boolean),

public int getWheelRotation ()

Returns the number of "clicks" the mouse wheel was rotated.

public long getWhen () [Inherited From InputEvent]

Returns the timestamp of when this event occurred.

public int getX () [Inherited From MouseEvent]

Returns the horizontal x position of the event relative to the source component.

public int getXOnScreen () [Inherited From MouseEvent]

Returns the absolute horizontal x position of the event.

public int getY () [Inherited From MouseEvent]

Returns the vertical y position of the event relative to the source component.

public int getYOnScreen () [Inherited From MouseEvent]

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 () [Inherited From MouseEvent]

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 MouseEvent]

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) [Inherited From MouseEvent]

Translates the event's coordinates to a new position by adding specified x (horizontal) and y (vertical) offsets.

Translates the event's coordinates to a new position
by adding specified x (horizontal) and y
(vertical) offsets.
Parameters:
- x - the horizontal x value to add to the current x coordinate position
- y - the vertical y value to add to the current y coordinate position

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 [Inherited From MouseEvent]

Indicates which, if any, of the mouse buttons has changed state.

Indicates which, if any, of the mouse buttons has changed state.

The only legal values are the following constants:
NOBUTTON,
BUTTON1,
BUTTON2 or
BUTTON3.
Serial:
See Also: MouseEvent.getButton().,

publicfinalstatic int BUTTON1 = "1" [Inherited From MouseEvent]

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" [Inherited From MouseEvent]

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" [Inherited From MouseEvent]

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 [Inherited From MouseEvent]

Indicates the number of quick consecutive clicks of a mouse button.

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.
Serial:
See Also: MouseEvent.getClickCount().,

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" [Inherited From MouseEvent]

The "mouse clicked" event.

The "mouse clicked" event. This MouseEvent
occurs when a mouse button is pressed and released.

publicfinalstatic int MOUSE_DRAGGED = "506" [Inherited From MouseEvent]

The "mouse dragged" event.

The "mouse dragged" event. This MouseEvent
occurs when the mouse position changes while a mouse button is pressed.

publicfinalstatic int MOUSE_ENTERED = "504" [Inherited From MouseEvent]

The "mouse entered" event.

The "mouse entered" event. This MouseEvent
occurs when the mouse cursor enters the unobscured part of component's
geometry.

publicfinalstatic long MOUSE_EVENT_MASK = "16" [Inherited From AWTEvent]

The event mask for selecting mouse events.

publicfinalstatic int MOUSE_EXITED = "505" [Inherited From MouseEvent]

The "mouse exited" event.

The "mouse exited" event. This MouseEvent
occurs when the mouse cursor exits the unobscured part of component's
geometry.

publicfinalstatic int MOUSE_FIRST = "500" [Inherited From MouseEvent]

The first number in the range of ids used for mouse events.

publicfinalstatic int MOUSE_LAST = "507" [Inherited From MouseEvent]

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" [Inherited From MouseEvent]

The "mouse moved" event.

The "mouse moved" event. This MouseEvent
occurs when the mouse position changes.

publicfinalstatic int MOUSE_PRESSED = "501" [Inherited From MouseEvent]

The "mouse pressed" event.

The "mouse pressed" event. This MouseEvent
occurs when a mouse button is pushed down.

publicfinalstatic int MOUSE_RELEASED = "502" [Inherited From MouseEvent]

The "mouse released" event.

The "mouse released" event. This MouseEvent
occurs when a mouse button is let up.

publicfinalstatic int MOUSE_WHEEL = "507" [Inherited From MouseEvent]

The "mouse wheel" event.

The "mouse wheel" event. This is the only MouseWheelEvent.
It occurs when a mouse equipped with a wheel has its wheel rotated.
Since: 1.4

publicfinalstatic long MOUSE_WHEEL_EVENT_MASK = "131072" [Inherited From AWTEvent]

The event mask for selecting mouse wheel events.

publicfinalstatic int NOBUTTON = "0" [Inherited From MouseEvent]

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 [Inherited From MouseEvent]

A property used to indicate whether a Popup Menu should appear with a certain gestures.

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.
Serial:
See Also: PopupMenu, MouseEvent.isPopupTrigger(),

publicfinalstatic int RESERVED_ID_MAX = "1999" [Inherited From AWTEvent]

The maximum value for reserved AWT event IDs.

pack-private int scrollAmount

Only valid for scrollType WHEEL_UNIT_SCROLL.

pack-private int scrollType

Indicates what sort of scrolling should take place in response to this event, based on platform settings.

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.

publicfinalstatic int WHEEL_BLOCK_SCROLL = "1"

Constant representing scrolling by a "block" (like scrolling with page-up, page-down keys)

publicfinalstatic int WHEEL_UNIT_SCROLL = "0"

Constant representing scrolling by "units" (like scrolling with the arrow keys)

pack-private int wheelRotation

Indicates how far the mouse wheel was rotated.

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 [Inherited From MouseEvent]

The mouse event's x coordinate.

pack-private int y [Inherited From MouseEvent]

The mouse event's y coordinate.