com.esri.arcgis.carto
Class MgrsGrid

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

All Implemented Interfaces:

IGraphicsComposite, IGridLadderLabels, IMapGrid, IMgrsGrid, IReferenceSystem, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MgrsGrid
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapGrid, IMgrsGrid, IGridLadderLabels, IPersistStream, IPersist, IClone, IGraphicsComposite, IReferenceSystem, java.io.Externalizable

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

Description 'The Military Grid Reference System (MGRS) object.' 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.IMapGrid

IID, IID03762c8b_f4d0_11d1_ade8_080009ec732a, xxDummy

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

IID, IID46240e54_b526_47f3_80a4_a7e2f2e1c262, xxDummy

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

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

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IID969cde4a_82d4_11d2_87dd_0000f8751720, xxDummy

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

IID, IID53b979cb_9576_40dd_8b7b_f445e5b1bac9, xxDummy

Constructor Summary

MgrsGrid()
Constructs a MgrsGrid using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	boundsChanged() Called when the extent of the parent map frame changes.
void	draw(IDisplay display, IMapFrame pMapFrame) Draws the map grid for a map frame to the given display.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	generateGraphics(IMapFrame pMapFrame, IGraphicsContainer graphicsContainer) Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.
IMapGridBorder	getBorder() The map grid border.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
double	getExteriorWidth(IDisplay pDisplay, IMapFrame pMapFrame) The width (in display units) of the portion of the grid that is outside of the frame.
IEnumElement	getGraphics(IDisplay display, java.lang.Object data) Graphic elements that are used to render this object.
ILineSymbol	getGridSquareBoundarySymbol() The line symbol used to display the boundaries of the grid squares.
IColor	getGridSquareLabelColor() The color used to display the grid square labels.
Font	getGridSquareLabelFont() The font used to display the grid square labels.
double	getGridSquareLabelSize() The font size used to display the grid square labels.
int	getGridSquareLabelStyle() The style used to display the grid square labels.
double	getInteriorTickLength() The length of the interior grid ticks.
ILineSymbol	getInteriorTickSymbol() The line symbol used to show interior grid ticks.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IGridLabel	getLabelFormat() The label format for map grid labels.
IColor	getLadderLabelColor() The color of the ladder labels.
int	getLadderLabelColumnCount() The number of ladder label columns.
Font	getLadderLabelFont() The fonst used to display ladder labels.
int	getLadderLabelRowCount() The number of ladder label rows.
double	getLadderLabelSize() The font size used to display ladder labels.
ILineSymbol	getLineSymbol() The symbol used to draw grid lines - null will draw no lines.
java.lang.String	getName() The name of the map grid.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
short	getSubTickCount() The number of subticks to draw between the major ticks.
double	getSubTickLength() The length of the subticks in points.
ILineSymbol	getSubTickLineSymbol() The symbol used to draw the subtick lines.
double	getTickLength() The length of the major ticks in points.
ILineSymbol	getTickLineSymbol() The line symbol used to draw the major ticks.
IMarkerSymbol	getTickMarkSymbol() The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isShowGridSquareIdentifiers() Indicates if the square identifiers should be displayed.
boolean	isShowLadderLabels() Indicates if ladder labels should be displayed.
boolean	isShowOuterLabelsOnly() Indicates if only the outer ladder labels should be shown.
boolean	isVisible() Indicates if the map grid is visible.
void	load(IStream pstm) load
void	prepareForOutput(int hDC, int dpi, tagRECT pixelBounds, IMapFrame pMapFrame) Prepares the map grid for output to a device.
void	queryBounds(IDisplay pDisplay, IMapFrame pMapFrame, IEnvelope bounds) The extent of the reference system in page space.
void	queryLabelVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) Returns the visibility of the labels along all four sides of the map grid.
void	querySubTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) Returns the visibility of the subticks along all four sides of the map grid.
void	queryTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) Returns the visibility of the ticks along all four sides of the map grid.
void	readExternal(java.io.ObjectInput in)
void	release() Release a MgrsGrid.
void	save(IStream pstm, int fClearDirty) save
void	setBorder(IMapGridBorder gridBorder) The map grid border.
void	setDefaults(IMapFrame pMapFrame) Sets the properties of the map grid to default values.
void	setGridSquareBoundarySymbol(ILineSymbol symbol) The line symbol used to display the boundaries of the grid squares.
void	setGridSquareLabelColor(IColor color) The color used to display the grid square labels.
void	setGridSquareLabelFont(Font font) The font used to display the grid square labels.
void	setGridSquareLabelSize(double size) The font size used to display the grid square labels.
void	setGridSquareLabelStyle(int style) The style used to display the grid square labels.
void	setInteriorTickLength(double lengthPts) The length of the interior grid ticks.
void	setInteriorTickSymbol(ILineSymbol symbol) The line symbol used to show interior grid ticks.
void	setLabelFormat(IGridLabel format) The label format for map grid labels.
void	setLabelVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) Sets the visibility of the labels along all four sides of the map grid.
void	setLadderLabelColor(IColor color) The color of the ladder labels.
void	setLadderLabelColumnCount(int columnCount) The number of ladder label columns.
void	setLadderLabelFont(Font font) The fonst used to display ladder labels.
void	setLadderLabelRowCount(int rowCount) The number of ladder label rows.
void	setLadderLabelSize(double size) The font size used to display ladder labels.
void	setLineSymbol(ILineSymbol symbol) The symbol used to draw grid lines - null will draw no lines.
void	setName(java.lang.String gridName) The name of the map grid.
void	setShowGridSquareIdentifiers(boolean show) Indicates if the square identifiers should be displayed.
void	setShowLadderLabels(boolean show) Indicates if ladder labels should be displayed.
void	setShowOuterLabelsOnly(boolean show) Indicates if only the outer ladder labels should be shown.
void	setSubTickCount(short count) The number of subticks to draw between the major ticks.
void	setSubTickLength(double lengthPoints) The length of the subticks in points.
void	setSubTickLineSymbol(ILineSymbol symbol) The symbol used to draw the subtick lines.
void	setSubTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) Sets the visibility of the subticks along all four sides of the map grid.
void	setTickLength(double lengthPoints) The length of the major ticks in points.
void	setTickLineSymbol(ILineSymbol symbol) The line symbol used to draw the major ticks.
void	setTickMarkSymbol(IMarkerSymbol symbol) The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
void	setTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) Sets the visibility of the ticks along all four sides of the map grid.
void	setVisible(boolean visible) Indicates if the map grid is visible.
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

MgrsGrid

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

Constructs a MgrsGrid using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MgrsGrid

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

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

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

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

Specified by:

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

getName

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

The name of the map grid.

Specified by:

getName in interface IMapGrid

Specified by:

getName in interface IReferenceSystem

Returns:

The gridName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String gridName)
             throws java.io.IOException,
                    AutomationException

The name of the map grid.

Specified by:

setName in interface IMapGrid

Specified by:

setName in interface IReferenceSystem

Parameters:

gridName - The gridName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineSymbol

public ILineSymbol getLineSymbol()
                          throws java.io.IOException,
                                 AutomationException

The symbol used to draw grid lines - null will draw no lines.

Specified by:

getLineSymbol in interface IMapGrid

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineSymbol

public void setLineSymbol(ILineSymbol symbol)
                   throws java.io.IOException,
                          AutomationException

The symbol used to draw grid lines - null will draw no lines.

Specified by:

setLineSymbol in interface IMapGrid

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTickMarkSymbol

public IMarkerSymbol getTickMarkSymbol()
                                throws java.io.IOException,
                                       AutomationException

The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Specified by:

getTickMarkSymbol in interface IMapGrid

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTickMarkSymbol

public void setTickMarkSymbol(IMarkerSymbol symbol)
                       throws java.io.IOException,
                              AutomationException

The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Specified by:

setTickMarkSymbol in interface IMapGrid

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelFormat

public IGridLabel getLabelFormat()
                          throws java.io.IOException,
                                 AutomationException

The label format for map grid labels.

Specified by:

getLabelFormat in interface IMapGrid

Specified by:

getLabelFormat in interface IReferenceSystem

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelFormat

public void setLabelFormat(IGridLabel format)
                    throws java.io.IOException,
                           AutomationException

The label format for map grid labels.

Specified by:

setLabelFormat in interface IMapGrid

Specified by:

setLabelFormat in interface IReferenceSystem

Parameters:

format - A reference to a com.esri.arcgis.carto.IGridLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTickLineSymbol

public ILineSymbol getTickLineSymbol()
                              throws java.io.IOException,
                                     AutomationException

The line symbol used to draw the major ticks.

Specified by:

getTickLineSymbol in interface IMapGrid

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTickLineSymbol

public void setTickLineSymbol(ILineSymbol symbol)
                       throws java.io.IOException,
                              AutomationException

The line symbol used to draw the major ticks.

Specified by:

setTickLineSymbol in interface IMapGrid

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTickLength

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

The length of the major ticks in points.

Specified by:

getTickLength in interface IMapGrid

Returns:

The lengthPoints

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTickLength

public void setTickLength(double lengthPoints)
                   throws java.io.IOException,
                          AutomationException

The length of the major ticks in points.

Specified by:

setTickLength in interface IMapGrid

Parameters:

lengthPoints - The lengthPoints (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubTickCount

public short getSubTickCount()
                      throws java.io.IOException,
                             AutomationException

The number of subticks to draw between the major ticks.

Specified by:

getSubTickCount in interface IMapGrid

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubTickCount

public void setSubTickCount(short count)
                     throws java.io.IOException,
                            AutomationException

The number of subticks to draw between the major ticks.

Specified by:

setSubTickCount in interface IMapGrid

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubTickLineSymbol

public ILineSymbol getSubTickLineSymbol()
                                 throws java.io.IOException,
                                        AutomationException

The symbol used to draw the subtick lines.

Specified by:

getSubTickLineSymbol in interface IMapGrid

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubTickLineSymbol

public void setSubTickLineSymbol(ILineSymbol symbol)
                          throws java.io.IOException,
                                 AutomationException

The symbol used to draw the subtick lines.

Specified by:

setSubTickLineSymbol in interface IMapGrid

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubTickLength

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

The length of the subticks in points.

Specified by:

getSubTickLength in interface IMapGrid

Returns:

The lengthPoints

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubTickLength

public void setSubTickLength(double lengthPoints)
                      throws java.io.IOException,
                             AutomationException

The length of the subticks in points.

Specified by:

setSubTickLength in interface IMapGrid

Parameters:

lengthPoints - The lengthPoints (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorder

public IMapGridBorder getBorder()
                         throws java.io.IOException,
                                AutomationException

The map grid border.

Specified by:

getBorder in interface IMapGrid

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorder

public void setBorder(IMapGridBorder gridBorder)
               throws java.io.IOException,
                      AutomationException

The map grid border.

Specified by:

setBorder in interface IMapGrid

Parameters:

gridBorder - A reference to a com.esri.arcgis.carto.IMapGridBorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if the map grid is visible.

Specified by:

isVisible in interface IMapGrid

Specified by:

isVisible in interface IReferenceSystem

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the map grid is visible.

Specified by:

setVisible in interface IMapGrid

Specified by:

setVisible in interface IReferenceSystem

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryLabelVisibility

public void queryLabelVisibility(boolean[] leftVis,
                                 boolean[] topVis,
                                 boolean[] rightVis,
                                 boolean[] bottomVis)
                          throws java.io.IOException,
                                 AutomationException

Returns the visibility of the labels along all four sides of the map grid.

Specified by:

queryLabelVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in/out: use single element array)

topVis - The topVis (in/out: use single element array)

rightVis - The rightVis (in/out: use single element array)

bottomVis - The bottomVis (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelVisibility

public void setLabelVisibility(boolean leftVis,
                               boolean topVis,
                               boolean rightVis,
                               boolean bottomVis)
                        throws java.io.IOException,
                               AutomationException

Sets the visibility of the labels along all four sides of the map grid.

Specified by:

setLabelVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in)

topVis - The topVis (in)

rightVis - The rightVis (in)

bottomVis - The bottomVis (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTickVisibility

public void queryTickVisibility(boolean[] leftVis,
                                boolean[] topVis,
                                boolean[] rightVis,
                                boolean[] bottomVis)
                         throws java.io.IOException,
                                AutomationException

Returns the visibility of the ticks along all four sides of the map grid.

Specified by:

queryTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in/out: use single element array)

topVis - The topVis (in/out: use single element array)

rightVis - The rightVis (in/out: use single element array)

bottomVis - The bottomVis (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTickVisibility

public void setTickVisibility(boolean leftVis,
                              boolean topVis,
                              boolean rightVis,
                              boolean bottomVis)
                       throws java.io.IOException,
                              AutomationException

Sets the visibility of the ticks along all four sides of the map grid.

Specified by:

setTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in)

topVis - The topVis (in)

rightVis - The rightVis (in)

bottomVis - The bottomVis (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

querySubTickVisibility

public void querySubTickVisibility(boolean[] leftVis,
                                   boolean[] topVis,
                                   boolean[] rightVis,
                                   boolean[] bottomVis)
                            throws java.io.IOException,
                                   AutomationException

Returns the visibility of the subticks along all four sides of the map grid.

Specified by:

querySubTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in/out: use single element array)

topVis - The topVis (in/out: use single element array)

rightVis - The rightVis (in/out: use single element array)

bottomVis - The bottomVis (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubTickVisibility

public void setSubTickVisibility(boolean leftVis,
                                 boolean topVis,
                                 boolean rightVis,
                                 boolean bottomVis)
                          throws java.io.IOException,
                                 AutomationException

Sets the visibility of the subticks along all four sides of the map grid.

Specified by:

setSubTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in)

topVis - The topVis (in)

rightVis - The rightVis (in)

bottomVis - The bottomVis (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaults

public void setDefaults(IMapFrame pMapFrame)
                 throws java.io.IOException,
                        AutomationException

Sets the properties of the map grid to default values.

Specified by:

setDefaults in interface IMapGrid

Specified by:

setDefaults in interface IReferenceSystem

Parameters:

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

generateGraphics

public void generateGraphics(IMapFrame pMapFrame,
                             IGraphicsContainer graphicsContainer)
                      throws java.io.IOException,
                             AutomationException

Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.

Specified by:

generateGraphics in interface IMapGrid

Specified by:

generateGraphics in interface IReferenceSystem

Parameters:

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

graphicsContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareForOutput

public void prepareForOutput(int hDC,
                             int dpi,
                             tagRECT pixelBounds,
                             IMapFrame pMapFrame)
                      throws java.io.IOException,
                             AutomationException

Prepares the map grid for output to a device.

Specified by:

prepareForOutput in interface IMapGrid

Specified by:

prepareForOutput in interface IReferenceSystem

Parameters:

hDC - The hDC (A COM typedef) (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IMapFrame pMapFrame)
          throws java.io.IOException,
                 AutomationException

Draws the map grid for a map frame to the given display.

Specified by:

draw in interface IMapGrid

Specified by:

draw in interface IReferenceSystem

Parameters:

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

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExteriorWidth

public double getExteriorWidth(IDisplay pDisplay,
                               IMapFrame pMapFrame)
                        throws java.io.IOException,
                               AutomationException

The width (in display units) of the portion of the grid that is outside of the frame.

Specified by:

getExteriorWidth in interface IMapGrid

Parameters:

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

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Returns:

The pWidth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowGridSquareIdentifiers

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

Indicates if the square identifiers should be displayed.

Specified by:

isShowGridSquareIdentifiers in interface IMgrsGrid

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowGridSquareIdentifiers

public void setShowGridSquareIdentifiers(boolean show)
                                  throws java.io.IOException,
                                         AutomationException

Indicates if the square identifiers should be displayed.

Specified by:

setShowGridSquareIdentifiers in interface IMgrsGrid

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelFont

public Font getGridSquareLabelFont()
                            throws java.io.IOException,
                                   AutomationException

The font used to display the grid square labels.

Specified by:

getGridSquareLabelFont in interface IMgrsGrid

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelFont

public void setGridSquareLabelFont(Font font)
                            throws java.io.IOException,
                                   AutomationException

The font used to display the grid square labels.

Specified by:

setGridSquareLabelFont in interface IMgrsGrid

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelSize

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

The font size used to display the grid square labels.

Specified by:

getGridSquareLabelSize in interface IMgrsGrid

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelSize

public void setGridSquareLabelSize(double size)
                            throws java.io.IOException,
                                   AutomationException

The font size used to display the grid square labels.

Specified by:

setGridSquareLabelSize in interface IMgrsGrid

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelColor

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

The color used to display the grid square labels.

Specified by:

getGridSquareLabelColor in interface IMgrsGrid

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.

setGridSquareLabelColor

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

The color used to display the grid square labels.

Specified by:

setGridSquareLabelColor in interface IMgrsGrid

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.

getGridSquareLabelStyle

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

The style used to display the grid square labels.

Specified by:

getGridSquareLabelStyle in interface IMgrsGrid

Returns:

A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelStyle

public void setGridSquareLabelStyle(int style)
                             throws java.io.IOException,
                                    AutomationException

The style used to display the grid square labels.

Specified by:

setGridSquareLabelStyle in interface IMgrsGrid

Parameters:

style - A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareBoundarySymbol

public ILineSymbol getGridSquareBoundarySymbol()
                                        throws java.io.IOException,
                                               AutomationException

The line symbol used to display the boundaries of the grid squares.

Specified by:

getGridSquareBoundarySymbol in interface IMgrsGrid

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareBoundarySymbol

public void setGridSquareBoundarySymbol(ILineSymbol symbol)
                                 throws java.io.IOException,
                                        AutomationException

The line symbol used to display the boundaries of the grid squares.

Specified by:

setGridSquareBoundarySymbol in interface IMgrsGrid

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInteriorTickSymbol

public ILineSymbol getInteriorTickSymbol()
                                  throws java.io.IOException,
                                         AutomationException

The line symbol used to show interior grid ticks.

Specified by:

getInteriorTickSymbol in interface IMgrsGrid

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInteriorTickSymbol

public void setInteriorTickSymbol(ILineSymbol symbol)
                           throws java.io.IOException,
                                  AutomationException

The line symbol used to show interior grid ticks.

Specified by:

setInteriorTickSymbol in interface IMgrsGrid

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInteriorTickLength

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

The length of the interior grid ticks.

Specified by:

getInteriorTickLength in interface IMgrsGrid

Returns:

The lengthPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInteriorTickLength

public void setInteriorTickLength(double lengthPts)
                           throws java.io.IOException,
                                  AutomationException

The length of the interior grid ticks.

Specified by:

setInteriorTickLength in interface IMgrsGrid

Parameters:

lengthPts - The lengthPts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowLadderLabels

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

Indicates if ladder labels should be displayed.

Specified by:

isShowLadderLabels in interface IGridLadderLabels

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowLadderLabels

public void setShowLadderLabels(boolean show)
                         throws java.io.IOException,
                                AutomationException

Indicates if ladder labels should be displayed.

Specified by:

setShowLadderLabels in interface IGridLadderLabels

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLadderLabelFont

public Font getLadderLabelFont()
                        throws java.io.IOException,
                               AutomationException

The fonst used to display ladder labels.

Specified by:

getLadderLabelFont in interface IGridLadderLabels

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLadderLabelFont

public void setLadderLabelFont(Font font)
                        throws java.io.IOException,
                               AutomationException

The fonst used to display ladder labels.

Specified by:

setLadderLabelFont in interface IGridLadderLabels

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLadderLabelSize

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

The font size used to display ladder labels.

Specified by:

getLadderLabelSize in interface IGridLadderLabels

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLadderLabelSize

public void setLadderLabelSize(double size)
                        throws java.io.IOException,
                               AutomationException

The font size used to display ladder labels.

Specified by:

setLadderLabelSize in interface IGridLadderLabels

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLadderLabelColor

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

The color of the ladder labels.

Specified by:

getLadderLabelColor in interface IGridLadderLabels

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.

setLadderLabelColor

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

The color of the ladder labels.

Specified by:

setLadderLabelColor in interface IGridLadderLabels

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.

getLadderLabelRowCount

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

The number of ladder label rows.

Specified by:

getLadderLabelRowCount in interface IGridLadderLabels

Returns:

The rowCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLadderLabelRowCount

public void setLadderLabelRowCount(int rowCount)
                            throws java.io.IOException,
                                   AutomationException

The number of ladder label rows.

Specified by:

setLadderLabelRowCount in interface IGridLadderLabels

Parameters:

rowCount - The rowCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLadderLabelColumnCount

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

The number of ladder label columns.

Specified by:

getLadderLabelColumnCount in interface IGridLadderLabels

Returns:

The columnCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLadderLabelColumnCount

public void setLadderLabelColumnCount(int columnCount)
                               throws java.io.IOException,
                                      AutomationException

The number of ladder label columns.

Specified by:

setLadderLabelColumnCount in interface IGridLadderLabels

Parameters:

columnCount - The columnCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowOuterLabelsOnly

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

Indicates if only the outer ladder labels should be shown.

Specified by:

isShowOuterLabelsOnly in interface IGridLadderLabels

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowOuterLabelsOnly

public void setShowOuterLabelsOnly(boolean show)
                            throws java.io.IOException,
                                   AutomationException

Indicates if only the outer ladder labels should be shown.

Specified by:

setShowOuterLabelsOnly in interface IGridLadderLabels

Parameters:

show - The show (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.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

queryBounds

public void queryBounds(IDisplay pDisplay,
                        IMapFrame pMapFrame,
                        IEnvelope bounds)
                 throws java.io.IOException,
                        AutomationException

The extent of the reference system in page space.

Specified by:

queryBounds in interface IReferenceSystem

Parameters:

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

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

boundsChanged

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

Called when the extent of the parent map frame changes.

Specified by:

boundsChanged in interface IReferenceSystem

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