com.esri.arcgis.framework
Interface IListDialog

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IListDialogProxy, ListDialog

public interface IListDialog
extends java.io.Serializable

COM Interface 'IListDialog'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that work with a dialog for displaying a list.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID5f399a16_0b7d_11d2_8c1e_0000f8774f55
static int	xxDummy Deprecated. Internal use only

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.
int	getChoice() The index of the string chosen (use after calling DoModal).

Field Detail

IID5f399a16_0b7d_11d2_8c1e_0000f8774f55

static final int IID5f399a16_0b7d_11d2_8c1e_0000f8774f55

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

addString

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.

Parameters:

choice - The choice (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChoice

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.

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doModal

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.

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.