com.esri.arcgis.systemUI
Interface IMultiItem

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ControlsMapBookmarksMultiItem, IMultiItemProxy, MultiItem, RasterTableShowMultiItem

public interface IMultiItem
extends java.io.Serializable

COM Interface 'IMultiItem'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSystemUI.olb'

Description: 'Provides access to members that define a multiItem.' 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	IIDaf948931_11d1_11d2_94b4_080009eebecb
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getCaption() The caption of the multiItem.
int	getHelpContextID() The help context ID associated with this multiItem.
java.lang.String	getHelpFile() The name of the help file associated with this multiItem.
int	getItemBitmap(int index) The bitmap for the item at the specified index.
java.lang.String	getItemCaption(int index) The caption of the item at the specified index.
java.lang.String	getMessage() The status bar message for all items on the multiItem.
java.lang.String	getName() The name of the multiItem.
boolean	isItemChecked(int index) Indicates if item at the specified index is checked.
boolean	isItemEnabled(int index) Indicates if the item at the specified index is enabled.
void	onItemClick(int index) Occurs when the item at the specified index is clicked.
int	onPopup(java.lang.Object hook) Occurs when the menu that contains the multiItem is about to be displayed.

Field Detail

IIDaf948931_11d1_11d2_94b4_080009eebecb

static final int IIDaf948931_11d1_11d2_94b4_080009eebecb

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the multiItem.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException

The caption of the multiItem.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

java.lang.String getMessage()
                            throws java.io.IOException,
                                   AutomationException

The status bar message for all items on the multiItem.

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException

The name of the help file associated with this multiItem.

Returns:

The helpFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

int getHelpContextID()
                     throws java.io.IOException,
                            AutomationException

The help context ID associated with this multiItem.

Returns:

The iD

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onPopup

int onPopup(java.lang.Object hook)
            throws java.io.IOException,
                   AutomationException

Occurs when the menu that contains the multiItem is about to be displayed.

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

Returns:

The itemCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemCaption

java.lang.String getItemCaption(int index)
                                throws java.io.IOException,
                                       AutomationException

The caption of the item at the specified index.

Parameters:

index - The index (in)

Returns:

The itemName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemBitmap

int getItemBitmap(int index)
                  throws java.io.IOException,
                         AutomationException

The bitmap for the item at the specified index.

Parameters:

index - The index (in)

Returns:

The bitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onItemClick

void onItemClick(int index)
                 throws java.io.IOException,
                        AutomationException

Occurs when the item at the specified index is clicked.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isItemChecked

boolean isItemChecked(int index)
                      throws java.io.IOException,
                             AutomationException

Indicates if item at the specified index is checked.

Parameters:

index - The index (in)

Returns:

The bChecked

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isItemEnabled

boolean isItemEnabled(int index)
                      throws java.io.IOException,
                             AutomationException

Indicates if the item at the specified index is enabled.

Parameters:

index - The index (in)

Returns:

The bEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.