com.esri.arcgis.schematic
Class INgCommandProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematic.INgCommandProxy
All Implemented Interfaces:
INgCommand, Externalizable, Serializable

public class INgCommandProxy
extends com.esri.arcgis.interop.Dispatch
implements INgCommand, Serializable

Provides access to members that control the command.

Description

A command is a procedure that generally triggers a specific treatment in response to an event from the application. A command can be applied to all object types and can be parameterized or not.

Schematics offers a full set of predefined commands, each with its own area of action, which means that it will apply to a given metatype only. If the execution of a given method or the chaining of a set of methods available from the esriSchematic library can be easily coded in your project instead of triggerring a predefined command, some predefined commands have no equivalent in the esriSchematic library. Here under is the list of all Schematics predefined commands:

CommandByPassNode, CommandCollapse, CommandCollapseTree, CommandCopy, CommandDecreaseSymbolSize, CommandDecreaseTextSize, CommandExpand, CommandExpandAll, CommandIncreaseSymbolSize, CommandIncreaseTextSize, CommandSeparateOverlappingLink, CommandTogglePropertyState, CommandPopupMenu


CommandCenterObject, CommandCloseDiagram, CommandCloseSession, CommandDigitConnectedLink, CommandDigitLink, CommandDigitNode, CommandFit, CommandFitAll, CommandLegend, CommandLoadAndDisplayElement, CommandNewView, CommandSelectFromSchematic, CommandSelectInSchematic, CommandOnLegendEntry, CommandOpenDiagram, CommandOpenDiagramForm, CommandPrint, CommandRefreshDiagram, CommandRefreshElement, CommandRepaint, CommandInitialPosition, CommandSaveDiagram, CommandSaveSession, CommandSelectElement, CommandSetDigitMode, CommandSetEditAndMoveMode, CommandSetPanMode, CommandSetPropertyState, CommandSetSelectMode, CommandSetZoomInMode, CommandSetZoomOutMode, CommandTileWindows, CommandUndisplayObject, CommandUnselectAll


CommandHorizontalAlignment, CommandRemoveLinkPoints, CommandRemoveElement, CommandRotate, CommandSelectTree, CommandSymmetry, CommandVerticalAlignment


CommandContainer, CommandDelegate, CommandDelegateSubType, CommandExecuteProcedure, CommandOnAllViews, CommandUser

Product Availability

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

See Also:
INgBehavior, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  INgCommandProxy()
           
  INgCommandProxy(Object obj)
           
protected INgCommandProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void execute()
          Executes the command.
 String getName()
          Name of the command.
 String getParameter()
          Parameters for the command.
 String getStatusText()
          Status bar description for the command.
 String getToolTipText()
          Description of the command in the button-related tootip.
 boolean isChecked()
          Indicates if the command has been executed.
 boolean isEnabled()
          Indicates if the command is enabled.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setName(String pVal)
          Name of the command.
 void setParameter(String pVal)
          Parameters for the command.
 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

INgCommandProxy

public INgCommandProxy()

INgCommandProxy

public INgCommandProxy(Object obj)
                throws IOException
Throws:
IOException

INgCommandProxy

protected INgCommandProxy(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

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the command.

Product Availability

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

Specified by:
getName in interface INgCommand
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the command.

Product Availability

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

Specified by:
setName in interface INgCommand
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameter

public String getParameter()
                    throws IOException,
                           AutomationException
Parameters for the command.

Product Availability

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

Specified by:
getParameter in interface INgCommand
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameter

public void setParameter(String pVal)
                  throws IOException,
                         AutomationException
Parameters for the command.

Product Availability

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

Specified by:
setParameter in interface INgCommand
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatusText

public String getStatusText()
                     throws IOException,
                            AutomationException
Status bar description for the command.

Product Availability

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

Specified by:
getStatusText in interface INgCommand
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolTipText

public String getToolTipText()
                      throws IOException,
                             AutomationException
Description of the command in the button-related tootip.

Product Availability

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

Specified by:
getToolTipText in interface INgCommand
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute()
             throws IOException,
                    AutomationException
Executes the command.

Product Availability

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

Specified by:
execute in interface INgCommand
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 has been executed.

Product Availability

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

Specified by:
isChecked in interface INgCommand
Returns:
The ret
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgBehavior

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException
Indicates if the command is enabled.

Product Availability

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

Specified by:
isEnabled in interface INgCommand
Returns:
The ret
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