com.esri.arcgis.controls
Class IARGlobeControlEventsAdapter

java.lang.Object
  com.esri.arcgis.controls.IARGlobeControlEventsAdapter

All Implemented Interfaces:

IARGlobeControlEvents, Serializable, EventListener

public class IARGlobeControlEventsAdapter
extends Object
implements IARGlobeControlEvents

See Also:

Serialized Form

Constructor Summary

IARGlobeControlEventsAdapter()

Method Summary

void	onAction(IARGlobeControlEventsOnActionEvent theEvent) Fires when an action takes place.
void	onDocumentLoaded(IARGlobeControlEventsOnDocumentLoadedEvent theEvent) Fires when a document is loaded into the control.
void	onDocumentUnloaded(IARGlobeControlEventsOnDocumentUnloadedEvent theEvent) Fires when a document is unloaded from the control.
void	onDoubleClick(IARGlobeControlEventsOnDoubleClickEvent theEvent) Fires when the user presses and releases any mouse button twice in quick succession, while over the globe.
void	onKeyDown(IARGlobeControlEventsOnKeyDownEvent theEvent) Fires after a key is pressed on the keyboard whilst the globe has focus.
void	onKeyUp(IARGlobeControlEventsOnKeyUpEvent theEvent) Fires after a pressed key is released on the keyboard whilst the globe has focus.
void	onMouseDown(IARGlobeControlEventsOnMouseDownEvent theEvent) Fires when the user presses any mouse button while over the globe.
void	onMouseMove(IARGlobeControlEventsOnMouseMoveEvent theEvent) Fires when the user moves the mouse pointer over the globe.
void	onMouseUp(IARGlobeControlEventsOnMouseUpEvent theEvent) Fires when the user releases any mouse button while over the globe.

Methods inherited from class java.lang.Object

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

Constructor Detail

IARGlobeControlEventsAdapter

public IARGlobeControlEventsAdapter()

Method Detail

onMouseDown

public void onMouseDown(IARGlobeControlEventsOnMouseDownEvent theEvent)
                 throws IOException,
                        AutomationException

Fires when the user presses any mouse button while over the globe.

Description

The OnMouseDown event is triggered when the user presses a mouse button on the globe display area of the ArcReaderGlobeControl. 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 current view (the top left hand corner). x coordinates increase from left to right.

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the ArcReaderGlobeControl (the top left hand corner). y coordinates increase from top to bottom.

To find the origin of the current view use ViewLeft and ViewTop properties. To convert x and y coorindates in pixels to globe units use the IARGlobe::ToSurfacePoint method.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onMouseDown in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDocumentLoaded

public void onDocumentLoaded(IARGlobeControlEventsOnDocumentLoadedEvent theEvent)
                      throws IOException,
                             AutomationException

Fires when a document is loaded into the control.

Description

The OnDocumentLoaded event is triggered whenever a document is loaded into the ArcReaderGlobeControl using the LoadDocument or ReloadDocument methods. It provides a mechanism for keeping track of the path and filename of the currently loaded document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onDocumentLoaded in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDocumentUnloaded

public void onDocumentUnloaded(IARGlobeControlEventsOnDocumentUnloadedEvent theEvent)
                        throws IOException,
                               AutomationException

Fires when a document is unloaded from the control.

Description

The OnDocumentUnloaded event is triggered whenever a document is unloaded from the ArcReaderGlobeControl using the UnloadDocument or ReloadDocument methods.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onDocumentUnloaded in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMouseUp

public void onMouseUp(IARGlobeControlEventsOnMouseUpEvent theEvent)
               throws IOException,
                      AutomationException

Fires when the user releases any mouse button while over the globe.

Description

The OnMouseUp event is triggered when the user releases a mouse button on the Globe display area of the ArcReaderGlobeControl. Use the event to specify actions that will occur when a given mouse button is released.

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 current view (the top left hand corner). x coordinates increase from left to right.

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the ArcReaderGlobeControl (the top left hand corner). y coordinates increase from top to bottom.

To find the origin of the current view use ViewLeft and ViewTop properties. To convert x and y coorindates in pixels to globe units use the IARGlobe::GetSurfacePoint method.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onMouseUp in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMouseMove

public void onMouseMove(IARGlobeControlEventsOnMouseMoveEvent theEvent)
                 throws IOException,
                        AutomationException

Fires when the user moves the mouse pointer over the globe.

Description

The OnMouseMove event is triggered continually as the mouse moves over the Globe display area of the ArcReaderGlobeControl.

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 current view (the top left hand corner). x coordinates increase from left to right.

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the ArcReaderGlobeControl (the top left hand corner). y coordinates increase from top to bottom.

To find the origin of the current view use ViewLeft and ViewTop properties. To convert x and y coordinates in pixels to globe units use the IARGlobe::ToSurfacePoint method.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onMouseMove in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDoubleClick

public void onDoubleClick(IARGlobeControlEventsOnDoubleClickEvent theEvent)
                   throws IOException,
                          AutomationException

Fires when the user presses and releases any mouse button twice in quick succession, while over the globe.

Description

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 current view (the top left hand corner). x coordinates increase from left to right.

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the ArcReaderGlobeControl (the top left hand corner). y coordinates increase from top to bottom.

To find the origin of the current view use ViewLeft and ViewTop properties. To convert x and y coordinates in pixels to globe units use the IARGlobe::ToSurfacePoint method.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onDoubleClick in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onKeyDown

public void onKeyDown(IARGlobeControlEventsOnKeyDownEvent theEvent)
               throws IOException,
                      AutomationException

Fires after a key is pressed on the keyboard whilst the globe has focus.

Description

The OnKeyDown event is triggered when the user presses a key whilst the globe display area of the ArcReaderGlobeControl has focus.

keyCode specifies a virtual key code value of the key pressed on the keyboard. For alpha-numeric keys this corresponds to the ASCII value, for example "A" key returns 65 which is the ASCII value for capital A. Other key codes are F1 to F12 are 112 to 123 respectively.

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, Shift would return 5.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onKeyDown in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onKeyUp

public void onKeyUp(IARGlobeControlEventsOnKeyUpEvent theEvent)
             throws IOException,
                    AutomationException

Fires after a pressed key is released on the keyboard whilst the globe has focus.

Description

The OnKeyUp event is triggered when the user releases a key whilst the globe display area of the ArcReaderGlobeControl has focus.

keyCode specifies a virtual key code value of the key pressed on the keyboard. For alpha-numeric keys this corresponds to the ASCII value, for example "A" key returns 65 which is the ASCII value for capital A. Other key codes are F1 to F12 are 112 to 123 respectively.

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, Shift would return 5.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onKeyUp in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onAction

public void onAction(IARGlobeControlEventsOnActionEvent theEvent)
              throws IOException,
                     AutomationException

Fires when an action takes place.

Description

The OnAction event triggers before an action occurs with the ArcReaderGlobeControl, and provides you with a mechanism for suppressing the action from taking place or customising the action that will take place.

action indicates the type of action taking place.

data supplied as part of the action.

suppressAction specifies a boolean indicating whether the default action will be suppressed. By default the action will not be suppressed

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

onAction in interface IARGlobeControlEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.