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

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

A map grid border that is calibrated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

CalibratedMapGridBorder()
Constructs a CalibratedMapGridBorder using ArcGIS Engine.

CalibratedMapGridBorder(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(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 String	getClsid() getClsid.
String	getDisplayName() The display name for the map grid border.
IColor	getForegroundColor() The foreground color of the border pattern.
IEnumElement	getGraphics(IDisplay display, Object data) Graphic elements that are used to render this object.
double	getInterval() The interval between border patterns in points.
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(ObjectInput in)
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(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

CalibratedMapGridBorder

public CalibratedMapGridBorder()
                        throws IOException,
                               UnknownHostException

Constructs a CalibratedMapGridBorder using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CalibratedMapGridBorder

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

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

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

The display name for the map grid border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDisplayName in interface IMapGridBorder

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws IOException,
                       AutomationException

The width of the map grid border in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface IMapGridBorder

Returns:

The widthPts

Throws:

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 IOException,
                 AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getForegroundColor

public IColor getForegroundColor()
                          throws IOException,
                                 AutomationException

The foreground color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getForegroundColor in interface ICalibratedMapGridBorder

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForegroundColor

public void setForegroundColor(IColor color)
                        throws IOException,
                               AutomationException

The foreground color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setForegroundColor in interface ICalibratedMapGridBorder

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The background color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackgroundColor in interface ICalibratedMapGridBorder

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException

The background color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackgroundColor in interface ICalibratedMapGridBorder

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorderWidth

public double getBorderWidth()
                      throws IOException,
                             AutomationException

The width of the border in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBorderWidth in interface ICalibratedMapGridBorder

Returns:

The widthPts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBorderWidth

public void setBorderWidth(double widthPts)
                    throws IOException,
                           AutomationException

The width of the border in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBorderWidth in interface ICalibratedMapGridBorder

Parameters:

widthPts - The widthPts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInterval

public double getInterval()
                   throws IOException,
                          AutomationException

The interval between border patterns in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInterval in interface ICalibratedMapGridBorder

Returns:

The intervalPts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInterval

public void setInterval(double intervalPts)
                 throws IOException,
                        AutomationException

The interval between border patterns in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInterval in interface ICalibratedMapGridBorder

Parameters:

intervalPts - The intervalPts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlternating

public boolean isAlternating()
                      throws IOException,
                             AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAlternating in interface ICalibratedMapGridBorder

Returns:

The alternating

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlternating

public void setAlternating(boolean alternating)
                    throws IOException,
                           AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAlternating in interface ICalibratedMapGridBorder

Parameters:

alternating - The alternating (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics(IDisplay display,
                                Object data)
                         throws IOException,
                                AutomationException

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

Product Availability

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

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:

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