com.esri.arcgis.carto
Interface IWMSMapLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

WMSMapLayer

public interface IWMSMapLayer
extends Serializable

Provides access to members that control the WMS map layer.

Remarks

A WMSMapLayer is a container of WMS layers. There are two ways to create a WMSMapLayer:

1. Add all the vailable WMS layers using EngineWMSMapLayerFactory.

2. Add selected or individual WMS layers to the WMSMapLayer through these steps:

• Set the URL in WMSConnectionName
• Use IDataLayer to connect the WMSMapLayer (now empty) to the WMSConnectionName (which now has the URL for connecting to the WMS service).
• Get the WMSServiceDescription from IWMSMapLayer (WMSMapLayer is now connected to the service and has access to the service the capabilities, this includes a list of WMS layer descriptions)
• Iterate through the WMSLayerDescriptions to find the WMS layer description or layer descriptions that you are interested in
• Use the CreateWMSLayer method to create a WMSLayer inside the WMSMapLayer

Product Availability

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

Method Summary

void	clearDrawCache() Clears the cache of images downloaded from the WMS server for drawing.
IColor	getBackgroundColor() Background color for the WMS Map Layer image.
boolean	isServerSupportsTransparency() Indicates whether transparency is suppported by the server.
boolean	isTransparentBackground() Indicates whether to make the background of the WMS Map Layer image transparent.
void	setBackgroundColor(IColor ppColor) Background color for the WMS Map Layer image.
void	setTransparentBackground(boolean transparent) Indicates whether to make the background of the WMS Map Layer image transparent.
void	setWMSServiceDescriptionByRef(IWMSServiceDescription rhs1) Associated WMSServiceDescription.

Method Detail

clearDrawCache

void clearDrawCache()
                    throws IOException,
                           AutomationException

Clears the cache of images downloaded from the WMS server for drawing.

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.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

Background color for the WMS Map Layer image.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(IColor ppColor)
                        throws IOException,
                               AutomationException

Background color for the WMS Map Layer image.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTransparentBackground

boolean isTransparentBackground()
                                throws IOException,
                                       AutomationException

Indicates whether to make the background of the WMS Map Layer image transparent.

Product Availability

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

Returns:

The transparent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentBackground

void setTransparentBackground(boolean transparent)
                              throws IOException,
                                     AutomationException

Indicates whether to make the background of the WMS Map Layer image transparent.

Product Availability

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

Parameters:

transparent - The transparent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isServerSupportsTransparency

boolean isServerSupportsTransparency()
                                     throws IOException,
                                            AutomationException

Indicates whether transparency is suppported by the server.

Product Availability

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

Returns:

The transparent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWMSServiceDescriptionByRef

void setWMSServiceDescriptionByRef(IWMSServiceDescription rhs1)
                                   throws IOException,
                                          AutomationException

Associated WMSServiceDescription.

Product Availability

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

Parameters:

rhs1 - A reference to a com.esri.arcgis.gisclient.IWMSServiceDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.