com.esri.arcgis.framework
Class Accelerator

java.lang.Object
  extended by com.esri.arcgis.framework.Accelerator
All Implemented Interfaces:
IAccelerator, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class Accelerator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAccelerator

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

Description 'Accelerator object.' 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.framework.IAccelerator
IID, IID08300de1_27fd_11d2_aa2f_000000000000, xxDummy
 
Constructor Summary
Accelerator(java.lang.Object obj)
          Construct a Accelerator using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void delete()
          Removes this accelerator from the accelerator table.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.Object getCommandID()
          The identifier of the command that this accelerator activates.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getKey()
          The keycode for this accelerator.
 int hashCode()
          the hashcode for this object
 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 release()
          Release a Accelerator.
 void setAlt(boolean bAlt)
          Indicates if the Alt key is pressed for this accelerator.
 void setCommandID(java.lang.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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Accelerator

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

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

Throws:
java.io.IOException - if there are interop problems Accelerator theAccelerator = (Accelerator) 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 Accelerator.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setShift

public void setShift(boolean bShift)
              throws java.io.IOException,
                     AutomationException
Indicates if the Shift key is pressed for this accelerator.

Specified by:
setShift in interface IAccelerator
Parameters:
bShift - The bShift (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShift

public boolean isShift()
                throws java.io.IOException,
                       AutomationException
Indicates if the Shift key is pressed for this accelerator.

Specified by:
isShift in interface IAccelerator
Returns:
The bShift
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlt

public void setAlt(boolean bAlt)
            throws java.io.IOException,
                   AutomationException
Indicates if the Alt key is pressed for this accelerator.

Specified by:
setAlt in interface IAccelerator
Parameters:
bAlt - The bAlt (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAlt

public boolean isAlt()
              throws java.io.IOException,
                     AutomationException
Indicates if the Alt key is pressed for this accelerator.

Specified by:
isAlt in interface IAccelerator
Returns:
The bAlt
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCtrl

public void setCtrl(boolean bCtrl)
             throws java.io.IOException,
                    AutomationException
Indicates if the Ctrl key is pressed for this accelerator.

Specified by:
setCtrl in interface IAccelerator
Parameters:
bCtrl - The bCtrl (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCtrl

public boolean isCtrl()
               throws java.io.IOException,
                      AutomationException
Indicates if the Ctrl key is pressed for this accelerator.

Specified by:
isCtrl in interface IAccelerator
Returns:
The bCtrl
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKey

public void setKey(int keyCode)
            throws java.io.IOException,
                   AutomationException
The keycode for this accelerator.

Specified by:
setKey in interface IAccelerator
Parameters:
keyCode - The keyCode (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKey

public int getKey()
           throws java.io.IOException,
                  AutomationException
The keycode for this accelerator.

Specified by:
getKey in interface IAccelerator
Returns:
The keyCode
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCommandID

public void setCommandID(java.lang.Object cmdID)
                  throws java.io.IOException,
                         AutomationException
The identifier of the command that this accelerator activates.

Specified by:
setCommandID in interface IAccelerator
Parameters:
cmdID - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCommandID

public java.lang.Object getCommandID()
                              throws java.io.IOException,
                                     AutomationException
The identifier of the command that this accelerator activates.

Specified by:
getCommandID in interface IAccelerator
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Removes this accelerator from the accelerator table.

Specified by:
delete in interface IAccelerator
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.