com.esri.arcgis.controls
Class ARCommandInfo

java.lang.Object
  com.esri.arcgis.controls.ARCommandInfo

All Implemented Interfaces:

IARCommandInfo, java.io.Serializable

public class ARCommandInfo

extends java.lang.Object

implements IARCommandInfo

ARCommandInfo object.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Constructor Summary

ARCommandInfo(java.lang.Object obj)
Construct a ARCommandInfo using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IARCommandInfo	getAsIARCommandInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
int	getBitmap() The bitmap used as an icon by the command.
java.lang.String	getCaption() The caption of the command.
java.lang.String	getCategory() The category the command is associated with.
int	getHelpContextID() The help context ID associated with the command.
java.lang.String	getHelpFile() The name of the help file associated with the command.
java.lang.String	getMessage() The message of the command.
java.lang.String	getName() The name of the command.
java.lang.String	getTooltip() The tooltip of the command.
int	hashCode() the hashcode for this object
boolean	isChecked() Indicates if the command is checked.
boolean	isEnabled() Indicates if the command is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ARCommandInfo

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

Construct a ARCommandInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARCommandInfo.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ARCommandInfo o = (ARCommandInfo)obj; // will not work

ARCommandInfo o = new ARCommandInfo(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server ARCommandInfo theARCommandInfo = (ARCommandInfo) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIARCommandInfo

public IARCommandInfo getAsIARCommandInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

isEnabled

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

Description copied from interface: IARCommandInfo

Indicates if the command is enabled.

Specified by:

isEnabled in interface IARCommandInfo

Returns:

The enabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isChecked

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

Description copied from interface: IARCommandInfo

Indicates if the command is checked.

Specified by:

isChecked in interface IARCommandInfo

Returns:

The checked

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getName

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

Description copied from interface: IARCommandInfo

The name of the command.

Specified by:

getName in interface IARCommandInfo

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCaption

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

Description copied from interface: IARCommandInfo

The caption of the command.

Specified by:

getCaption in interface IARCommandInfo

Returns:

The caption

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTooltip

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

Description copied from interface: IARCommandInfo

The tooltip of the command.

Specified by:

getTooltip in interface IARCommandInfo

Returns:

The tooltip

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMessage

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

Description copied from interface: IARCommandInfo

The message of the command.

Specified by:

getMessage in interface IARCommandInfo

Returns:

The message

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getHelpFile

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

Description copied from interface: IARCommandInfo

The name of the help file associated with the command.

Specified by:

getHelpFile in interface IARCommandInfo

Returns:

The helpFile

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getHelpContextID

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

Description copied from interface: IARCommandInfo

The help context ID associated with the command.

Specified by:

getHelpContextID in interface IARCommandInfo

Returns:

The helpContextID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBitmap

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

Description copied from interface: IARCommandInfo

The bitmap used as an icon by the command.

Specified by:

getBitmap in interface IARCommandInfo

Returns:

The bitmap

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

Description copied from interface: IARCommandInfo

The category the command is associated with.

Specified by:

getCategory in interface IARCommandInfo

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.