com.esri.arcgis.catalogUI
Class SpatialReferenceDialog

java.lang.Object
  extended by com.esri.arcgis.catalogUI.SpatialReferenceDialog
All Implemented Interfaces:
ISpatialReferenceDialog, ISpatialReferenceDialog2, ISpatialReferenceDialog3, ISpatialReferenceDialogContext, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SpatialReferenceDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISpatialReferenceDialog, ISpatialReferenceDialog2, ISpatialReferenceDialog3, ISpatialReferenceDialogContext

Provides access to the spatial reference dialog.

Remarks

Use ISpatialReferenceDialog2 if you want to individually control which domain and precision (resolution) values (xy, z, or measure) are editable through the DoModelEdit method.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
SpatialReferenceDialog()
          Constructs a SpatialReferenceDialog using ArcGIS Engine.
SpatialReferenceDialog(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SpatialReferenceDialog theSpatialReferenceDialog = (SpatialReferenceDialog) obj;
 
Method Summary
 ISpatialReference doModalCreate(boolean hasXY, boolean hasZ, boolean hasM, int hParent)
          Prompts the user to define a new spatial reference.
 ISpatialReference doModalCreate3(boolean hasZ, int hParent)
          Prompts the user to define a new spatial reference.
 ISpatialReference doModalEdit(ISpatialReference inputSpatialReference, boolean hasXY, boolean hasZ, boolean hasM, boolean coordPageReadOnly, boolean xyDomainPageReadOnly, boolean mDomainPageReadOnly, boolean zDomainPageReadOnly, int hParent)
          Displays/edits the properties of the given spatial reference.
 ISpatialReference doModalEdit(ISpatialReference inputSpatialReference, boolean hasXY, boolean hasZ, boolean hasM, boolean coordPageReadOnly, boolean domainPageReadOnly, int hParent)
          Displays/edits the properties of the given spatial reference.
 ISpatialReference doModalEdit3(ISpatialReference inputSpatialReference, boolean hasZ, int hParent)
          Displays/edits the properties of the given spatial reference.
 boolean equals(Object o)
          Compare this object with another
 IBasicMap getBasicMap()
          The basic map that provides the layer list and spatial filtering extent.
static String getClsid()
          getClsid.
 int getXYFilter()
          Restriction on the type of coordinate system to show.
 int hashCode()
          the hashcode for this object
 void setBasicMapByRef(IBasicMap basicMap)
          The basic map that provides the layer list and spatial filtering extent.
 void setXYFilter(int filter)
          Restriction on the type of coordinate system to show.
 
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

SpatialReferenceDialog

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

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

SpatialReferenceDialog

public SpatialReferenceDialog(Object obj)
                       throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SpatialReferenceDialog theSpatialReferenceDialog = (SpatialReferenceDialog) obj;

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

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

doModalCreate

public ISpatialReference doModalCreate(boolean hasXY,
                                       boolean hasZ,
                                       boolean hasM,
                                       int hParent)
                                throws IOException,
                                       AutomationException
Prompts the user to define a new spatial reference.

Remarks

Set the hasXY, hasZ, and hasM parameters to True if you want to be able to define the domain and precision (resolution) values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
doModalCreate in interface ISpatialReferenceDialog
Specified by:
doModalCreate in interface ISpatialReferenceDialog2
Parameters:
hasXY - The hasXY (in)
hasZ - The hasZ (in)
hasM - The hasM (in)
hParent - The hParent (A COM typedef) (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doModalEdit

public ISpatialReference doModalEdit(ISpatialReference inputSpatialReference,
                                     boolean hasXY,
                                     boolean hasZ,
                                     boolean hasM,
                                     boolean coordPageReadOnly,
                                     boolean domainPageReadOnly,
                                     int hParent)
                              throws IOException,
                                     AutomationException
Displays/edits the properties of the given spatial reference.

Remarks

If the coordPageReadOnly parameter is True, the user cannot edit the coordinate system information. Set the hasXY, hasZ, or hasM parameters to True if you wish to display or edit the domain and precision (resolution) values. If the domainPageReadOnly parameter is True, you cannot edit the domain and precision (resolution) values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
doModalEdit in interface ISpatialReferenceDialog
Parameters:
inputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
hasXY - The hasXY (in)
hasZ - The hasZ (in)
hasM - The hasM (in)
coordPageReadOnly - The coordPageReadOnly (in)
domainPageReadOnly - The domainPageReadOnly (in)
hParent - The hParent (A COM typedef) (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doModalEdit

public ISpatialReference doModalEdit(ISpatialReference inputSpatialReference,
                                     boolean hasXY,
                                     boolean hasZ,
                                     boolean hasM,
                                     boolean coordPageReadOnly,
                                     boolean xyDomainPageReadOnly,
                                     boolean mDomainPageReadOnly,
                                     boolean zDomainPageReadOnly,
                                     int hParent)
                              throws IOException,
                                     AutomationException
Displays/edits the properties of the given spatial reference.

Description

Provides access to the XY, Z, and measure domain pages properties.

Remarks

If the coordPageReadOnly parameter is True, the user cannot edit the coordinate system information. Set the hasXY, hasZ, or hasM parameters to True if you wish to display or edit the domain and precision (resolution) values. If the xyDomainPageReadOnly, mDomainPageReadOnly, or zDomainPageReadOnly parameters are True, you cannot edit the corresponding domain and precision (resolution) values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
doModalEdit in interface ISpatialReferenceDialog2
Parameters:
inputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
hasXY - The hasXY (in)
hasZ - The hasZ (in)
hasM - The hasM (in)
coordPageReadOnly - The coordPageReadOnly (in)
xyDomainPageReadOnly - The xyDomainPageReadOnly (in)
mDomainPageReadOnly - The mDomainPageReadOnly (in)
zDomainPageReadOnly - The zDomainPageReadOnly (in)
hParent - The hParent (A COM typedef) (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doModalCreate3

public ISpatialReference doModalCreate3(boolean hasZ,
                                        int hParent)
                                 throws IOException,
                                        AutomationException
Prompts the user to define a new spatial reference.

Remarks

This method is not implemented.

Product Availability

Available with ArcGIS Desktop.

Specified by:
doModalCreate3 in interface ISpatialReferenceDialog3
Parameters:
hasZ - The hasZ (in)
hParent - The hParent (A COM typedef) (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doModalEdit3

public ISpatialReference doModalEdit3(ISpatialReference inputSpatialReference,
                                      boolean hasZ,
                                      int hParent)
                               throws IOException,
                                      AutomationException
Displays/edits the properties of the given spatial reference.

Product Availability

Available with ArcGIS Desktop.

Specified by:
doModalEdit3 in interface ISpatialReferenceDialog3
Parameters:
inputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
hasZ - The hasZ (in)
hParent - The hParent (A COM typedef) (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBasicMap

public IBasicMap getBasicMap()
                      throws IOException,
                             AutomationException
The basic map that provides the layer list and spatial filtering extent.

Product Availability

Available with ArcGIS Desktop.

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

setBasicMapByRef

public void setBasicMapByRef(IBasicMap basicMap)
                      throws IOException,
                             AutomationException
The basic map that provides the layer list and spatial filtering extent.

Product Availability

Available with ArcGIS Desktop.

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

getXYFilter

public int getXYFilter()
                throws IOException,
                       AutomationException
Restriction on the type of coordinate system to show.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getXYFilter in interface ISpatialReferenceDialogContext
Returns:
A com.esri.arcgis.catalogUI.esriSpatialReferenceXYFilter constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXYFilter

public void setXYFilter(int filter)
                 throws IOException,
                        AutomationException
Restriction on the type of coordinate system to show.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setXYFilter in interface ISpatialReferenceDialogContext
Parameters:
filter - A com.esri.arcgis.catalogUI.esriSpatialReferenceXYFilter constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.