com.esri.arcgis.carto
Class MapInset

java.lang.Object
  com.esri.arcgis.carto.MapInset

All Implemented Interfaces:

IBoundsProperties, IMapInset, IMapInset2, IMapSurround, IQuerySize, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class MapInset
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapInset, IMapInset2, IMapSurround, IQuerySize, IBoundsProperties, IConnectionPointContainer, IPersistStream, IPersist, IClone, Externalizable

A map surround for displaying an inset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

MapInset()
Constructs a MapInset using ArcGIS Engine.

MapInset(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapInset theMapInset = (MapInset) obj;

Method Summary

void	addIMapSurroundEventsListener(IMapSurroundEvents theListener) addIMapSurroundEventsListener.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	calculateVisibleBounds() Calculates the visible bounds by applying the zoom or scale parameter to MapBounds (used when snapshot is false).
void	delayEvents(boolean delay) Used to batch operations together to minimize notifications.
void	draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds) Draws the map surround into the specified display bounds.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed) Adjusts the map surround to fit the bounds.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getDescription() Description reflecting the current settings of the MapInset.
void	getDeviceFrame(int[] left, int[] top, int[] right, int[] bottom) Pixel extent of the inset.
IEnvelope	getFullExtent() The maximum extent shown by the inset.
int	getIcon() Icon used to represent the map surround.
IMap	getMap() The parent map.
IEnvelope	getMapBounds() The relative position of the inset to the associated map (used when the inset is live).
String	getName() Name of the map surround.
double	getReferenceScale() Reference scale of the inset.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IEnvelope	getVisibleBounds() The map extent shown by the inset (used when the inset is not live).
double	getZoomPercent() Zoom amount as a percentage.
double	getZoomScale() The zoom amount as an absolute Scale (i.e., 1:20000).
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFixedAspectRatio() Indicates if the bounds has a fixed aspect ratio.
boolean	isFixedSize() Indicates if size is determined by some other property like the symbol.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isLive() Indicates if the inset shows a live view of the underlying map.
boolean	isUsingZoomScale() Indicates if ZoomScale or ZoomPercent is being used.
void	load(IStream pstm) load
void	queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds) Returns the bounds of the map surround.
void	querySize(double[] widthPoints, double[] heightPoints) Get the size in points.
void	readExternal(ObjectInput in)
void	refresh() Makes sure the latest updates are refected the next time the Map Surround is drawn.
void	removeIMapSurroundEventsListener(IMapSurroundEvents theListener) removeIMapSurroundEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	setDeviceFrame(int left, int top, int right, int bottom) Pixel extent of the inset.
void	setFixedAspectRatio(boolean flag) Indicates if the bounds has a fixed aspect ratio.
void	setFullExtent(IEnvelope fullExtent) The maximum extent shown by the inset.
void	setIsLive(boolean isLive) Indicates if the inset shows a live view of the underlying map.
void	setMapBounds(IEnvelope bounds) The relative position of the inset to the associated map (used when the inset is live).
void	setMapByRef(IMap map) The parent map.
void	setName(String name) Name of the map surround.
void	setReferenceScale(double refScale) Reference scale of the inset.
void	setVisibleBounds(IEnvelope visibleBounds) The map extent shown by the inset (used when the inset is not live).
void	setZoomPercent(double percent) Zoom amount as a percentage.
void	setZoomScale(double scale) The zoom amount as an absolute Scale (i.e., 1:20000).
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

MapInset

public MapInset()
         throws IOException,
                UnknownHostException

Constructs a MapInset using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MapInset

public MapInset(Object obj)
         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapInset theMapInset = (MapInset) obj;

Construct a MapInset using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MapInset.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addIMapSurroundEventsListener

public void addIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                   throws IOException

addIMapSurroundEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.

Throws:

IOException - If there are communications problems.

removeIMapSurroundEventsListener

public void removeIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                      throws IOException

removeIMapSurroundEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.

Throws:

IOException - If there are communications problems.

getMapBounds

public IEnvelope getMapBounds()
                       throws IOException,
                              AutomationException

The relative position of the inset to the associated map (used when the inset is live). The zoom amount is applied to this rectangle to determine the visible bounds that is actually drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapBounds in interface IMapInset

Specified by:

getMapBounds in interface IMapInset2

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapBounds

public void setMapBounds(IEnvelope bounds)
                  throws IOException,
                         AutomationException

The relative position of the inset to the associated map (used when the inset is live). The zoom amount is applied to this rectangle to determine the visible bounds that is actually drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapBounds in interface IMapInset

Specified by:

setMapBounds in interface IMapInset2

Parameters:

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisibleBounds

public IEnvelope getVisibleBounds()
                           throws IOException,
                                  AutomationException

The map extent shown by the inset (used when the inset is not live).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVisibleBounds in interface IMapInset

Specified by:

getVisibleBounds in interface IMapInset2

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisibleBounds

public void setVisibleBounds(IEnvelope visibleBounds)
                      throws IOException,
                             AutomationException

The map extent shown by the inset (used when the inset is not live).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisibleBounds in interface IMapInset

Specified by:

setVisibleBounds in interface IMapInset2

Parameters:

visibleBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLive

public boolean isLive()
               throws IOException,
                      AutomationException

Indicates if the inset shows a live view of the underlying map. False means a snapshot of the underlying map is taken at the time the flag is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isLive in interface IMapInset

Specified by:

isLive in interface IMapInset2

Returns:

The isLive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsLive

public void setIsLive(boolean isLive)
               throws IOException,
                      AutomationException

Indicates if the inset shows a live view of the underlying map. False means a snapshot of the underlying map is taken at the time the flag is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsLive in interface IMapInset

Specified by:

setIsLive in interface IMapInset2

Parameters:

isLive - The isLive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsingZoomScale

public boolean isUsingZoomScale()
                         throws IOException,
                                AutomationException

Indicates if ZoomScale or ZoomPercent is being used. The one specified last is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUsingZoomScale in interface IMapInset

Specified by:

isUsingZoomScale in interface IMapInset2

Returns:

The usingZoomScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZoomPercent

public double getZoomPercent()
                      throws IOException,
                             AutomationException

Zoom amount as a percentage. 100 means show the underlying map at normal size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getZoomPercent in interface IMapInset

Specified by:

getZoomPercent in interface IMapInset2

Returns:

The percent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomPercent

public void setZoomPercent(double percent)
                    throws IOException,
                           AutomationException

Zoom amount as a percentage. 100 means show the underlying map at normal size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZoomPercent in interface IMapInset

Specified by:

setZoomPercent in interface IMapInset2

Parameters:

percent - The percent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZoomScale

public double getZoomScale()
                    throws IOException,
                           AutomationException

The zoom amount as an absolute Scale (i.e., 1:20000).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getZoomScale in interface IMapInset

Specified by:

getZoomScale in interface IMapInset2

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomScale

public void setZoomScale(double scale)
                  throws IOException,
                         AutomationException

The zoom amount as an absolute Scale (i.e., 1:20000).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZoomScale in interface IMapInset

Specified by:

setZoomScale in interface IMapInset2

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description reflecting the current settings of the MapInset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IMapInset

Specified by:

getDescription in interface IMapInset2

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateVisibleBounds

public void calculateVisibleBounds()
                            throws IOException,
                                   AutomationException

Calculates the visible bounds by applying the zoom or scale parameter to MapBounds (used when snapshot is false).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

calculateVisibleBounds in interface IMapInset

Specified by:

calculateVisibleBounds in interface IMapInset2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws IOException,
                   AutomationException

The parent map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMap in interface IMapSurround

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.

setMapByRef

public void setMapByRef(IMap map)
                 throws IOException,
                        AutomationException

The parent map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapByRef in interface IMapSurround

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.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IMapSurround

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IMapSurround

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIcon

public int getIcon()
            throws IOException,
                   AutomationException

Icon used to represent the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIcon in interface IMapSurround

Returns:

The hIcon (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

public void queryBounds(IDisplay display,
                        IEnvelope oldBounds,
                        IEnvelope newBounds)
                 throws IOException,
                        AutomationException

Returns the bounds of the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryBounds in interface IMapSurround

Parameters:

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

oldBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

newBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fitToBounds

public void fitToBounds(IDisplay display,
                        IEnvelope bounds,
                        boolean[] changed)
                 throws IOException,
                        AutomationException

Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

fitToBounds in interface IMapSurround

Parameters:

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

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

changed - The changed (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delayEvents

public void delayEvents(boolean delay)
                 throws IOException,
                        AutomationException

Used to batch operations together to minimize notifications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

delayEvents in interface IMapSurround

Parameters:

delay - The delay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Makes sure the latest updates are refected the next time the Map Surround is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

refresh in interface IMapSurround

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 ITrackCancel trackCancel,
                 IEnvelope bounds)
          throws IOException,
                 AutomationException

Draws the map surround into the specified display bounds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IMapSurround

Parameters:

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

public IEnvelope getFullExtent()
                        throws IOException,
                               AutomationException

The maximum extent shown by the inset.

Product Availability

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

Specified by:

getFullExtent in interface IMapInset2

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullExtent

public void setFullExtent(IEnvelope fullExtent)
                   throws IOException,
                          AutomationException

The maximum extent shown by the inset.

Product Availability

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

Specified by:

setFullExtent in interface IMapInset2

Parameters:

fullExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws IOException,
                                AutomationException

Reference scale of the inset.

Product Availability

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

Specified by:

getReferenceScale in interface IMapInset2

Returns:

The refScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double refScale)
                       throws IOException,
                              AutomationException

Reference scale of the inset.

Product Availability

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

Specified by:

setReferenceScale in interface IMapInset2

Parameters:

refScale - The refScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeviceFrame

public void getDeviceFrame(int[] left,
                           int[] top,
                           int[] right,
                           int[] bottom)
                    throws IOException,
                           AutomationException

Pixel extent of the inset.

Product Availability

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

Specified by:

getDeviceFrame in interface IMapInset2

Parameters:

left - The left (out: use single element array)

top - The top (out: use single element array)

right - The right (out: use single element array)

bottom - The bottom (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeviceFrame

public void setDeviceFrame(int left,
                           int top,
                           int right,
                           int bottom)
                    throws IOException,
                           AutomationException

Pixel extent of the inset.

Product Availability

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

Specified by:

setDeviceFrame in interface IMapInset2

Parameters:

left - The left (in)

top - The top (in)

right - The right (in)

bottom - The bottom (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

querySize

public void querySize(double[] widthPoints,
                      double[] heightPoints)
               throws IOException,
                      AutomationException

Get the size in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

querySize in interface IQuerySize

Parameters:

widthPoints - The widthPoints (in/out: use single element array)

heightPoints - The heightPoints (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedAspectRatio

public boolean isFixedAspectRatio()
                           throws IOException,
                                  AutomationException

Indicates if the bounds has a fixed aspect ratio.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFixedAspectRatio in interface IBoundsProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedAspectRatio

public void setFixedAspectRatio(boolean flag)
                         throws IOException,
                                AutomationException

Indicates if the bounds has a fixed aspect ratio.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFixedAspectRatio in interface IBoundsProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedSize

public boolean isFixedSize()
                    throws IOException,
                           AutomationException

Indicates if size is determined by some other property like the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFixedSize in interface IBoundsProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException