com.esri.arcgis.controls
Class IEngineNAWindowEventsProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.IEngineNAWindowEventsProxy
All Implemented Interfaces:
IEngineNAWindowEvents, Externalizable, Serializable, EventListener

public class IEngineNAWindowEventsProxy
extends com.esri.arcgis.interop.Dispatch
implements IEngineNAWindowEvents, Serializable

Provides access to events triggered by the network analysis window.

Description

The IEngineNAWindowEvents interface is an outgoing interface on the IEngineNetworkAnalystEnvironment::NAWindow object that is used to notify listeners when the selected analysis layer, selected category, analysis results, or context has been updated.

These events are not fired if IEngineNAWindow::DelayEvents has been set to true.

Product Availability

Available with ArcGIS Engine.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IEngineNAWindowEventsProxy()
           
  IEngineNAWindowEventsProxy(Object obj)
           
protected IEngineNAWindowEventsProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void onActiveAnalysisChanged(IEngineNAWindowEventsOnActiveAnalysisChangedEvent theEvent)
          Called when the active analysis changes.
 void onActiveCategoryChanged(IEngineNAWindowEventsOnActiveCategoryChangedEvent theEvent)
          Called when the active category changes.
 void onActiveNAContextUpdated(IEngineNAWindowEventsOnActiveNAContextUpdatedEvent theEvent)
          Called when the active context has been updated.
 void onActiveNAResultUpdated(IEngineNAWindowEventsOnActiveNAResultUpdatedEvent theEvent)
          Called when the active result has been updated.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IEngineNAWindowEventsProxy

public IEngineNAWindowEventsProxy()

IEngineNAWindowEventsProxy

public IEngineNAWindowEventsProxy(Object obj)
                           throws IOException
Throws:
IOException

IEngineNAWindowEventsProxy

protected IEngineNAWindowEventsProxy(Object obj,
                                     String iid)
                              throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

onActiveCategoryChanged

public void onActiveCategoryChanged(IEngineNAWindowEventsOnActiveCategoryChangedEvent theEvent)
                             throws IOException,
                                    AutomationException
Called when the active category changes.

Description

The OnActiveCategoryChanged event is fired when a different category (e.g. Stops, Barriers, Routes, etc) is chosen within the IEngineNetworkAnalystEnvironment::NAWindow interactively by the end user.

The event is not fired when the IEngineNAWindow::ActiveCategory property is set programatically or if IEngineNAWindow::DelayEvents has been set to true.

Product Availability

Available with ArcGIS Engine.

Specified by:
onActiveCategoryChanged in interface IEngineNAWindowEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onActiveAnalysisChanged

public void onActiveAnalysisChanged(IEngineNAWindowEventsOnActiveAnalysisChangedEvent theEvent)
                             throws IOException,
                                    AutomationException
Called when the active analysis changes.

Description

The OnActiveAnalysisChanged event is fired when a NALayer is chosen from the dropdown at the top of the IEngineNetworkAnalystEnvironment::NAWindow or the IEngineNAWindow::ActiveAnalysis is programatically set.

The event is not fired when the IEngineNAWindow::ActiveAnalysis property is set programatically to Nothing or if IEngineNAWindow::DelayEvents has been set to true.

Product Availability

Available with ArcGIS Engine.

Specified by:
onActiveAnalysisChanged in interface IEngineNAWindowEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onActiveNAContextUpdated

public void onActiveNAContextUpdated(IEngineNAWindowEventsOnActiveNAContextUpdatedEvent theEvent)
                              throws IOException,
                                     AutomationException
Called when the active context has been updated.

Description

The OnActiveNAContextUpdated event is fired when the NAContext is modified. This includes edits to a NALocationObject in INAContext::NAClasses.

This event is not fired if IEngineNAWindow::DelayEvents has been set to true.

Product Availability

Available with ArcGIS Engine.

Specified by:
onActiveNAContextUpdated in interface IEngineNAWindowEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onActiveNAResultUpdated

public void onActiveNAResultUpdated(IEngineNAWindowEventsOnActiveNAResultUpdatedEvent theEvent)
                             throws IOException,
                                    AutomationException
Called when the active result has been updated.

Description

The OnActiveNAResultUpdated event is fired when a solve is performed and the analysis results have changed.

This event is not fired if IEngineNAWindow::DelayEvents has been set to true.

Product Availability

Available with ArcGIS Engine.

Specified by:
onActiveNAResultUpdated in interface IEngineNAWindowEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException