com.esri.arcgis.framework
Class ICommandItemProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.framework.ICommandItemProxy

All Implemented Interfaces:

ICommandItem, java.io.Externalizable, java.io.Serializable

public class ICommandItemProxy
extends com.esri.arcgis.interop.Dispatch
implements ICommandItem, java.io.Serializable

Internal use class Proxy for COM Interface 'ICommandItem'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that define a command item.' 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

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IID423b7723_b858_11d1_947b_080009eebecb

Constructor Summary

	ICommandItemProxy() For internal use only
	ICommandItemProxy(java.lang.Object obj)
protected	ICommandItemProxy(java.lang.Object obj, java.lang.String iid)
	ICommandItemProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	ICommandItemProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	delete() Removes this object from the commandbar.
void	execute() Causes the command to execute.
java.lang.String	getAction() The name of the VBA macro this command should run when pressed.
java.lang.String	getCaption() The caption of this command item.
java.lang.String	getCategory() The name of the category with which this command item is associated.
ICommand	getCommand() A reference to the internal command object.
java.lang.Object	getFaceID() The bitmap that is used as the icon on this command item.
int	getHelpContextID() The help context ID associated with this command item.
java.lang.String	getHelpFile() The help file associated with this command item.
IUID	getID() The unique integer ID associated with this command item.
int	getIndex() The positional index of this command item within its menu or toolbar.
java.lang.String	getMessage() The status bar message for this command item.
java.lang.String	getName() The name of this command item.
ICommandBar	getParent() The menu or toolbar that this command item currently resides on.
int	getStyle() The display style of this command item.
java.lang.String	getTag() The tag for this command item.
java.lang.String	getTooltip() The tooltip for this command item.
int	getType() The type of this command item.
boolean	isBuiltIn() Indicates whether this command item is built-in or if it was implemented through VBA.
boolean	isGroup() Indicates if this command item begins a menu or toolbar group.
void	refresh() Causes the command to be redrawn.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	reset() Restores this command item's properties to that of the original.
void	setAction(java.lang.String macro) The name of the VBA macro this command should run when pressed.
void	setCaption(java.lang.String name) The caption of this command item.
void	setFaceID(java.lang.Object faceID) The bitmap that is used as the icon on this command item.
void	setGroup(boolean group) Indicates if this command item begins a menu or toolbar group.
void	setHelpContextID(int contextID) The help context ID associated with this command item.
void	setHelpFile(java.lang.String helpFile) The help file associated with this command item.
void	setMessage(java.lang.String message) The status bar message for this command item.
void	setName(java.lang.String name) The name of this command item.
void	setStyle(int style) The display style of this command item.
void	setTag(java.lang.String tag) The tag for this command item.
void	setTooltip(java.lang.String tooltip) The tooltip for this command item.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

ICommandItemProxy

public ICommandItemProxy(java.lang.String CLSID,
                         java.lang.String host,
                         com.esri.arcgis.interop.AuthInfo authInfo)
                  throws java.net.UnknownHostException,
                         java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

ICommandItemProxy

public ICommandItemProxy()

For internal use only

ICommandItemProxy

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

Throws:

java.io.IOException

ICommandItemProxy

protected ICommandItemProxy(java.lang.Object obj,
                            java.lang.String iid)
                     throws java.io.IOException

Throws:

java.io.IOException

ICommandItemProxy

protected ICommandItemProxy(java.lang.String CLSID,
                            java.lang.String iid,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getAction

public java.lang.String getAction()
                           throws java.io.IOException,
                                  AutomationException

The name of the VBA macro this command should run when pressed.

Specified by:

getAction in interface ICommandItem

Returns:

The macro

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAction

public void setAction(java.lang.String macro)
               throws java.io.IOException,
                      AutomationException

The name of the VBA macro this command should run when pressed.

Specified by:

setAction in interface ICommandItem

Parameters:

macro - The macro (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBuiltIn

public boolean isBuiltIn()
                  throws java.io.IOException,
                         AutomationException

Indicates whether this command item is built-in or if it was implemented through VBA.

Specified by:

isBuiltIn in interface ICommandItem

Returns:

The builtIn

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

The name of the category with which this command item is associated.

Specified by:

getCategory in interface ICommandItem

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCommand

public ICommand getCommand()
                    throws java.io.IOException,
                           AutomationException

A reference to the internal command object.

Specified by:

getCommand in interface ICommandItem

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.

delete

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

Removes this object from the commandbar.

Specified by:

delete in interface ICommandItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFaceID

public void setFaceID(java.lang.Object faceID)
               throws java.io.IOException,
                      AutomationException

The bitmap that is used as the icon on this command item.

Specified by:

setFaceID in interface ICommandItem

Parameters:

faceID - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFaceID

public java.lang.Object getFaceID()
                           throws java.io.IOException,
                                  AutomationException

The bitmap that is used as the icon on this command item.

Specified by:

getFaceID in interface ICommandItem

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroup

public void setGroup(boolean group)
              throws java.io.IOException,
                     AutomationException

Indicates if this command item begins a menu or toolbar group.

Specified by:

setGroup in interface ICommandItem

Parameters:

group - The group (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGroup

public boolean isGroup()
                throws java.io.IOException,
                       AutomationException

Indicates if this command item begins a menu or toolbar group.

Specified by:

isGroup in interface ICommandItem

Returns:

The group

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException

The help file associated with this command item.

Specified by:

getHelpFile in interface ICommandItem

Returns:

The helpFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpFile

public void setHelpFile(java.lang.String helpFile)
                 throws java.io.IOException,
                        AutomationException

The help file associated with this command item.

Specified by:

setHelpFile in interface ICommandItem

Parameters:

helpFile - The helpFile (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

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

The help context ID associated with this command item.

Specified by:

getHelpContextID in interface ICommandItem

Returns:

The contextID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpContextID

public void setHelpContextID(int contextID)
                      throws java.io.IOException,
                             AutomationException

The help context ID associated with this command item.

Specified by:

setHelpContextID in interface ICommandItem

Parameters:

contextID - The contextID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

public IUID getID()
           throws java.io.IOException,
                  AutomationException

The unique integer ID associated with this command item.

Specified by:

getID in interface ICommandItem

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.

getIndex

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

The positional index of this command item within its menu or toolbar.

Specified by:

getIndex in interface ICommandItem

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of this command item.

Specified by:

getName in interface ICommandItem

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of this command item.

Specified by:

setName in interface ICommandItem

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCaption

public void setCaption(java.lang.String name)
                throws java.io.IOException,
                       AutomationException

The caption of this command item.

Specified by:

setCaption in interface ICommandItem

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

public java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException

The caption of this command item.

Specified by:

getCaption in interface ICommandItem

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParent

public ICommandBar getParent()
                      throws java.io.IOException,
                             AutomationException

The menu or toolbar that this command item currently resides on.

Specified by:

getParent in interface ICommandItem

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Restores this command item's properties to that of the original.

Specified by:

reset in interface ICommandItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyle

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

The display style of this command item.

Specified by:

getStyle in interface ICommandItem

Returns:

A com.esri.arcgis.systemUI.esriCommandStyles constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStyle

public void setStyle(int style)
              throws java.io.IOException,
                     AutomationException

The display style of this command item.

Specified by:

setStyle in interface ICommandItem

Parameters:

style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTag

public java.lang.String getTag()
                        throws java.io.IOException,
                               AutomationException

The tag for this command item.

Specified by:

getTag in interface ICommandItem

Returns:

The tag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTag

public void setTag(java.lang.String tag)
            throws java.io.IOException,
                   AutomationException

The tag for this command item.

Specified by:

setTag in interface ICommandItem

Parameters:

tag - The tag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTooltip

public java.lang.String getTooltip()
                            throws java.io.IOException,
                                   AutomationException

The tooltip for this command item.

Specified by:

getTooltip in interface ICommandItem

Returns:

The tooltip

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTooltip

public void setTooltip(java.lang.String tooltip)
                throws java.io.IOException,
                       AutomationException

The tooltip for this command item.

Specified by:

setTooltip in interface ICommandItem

Parameters:

tooltip - The tooltip (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of this command item.

Specified by:

getType in interface ICommandItem

Returns:

A com.esri.arcgis.framework.esriCommandTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

public java.lang.String getMessage()
                            throws java.io.IOException,
                                   AutomationException

The status bar message for this command item.

Specified by:

getMessage in interface ICommandItem

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMessage

public void setMessage(java.lang.String message)
                throws java.io.IOException,
                       AutomationException

The status bar message for this command item.

Specified by:

setMessage in interface ICommandItem

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

execute

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

Causes the command to execute.

Specified by:

execute in interface ICommandItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

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

Causes the command to be redrawn.

Specified by:

refresh in interface ICommandItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.