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, Externalizable, Serializable

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

Snapping Grid for use with a PageLayout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

SnapGrid()
Constructs a SnapGrid using ArcGIS Engine.

SnapGrid(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(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
double	getHorizontalSpacing() The horizontal distance between grid points.
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(ObjectInput in)
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(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

SnapGrid

public SnapGrid()
         throws IOException,
                UnknownHostException

Constructs a SnapGrid using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SnapGrid

public SnapGrid(Object obj)
         throws 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:

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

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the snapping grid is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ISnapGrid

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsVisible

public void setIsVisible(boolean isVisible)
                  throws IOException,
                         AutomationException

Indicates if the snapping grid is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsVisible in interface ISnapGrid

Parameters:

isVisible - The isVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalSpacing

public double getHorizontalSpacing()
                            throws IOException,
                                   AutomationException

The horizontal distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHorizontalSpacing in interface ISnapGrid

Returns:

The spacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalSpacing

public void setHorizontalSpacing(double spacing)
                          throws IOException,
                                 AutomationException

The horizontal distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHorizontalSpacing in interface ISnapGrid

Parameters:

spacing - The spacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalSpacing

public double getVerticalSpacing()
                          throws IOException,
                                 AutomationException

The vertical distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVerticalSpacing in interface ISnapGrid

Returns:

The spacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalSpacing

public void setVerticalSpacing(double spacing)
                        throws IOException,
                               AutomationException

The vertical distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVerticalSpacing in interface ISnapGrid

Parameters:

spacing - The spacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

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

Draw the grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

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