com.esri.arcgis.schematic
Interface INgBehavior

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgBehaviorProxy, NgBehavior

public interface INgBehavior
extends Serializable

Provides access to members that control the behavior.

Description

A behavior brings together four elements:

- An event name; that is, an action by the end user: EventName

-Anobject type name: ObjectTypeName

-A metatype of objects: MetaType

A command; that is, the response from the application: Command

which reads: such event (LeftClick, RightClick ...) on such object type of such metatype will trigger such command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	delete() Deletes the behavior.
INgCommand	getCommand() Command to be triggered.
String	getEventName() Name of the event to be responded to.
int	getMetaType() Object metatype to be impacted.
String	getObjectTypeName() Identifier for the object type used to filter command triggering.
INgProject	getProject() Project of the behavior.
void	set(String evtName, int metaType, String objectTypeName) Modifies the behavior so that it responds to the event named 'eventName' when such event impacts the object type named 'objectTypeName' whose metatype is 'metaType'.
void	setCommand(INgCommand pVal) Command to be triggered.
void	setEventName(String pVal) Name of the event to be responded to.
void	setMetaType(int pVal) Object metatype to be impacted.
void	setObjectTypeName(String pVal) Identifier for the object type used to filter command triggering.

Method Detail

getCommand

INgCommand getCommand()
                      throws IOException,
                             AutomationException

Command to be triggered.

Description

This command must be defined for the currently opened project. Schematics offers a full set of predefined commands, each with its own area of action, which means that it will apply to a given metatype only (for more details about commands, see the INgCommand interface).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.schematic.INgCommand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCommand

void setCommand(INgCommand pVal)
                throws IOException,
                       AutomationException

Command to be triggered.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - A reference to a com.esri.arcgis.schematic.INgCommand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventName

String getEventName()
                    throws IOException,
                           AutomationException

Name of the event to be responded to.

Description

This event name can be a user event name set by the application or a predefined Schematics event name (generally a mouse click or a keyboard key being pressed). Possible predefined event names depend on the object MetaType.

List of predefined events available from schematic elements

Predefined events available for schematic elements are those available for MetaType metatype "esriNgMetaTypeElement", "esriNgMetaTypeLegendGroup", "esriNgMetaTypeLegendProperty" or "esriNgMetaTypeLegendPropertyFilter"

The predefined event names list is:

• LeftClick: Event triggered by clicking an element with the left mouse button.
• RightClick: Event triggered by clicking an element with the right mouse button.
• LeftDblClick: Event triggered by double clicking an element with the left mouse button
• RightDblClick: Event triggered by double clicking an element with the right mouse button.
• KeykeyFlag/keyCode/keyAscii: Event triggered when pressing either the keyCode, the keyAscii or the keyFlag key (code, ascii code and control code key, respectively). For the event to have an impact, one or several element(s) must be selected. See keyboard key codes list.

List of predefined events available from schematic views

Predefined events available for schematic views are those available for the MetaType metatype "esriNgMetaTypeView"

The predefined event names list is:

• LeftClick: Event triggered by a left mouse button click in a view.
• RightClick: Event triggered by a right mouse button click in a view.
• LeftDblClick: Event triggered by a double left mouse button click in a view.
• RightDblClick: Event triggered by a double right mouse button click in a view.
• KeykeyFlag/keyCode/keyAscii: Event triggered when pressing either the keyCode, the keyAscii or the keyFlag key (code, ascii code and control code key, respectively). For the event to have an impact, a view must be active. See keyboard key codes list.

Note: For all object metatypes (esriNgMetaTypeDiagram, esriNgMetaTypeView, esriNgMetaTypeElement, esriNgMetaTypeLegendGroup, esriNgMetaTypeLegendProperty, esriNgMetaTypeLegendPropertyFilter), you can also use a "UserEventName". This event name is set by the application. It can be triggered by the application through a series of messages exchanged with ArcGIS Schematics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEventName

void setEventName(String pVal)
                  throws IOException,
                         AutomationException

Name of the event to be responded to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetaType

int getMetaType()
                throws IOException,
                       AutomationException

Object metatype to be impacted.

Description

Here are the list of the MetaType values that are available

• The esriNgMetaTypeDiagram metaType encompasses all of the application’s diagrams, whatever their type.
• The esriNgMetaTypeView metatype encompasses all of the views created by the application (a diagram includes one or several views).
• The esriNgMetaTypeElement metatype encompasses all of the elements defined in the application whatever their graphic type (esriNgElementNode, esriNgElementLink, esriNgElementDrawing, etc.).
• The esriNgMetaTypeLegendGroup encompasses legend entries associated with element groups.
• The esriNgMetaTypeLegendProperty encompasses legend entries associated with properties.
• The esriNgMetaTypeLegendPropertyFilter encompasses legend entries associated with property filters

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.schematic.esriNgMetaType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetaType

void setMetaType(int pVal)
                 throws IOException,
                        AutomationException

Object metatype to be impacted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - A com.esri.arcgis.schematic.esriNgMetaType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectTypeName

String getObjectTypeName()
                         throws IOException,
                                AutomationException

Identifier for the object type used to filter command triggering.

Description

The object type name must be defined for the currently open project. If the command is to apply to all object types of the MetaType metatype, this identifier is not required. If the metatype is equal to esriNgMetaTypeView, the ObjectTypeName parameter is set to the name of the diagram type associated with the views. This diagram type must be defined for the currently open project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectTypeName

void setObjectTypeName(String pVal)
                       throws IOException,
                              AutomationException

Identifier for the object type used to filter command triggering.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

set

void set(String evtName,
         int metaType,
         String objectTypeName)
         throws IOException,
                AutomationException

Modifies the behavior so that it responds to the event named 'eventName' when such event impacts the object type named 'objectTypeName' whose metatype is 'metaType'.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

evtName - The evtName (in)

metaType - A com.esri.arcgis.schematic.esriNgMetaType constant (in)

objectTypeName - The objectTypeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete()
            throws IOException,
                   AutomationException

Deletes the behavior.

Remarks

Before deleting a behavior, check that its event name is not used by another behavior. For example, behaviors that display popup menus often trigger other behaviors.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProject

INgProject getProject()
                      throws IOException,
                             AutomationException

Project of the behavior.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.schematic.INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.