com.esri.arcgis.carto
Class AOIBookmark

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

All Implemented Interfaces:

IAOIBookmark, IPersist, IPersistStream, ISpatialBookmark, java.io.Serializable

public class AOIBookmark

extends java.lang.Object

implements IAOIBookmark, ISpatialBookmark, IPersistStream, IPersist

An AOI bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

Use AOIBookmark to save the areas of interest by dragging a rectangle in the map.

See Also:

Serialized Form

Constructor Summary

AOIBookmark()
Constructs a AOIBookmark using ArcGIS Engine.

AOIBookmark(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IAOIBookmark	getAsIAOIBookmark() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISpatialBookmark	getAsISpatialBookmark() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getBookmarkType() Type of the bookmark.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IEnvelope	getLocation() Location of the bookmark.
java.lang.String	getName() Name of the bookmark.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setLocationByRef(IEnvelope location) Location of the bookmark.
void	setName(java.lang.String name) Name of the bookmark.
void	zoomTo(IMap map) Zooms to the bookmark.

Methods inherited from class java.lang.Object

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

Constructor Detail

AOIBookmark

public AOIBookmark()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a AOIBookmark using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AOIBookmark

public AOIBookmark(java.lang.Object obj)
            throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a AOIBookmark using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AOIBookmark.
AOIBookmark theAOIBookmark = (AOIBookmark) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIAOIBookmark

public IAOIBookmark getAsIAOIBookmark()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISpatialBookmark

public ISpatialBookmark getAsISpatialBookmark()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getLocation

public IEnvelope getLocation()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAOIBookmark

Location of the bookmark.

Supported Platforms

Windows, Solaris, Linux

Description

Location property contains the saved view extent of area of interest.

Specified by:

getLocation in interface IAOIBookmark

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setLocationByRef

public void setLocationByRef(IEnvelope location)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAOIBookmark

Location of the bookmark.

Specified by:

setLocationByRef in interface IAOIBookmark

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getBookmarkType

public java.lang.String getBookmarkType()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: ISpatialBookmark

Type of the bookmark.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBookmarkType in interface ISpatialBookmark

Returns:

The type

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ISpatialBookmark

Name of the bookmark.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ISpatialBookmark

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISpatialBookmark

Name of the bookmark.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ISpatialBookmark

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomTo

public void zoomTo(IMap map)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ISpatialBookmark

Zooms to the bookmark.

Supported Platforms

Windows, Solaris, Linux

Specified by:

zoomTo in interface ISpatialBookmark

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.