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

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

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

Description 'Snapping Guides 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.ISnapGuides

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

SnapGuides()
Constructs a SnapGuides using ArcGIS Engine.

SnapGuides(java.lang.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(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getDrawLevel() Level where guides are drawn.
double	getGuide(int idx) The nth guide.
int	getGuideCount() The number of guides.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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(java.io.ObjectInput in)
void	release() Release a SnapGuides.
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(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

SnapGuides

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

Constructs a SnapGuides using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SnapGuides

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

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

Specified by:

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

isAreVisible

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

Indicates if snapping guides are visible.

Specified by:

isAreVisible in interface ISnapGuides

Returns:

The areVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreVisible

public void setAreVisible(boolean areVisible)
                   throws java.io.IOException,
                          AutomationException

Indicates if snapping guides are visible.

Specified by:

setAreVisible in interface ISnapGuides

Parameters:

areVisible - The areVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDrawLevel

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

Level where guides are drawn.

Specified by:

getDrawLevel in interface ISnapGuides

Returns:

A com.esri.arcgis.carto.esriViewDrawPhase constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawLevel

public void setDrawLevel(int drawLevel)
                  throws java.io.IOException,
                         AutomationException

Level where guides are drawn.

Specified by:

setDrawLevel in interface ISnapGuides

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGuideCount

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

The number of guides.

Specified by:

getGuideCount in interface ISnapGuides

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGuide

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

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

Specified by:

setGuide in interface ISnapGuides

Parameters:

idx - The idx (in)

pos - The pos (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGuide

public double getGuide(int idx)
                throws java.io.IOException,
                       AutomationException

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

Specified by:

getGuide in interface ISnapGuides

Parameters:

idx - The idx (in)

Returns:

The pos

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addGuide

public void addGuide(double pos)
              throws java.io.IOException,
                     AutomationException

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

Specified by:

addGuide in interface ISnapGuides

Parameters:

pos - The pos (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeGuide

public void removeGuide(int idx)
                 throws java.io.IOException,
                        AutomationException

Removes the nth guide.

Specified by:

removeGuide in interface ISnapGuides

Parameters:

idx - The idx (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllGuides

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

Removes all the guides.

Specified by:

removeAllGuides in interface ISnapGuides

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

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

Draw a fine line showing exactly where objects will snap.

Specified by:

draw in interface ISnapGuides

Parameters:

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

isHorizontal - The isHorizontal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawHighlight

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

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

Specified by:

drawHighlight in interface ISnapGuides

Parameters:

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

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