com.esri.arcgis.system
Class IExtensionAcceleratorsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.system.IExtensionAcceleratorsProxy

All Implemented Interfaces:

IExtensionAccelerators, Externalizable, Serializable

public class IExtensionAcceleratorsProxy
extends com.esri.arcgis.interop.Dispatch
implements IExtensionAccelerators, Serializable

Provides access to a method that creates extension accelerators.

Description

IExtensionAccelerators is implemented by extensions to define keyboard accelerators. This interface is not normally called from client code

Remarks

The CreateAccelerators method creates the accelerators for the extension. This method is called when the accelerator table is created during application startup, when a new document is created, or when a document is opened.

When To Use

If you want any of the commands in your extension to have keyboard accelerators associated with them, your extension needs to implement IExtensionAccelerators. In your class module for your extension you would implement both IExtension and IExtensionAccelerators.

Product Availability

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

See Also:

IAccelerator, IExtension, IAcceleratorTable, Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IExtensionAcceleratorsProxy()
	IExtensionAcceleratorsProxy(Object obj)
protected	IExtensionAcceleratorsProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	createAccelerators() Called to create the keyboard accelerators for this extension.
void	removeListener(String iidStr, Object theListener)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IExtensionAcceleratorsProxy

public IExtensionAcceleratorsProxy()

IExtensionAcceleratorsProxy

public IExtensionAcceleratorsProxy(Object obj)
                            throws IOException

Throws:

IOException

IExtensionAcceleratorsProxy

protected IExtensionAcceleratorsProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

createAccelerators

public void createAccelerators()
                        throws IOException,
                               AutomationException

Called to create the keyboard accelerators for this extension.

Remarks

The CreateAccelerators method creates the accelerators for the extension. This method is called when the accelerator table is created during application startup, when a new document is created, or when a document is opened.

When you use the CreateAccelerators method to assign an accelerator to one of the commands in your extension, you should check to make sure that no other command is currently using the key combination that you want to use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createAccelerators in interface IExtensionAccelerators

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IAccelerator, IAcceleratorTable