com.esri.arcgis.carto
Class SnapGrid

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

All Implemented Interfaces:

ISnapGrid, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class SnapGrid
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISnapGrid, IPersistStream, IPersist, java.io.Externalizable

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

Description 'Snapping Grid for use with a PageLayout.' 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.ISnapGrid

IID, IID31e081aa_cb02_11d1_876c_0000f8751720, 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

SnapGrid()
Constructs a SnapGrid using ArcGIS Engine.

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

Method Summary

void	draw(IDisplay display, IPage page) Draw the grid.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
double	getHorizontalSpacing() The horizontal distance between grid points.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getVerticalSpacing() The vertical distance between grid points.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isVisible() Indicates if the snapping grid is visible.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a SnapGrid.
void	save(IStream pstm, int fClearDirty) save
void	setHorizontalSpacing(double spacing) The horizontal distance between grid points.
void	setIsVisible(boolean isVisible) Indicates if the snapping grid is visible.
void	setVerticalSpacing(double spacing) The vertical distance between grid points.
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

SnapGrid

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

Constructs a SnapGrid using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SnapGrid

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

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

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

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

Specified by:

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

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the snapping grid is visible.

Specified by:

isVisible in interface ISnapGrid

Returns:

The isVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsVisible

public void setIsVisible(boolean isVisible)
                  throws java.io.IOException,
                         AutomationException

Indicates if the snapping grid is visible.

Specified by:

setIsVisible in interface ISnapGrid

Parameters:

isVisible - The isVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHorizontalSpacing

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

The horizontal distance between grid points.

Specified by:

getHorizontalSpacing in interface ISnapGrid

Returns:

The spacing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHorizontalSpacing

public void setHorizontalSpacing(double spacing)
                          throws java.io.IOException,
                                 AutomationException

The horizontal distance between grid points.

Specified by:

setHorizontalSpacing in interface ISnapGrid

Parameters:

spacing - The spacing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVerticalSpacing

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

The vertical distance between grid points.

Specified by:

getVerticalSpacing in interface ISnapGrid

Returns:

The spacing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVerticalSpacing

public void setVerticalSpacing(double spacing)
                        throws java.io.IOException,
                               AutomationException

The vertical distance between grid points.

Specified by:

setVerticalSpacing in interface ISnapGrid

Parameters:

spacing - The spacing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IPage page)
          throws java.io.IOException,
                 AutomationException

Draw the grid.

Specified by:

draw in interface ISnapGrid

Parameters:

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

page - A reference to a com.esri.arcgis.carto.IPage (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