com.esri.arcgis.systemUI
Class IItemDefProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.systemUI.IItemDefProxy

All Implemented Interfaces:

java.io.Externalizable, IItemDef, java.io.Serializable

public class IItemDefProxy

extends Dispatch

implements IItemDef, java.io.Serializable

Provides access to members that define an item on a commandbar.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IItemDefProxy() For internal use only
	IItemDefProxy(java.lang.Object obj)
protected	IItemDefProxy(java.lang.Object obj, java.lang.String iid)
	IItemDefProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IItemDefProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	setGroup(boolean rhs1) Indicates if the defined item should start a group on the menu or toolbar.
void	setID(java.lang.String rhs1) The CLSID or PROGID of the item being defined.
void	setSubType(int rhs1) The subtype of the item being defined.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IItemDefProxy

public IItemDefProxy(java.lang.String CLSID,
                     java.lang.String host,
                     AuthInfo authInfo)
              throws java.net.UnknownHostException,
                     java.io.IOException

IItemDefProxy

public IItemDefProxy()

For internal use only

IItemDefProxy

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

IItemDefProxy

protected IItemDefProxy(java.lang.Object obj,
                        java.lang.String iid)
                 throws java.io.IOException

IItemDefProxy

protected IItemDefProxy(java.lang.String CLSID,
                        java.lang.String iid,
                        java.lang.String host,
                        AuthInfo authInfo)
                 throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

setID

public void setID(java.lang.String rhs1)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IItemDef

The CLSID or PROGID of the item being defined.

Supported Platforms

Windows, Solaris, Linux

Remarks

The ID property is a string representing either the CLSID or ProgID of the coclass for a command or menu. COM coclasses are identified by a globally unique identifier (GUID). The GUID for a coclass is called class ID (CLSID). A ProgID is a text alias for a CLSID; the ProgID is a string composed of the project name and the class name of the coclass.

To find the CLSID, ProgID, and subtype of a built-in command or menu in ArcMap or ArcCatalog, refer to the following technical documents:

ArcObjects Developer Help > Technical Documents > ArcMap: Names and IDs of commands and commandbars

ArcObjects Developer Help > Technical Documents > ArcCatalog: Names and IDs of commands and commandbars

Specified by:

setID in interface IItemDef

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroup

public void setGroup(boolean rhs1)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IItemDef

Indicates if the defined item should start a group on the menu or toolbar.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use True for Group if the item is to be the first item in a group on the toolbar or menu; a separator bar will be placed to the left of the item. Use False, the default, for Group if the item does not start a group.

Specified by:

setGroup in interface IItemDef

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubType

public void setSubType(int rhs1)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IItemDef

The subtype of the item being defined.

Supported Platforms

Windows, Solaris, Linux

Remarks

Some commands are subtyped (i.e. they implement ICommandSubtype). If a class implements both ICommand and ICommandSubtype, then there is more than one command defined in that single class. Each individual command has an identifier known as a subtype. This command class has only one GUID, so in order to get access to each individual command in that class, you need to use the subtypes. That is why IItemDef has both an ID property and a SubType property. You only need to use the SubType property if you are working with a subtyped command.

If the command you want to use is a subtyped command, use the SubType property to specify which subtype of the command you want.

To find the CLSID, ProgID, and subtype of a built-in command in ArcMap or ArcCatalog, refer to the following technical documents:

ArcObjects Developer Help > Technical Documents > ArcMap: Names and IDs of commands and commandbars

ArcObjects Developer Help > Technical Documents > ArcCatalog: Names and IDs of commands and commandbars

Specified by:

setSubType in interface IItemDef

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.