com.esri.arcgis.carto
Interface INetworkRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

NetworkDirtyAreaRenderer, NetworkTrafficRenderer, SimpleNetworkRenderer

public interface INetworkRenderer
extends Serializable

Provides access to members that control functions common to all Network renderers.

Product Availability

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

Method Summary

boolean	canRender(INetworkLayer layer, IDisplay display) Indicates if the renderer can draw.
void	draw(INetworkLayer layer, int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the network dataset.
String	getName() The descriptive name of a renderer.
int	getRendererType() The type of the network renderer.
boolean	isRenderPhase(int drawPhase) Indicates if renderer uses the specified draw phase.
void	setName(String name) The descriptive name of a renderer.
void	setRendererType(int type) The type of the network renderer.

Method Detail

draw

void draw(INetworkLayer layer,
          int drawPhase,
          IDisplay display,
          ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the network dataset.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.INetworkLayer (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRender

boolean canRender(INetworkLayer layer,
                  IDisplay display)
                  throws IOException,
                         AutomationException

Indicates if the renderer can draw.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.INetworkLayer (in)

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

Returns:

The canRender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The descriptive name of a renderer.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The descriptive name of a renderer.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRenderPhase

boolean isRenderPhase(int drawPhase)
                      throws IOException,
                             AutomationException

Indicates if renderer uses the specified draw phase.

Product Availability

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

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRendererType

int getRendererType()
                    throws IOException,
                           AutomationException

The type of the network renderer.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriNetworkRendererType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererType

void setRendererType(int type)
                     throws IOException,
                            AutomationException

The type of the network renderer.

Product Availability

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

Parameters:

type - A com.esri.arcgis.carto.esriNetworkRendererType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.