com.esri.arcgis.framework
Class ListDialog

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

All Implemented Interfaces:

IListDialog, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ListDialog
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IListDialog

COM Class 'ListDialog'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description 'List Dialog object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.framework.IListDialog

IID, IID5f399a16_0b7d_11d2_8c1e_0000f8774f55, xxDummy

Constructor Summary

ListDialog()
Constructs a ListDialog using ArcGIS Engine.

ListDialog(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ListDialog theListDialog = (ListDialog) obj;

Method Summary

void	addString(java.lang.String choice) Adds a string to the list that the dialog will show.
boolean	doModal(java.lang.String title, int initialChoice, int hWnd) Displays the list dialog and lets the user select a choice.
boolean	equals(java.lang.Object o) Compare this object with another
int	getChoice() The index of the string chosen (use after calling DoModal).
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
void	release() Release a ListDialog.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListDialog

public ListDialog()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a ListDialog using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ListDialog

public ListDialog(java.lang.Object obj)
           throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ListDialog.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

addString

public void addString(java.lang.String choice)
               throws java.io.IOException,
                      AutomationException

Adds a string to the list that the dialog will show. These strings will be sorted in alphabetical order.

Specified by:

addString in interface IListDialog

Parameters:

choice - The choice (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChoice

public int getChoice()
              throws java.io.IOException,
                     AutomationException

The index of the string chosen (use after calling DoModal). Strings are numbered starting at 0 in the order that they were added, not the order that they appear in the dialog.

Specified by:

getChoice in interface IListDialog

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(java.lang.String title,
                       int initialChoice,
                       int hWnd)
                throws java.io.IOException,
                       AutomationException

Displays the list dialog and lets the user select a choice. Returns false if the user hits the cancel button.

Specified by:

doModal in interface IListDialog

Parameters:

title - The title (in)

initialChoice - The initialChoice (in)

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

Returns:

The pOK

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.