com.esri.arcgis.controls
Class IMapControlEvents2OnMouseDownEvent

java.lang.Object
  java.util.EventObject
      com.esri.arcgis.controls.IMapControlEvents2OnMouseDownEvent

All Implemented Interfaces:

Serializable

public class IMapControlEvents2OnMouseDownEvent
extends EventObject

Description

The OnMouseDown event is triggered when the user presses a mouse button on the MapControl. Use the event to specify actions that will occur when a given mouse button is pressed.

button specifies which mouse button was pressed. 1 for the left mouse button, 2 for the right mouse button, and 4 for the middle mouse button.

shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.

x is the X coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the MapControl (the top left hand corner).

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the MapControl (the top left hand corner).

mapX is the X coordinate, in map units, where the mouse button was pressed referenced against the origin (bottom left hand corner) of the IMapControl2::Map. The values returned are in IMapControl2::MapUnits.

mapY is the Y coordinate, in map units, where the mouse button was pressed referenced against the origin (bottom left hand corner) of the IMapControl2::Map. The values returned are in IMapControl2::MapUnits

Remarks

Use the win32 SetCapture function to continue receiving mouse events (until the mouse is released) when the mouse is moved outside the control's display area. The win32 ReleaseCapture function releases the mouse.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

IMapControlEvents2OnMouseDownEvent(Object source)

Method Summary

int	getButton()
double	getMapX()
double	getMapY()
int	getShift()
int	getX()
int	getY()
void	init(int button, int shift, int x, int y, double mapX, double mapY)

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IMapControlEvents2OnMouseDownEvent

public IMapControlEvents2OnMouseDownEvent(Object source)

Method Detail

init

public void init(int button,
                 int shift,
                 int x,
                 int y,
                 double mapX,
                 double mapY)

getButton

public final int getButton()

getShift

public final int getShift()

getX

public final int getX()

getY

public final int getY()

getMapX

public final double getMapX()

getMapY

public final double getMapY()