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, java.io.Externalizable, java.io.Serializable

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

COM Class 'GraphicSnapEnvironment'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Collection of Snap Agents used to snap a graphic point.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IGraphicSnapEnvironment

IID, IID56fd87f6_ddce_11d1_8778_0000f8751720, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicSnapEnvironment2

IID, IID51ae6186_47a9_489a_a91d_a0e6caf320f1, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

GraphicSnapEnvironment()
Constructs a GraphicSnapEnvironment using ArcGIS Engine.

GraphicSnapEnvironment(java.lang.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(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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(java.io.ObjectInput in)
void	release() Release a GraphicSnapEnvironment.
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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GraphicSnapEnvironment

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

Constructs a GraphicSnapEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GraphicSnapEnvironment

public GraphicSnapEnvironment(java.lang.Object obj)
                       throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GraphicSnapEnvironment.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

snapShape

public void snapShape(IGeometry shape)
               throws java.io.IOException,
                      AutomationException

Snap the shape using the agents in the environment.

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:

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

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

public double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException

The snap tolerance in page units.

Specified by:

getSnapTolerance in interface IGraphicSnapEnvironment

Specified by:

getSnapTolerance in interface IGraphicSnapEnvironment2

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

public void setSnapTolerance(double tol)
                      throws java.io.IOException,
                             AutomationException

The snap tolerance in page units.

Specified by:

setSnapTolerance in interface IGraphicSnapEnvironment

Specified by:

setSnapTolerance in interface IGraphicSnapEnvironment2

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapAgentOrder

public void setSnapAgentOrder(IArray guids)
                       throws java.io.IOException,
                              AutomationException

An array of IDs indicating how agents should be ordered.

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:

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

AutomationException - If the ArcObject component throws an exception.

getSnapAgentOrder

public IArray getSnapAgentOrder()
                         throws java.io.IOException,
                                AutomationException

An array of IDs indicating how agents should be ordered.

Specified by:

getSnapAgentOrder in interface IGraphicSnapEnvironment

Specified by:

getSnapAgentOrder in interface IGraphicSnapEnvironment2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapAgentCount

public int getSnapAgentCount()
                      throws java.io.IOException,
                             AutomationException

The number of snap agents.

Specified by:

getSnapAgentCount in interface IGraphicSnapEnvironment

Specified by:

getSnapAgentCount in interface IGraphicSnapEnvironment2

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapAgent

public IGraphicSnap getSnapAgent(int index)
                          throws java.io.IOException,
                                 AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

clearSnapAgents

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

Remove all snap agents.

Specified by:

clearSnapAgents in interface IGraphicSnapEnvironment

Specified by:

clearSnapAgents in interface IGraphicSnapEnvironment2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSnapAgent

public void addSnapAgent(IGraphicSnap snapAgent)
                  throws java.io.IOException,
                         AutomationException

Add a new snap agent to the environment.

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:

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

AutomationException - If the ArcObject component throws an exception.

deleteSnapAgent

public void deleteSnapAgent(IGraphicSnap snapAgent)
                     throws java.io.IOException,
                            AutomationException

Remove specified snap agent from the environment.

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:

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

AutomationException - If the ArcObject component throws an exception.

snapShapeEx

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

Snap the shape using the agents in the environment.

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:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException