com.esri.arcgis.carto
Class FeatureBookmark

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

All Implemented Interfaces:

IFeatureBookmark, ISpatialBookmark, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class FeatureBookmark
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureBookmark, ISpatialBookmark, IPersistStream, IPersist, Externalizable

A feature bookmark.

Description

Use FeatureBookmark to save the areas of interest by selecting features in the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

FeatureBookmark()
Constructs a FeatureBookmark using ArcGIS Engine.

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

Method Summary

void	draw(IDisplay display) Draws the feature on the map display.
boolean	equals(Object o) Compare this object with another
void	flash(IDisplay display) Flashes the feature on the map display.
String	getBookmarkType() Type of the bookmark.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IFeatureClass	getFeatureClass() Feature class.
int	getFeatureId() Feature id.
String	getName() Name of the bookmark.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	panTo(IDisplay display) Pans to the feature on the map display.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setFeatureClass(IFeatureClass featureClass) Feature class.
void	setFeatureId(int fID) Feature id.
void	setName(String name) Name of the bookmark.
void	writeExternal(ObjectOutput out)
void	zoomTo(IMap map) Zooms to the bookmark.

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

FeatureBookmark

public FeatureBookmark()
                throws IOException,
                       UnknownHostException

Constructs a FeatureBookmark using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FeatureBookmark

public FeatureBookmark(Object obj)
                throws IOException

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

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

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

getFeatureId

public int getFeatureId()
                 throws IOException,
                        AutomationException

Feature id.

Description

FeatureId is the OID associated with the selected feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureId in interface IFeatureBookmark

Returns:

The fID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureId

public void setFeatureId(int fID)
                  throws IOException,
                         AutomationException

Feature id.

Description

FeatureId is the OID associated with the selected feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureId in interface IFeatureBookmark

Parameters:

fID - The fID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException

Feature class.

Description

FeatureClass is the IFeatureClass associated with the selected feature layer. The easiest way to get the selected layer is to use IMxDocument::Get_Selected layer. See example for further information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureClass in interface IFeatureBookmark

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClass

public void setFeatureClass(IFeatureClass featureClass)
                     throws IOException,
                            AutomationException

Feature class.

Description

FeatureClass is the IFeatureClass associated with the selected feature layer. The easiest way to get the selected layer is to use IMxDocument::Get_Selected layer. See example for further information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureClass in interface IFeatureBookmark

Parameters:

featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

panTo

public void panTo(IDisplay display)
           throws IOException,
                  AutomationException

Pans to the feature on the map display.

Description

PanTo the feature location specified by this bookmark. Not implemented at version 9.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

panTo in interface IFeatureBookmark

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flash

public void flash(IDisplay display)
           throws IOException,
                  AutomationException

Flashes the feature on the map display.

Description

Flash the shape of the bookmarked feature. Not implemented at version 9.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

flash in interface IFeatureBookmark

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display)
          throws IOException,
                 AutomationException

Draws the feature on the map display.

Description

Draw the feature associated with the bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IFeatureBookmark

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarkType

public String getBookmarkType()
                       throws IOException,
                              AutomationException

Type of the bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBookmarkType in interface ISpatialBookmark

Returns:

The type

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ISpatialBookmark

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ISpatialBookmark

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomTo

public void zoomTo(IMap map)
            throws IOException,
                   AutomationException

Zooms to the bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

zoomTo in interface ISpatialBookmark

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.

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.

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