com.esri.arcgis.framework
Class MultiItem

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

All Implemented Interfaces:

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

public class MultiItem
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMultiItem

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

Description 'MultiItem CoType.' 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.systemUI.IMultiItem

IID, IIDaf948931_11d1_11d2_94b4_080009eebecb, xxDummy

Constructor Summary

MultiItem(java.lang.Object obj)
Construct a MultiItem using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMessage() The status bar message for all items on the multiItem.
java.lang.String	getName() The name of the multiItem.
int	hashCode() the hashcode for this object
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.
void	release() Release a MultiItem.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiItem

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

Construct a MultiItem using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MultiItem.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
MultiItem o = (MultiItem)obj; // will not work

MultiItem o = new MultiItem(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems MultiItem theMultiItem = (MultiItem) obj;

Method Detail

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 MultiItem.

Specified by:

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

getName

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

The name of the multiItem.

Specified by:

getName in interface IMultiItem

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

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

The caption of the multiItem.

Specified by:

getCaption in interface IMultiItem

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

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

The status bar message for all items on the multiItem.

Specified by:

getMessage in interface IMultiItem

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

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

The name of the help file associated with this multiItem.

Specified by:

getHelpFile in interface IMultiItem

Returns:

The helpFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

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

The help context ID associated with this multiItem.

Specified by:

getHelpContextID in interface IMultiItem

Returns:

The iD

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onPopup

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

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

Specified by:

onPopup in interface IMultiItem

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

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

The caption of the item at the specified index.

Specified by:

getItemCaption in interface IMultiItem

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

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

The bitmap for the item at the specified index.

Specified by:

getItemBitmap in interface IMultiItem

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

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

Occurs when the item at the specified index is clicked.

Specified by:

onItemClick in interface IMultiItem

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isItemChecked

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

Indicates if item at the specified index is checked.

Specified by:

isItemChecked in interface IMultiItem

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

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

Indicates if the item at the specified index is enabled.

Specified by:

isItemEnabled in interface IMultiItem

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.