com.esri.arcgis.controls
Interface ICommandPoolEdit

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CommandPool, ICommandPoolEditProxy

public interface ICommandPoolEdit
extends java.io.Serializable

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

Description: 'Provides access to members that control 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	IIDcbb44409_c9b4_400b_be35_446516674392
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addCommand(ICommand command, IUID pUID) Adds the specified command to the command pool.
IArray	addUID(IUID uID) Adds the given UID to the command pool and returns an array of command objects.
void	callOnCreate(ICommand pCommand) Calls the specified command OnCreate method if the Hook is set and OnCreate has not already been called.
java.lang.Object	getHook() The object that is passed as a hook to the OnCreate method on the command.
void	remove(ICommand command) Decrements the usage count of the command.
void	removeAll() Removes all commands from the command pool, regardless of each commands usage count.
void	setHook(java.lang.Object pHook) Sets the object that is passed as a hook to the OnCreate method on the command.

Field Detail

IIDcbb44409_c9b4_400b_be35_446516674392

static final int IIDcbb44409_c9b4_400b_be35_446516674392

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

addCommand

void addCommand(ICommand command,
                IUID pUID)
                throws java.io.IOException,
                       AutomationException

Adds the specified command to the command pool. If the command already exists its usage count incremented by 1.

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addUID

IArray addUID(IUID uID)
              throws java.io.IOException,
                     AutomationException

Adds the given UID to the command pool and returns an array of command objects.

Parameters:

uID - A reference to a com.esri.arcgis.system.IUID (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.

remove

void remove(ICommand command)
            throws java.io.IOException,
                   AutomationException

Decrements the usage count of the command. If this reaches zero the command is removed from the command pool.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws java.io.IOException,
                      AutomationException

Removes all commands from the command pool, regardless of each commands usage count.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

callOnCreate

void callOnCreate(ICommand pCommand)
                  throws java.io.IOException,
                         AutomationException

Calls the specified command OnCreate method if the Hook is set and OnCreate has not already been called.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHook

void setHook(java.lang.Object pHook)
             throws java.io.IOException,
                    AutomationException

Sets the object that is passed as a hook to the OnCreate method on the command.

Parameters:

pHook - A reference to another Automation Object (IDispatch) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHook

java.lang.Object getHook()
                         throws java.io.IOException,
                                AutomationException

The object that is passed as a hook to the OnCreate method on the command.

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.