com.esri.arcgis.carto
Class IWMSGroupLayerProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IWMSGroupLayerProxy
All Implemented Interfaces:
IWMSGroupLayer, Externalizable, Serializable

public class IWMSGroupLayerProxy
extends com.esri.arcgis.interop.Dispatch
implements IWMSGroupLayer, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IWMSGroupLayerProxy()
           
  IWMSGroupLayerProxy(Object obj)
           
protected IWMSGroupLayerProxy(Object obj, String iid)
           
 
Method Summary
 void add(ILayer wMSLayer)
          Adds the given WMS Layer at the given position.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setExpanded(boolean pValid)
          Indicates if the layer is expanded or collapsed.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IWMSGroupLayerProxy

public IWMSGroupLayerProxy()

IWMSGroupLayerProxy

public IWMSGroupLayerProxy(Object obj)
                    throws IOException
Throws:
IOException

IWMSGroupLayerProxy

protected IWMSGroupLayerProxy(Object obj,
                              String iid)
                       throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getWMSServiceDescription

public IWMSServiceDescription getWMSServiceDescription()
                                                throws IOException,
                                                       AutomationException
Associated WMSServiceDescription.

Product Availability

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

Specified by:
getWMSServiceDescription in interface IWMSGroupLayer
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

public 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.

Specified by:
createWMSLayer in interface IWMSGroupLayer
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

public 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.

Specified by:
createWMSGroupLayer in interface IWMSGroupLayer
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

public 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.

Specified by:
createWMSGroupLayers in interface IWMSGroupLayer
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

public 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.

Specified by:
insertLayers in interface IWMSGroupLayer
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

public 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.

Specified by:
insertLayer in interface IWMSGroupLayer
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

public 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.

Specified by:
moveLayer in interface IWMSGroupLayer
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

public 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.

Specified by:
add in interface IWMSGroupLayer
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

public 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.

Specified by:
delete in interface IWMSGroupLayer
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

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

Product Availability

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

Specified by:
clear in interface IWMSGroupLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExpanded

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

Product Availability

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

Specified by:
isExpanded in interface IWMSGroupLayer
Returns:
The pValid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpanded

public 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.

Specified by:
setExpanded in interface IWMSGroupLayer
Parameters:
pValid - The pValid (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

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

Product Availability

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

Specified by:
getCount in interface IWMSGroupLayer
Returns:
The pLayerCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

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

Product Availability

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

Specified by:
getLayer in interface IWMSGroupLayer
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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException