com.esri.arcgis.framework
Class CoordinateDialog

java.lang.Object
  extended by com.esri.arcgis.framework.CoordinateDialog
All Implemented Interfaces:
ICoordinateDialog, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CoordinateDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICoordinateDialog

A dialog used for getting coordinates.

Remarks

The coordinate dialog is a dialog used for getting user input in the form of X and Y coordinates.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
NumberDialog, INumberDialog, Serialized Form

Constructor Summary
CoordinateDialog()
          Constructs a CoordinateDialog using ArcGIS Engine.
CoordinateDialog(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CoordinateDialog theCoordinateDialog = (CoordinateDialog) obj;
 
Method Summary
 boolean doModal(String title, double initialX, double initialY, int numDecs, int hWnd)
          Shows the dialog.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 double getX()
          The X value entered in the dialog.
 double getY()
          The Y value entered in the dialog.
 int hashCode()
          the hashcode for this object
 
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

CoordinateDialog

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

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

CoordinateDialog

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

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

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

getX

public double getX()
            throws IOException,
                   AutomationException
The X value entered in the dialog.

Remarks

The X property allows you to get the X value that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getX in interface ICoordinateDialog
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getY

public double getY()
            throws IOException,
                   AutomationException
The Y value entered in the dialog.

Remarks

The Y property allows you to get the Y value that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getY in interface ICoordinateDialog
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(String title,
                       double initialX,
                       double initialY,
                       int numDecs,
                       int hWnd)
                throws IOException,
                       AutomationException
Shows the dialog.

Description

Title is a string that specifies the title of the dialog.

initialX specifies the intial value of X to be displayed in the dialog.

initialY specifies the intial value of Y to be displayed in the dialog.

numDecs specifies the number of decimal places to be used for the values.

hWnd specifies the window handle of the parent window. In most cases this will be the hWnd of the application.

Remarks

If non-numeric values were entered or if the dialog was cancelled, the DoModal method returns False.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
doModal in interface ICoordinateDialog
Parameters:
title - The title (in)
initialX - The initialX (in)
initialY - The initialY (in)
numDecs - The numDecs (in)
hWnd - The hWnd (A COM typedef) (in)
Returns:
The okPressed
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.