com.esri.arcgis.controls
Interface IEngineNAWindow

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IEngineNAWindow2

All Known Implementing Classes:

IEngineNAWindow2Proxy, IEngineNAWindowProxy

public interface IEngineNAWindow
extends java.io.Serializable

COM Interface 'IEngineNAWindow'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to the network analysis window.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDcc384577_67f8_4b16_af7f_67c3de386209
static int	xxDummy Deprecated. Internal use only

Method Summary

void	abortOperation(INAContext pNAContext) Cancels the operation in progress.
void	delayEvents(IEngineNAWindowCategory pCategory, boolean flag) Indicates if events should be delayed for a category.
void	delayWindowUpdates(boolean flag) Indicates if window updates should be delayed.
INALayer	getActiveAnalysis() The current analysis shown in the window.
IEngineNAWindowCategory	getActiveCategory() The current category shown in the window.
IEngineNAWindowCategory	getCategoryByNAClassName(java.lang.String name) The network analysis window by category.
int	getHWnd() The handle to the analysis window.
IColor	getItemSelectionColor() The color used for selected items.
ISelection	getSelection() The current selection in the window.
void	setActiveAnalysis(INALayer analysisLayer) The current analysis shown in the window.
void	setActiveCategory(IEngineNAWindowCategory category) The current category shown in the window.
void	setItemSelectionColor(IColor color) The color used for selected items.
void	setMessage(java.lang.String rhs1) Displays a message at the bottom of the window.
void	startOperation(INAContext pNAContext) Starts an analysis window operation.
void	stopOperation(INAContext pNAContext, java.lang.String message) Stops an analysis window operation.
void	updateContent(IEngineNAWindowCategory category) Refresh the window contents.

Field Detail

IIDcc384577_67f8_4b16_af7f_67c3de386209

static final int IIDcc384577_67f8_4b16_af7f_67c3de386209

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setMessage

void setMessage(java.lang.String rhs1)
                throws java.io.IOException,
                       AutomationException

Displays a message at the bottom of the window.

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveAnalysis

INALayer getActiveAnalysis()
                           throws java.io.IOException,
                                  AutomationException

The current analysis shown in the window.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INALayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveAnalysis

void setActiveAnalysis(INALayer analysisLayer)
                       throws java.io.IOException,
                              AutomationException

The current analysis shown in the window.

Parameters:

analysisLayer - A reference to a com.esri.arcgis.networkanalyst.INALayer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveCategory

IEngineNAWindowCategory getActiveCategory()
                                          throws java.io.IOException,
                                                 AutomationException

The current category shown in the window.

Returns:

A reference to a com.esri.arcgis.controls.IEngineNAWindowCategory

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveCategory

void setActiveCategory(IEngineNAWindowCategory category)
                       throws java.io.IOException,
                              AutomationException

The current category shown in the window.

Parameters:

category - A reference to a com.esri.arcgis.controls.IEngineNAWindowCategory (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelection

ISelection getSelection()
                        throws java.io.IOException,
                               AutomationException

The current selection in the window.

Returns:

A reference to a com.esri.arcgis.carto.ISelection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategoryByNAClassName

IEngineNAWindowCategory getCategoryByNAClassName(java.lang.String name)
                                                 throws java.io.IOException,
                                                        AutomationException

The network analysis window by category.

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.controls.IEngineNAWindowCategory

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateContent

void updateContent(IEngineNAWindowCategory category)
                   throws java.io.IOException,
                          AutomationException

Refresh the window contents.

Parameters:

category - A reference to a com.esri.arcgis.controls.IEngineNAWindowCategory (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delayEvents

void delayEvents(IEngineNAWindowCategory pCategory,
                 boolean flag)
                 throws java.io.IOException,
                        AutomationException

Indicates if events should be delayed for a category.

Parameters:

pCategory - A reference to a com.esri.arcgis.controls.IEngineNAWindowCategory (in)

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delayWindowUpdates

void delayWindowUpdates(boolean flag)
                        throws java.io.IOException,
                               AutomationException

Indicates if window updates should be delayed.

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException

The handle to the analysis window.

Returns:

The hWnd (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemSelectionColor

IColor getItemSelectionColor()
                             throws java.io.IOException,
                                    AutomationException

The color used for selected items.

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemSelectionColor

void setItemSelectionColor(IColor color)
                           throws java.io.IOException,
                                  AutomationException

The color used for selected items.

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startOperation

void startOperation(INAContext pNAContext)
                    throws java.io.IOException,
                           AutomationException

Starts an analysis window operation.

Parameters:

pNAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopOperation

void stopOperation(INAContext pNAContext,
                   java.lang.String message)
                   throws java.io.IOException,
                          AutomationException

Stops an analysis window operation.

Parameters:

pNAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)

message - The message (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

abortOperation

void abortOperation(INAContext pNAContext)
                    throws java.io.IOException,
                           AutomationException

Cancels the operation in progress.

Parameters:

pNAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.