com.esri.arcgis.cartoUI
Class MapGridWizard

java.lang.Object
  com.esri.arcgis.cartoUI.MapGridWizard

All Implemented Interfaces:

IMapGridWizard, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MapGridWizard
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapGridWizard

Map grid wizard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

MapGridWizard()
Constructs a MapGridWizard using ArcGIS Engine.

MapGridWizard(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapGridWizard theMapGridWizard = (MapGridWizard) obj;

Method Summary

boolean	doModal(int parentHWnd) Shows the map grid wizard.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IElement	getGraphicElement() The generated graphic element, if any (valid after calling DoModal).
IMapGrid	getMapGrid() The specified grid (valid after calling DoModal).
int	hashCode() the hashcode for this object
void	setInitialGrid(IMapGrid rhs1) The initial map grid (optional).
void	setMapFrameByRef(IMapFrame rhs1) The map frame the grid will be added to.
void	setPageLayoutByRef(IPageLayout rhs1) The page layout containing the map frame.

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

MapGridWizard

public MapGridWizard()
              throws IOException,
                     UnknownHostException

Constructs a MapGridWizard using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MapGridWizard

public MapGridWizard(Object obj)
              throws IOException

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

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

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

setMapFrameByRef

public void setMapFrameByRef(IMapFrame rhs1)
                      throws IOException,
                             AutomationException

The map frame the grid will be added to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setMapFrameByRef in interface IMapGridWizard

Parameters:

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

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout rhs1)
                        throws IOException,
                               AutomationException

The page layout containing the map frame.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setPageLayoutByRef in interface IMapGridWizard

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitialGrid

public void setInitialGrid(IMapGrid rhs1)
                    throws IOException,
                           AutomationException

The initial map grid (optional).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setInitialGrid in interface IMapGridWizard

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IMapGrid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapGrid

public IMapGrid getMapGrid()
                    throws IOException,
                           AutomationException

The specified grid (valid after calling DoModal).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMapGrid in interface IMapGridWizard

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGraphicElement

public IElement getGraphicElement()
                           throws IOException,
                                  AutomationException

The generated graphic element, if any (valid after calling DoModal).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getGraphicElement in interface IMapGridWizard

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(int parentHWnd)
                throws IOException,
                       AutomationException

Shows the map grid wizard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModal in interface IMapGridWizard

Parameters:

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

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.