com.esri.arcgis.framework
Interface IAcceleratorTable

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AcceleratorTable, IAcceleratorTableProxy

public interface IAcceleratorTable
extends java.io.Serializable

COM Interface 'IAcceleratorTable'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that modify the accelerator table.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID08300de2_27fd_11d2_aa2f_000000000000
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	add(java.lang.Object iD, int key, boolean bCtrl, boolean bAlt, boolean bShift) Adds a new accelerator to the accelerator table.
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.
int	getCount() The count of accelerator items in the table.
IAccelerator	getItem(int index) The accelerator object at the specified index.

Field Detail

IID08300de2_27fd_11d2_aa2f_000000000000

static final int IID08300de2_27fd_11d2_aa2f_000000000000

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getCount

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

The count of accelerator items in the table.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItem

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

The accelerator object at the specified index.

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

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.

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

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

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

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

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.

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.