|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.interop.Dispatch com.esri.arcgis.framework.IAcceleratorProxy
public class IAcceleratorProxy
Provides access to members that define an accelerator.
An accelerator is a mapping between a particular keyboard combination and a command. When you press the combination of keys on the keyboard, the command is executed. For example, Ctrl-C is a well-known accelerator for copying something in Windows. Some commands in the application already have accelerators assigned to them but you can also assign additional accelerators to these commands.
Use the IAcceleratorTable::Add method to create an accelerator.
The following example prints the keyboard accelerator assigned to the built-in Copy command. You would get m_app from the hook in ICommand::OnCreate().
IAcceleratorTable.getItem(int)
,
IAcceleratorTable.findByKey(int, boolean, boolean, boolean)
,
IAcceleratorTable.add(java.lang.Object, int, boolean, boolean, boolean)
,
Serialized FormField Summary | |
---|---|
boolean |
noncastable
|
Fields inherited from class com.esri.arcgis.interop.Dispatch |
---|
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef |
Constructor Summary | |
---|---|
|
IAcceleratorProxy()
|
|
IAcceleratorProxy(Object obj)
|
protected |
IAcceleratorProxy(Object obj,
String iid)
|
Method Summary | |
---|---|
void |
addListener(String iidStr,
Object theListener,
Object theSource)
|
void |
delete()
Removes this accelerator from the accelerator table. |
Object |
getCommandID()
The identifier of the command that this accelerator activates. |
int |
getKey()
The keycode for this accelerator. |
boolean |
isAlt()
Indicates if the Alt key is pressed for this accelerator. |
boolean |
isCtrl()
Indicates if the Ctrl key is pressed for this accelerator. |
boolean |
isShift()
Indicates if the Shift key is pressed for this accelerator. |
void |
removeListener(String iidStr,
Object theListener)
|
void |
setAlt(boolean bAlt)
Indicates if the Alt key is pressed for this accelerator. |
void |
setCommandID(Object cmdID)
The identifier of the command that this accelerator activates. |
void |
setCtrl(boolean bCtrl)
Indicates if the Ctrl key is pressed for this accelerator. |
void |
setKey(int keyCode)
The keycode for this accelerator. |
void |
setShift(boolean bShift)
Indicates if the Shift key is pressed for this accelerator. |
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 |
---|
public boolean noncastable
Constructor Detail |
---|
public IAcceleratorProxy()
public IAcceleratorProxy(Object obj) throws IOException
IOException
protected IAcceleratorProxy(Object obj, String iid) throws IOException
IOException
Method Detail |
---|
public void addListener(String iidStr, Object theListener, Object theSource) throws IOException
addListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void removeListener(String iidStr, Object theListener) throws IOException
removeListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void setShift(boolean bShift) throws IOException, AutomationException
setShift
in interface IAccelerator
bShift
- The bShift (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShift() throws IOException, AutomationException
Use True if the Shift key is one of the keys used in the accelerator; otherwise use False.
isShift
in interface IAccelerator
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAlt(boolean bAlt) throws IOException, AutomationException
setAlt
in interface IAccelerator
bAlt
- The bAlt (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAlt() throws IOException, AutomationException
Use True if the Alt key is one of the keys used in the accelerator; otherwise use False.
isAlt
in interface IAccelerator
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCtrl(boolean bCtrl) throws IOException, AutomationException
setCtrl
in interface IAccelerator
bCtrl
- The bCtrl (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCtrl() throws IOException, AutomationException
Use True if the Ctrl key is one of the keys used in the accelerator; otherwise use False.
isCtrl
in interface IAccelerator
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setKey(int keyCode) throws IOException, AutomationException
anAccelerator.Key = vbKeyA
Dim x as Long x = anAccelerator.Key
setKey
in interface IAccelerator
keyCode
- The keyCode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getKey() throws IOException, AutomationException
getKey
in interface IAccelerator
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCommandID(Object cmdID) throws IOException, AutomationException
setCommandID
in interface IAccelerator
cmdID
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getCommandID() throws IOException, AutomationException
value specifies the unique identifier of the command. For built-in commands, use the UID. For VBA macros and UIControls, use a string representing the full name of the command.
getCommandID
in interface IAccelerator
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void delete() throws IOException, AutomationException
delete
in interface IAccelerator
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |