com.esri.arcgis.controls
Class IARControlEventsOnActionEvent

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

All Implemented Interfaces:

Serializable

public class IARControlEventsOnActionEvent
extends EventObject

Description

The OnAction event triggers before an action occurs with the ArcReaderControl, and provides you with a mechanism for suppressing the action from taking place or customising the action that will take place. For example, by default any hyperlinks that are accessed when the CurrentARTool is the esriARToolMapHyperlinks tool open in the systems default browser. You may want to suppress this default action and open the hyperlinks in a web browser control.

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

Remarks

esriARActionMapProperties: Occurs when the user right clicks on a map in the Table of Contents (TOC) and chooses properties from the drop down context menu. The data passed to the event is an ARMap .

esriARActionLayerProperties: Occurs when the user right clicks on a layer in the Table of Contents (TOC) and chooses properties ffrom the drop down context menu. The data passed to the event is an ARLayer.

esriARActionHyperlink: Occurs when the user accesses a hyperlink, either through the CurrentARTool when it is set to the esriARToolMapHyperlink tool, or when accessing hyperlinks through the identify dialog when the CurrentARTool is the esriARToolMapIdentify tool. The data passed to the event is a string representing the URL of the hyperlink.

esriARActionIdentify: Occurs when the CurrentARTool is the esriARToolMapIdentify tool and is used on the CurrentView. The data passed to the event is an array or map coordinates. In the mouse down event of the tool, the array consists of an x and y coordinate. In the mouse up event of the tool, the array consists of the starting x and y coordinates and the finishing x and y coordinates. These four coordinates will be different is the user has tracked a rectangle with the tool. If the user has clicked a point these coordinates will be duplicated.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

IARControlEventsOnActionEvent(Object source)

Method Summary

int	getAction()
Object	getData()
boolean	getSuppressAction()
void	init(int action, Object data, boolean[] suppressAction)
void	setSuppressAction(boolean suppressAction)

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

IARControlEventsOnActionEvent

public IARControlEventsOnActionEvent(Object source)

Method Detail

init

public void init(int action,
                 Object data,
                 boolean[] suppressAction)

getAction

public final int getAction()

getData

public final Object getData()

getSuppressAction

public final boolean getSuppressAction()

setSuppressAction

public final void setSuppressAction(boolean suppressAction)