com.esri.arcgis.carto
Class FeatureExtent

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

All Implemented Interfaces:

IFeatureExtent, IMapArea, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class FeatureExtent
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapArea, IFeatureExtent, IXMLSerialize, IPersistStream, IPersist, Externalizable

The Feature Extent coclass allows you to zoom to selected features in a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

FeatureExtent()
Constructs a FeatureExtent using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
double	getDefaultScale() Scale at which the extent of a single point is drawn.
double	getExpandRatio() Ratio used to expand the extent.
IEnvelope	getExtent() The geographic extent of the map.
IFIDSet	getFeatureIDs() The set of feature IDs.
int	getLayerID() The ID of the layer.
String	getMapName() Name of the map (data frame).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setDefaultScale(double mapScale) Scale at which the extent of a single point is drawn.
void	setExpandRatio(double ratio) Ratio used to expand the extent.
void	setFeatureIDs(IFIDSet featureIDs) The set of feature IDs.
void	setLayerID(int layerID) The ID of the layer.
void	setMapName(String name) Name of the map (data frame).
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

FeatureExtent

public FeatureExtent()
              throws IOException,
                     UnknownHostException

Constructs a FeatureExtent using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FeatureExtent

public FeatureExtent(Object obj)
              throws IOException

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

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

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

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The geographic extent of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IMapArea

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.

getMapName

public String getMapName()
                  throws IOException,
                         AutomationException

Name of the map (data frame).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapName in interface IFeatureExtent

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapName

public void setMapName(String name)
                throws IOException,
                       AutomationException

Name of the map (data frame).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapName in interface IFeatureExtent

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerID

public int getLayerID()
               throws IOException,
                      AutomationException

The ID of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayerID in interface IFeatureExtent

Returns:

The layerID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerID

public void setLayerID(int layerID)
                throws IOException,
                       AutomationException

The ID of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerID in interface IFeatureExtent

Parameters:

layerID - The layerID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureIDs

public IFIDSet getFeatureIDs()
                      throws IOException,
                             AutomationException

The set of feature IDs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureIDs in interface IFeatureExtent

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureIDs

public void setFeatureIDs(IFIDSet featureIDs)
                   throws IOException,
                          AutomationException

The set of feature IDs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureIDs in interface IFeatureExtent

Parameters:

featureIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpandRatio

public double getExpandRatio()
                      throws IOException,
                             AutomationException

Ratio used to expand the extent.

Remarks

Use ExpandRatio to add a "buffer" around the requested geographic extent. For example, an ExpandRatio value of 1.5 will expand the map extent by 1.5 times.ExpandRatio should be used to ensure that the set of features can be viewed easily. Otherwise, some features may be at the very edge of the displayed map extent. If the ExpandRatio is not set (the default value is 1) some of the selected features will be located at the very edge of the map image. A number greater than 1 will "zoom out", providing a spatial buffer around the selected features. A number less than 1 will "zoom in".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExpandRatio in interface IFeatureExtent

Returns:

The ratio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpandRatio

public void setExpandRatio(double ratio)
                    throws IOException,
                           AutomationException

Ratio used to expand the extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExpandRatio in interface IFeatureExtent

Parameters:

ratio - The ratio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultScale

public double getDefaultScale()
                       throws IOException,
                              AutomationException

Scale at which the extent of a single point is drawn.

Remarks

Use DefaultScale to control the map scale when zooming to a single point feature. The DefaultScale value only affects conditions where a single point feature is selected. This value will be ignored when selecting multiple points or when selecting other feature types. If this value is not set and FeatureIDs is comprised of a single point feature, the new spatial extent may be too large.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultScale in interface IFeatureExtent

Returns:

The mapScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultScale

public void setDefaultScale(double mapScale)
                     throws IOException,
                            AutomationException

Scale at which the extent of a single point is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultScale in interface IFeatureExtent

Parameters:

mapScale - The mapScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (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