com.esri.arcgis.carto
Class GraphicSnapEnvironment

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

All Implemented Interfaces:

IGraphicSnapEnvironment, IGraphicSnapEnvironment2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class GraphicSnapEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGraphicSnapEnvironment, IGraphicSnapEnvironment2, IPersistStream, IPersist, Externalizable

Collection of Snap Agents used to snap a graphic point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

GraphicSnapEnvironment()
Constructs a GraphicSnapEnvironment using ArcGIS Engine.

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

Method Summary

void	addSnapAgent(IGraphicSnap snapAgent) Add a new snap agent to the environment.
void	clearSnapAgents() Remove all snap agents.
void	deleteSnapAgent(IGraphicSnap snapAgent) Remove specified snap agent from the environment.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IGraphicSnap	getSnapAgent(int index) The snap agent at the specified index.
int	getSnapAgentCount() The number of snap agents.
IArray	getSnapAgentOrder() An array of IDs indicating how agents should be ordered.
double	getSnapTolerance() The snap tolerance in page units.
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	setSnapAgentOrder(IArray guids) An array of IDs indicating how agents should be ordered.
void	setSnapTolerance(double tol) The snap tolerance in page units.
void	snapShape(IGeometry shape) Snap the shape using the agents in the environment.
void	snapShapeEx(IElement pElement, IGeometry shape) Snap the shape using the agents in the environment.
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

GraphicSnapEnvironment

public GraphicSnapEnvironment()
                       throws IOException,
                              UnknownHostException

Constructs a GraphicSnapEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GraphicSnapEnvironment

public GraphicSnapEnvironment(Object obj)
                       throws IOException

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

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

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

snapShape

public void snapShape(IGeometry shape)
               throws IOException,
                      AutomationException

Snap the shape using the agents in the environment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

snapShape in interface IGraphicSnapEnvironment

Specified by:

snapShape in interface IGraphicSnapEnvironment2

Parameters:

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

public double getSnapTolerance()
                        throws IOException,
                               AutomationException

The snap tolerance in page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSnapTolerance in interface IGraphicSnapEnvironment

Specified by:

getSnapTolerance in interface IGraphicSnapEnvironment2

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

public void setSnapTolerance(double tol)
                      throws IOException,
                             AutomationException

The snap tolerance in page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSnapTolerance in interface IGraphicSnapEnvironment

Specified by:

setSnapTolerance in interface IGraphicSnapEnvironment2

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapAgentOrder

public void setSnapAgentOrder(IArray guids)
                       throws IOException,
                              AutomationException

An array of IDs indicating how agents should be ordered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSnapAgentOrder in interface IGraphicSnapEnvironment

Specified by:

setSnapAgentOrder in interface IGraphicSnapEnvironment2

Parameters:

guids - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapAgentOrder

public IArray getSnapAgentOrder()
                         throws IOException,
                                AutomationException

An array of IDs indicating how agents should be ordered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSnapAgentOrder in interface IGraphicSnapEnvironment

Specified by:

getSnapAgentOrder in interface IGraphicSnapEnvironment2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapAgentCount

public int getSnapAgentCount()
                      throws IOException,
                             AutomationException

The number of snap agents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSnapAgentCount in interface IGraphicSnapEnvironment

Specified by:

getSnapAgentCount in interface IGraphicSnapEnvironment2

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapAgent

public IGraphicSnap getSnapAgent(int index)
                          throws IOException,
                                 AutomationException

The snap agent at the specified index. The index argument is zero based.

Product Availability

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

Specified by:

getSnapAgent in interface IGraphicSnapEnvironment

Specified by:

getSnapAgent in interface IGraphicSnapEnvironment2

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearSnapAgents

public void clearSnapAgents()
                     throws IOException,
                            AutomationException

Remove all snap agents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearSnapAgents in interface IGraphicSnapEnvironment

Specified by:

clearSnapAgents in interface IGraphicSnapEnvironment2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSnapAgent

public void addSnapAgent(IGraphicSnap snapAgent)
                  throws IOException,
                         AutomationException

Add a new snap agent to the environment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addSnapAgent in interface IGraphicSnapEnvironment

Specified by:

addSnapAgent in interface IGraphicSnapEnvironment2

Parameters:

snapAgent - A reference to a com.esri.arcgis.carto.IGraphicSnap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteSnapAgent

public void deleteSnapAgent(IGraphicSnap snapAgent)
                     throws IOException,
                            AutomationException

Remove specified snap agent from the environment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteSnapAgent in interface IGraphicSnapEnvironment

Specified by:

deleteSnapAgent in interface IGraphicSnapEnvironment2

Parameters:

snapAgent - A reference to a com.esri.arcgis.carto.IGraphicSnap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

snapShapeEx

public void snapShapeEx(IElement pElement,
                        IGeometry shape)
                 throws IOException,
                        AutomationException

Snap the shape using the agents in the environment.

Product Availability

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

Specified by:

snapShapeEx in interface IGraphicSnapEnvironment2

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

shape - A reference to a com.esri.arcgis.geometry.IGeometry (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