com.esri.arcgis.carto
Interface IWMSGroupLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

IWMSGroupLayerProxy, WMSGroupLayer, WMSMapLayer

public interface IWMSGroupLayer
extends Serializable

Provides access to members that control the WMS group layer.

Remarks

Manages the contents of a WMSMapLayer or a WMSGroupLayer.

Product Availability

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

Method Summary

void	add(ILayer wMSLayer) Adds the given WMS Layer at the given position.
void	clear() Deletes all the sub layers.
IWMSGroupLayer	createWMSGroupLayer(String groupName) Creates an empty WMSGroupLayer with the given name.
IWMSGroupLayer	createWMSGroupLayers(IWMSLayerDescription wMSGroupLayerDescription) Creates a new WMSGroupLayer for the given WMSLayerDescription recursively including all the sub layers.
IWMSLayer	createWMSLayer(IWMSLayerDescription pWMSLayerDescription) Creates a new WMSLayer for the given WMSLayerDescription.
void	delete(ILayer pWMSLayer) Deletes the given layer if it exists.
int	getCount() Number of sub layers.
ILayer	getLayer(int index) Sub layer at the given index.
IWMSServiceDescription	getWMSServiceDescription() Associated WMSServiceDescription.
void	insertLayer(ILayer wMSLayer, int insertPosition) Inserts the given WMS Layer at the given position.
void	insertLayers(IEnumLayer wMSLayers, int insertPosition) Inserts the given WMS Layers at the given position.
boolean	isExpanded() Indicates if the layer is expanded or collapsed.
void	moveLayer(ILayer wMSLayer, int toPosition) Moves the given layer to the given position within the group layer.
void	setExpanded(boolean pValid) Indicates if the layer is expanded or collapsed.

Method Detail

getWMSServiceDescription

IWMSServiceDescription getWMSServiceDescription()
                                                throws IOException,
                                                       AutomationException

Associated WMSServiceDescription.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.gisclient.IWMSServiceDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createWMSLayer

IWMSLayer createWMSLayer(IWMSLayerDescription pWMSLayerDescription)
                         throws IOException,
                                AutomationException

Creates a new WMSLayer for the given WMSLayerDescription.

Product Availability

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

Parameters:

pWMSLayerDescription - A reference to a com.esri.arcgis.gisclient.IWMSLayerDescription (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createWMSGroupLayer

IWMSGroupLayer createWMSGroupLayer(String groupName)
                                   throws IOException,
                                          AutomationException

Creates an empty WMSGroupLayer with the given name.

Product Availability

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

Parameters:

groupName - The groupName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createWMSGroupLayers

IWMSGroupLayer createWMSGroupLayers(IWMSLayerDescription wMSGroupLayerDescription)
                                    throws IOException,
                                           AutomationException

Creates a new WMSGroupLayer for the given WMSLayerDescription recursively including all the sub layers.

Product Availability

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

Parameters:

wMSGroupLayerDescription - A reference to a com.esri.arcgis.gisclient.IWMSLayerDescription (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertLayers

void insertLayers(IEnumLayer wMSLayers,
                  int insertPosition)
                  throws IOException,
                         AutomationException

Inserts the given WMS Layers at the given position. Only layers created by this WMS group layer or its parent layers are valid.

Product Availability

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

Parameters:

wMSLayers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)

insertPosition - The insertPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertLayer

void insertLayer(ILayer wMSLayer,
                 int insertPosition)
                 throws IOException,
                        AutomationException

Inserts the given WMS Layer at the given position. Only layer created by this WMS group layer or its parent layers are valid.

Product Availability

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

Parameters:

wMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

insertPosition - The insertPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveLayer

void moveLayer(ILayer wMSLayer,
               int toPosition)
               throws IOException,
                      AutomationException

Moves the given layer to the given position within the group layer.

Product Availability

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

Parameters:

wMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

toPosition - The toPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(ILayer wMSLayer)
         throws IOException,
                AutomationException

Adds the given WMS Layer at the given position. Only layer created by this WMS group layer or its parent layers are valid.

Product Availability

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

Parameters:

wMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete(ILayer pWMSLayer)
            throws IOException,
                   AutomationException

Deletes the given layer if it exists.

Product Availability

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

Parameters:

pWMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException

Deletes all the sub layers.

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.

isExpanded

boolean isExpanded()
                   throws IOException,
                          AutomationException

Indicates if the layer is expanded or collapsed.

Product Availability

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

Returns:

The pValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpanded

void setExpanded(boolean pValid)
                 throws IOException,
                        AutomationException

Indicates if the layer is expanded or collapsed.

Product Availability

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

Parameters:

pValid - The pValid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of sub layers.

Product Availability

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

Returns:

The pLayerCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int index)
                throws IOException,
                       AutomationException

Sub layer at the given index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.