com.esri.arcgis.controls
Interface ICommandPool

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ICommandPool2

All Known Implementing Classes:

CommandPool, ICommandPool2Proxy, ICommandPoolProxy

public interface ICommandPool
extends java.io.Serializable

COM Interface 'ICommandPool'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to the contents of the command pool.' 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	IID85490941_3a6a_47c4_8e42_7f6997534ddf
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	created(ICommand command) Indicates if the commands OnCreate method has been called.
boolean	exists(ICommand command) Indicates if the given command exists in the command pool.
ICommand	findByUID(IUID uID) Searches the command pool for the given UID.
ICommand	getCommand(int index) The command at the given index.
int	getCount() The number of commands in the command pool.
IUID	getUID(ICommand command) The UID of the given command.
int	getUsageCount(ICommand command) The number of items using the given command.

Field Detail

IID85490941_3a6a_47c4_8e42_7f6997534ddf

static final int IID85490941_3a6a_47c4_8e42_7f6997534ddf

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 number of commands in the command pool.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUsageCount

int getUsageCount(ICommand command)
                  throws java.io.IOException,
                         AutomationException

The number of items using the given command.

Parameters:

command - A reference to a com.esri.arcgis.systemUI.ICommand (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exists

boolean exists(ICommand command)
               throws java.io.IOException,
                      AutomationException

Indicates if the given command exists in the command pool.

Parameters:

command - A reference to a com.esri.arcgis.systemUI.ICommand (in)

Returns:

The res

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findByUID

ICommand findByUID(IUID uID)
                   throws java.io.IOException,
                          AutomationException

Searches the command pool for the given UID. Returns matching command if the UID is found or nothing.

Parameters:

uID - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

A reference to a com.esri.arcgis.systemUI.ICommand

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUID

IUID getUID(ICommand command)
            throws java.io.IOException,
                   AutomationException

The UID of the given command. May return nothing.

Parameters:

command - A reference to a com.esri.arcgis.systemUI.ICommand (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCommand

ICommand getCommand(int index)
                    throws java.io.IOException,
                           AutomationException

The command at the given index.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.systemUI.ICommand

Throws:

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

AutomationException - If the ArcObject component throws an exception.

created

boolean created(ICommand command)
                throws java.io.IOException,
                       AutomationException

Indicates if the commands OnCreate method has been called.

Parameters:

command - A reference to a com.esri.arcgis.systemUI.ICommand (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.