com.esri.arcgis.carto
Class CalibratedMapGridBorder

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

All Implemented Interfaces:

ICalibratedMapGridBorder, IGraphicsComposite, IMapGridBorder, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class CalibratedMapGridBorder
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapGridBorder, ICalibratedMapGridBorder, IGraphicsComposite, IPersistStream, java.io.Externalizable

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

Description 'A map grid border that is calibrated.' 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.IMapGridBorder

IID, IIDac81ecf9_9ee4_11d2_aadf_000000000000, xxDummy

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

IID, IID6ca416af_e160_11d2_9f4e_00c04f6bc78e, xxDummy

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

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

CalibratedMapGridBorder()
Constructs a CalibratedMapGridBorder using ArcGIS Engine.

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

Method Summary

void	draw(IDisplay display, IGeometry frameGeometry, IGeometry mapGeometry) Draws the border to the specified display, using the frame bounds and the map bounds in page space.
boolean	equals(java.lang.Object o) Compare this object with another
IColor	getBackgroundColor() The background color of the border pattern.
double	getBorderWidth() The width of the border in points.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDisplayName() The display name for the map grid border.
IColor	getForegroundColor() The foreground color of the border pattern.
IEnumElement	getGraphics(IDisplay display, java.lang.Object data) Graphic elements that are used to render this object.
double	getInterval() The interval between border patterns in points.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getWidth() The width of the map grid border in points.
int	hashCode() the hashcode for this object
boolean	isAlternating() Indicates if the border pattern alternates across the width of the border.
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a CalibratedMapGridBorder.
void	save(IStream pstm, int fClearDirty) save
void	setAlternating(boolean alternating) Indicates if the border pattern alternates across the width of the border.
void	setBackgroundColor(IColor color) The background color of the border pattern.
void	setBorderWidth(double widthPts) The width of the border in points.
void	setForegroundColor(IColor color) The foreground color of the border pattern.
void	setInterval(double intervalPts) The interval between border patterns in 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

CalibratedMapGridBorder

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

Constructs a CalibratedMapGridBorder using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CalibratedMapGridBorder

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

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

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

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

Specified by:

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

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

The display name for the map grid border.

Specified by:

getDisplayName in interface IMapGridBorder

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

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

The width of the map grid border in points.

Specified by:

getWidth in interface IMapGridBorder

Returns:

The widthPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IGeometry frameGeometry,
                 IGeometry mapGeometry)
          throws java.io.IOException,
                 AutomationException

Draws the border to the specified display, using the frame bounds and the map bounds in page space.

Specified by:

draw in interface IMapGridBorder

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getForegroundColor

public IColor getForegroundColor()
                          throws java.io.IOException,
                                 AutomationException

The foreground color of the border pattern.

Specified by:

getForegroundColor in interface ICalibratedMapGridBorder

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setForegroundColor

public void setForegroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

The foreground color of the border pattern.

Specified by:

setForegroundColor in interface ICalibratedMapGridBorder

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

The background color of the border pattern.

Specified by:

getBackgroundColor in interface ICalibratedMapGridBorder

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

The background color of the border pattern.

Specified by:

setBackgroundColor in interface ICalibratedMapGridBorder

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorderWidth

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

The width of the border in points.

Specified by:

getBorderWidth in interface ICalibratedMapGridBorder

Returns:

The widthPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorderWidth

public void setBorderWidth(double widthPts)
                    throws java.io.IOException,
                           AutomationException

The width of the border in points.

Specified by:

setBorderWidth in interface ICalibratedMapGridBorder

Parameters:

widthPts - The widthPts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInterval

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

The interval between border patterns in points.

Specified by:

getInterval in interface ICalibratedMapGridBorder

Returns:

The intervalPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInterval

public void setInterval(double intervalPts)
                 throws java.io.IOException,
                        AutomationException

The interval between border patterns in points.

Specified by:

setInterval in interface ICalibratedMapGridBorder

Parameters:

intervalPts - The intervalPts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAlternating

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

Indicates if the border pattern alternates across the width of the border.

Specified by:

isAlternating in interface ICalibratedMapGridBorder

Returns:

The alternating

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlternating

public void setAlternating(boolean alternating)
                    throws java.io.IOException,
                           AutomationException

Indicates if the border pattern alternates across the width of the border.

Specified by:

setAlternating in interface ICalibratedMapGridBorder

Parameters:

alternating - The alternating (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics(IDisplay display,
                                java.lang.Object data)
                         throws java.io.IOException,
                                AutomationException

Graphic elements that are used to render this object. The data argument is defined by the coclass that implements this interface.

Specified by:

getGraphics in interface IGraphicsComposite

Parameters:

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

data - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumElement

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