com.esri.arcgis.cartoUI
Interface INetworkRendererPropertyPage

All Superinterfaces:

Serializable

All Known Implementing Classes:

INetworkRendererPropertyPageProxy, NetworkDirtyAreaRendererPropertyPage, NetworkTrafficRendererPropertyPage, SimpleNetworkRendererPropertyPage

public interface INetworkRendererPropertyPage
extends Serializable

Provides access to members that control the NetworkRendererPropertyPage.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	canEdit(INetworkRenderer obj, boolean[] result) Indicates if the network renderer can be edited by the property page.
String	getCategory() Category for the renderer property page.
IUID	getClassID() Property page class id (unique identifier object).
String	getDescription() Description of the renderer.
String	getName(int rendererType) Renderer name for the specified renderer type.
int	getPreviewImage() Preview bitmap for the renderer that appears on the page.
IUID	getRendererClassID() Renderer class id (unique identifier object).
boolean	isAppliesTo(int rendererType) Indicates if the property page is applicable to the specified renderer type.

Method Detail

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the renderer.

Product Availability

Available with ArcGIS Desktop.

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName(int rendererType)
               throws IOException,
                      AutomationException

Renderer name for the specified renderer type.

Product Availability

Available with ArcGIS Desktop.

Parameters:

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

Category for the renderer property page.

Product Availability

Available with ArcGIS Desktop.

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAppliesTo

boolean isAppliesTo(int rendererType)
                    throws IOException,
                           AutomationException

Indicates if the property page is applicable to the specified renderer type.

Product Availability

Available with ArcGIS Desktop.

Parameters:

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreviewImage

int getPreviewImage()
                    throws IOException,
                           AutomationException

Preview bitmap for the renderer that appears on the page.

Product Availability

Available with ArcGIS Desktop.

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRendererClassID

IUID getRendererClassID()
                        throws IOException,
                               AutomationException

Renderer class id (unique identifier object).

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

IUID getClassID()
                throws IOException,
                       AutomationException

Property page class id (unique identifier object).

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canEdit

void canEdit(INetworkRenderer obj,
             boolean[] result)
             throws IOException,
                    AutomationException

Indicates if the network renderer can be edited by the property page.

Product Availability

Available with ArcGIS Desktop.

Parameters:

obj - A reference to a com.esri.arcgis.carto.INetworkRenderer (in)

result - The result (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.