com.esri.arcgis.carto
Class SnapGuides

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

All Implemented Interfaces:

ISnapGuides, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class SnapGuides
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISnapGuides, IPersistStream, IPersist, Externalizable

Snapping Guides 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

SnapGuides()
Constructs a SnapGuides using ArcGIS Engine.

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

Method Summary

void	addGuide(double pos) Adds a guide at the specified position.
void	draw(IDisplay display, boolean isHorizontal) Draw a fine line showing exactly where objects will snap.
void	drawHighlight(IDisplay display, boolean isHorizontal) Draw a highlight around the snap line for a nice visual effect.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDrawLevel() Level where guides are drawn.
double	getGuide(int idx) The nth guide.
int	getGuideCount() The number of guides.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isAreVisible() Indicates if snapping guides are visible.
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	removeAllGuides() Removes all the guides.
void	removeGuide(int idx) Removes the nth guide.
void	save(IStream pstm, int fClearDirty) save
void	setAreVisible(boolean areVisible) Indicates if snapping guides are visible.
void	setDrawLevel(int drawLevel) Level where guides are drawn.
void	setGuide(int idx, double pos) The nth guide.
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

SnapGuides

public SnapGuides()
           throws IOException,
                  UnknownHostException

Constructs a SnapGuides using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SnapGuides

public SnapGuides(Object obj)
           throws IOException

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

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

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

isAreVisible

public boolean isAreVisible()
                     throws IOException,
                            AutomationException

Indicates if snapping guides are visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAreVisible in interface ISnapGuides

Returns:

The areVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreVisible

public void setAreVisible(boolean areVisible)
                   throws IOException,
                          AutomationException

Indicates if snapping guides are visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAreVisible in interface ISnapGuides

Parameters:

areVisible - The areVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDrawLevel

public int getDrawLevel()
                 throws IOException,
                        AutomationException

Level where guides are drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDrawLevel in interface ISnapGuides

Returns:

A com.esri.arcgis.carto.esriViewDrawPhase constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawLevel

public void setDrawLevel(int drawLevel)
                  throws IOException,
                         AutomationException

Level where guides are drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDrawLevel in interface ISnapGuides

Parameters:

drawLevel - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGuideCount

public int getGuideCount()
                  throws IOException,
                         AutomationException

The number of guides.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGuideCount in interface ISnapGuides

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGuide

public void setGuide(int idx,
                     double pos)
              throws IOException,
                     AutomationException

The nth guide. The position is specified in page units.

Product Availability

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

Specified by:

setGuide in interface ISnapGuides

Parameters:

idx - The idx (in)

pos - The pos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGuide

public double getGuide(int idx)
                throws IOException,
                       AutomationException

The nth guide. The position is specified in page units.

Product Availability

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

Specified by:

getGuide in interface ISnapGuides

Parameters:

idx - The idx (in)

Returns:

The pos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addGuide

public void addGuide(double pos)
              throws IOException,
                     AutomationException

Adds a guide at the specified position. The position is specified in page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addGuide in interface ISnapGuides

Parameters:

pos - The pos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeGuide

public void removeGuide(int idx)
                 throws IOException,
                        AutomationException

Removes the nth guide.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeGuide in interface ISnapGuides

Parameters:

idx - The idx (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllGuides

public void removeAllGuides()
                     throws IOException,
                            AutomationException

Removes all the guides.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAllGuides in interface ISnapGuides

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 boolean isHorizontal)
          throws IOException,
                 AutomationException

Draw a fine line showing exactly where objects will snap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ISnapGuides

Parameters:

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

isHorizontal - The isHorizontal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawHighlight

public void drawHighlight(IDisplay display,
                          boolean isHorizontal)
                   throws IOException,
                          AutomationException

Draw a highlight around the snap line for a nice visual effect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

drawHighlight in interface ISnapGuides

Parameters:

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

isHorizontal - The isHorizontal (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