com.esri.arcgis.carto
Class MgrsGrid

java.lang.Object
  extended by com.esri.arcgis.carto.MgrsGrid
All Implemented Interfaces:
IGraphicsComposite, IGridLadderLabels, IMapGrid, IMgrsGrid, IReferenceSystem, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

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

The Military Grid Reference System (MGRS) object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MgrsGrid()
          Constructs a MgrsGrid using ArcGIS Engine.
MgrsGrid(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(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 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, 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.
 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.
 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)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when 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(ObjectInput in)
           
 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(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(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

MgrsGrid

public MgrsGrid()
         throws IOException,
                UnknownHostException
Constructs a MgrsGrid using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MgrsGrid

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

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the map grid.

Description

Name is the name of the grid as it appears in the dataframe properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IMapGrid
Specified by:
getName in interface IReferenceSystem
Returns:
The gridName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String gridName)
             throws IOException,
                    AutomationException
The name of the map grid.

Description

Name is the name of the grid as it appears in the dataframe properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface IMapGrid
Specified by:
setName in interface IReferenceSystem
Parameters:
gridName - The gridName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLineSymbol

public ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException
The symbol used to draw grid lines - null will draw no lines.

Description

LineSymbol is the line symbol that will be used to draw the grid lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLineSymbol in interface IMapGrid
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLineSymbol

public void setLineSymbol(ILineSymbol symbol)
                   throws IOException,
                          AutomationException
The symbol used to draw grid lines - null will draw no lines.

Description

LineSymbol is the line symbol that will be used to draw the grid lines.
.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLineSymbol in interface IMapGrid
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTickMarkSymbol

public IMarkerSymbol getTickMarkSymbol()
                                throws IOException,
                                       AutomationException
The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Description

TickMarkSymbol is the marker symbol that may be drawn at the intersection of grid lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTickMarkSymbol in interface IMapGrid
Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickMarkSymbol

public void setTickMarkSymbol(IMarkerSymbol symbol)
                       throws IOException,
                              AutomationException
The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Description

TickMarkSymbol is the marker symbol that may be drawn at the intersection of grid lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTickMarkSymbol in interface IMapGrid
Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelFormat

public IGridLabel getLabelFormat()
                          throws IOException,
                                 AutomationException
The label format for map grid labels.

Description

LabelFormat is the label format for the grid labels. This is an IGridLabel, which is the generic interface that supports all the other specific types of grid labels, which in turn support the various number formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelFormat in interface IMapGrid
Specified by:
getLabelFormat in interface IReferenceSystem
Returns:
A reference to a com.esri.arcgis.carto.IGridLabel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelFormat

public void setLabelFormat(IGridLabel format)
                    throws IOException,
                           AutomationException
The label format for map grid labels.

Description

LabelFormat is the label format for the grid labels. This is an IGridLabel , which is the generic interface that supports all the other specific types of grid labels, which in turn support the various number formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTickLineSymbol

public ILineSymbol getTickLineSymbol()
                              throws IOException,
                                     AutomationException
The line symbol used to draw the major ticks.

Description

TickLineSymbol is the line symbol that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTickLineSymbol in interface IMapGrid
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickLineSymbol

public void setTickLineSymbol(ILineSymbol symbol)
                       throws IOException,
                              AutomationException
The line symbol used to draw the major ticks.

Description

TickLineSymbol is the line symbol that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTickLineSymbol in interface IMapGrid
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTickLength

public double getTickLength()
                     throws IOException,
                            AutomationException
The length of the major ticks in points.

Description

TickLength is the length of the line symbol in points (approx. 1/72 inch) that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTickLength in interface IMapGrid
Returns:
The lengthPoints
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickLength

public void setTickLength(double lengthPoints)
                   throws IOException,
                          AutomationException
The length of the major ticks in points.

Description

TickLength is the length of the line symbol in points (approx. 1/72 inch) that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTickLength in interface IMapGrid
Parameters:
lengthPoints - The lengthPoints (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubTickCount

public short getSubTickCount()
                      throws IOException,
                             AutomationException
The number of subticks to draw between the major ticks.

Description

SubTickCount is the number of subticks that will be displayed between the TickLineSymbols. Or, if you optionally use an ICalibratedMapBorder it is the number of times the fill symbol of the calibrated border changes. To use subtick marks, use an ISimpleMapBorder.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubTickCount in interface IMapGrid
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickCount

public void setSubTickCount(short count)
                     throws IOException,
                            AutomationException
The number of subticks to draw between the major ticks.

Description

SubTickCount is the number of subticks that will be displayed between the TickLineSymbols . Or, if you optionally use an ICalibratedMapBorder it is the number of times the fill symbol of the calibrated border changes. To use subtick marks, use an ISimpleMapBorder.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSubTickCount in interface IMapGrid
Parameters:
count - The count (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubTickLineSymbol

public ILineSymbol getSubTickLineSymbol()
                                 throws IOException,
                                        AutomationException
The symbol used to draw the subtick lines.

Description

SubTickLineSymbol is the line symbol used to draw subticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubTickLineSymbol in interface IMapGrid
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickLineSymbol

public void setSubTickLineSymbol(ILineSymbol symbol)
                          throws IOException,
                                 AutomationException
The symbol used to draw the subtick lines.

Description

SubTickLineSymbol is the line symbol used to draw subticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSubTickLineSymbol in interface IMapGrid
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubTickLength

public double getSubTickLength()
                        throws IOException,
                               AutomationException
The length of the subticks in points.

Description

SubTickLength is the length of the subtick marks in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubTickLength in interface IMapGrid
Returns:
The lengthPoints
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickLength

public void setSubTickLength(double lengthPoints)
                      throws IOException,
                             AutomationException
The length of the subticks in points.

Description

SubTickLength is the length of the subtick marks in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSubTickLength in interface IMapGrid
Parameters:
lengthPoints - The lengthPoints (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorder

public IMapGridBorder getBorder()
                         throws IOException,
                                AutomationException
The map grid border.

Description

Border is the border that will be drawn around the map. Note that your LabelOffset will need to accomodate your border's width. There are two types of borders: ICalibratedMapBorder and ISimpleMapBorder.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBorder in interface IMapGrid
Returns:
A reference to a com.esri.arcgis.carto.IMapGridBorder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorder

public void setBorder(IMapGridBorder gridBorder)
               throws IOException,
                      AutomationException
The map grid border.

Description

Border is the border that will be drawn around the map. Note that your LabelOffset will need to accomodate your border's width. There are two types of borders: ICalibratedMapBorder and ISimpleMapBorder .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBorder in interface IMapGrid
Parameters:
gridBorder - A reference to a com.esri.arcgis.carto.IMapGridBorder (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if the map grid is visible.

Description

Visible is whether the MapGrid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isVisible in interface IMapGrid
Specified by:
isVisible in interface IReferenceSystem
Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException
Indicates if the map grid is visible.

Description

Visible is whether the MapGrid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVisible in interface IMapGrid
Specified by:
setVisible in interface IReferenceSystem
Parameters:
visible - The visible (in)
Throws:
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 IOException,
                                 AutomationException
Returns the visibility of the labels along all four sides of the map grid.

Description

QueryLabelVisibility is whether the labels on each of the sides of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                               AutomationException
Sets the visibility of the labels along all four sides of the map grid.

Description

SetLabelVisibility sets whether the labels on each of the sides of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelVisibility in interface IMapGrid
Parameters:
leftVis - The leftVis (in)
topVis - The topVis (in)
rightVis - The rightVis (in)
bottomVis - The bottomVis (in)
Throws:
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 IOException,
                                AutomationException
Returns the visibility of the ticks along all four sides of the map grid.

Description

QueryTickVisibility is whether the ticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                              AutomationException
Sets the visibility of the ticks along all four sides of the map grid.

Description

SetTickVisibility sets whether the ticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTickVisibility in interface IMapGrid
Parameters:
leftVis - The leftVis (in)
topVis - The topVis (in)
rightVis - The rightVis (in)
bottomVis - The bottomVis (in)
Throws:
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 IOException,
                                   AutomationException
Returns the visibility of the subticks along all four sides of the map grid.

Description

QuerySubTickVisibility is whether the subticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                                 AutomationException
Sets the visibility of the subticks along all four sides of the map grid.

Description

SetSubTickVisibility sets whether the subticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSubTickVisibility in interface IMapGrid
Parameters:
leftVis - The leftVis (in)
topVis - The topVis (in)
rightVis - The rightVis (in)
bottomVis - The bottomVis (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaults

public void setDefaults(IMapFrame pMapFrame)
                 throws IOException,
                        AutomationException
Sets the properties of the map grid to default values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generateGraphics

public void generateGraphics(IMapFrame pMapFrame,
                             IGraphicsContainer graphicsContainer)
                      throws IOException,
                             AutomationException
Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                             AutomationException
Prepares the map grid for output to a device.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.display.tagRECT (in)
pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IMapFrame pMapFrame)
          throws IOException,
                 AutomationException
Draws the map grid for a map frame to the given display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExteriorWidth

public double getExteriorWidth(IDisplay pDisplay,
                               IMapFrame pMapFrame)
                        throws IOException,
                               AutomationException
The width (in display units) of the portion of the grid that is outside of the frame.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowGridSquareIdentifiers

public boolean isShowGridSquareIdentifiers()
                                    throws IOException,
                                           AutomationException
Indicates if the square identifiers should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShowGridSquareIdentifiers in interface IMgrsGrid
Returns:
The show
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowGridSquareIdentifiers

public void setShowGridSquareIdentifiers(boolean show)
                                  throws IOException,
                                         AutomationException
Indicates if the square identifiers should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShowGridSquareIdentifiers in interface IMgrsGrid
Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelFont

public Font getGridSquareLabelFont()
                            throws IOException,
                                   AutomationException
The font used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelFont

public void setGridSquareLabelFont(Font font)
                            throws IOException,
                                   AutomationException
The font used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelSize

public double getGridSquareLabelSize()
                              throws IOException,
                                     AutomationException
The font size used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGridSquareLabelSize in interface IMgrsGrid
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelSize

public void setGridSquareLabelSize(double size)
                            throws IOException,
                                   AutomationException
The font size used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGridSquareLabelSize in interface IMgrsGrid
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelColor

public IColor getGridSquareLabelColor()
                               throws IOException,
                                      AutomationException
The color used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGridSquareLabelColor in interface IMgrsGrid
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.

setGridSquareLabelColor

public void setGridSquareLabelColor(IColor color)
                             throws IOException,
                                    AutomationException
The color used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGridSquareLabelColor in interface IMgrsGrid
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.

getGridSquareLabelStyle

public int getGridSquareLabelStyle()
                            throws IOException,
                                   AutomationException
The style used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGridSquareLabelStyle in interface IMgrsGrid
Returns:
A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelStyle

public void setGridSquareLabelStyle(int style)
                             throws IOException,
                                    AutomationException
The style used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGridSquareLabelStyle in interface IMgrsGrid
Parameters:
style - A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridSquareBoundarySymbol

public ILineSymbol getGridSquareBoundarySymbol()
                                        throws IOException,
                                               AutomationException
The line symbol used to display the boundaries of the grid squares.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGridSquareBoundarySymbol in interface IMgrsGrid
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridSquareBoundarySymbol

public void setGridSquareBoundarySymbol(ILineSymbol symbol)
                                 throws IOException,
                                        AutomationException
The line symbol used to display the boundaries of the grid squares.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGridSquareBoundarySymbol in interface IMgrsGrid
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInteriorTickSymbol

public ILineSymbol getInteriorTickSymbol()
                                  throws IOException,
                                         AutomationException
The line symbol used to show interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getInteriorTickSymbol in interface IMgrsGrid
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInteriorTickSymbol

public void setInteriorTickSymbol(ILineSymbol symbol)
                           throws IOException,
                                  AutomationException
The line symbol used to show interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setInteriorTickSymbol in interface IMgrsGrid
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInteriorTickLength

public double getInteriorTickLength()
                             throws IOException,
                                    AutomationException
The length of the interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getInteriorTickLength in interface IMgrsGrid
Returns:
The lengthPts
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInteriorTickLength

public void setInteriorTickLength(double lengthPts)
                           throws IOException,
                                  AutomationException
The length of the interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setInteriorTickLength in interface IMgrsGrid
Parameters:
lengthPts - The lengthPts (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLadderLabels

public boolean isShowLadderLabels()
                           throws IOException,
                                  AutomationException
Indicates if ladder labels should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShowLadderLabels in interface IGridLadderLabels
Returns:
The show
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLadderLabels

public void setShowLadderLabels(boolean show)
                         throws IOException,
                                AutomationException
Indicates if ladder labels should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShowLadderLabels in interface IGridLadderLabels
Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLadderLabelFont

public Font getLadderLabelFont()
                        throws IOException,
                               AutomationException
The fonst used to display ladder labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLadderLabelFont

public void setLadderLabelFont(Font font)
                        throws IOException,
                               AutomationException
The fonst used to display ladder labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLadderLabelSize

public double getLadderLabelSize()
                          throws IOException,
                                 AutomationException
The font size used to display ladder labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLadderLabelSize in interface IGridLadderLabels
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLadderLabelSize

public void setLadderLabelSize(double size)
                        throws IOException,
                               AutomationException
The font size used to display ladder labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLadderLabelSize in interface IGridLadderLabels
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLadderLabelColor

public IColor getLadderLabelColor()
                           throws IOException,
                                  AutomationException
The color of the ladder labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLadderLabelColor in interface IGridLadderLabels
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.

setLadderLabelColor

public void setLadderLabelColor(IColor color)
                         throws IOException,
                                AutomationException
The color of the ladder labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLadderLabelColor in interface IGridLadderLabels
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.

getLadderLabelRowCount

public int getLadderLabelRowCount()
                           throws IOException,
                                  AutomationException
The number of ladder label rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLadderLabelRowCount in interface IGridLadderLabels
Returns:
The rowCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLadderLabelRowCount

public void setLadderLabelRowCount(int rowCount)
                            throws IOException,
                                   AutomationException
The number of ladder label rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLadderLabelRowCount in interface IGridLadderLabels
Parameters:
rowCount - The rowCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLadderLabelColumnCount

public int getLadderLabelColumnCount()
                              throws IOException,
                                     AutomationException
The number of ladder label columns.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLadderLabelColumnCount in interface IGridLadderLabels
Returns:
The columnCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLadderLabelColumnCount

public void setLadderLabelColumnCount(int columnCount)
                               throws IOException,
                                      AutomationException
The number of ladder label columns.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLadderLabelColumnCount in interface IGridLadderLabels
Parameters:
columnCount - The columnCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowOuterLabelsOnly

public boolean isShowOuterLabelsOnly()
                              throws IOException,
                                     AutomationException
Indicates if only the outer ladder labels should be shown.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShowOuterLabelsOnly in interface IGridLadderLabels
Returns:
The show
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowOuterLabelsOnly

public void setShowOuterLabelsOnly(boolean show)
                            throws IOException,
                                   AutomationException
Indicates if only the outer ladder labels should be shown.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShowOuterLabelsOnly in interface IGridLadderLabels
Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
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.

queryBounds

public void queryBounds(IDisplay pDisplay,
                        IMapFrame pMapFrame,
                        IEnvelope bounds)
                 throws IOException,
                        AutomationException
The extent of the reference system in page space.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

boundsChanged

public void boundsChanged()
                   throws IOException,
                          AutomationException
Called when the extent of the parent map frame changes.

Product Availability

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

Specified by:
boundsChanged in interface IReferenceSystem
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