com.esri.arcgis.controls
Class IARCommandInfoProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by 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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
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 readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException