com.esri.arcgis.carto
Class IMapsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IMapsProxy

All Implemented Interfaces:

IMaps, Externalizable, Serializable

public class IMapsProxy
extends com.esri.arcgis.interop.Dispatch
implements IMaps, Serializable

Provides access to members that control the maps collection.

Superseded By

IMaps2

Remarks

Use IMaps interface to get access to a collection of Maps object using IMxDocument.Maps property.

Please ignore the above statement in the Product Availability section. IMaps interface is NOT available with ArcGIS Server and ArcGIS Engine since this interface is used to get access to a Maps object, which is a non-creatable object. References to non-creatable objects must be obtained through other objects. IMaps interface is available only with ArcGIS Desktop.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IMapsProxy()
	IMapsProxy(Object obj)
protected	IMapsProxy(Object obj, String iid)

Method Summary

void	add(IMap map) Adds a map to the collection.
void	addListener(String iidStr, Object theListener, Object theSource)
IMap	create() Creates a new map.
int	getCount() Number of maps.
IMap	getItem(int index) The map at the given index.
void	remove(IMap map) Removes a map from the collection.
void	removeAt(int index) Removes a map at the specified index.
void	removeListener(String iidStr, Object theListener)
void	reset() Removes all maps from the collection.

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IMapsProxy

public IMapsProxy()

IMapsProxy

public IMapsProxy(Object obj)
           throws IOException

Throws:

IOException

IMapsProxy

protected IMapsProxy(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

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of maps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IMaps

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItem

public IMap getItem(int index)
             throws IOException,
                    AutomationException

The map at the given index.

Product Availability

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

Specified by:

getItem in interface IMaps

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

public IMap create()
            throws IOException,
                   AutomationException

Creates a new map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

create in interface IMaps

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IMap map)
            throws IOException,
                   AutomationException

Removes a map from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IMaps

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(IMap map)
         throws IOException,
                AutomationException

Adds a map to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IMaps

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAt

public void removeAt(int index)
              throws IOException,
                     AutomationException

Removes a map at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAt in interface IMaps

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Removes all maps from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IMaps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.