com.esri.arcgis.framework
Class NumberDialog

java.lang.Object
  com.esri.arcgis.framework.NumberDialog

All Implemented Interfaces:

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

public class NumberDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INumberDialog

A dialog used for getting a number.

Remarks

The number dialog is dialog used for getting user input in the form of a number.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

ICoordinateDialog, CoordinateDialog, Serialized Form

Constructor Summary

NumberDialog()
Constructs a NumberDialog using ArcGIS Engine.

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

Method Summary

boolean	doModal(String title, double initialValue, int numDecs, int hWnd) Shows the dialog.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
double	getValue() The number 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

NumberDialog

public NumberDialog()
             throws IOException,
                    UnknownHostException

Constructs a NumberDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NumberDialog

public NumberDialog(Object obj)
             throws IOException

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

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

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

getValue

public double getValue()
                throws IOException,
                       AutomationException

The number value entered in the dialog.

Remarks

The Value property allows you to get the number that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getValue in interface INumberDialog

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 initialValue,
                       int numDecs,
                       int hWnd)
                throws IOException,
                       AutomationException

Shows the dialog.

Description

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

initialValue specifies the intial value to be displayed in the dialog.

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

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

Remarks

If a non-numeric value was 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 INumberDialog

Parameters:

title - The title (in)

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