com.esri.arcgis.framework
Class AcceleratorTable

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

All Implemented Interfaces:

IAcceleratorTable, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class AcceleratorTable
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAcceleratorTable, IPersist, IPersistStream, java.io.Externalizable

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

Description 'Accelerator Table 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.framework.IAcceleratorTable

IID, IID08300de2_27fd_11d2_aa2f_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

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

Method Summary

boolean	add(java.lang.Object iD, int key, boolean bCtrl, boolean bAlt, boolean bShift) Adds a new accelerator to the accelerator table.
boolean	equals(java.lang.Object o) Compare this object with another
IArray	find(java.lang.Object iD) Finds the accelerator object/s currently associated with the specified command ID.
IAccelerator	findByKey(int key, boolean bCtrl, boolean bAlt, boolean bShift) Finds the accelerator object associated with the specified key combination.
void	getClassID(GUID[] pClassID) getClassID
int	getCount() The count of accelerator items in the table.
IAccelerator	getItem(int index) The accelerator object at the specified index.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a AcceleratorTable.
void	save(IStream pstm, int fClearDirty) save
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AcceleratorTable

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

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

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

Throws:

java.io.IOException - if there are interop problems AcceleratorTable theAcceleratorTable = (AcceleratorTable) 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 AcceleratorTable.

Specified by:

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

getCount

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

The count of accelerator items in the table.

Specified by:

getCount in interface IAcceleratorTable

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItem

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

The accelerator object at the specified index.

Specified by:

getItem in interface IAcceleratorTable

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.framework.IAccelerator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public boolean add(java.lang.Object iD,
                   int key,
                   boolean bCtrl,
                   boolean bAlt,
                   boolean bShift)
            throws java.io.IOException,
                   AutomationException

Adds a new accelerator to the accelerator table.

Specified by:

add in interface IAcceleratorTable

Parameters:

iD - A Variant (in)

key - The key (in)

bCtrl - The bCtrl (in, optional, pass false if not required)

bAlt - The bAlt (in, optional, pass false if not required)

bShift - The bShift (in, optional, pass false if not required)

Returns:

The bSucceeded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

public IArray find(java.lang.Object iD)
            throws java.io.IOException,
                   AutomationException

Finds the accelerator object/s currently associated with the specified command ID.

Specified by:

find in interface IAcceleratorTable

Parameters:

iD - A Variant (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findByKey

public IAccelerator findByKey(int key,
                              boolean bCtrl,
                              boolean bAlt,
                              boolean bShift)
                       throws java.io.IOException,
                              AutomationException

Finds the accelerator object associated with the specified key combination.

Specified by:

findByKey in interface IAcceleratorTable

Parameters:

key - The key (in)

bCtrl - The bCtrl (in, optional, pass false if not required)

bAlt - The bAlt (in, optional, pass false if not required)

bShift - The bShift (in, optional, pass false if not required)

Returns:

A reference to a com.esri.arcgis.framework.IAccelerator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException