com.esri.arcgis.controls
Class IARCommandInfoProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IARCommandInfoProxy

All Implemented Interfaces:

IARCommandInfo, Externalizable, Serializable

public class IARCommandInfoProxy
extends com.esri.arcgis.interop.Dispatch
implements IARCommandInfo, Serializable

Provides access to members that control the ARCommandInfo.

Description

The IARCommandInfo interface is a starting point for getting properties about the built-in tools.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:

Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IARCommandInfoProxy()
	IARCommandInfoProxy(Object obj)
protected	IARCommandInfoProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getBitmap() The bitmap used as an icon by the command.
String	getCaption() The caption of the command.
String	getCategory() The category the command is associated with.
int	getHelpContextID() The help context ID associated with the command.
String	getHelpFile() The name of the help file associated with the command.
String	getMessage() The message of the command.
String	getName() The name of the command.
String	getTooltip() The tooltip of the command.
boolean	isChecked() Indicates if the command is checked.
boolean	isEnabled() Indicates if the command is enabled.
void	removeListener(String iidStr, Object theListener)

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

noncastable

public boolean noncastable

Constructor Detail

IARCommandInfoProxy

public IARCommandInfoProxy()

IARCommandInfoProxy

public IARCommandInfoProxy(Object obj)
                    throws IOException

Throws:

IOException

IARCommandInfoProxy

protected IARCommandInfoProxy(Object obj,
                              String iid)
                       throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

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

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

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

Throws:

IOException

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the command is enabled.

Description

Indicates the enabled state of the specified ARTool command. Check a tools enabled state before setting it as the IARControl::CurrentARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isEnabled in interface IARCommandInfo

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChecked

public boolean isChecked()
                  throws IOException,
                         AutomationException

Indicates if the command is checked.

Description

Indicates the checked state of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isChecked in interface IARCommandInfo

Returns:

The checked

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the command.

Description

Returns the Name of the specified ARTool command. By convention a command's name should include its Category name and Caption (<Category>_<Caption>).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getName in interface IARCommandInfo

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException

The caption of the command.

Description

Returns the Caption of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCaption in interface IARCommandInfo

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTooltip

public String getTooltip()
                  throws IOException,
                         AutomationException

The tooltip of the command.

Description

Returns the Tooltip of the specified ARTool command.

Remarks

For example, use the Tooltip to set the label caption that appears when the mouse moves over an ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getTooltip in interface IARCommandInfo

Returns:

The tooltip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage()
                  throws IOException,
                         AutomationException

The message of the command.

Description

Returns the Message of the specified ARTool command. For example, use the Message to set the text that appears in a status bar as the mouse moves over an ARTool.

Remarks

For example, use the Message to set the text that appears in a status bar as the mouse moves over an ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getMessage in interface IARCommandInfo

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException

The name of the help file associated with the command.

Description

Returns the HelpFile of the specified ARTool command. This is the name of the help file that contains the context sensitive help topic for the ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getHelpFile in interface IARCommandInfo

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID()
                     throws IOException,
                            AutomationException

The help context ID associated with the command.

Description

Returns the HelpContextID of the specified ARTool command. This is used to specify the mapped numeric value of the topic ID of the context sensitive help topic for the ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getHelpContextID in interface IARCommandInfo

Returns:

The helpContextID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitmap

public int getBitmap()
              throws IOException,
                     AutomationException

The bitmap used as an icon by the command.

Description

Returns the Bitmap handle of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getBitmap in interface IARCommandInfo

Returns:

The bitmap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category the command is associated with.

Description

Returns the Category of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCategory in interface IARCommandInfo

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.