com.esri.arcgis.carto
Interface IWMSGroupLayer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IWMSGroupLayerProxy, WMSGroupLayer, WMSMapLayer

public interface IWMSGroupLayer
extends java.io.Serializable

COM Interface 'IWMSGroupLayer'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the WMS group layer.' 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 IIDd43d9a73_ff6c_4a19_b36a_d7ecbe61962a
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void add(ILayer wMSLayer)
          Adds the given WMS Layer at the given position.
 void clear()
          Deletes all the sub layers.
 IWMSGroupLayer createWMSGroupLayer(java.lang.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.
 

Field Detail

IIDd43d9a73_ff6c_4a19_b36a_d7ecbe61962a

static final int IIDd43d9a73_ff6c_4a19_b36a_d7ecbe61962a
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

getWMSServiceDescription

IWMSServiceDescription getWMSServiceDescription()
                                                throws java.io.IOException,
                                                       AutomationException
Associated WMSServiceDescription.

Returns:
A reference to a com.esri.arcgis.gisclient.IWMSServiceDescription
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createWMSLayer

IWMSLayer createWMSLayer(IWMSLayerDescription pWMSLayerDescription)
                         throws java.io.IOException,
                                AutomationException
Creates a new WMSLayer for the given WMSLayerDescription.

Parameters:
pWMSLayerDescription - A reference to a com.esri.arcgis.gisclient.IWMSLayerDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.IWMSLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createWMSGroupLayer

IWMSGroupLayer createWMSGroupLayer(java.lang.String groupName)
                                   throws java.io.IOException,
                                          AutomationException
Creates an empty WMSGroupLayer with the given name.

Parameters:
groupName - The groupName (in)
Returns:
A reference to a com.esri.arcgis.carto.IWMSGroupLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createWMSGroupLayers

IWMSGroupLayer createWMSGroupLayers(IWMSLayerDescription wMSGroupLayerDescription)
                                    throws java.io.IOException,
                                           AutomationException
Creates a new WMSGroupLayer for the given WMSLayerDescription recursively including all the sub layers.

Parameters:
wMSGroupLayerDescription - A reference to a com.esri.arcgis.gisclient.IWMSLayerDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.IWMSGroupLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertLayers

void insertLayers(IEnumLayer wMSLayers,
                  int insertPosition)
                  throws java.io.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.

Parameters:
wMSLayers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)
insertPosition - The insertPosition (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertLayer

void insertLayer(ILayer wMSLayer,
                 int insertPosition)
                 throws java.io.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.

Parameters:
wMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
insertPosition - The insertPosition (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveLayer

void moveLayer(ILayer wMSLayer,
               int toPosition)
               throws java.io.IOException,
                      AutomationException
Moves the given layer to the given position within the group layer.

Parameters:
wMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
toPosition - The toPosition (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

void add(ILayer wMSLayer)
         throws java.io.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.

Parameters:
wMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

void delete(ILayer pWMSLayer)
            throws java.io.IOException,
                   AutomationException
Deletes the given layer if it exists.

Parameters:
pWMSLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws java.io.IOException,
                  AutomationException
Deletes all the sub layers.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExpanded

boolean isExpanded()
                   throws java.io.IOException,
                          AutomationException
Indicates if the layer is expanded or collapsed.

Returns:
The pValid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpanded

void setExpanded(boolean pValid)
                 throws java.io.IOException,
                        AutomationException
Indicates if the layer is expanded or collapsed.

Parameters:
pValid - The pValid (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws java.io.IOException,
                    AutomationException
Number of sub layers.

Returns:
The pLayerCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException
Sub layer at the given index.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.