com.esri.arcgis.carto
Class MarginSnap

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

All Implemented Interfaces:

IGraphicSnap, IPageLayoutSnap, com.esri.arcgis.interop.RemoteObjRef, IPersist, java.io.Serializable

public class MarginSnap
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPageLayoutSnap, IGraphicSnap, IPersist

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

Description 'Snap to margins agent.' 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

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

IID, IIDfc27faaf_db88_11d1_8778_0000f8751720, xxDummy

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

IID56fd87f5_ddce_11d1_8778_0000f8751720

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

IID, IID0000010c_0000_0000_c000_000000000046, xxDummy

Constructor Summary

MarginSnap()
Constructs a MarginSnap using ArcGIS Engine.

MarginSnap(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MarginSnap theMarginSnap = (MarginSnap) obj;

Method Summary

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.
java.lang.String	getName() The name of the snap agent.
int	hashCode() the hashcode for this object
void	release() Release a MarginSnap.
void	setPageLayout(IPageLayout rhs1) The PageLayout that this snap agent is associated with.
boolean	snapX(IGeometry shape, double tolerance) Indicates if the point is snapped in the horizontal direction.
boolean	snapY(IGeometry shape, double tolerance) Indicates if the point is snapped in the vertical direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarginSnap

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

Constructs a MarginSnap using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MarginSnap

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

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

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

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

Specified by:

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

setPageLayout

public void setPageLayout(IPageLayout rhs1)
                   throws java.io.IOException,
                          AutomationException

The PageLayout that this snap agent is associated with.

Specified by:

setPageLayout in interface IPageLayoutSnap

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IPageLayout (in)

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

The name of the snap agent.

Specified by:

getName in interface IGraphicSnap

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

snapX

public boolean snapX(IGeometry shape,
                     double tolerance)
              throws java.io.IOException,
                     AutomationException

Indicates if the point is snapped in the horizontal direction.

Specified by:

snapX in interface IGraphicSnap

Parameters:

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

tolerance - The tolerance (in)

Returns:

The snapped

Throws:

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

AutomationException - If the ArcObject component throws an exception.

snapY

public boolean snapY(IGeometry shape,
                     double tolerance)
              throws java.io.IOException,
                     AutomationException

Indicates if the point is snapped in the vertical direction.

Specified by:

snapY in interface IGraphicSnap

Parameters:

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

tolerance - The tolerance (in)

Returns:

The snapped

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.