com.esri.arcgis.systemUI
Interface ICommandSubType

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ControlsInkEraserTool, ControlsInkHighlightTool, ControlsInkPenTool, ICommandSubTypeProxy

public interface ICommandSubType

extends java.io.Serializable

Provides access to members that define a subtyped command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

When To Use

The ICommandSubType interface is used when you want to have more than one command in a single class. You would implement both ICommand and ICommandSubType in your class. With the ICommandSubType interface you would specify how many subtypes there are. Then, within the implementation each ICommand property you would set the property for each subtype instead of implementing the ICommand interface multiple times.

See Also:

ICommand

Method Summary

int	getCount() The number of commands defined with this CLSID.
void	setSubType(int subType) The subtype of the command.

Method Detail

setSubType

public void setSubType(int subType)
                throws java.io.IOException,
                       AutomationException

The subtype of the command.

Parameters:

subType - The subType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

The number of commands defined with this CLSID.

Supported Platforms

Windows, Solaris, Linux

Remarks

Decide how many Command objects you will be providing in the class, and return this value from GetCount.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.