gov.sandia.ccaffeine.dc.user_iface.gui.guicmd
Class CmdActionGUIExit

java.lang.Object
  extended by gov.sandia.ccaffeine.dc.user_iface.gui.guicmd.CmdActionGUI
      extended by gov.sandia.ccaffeine.dc.user_iface.gui.guicmd.CmdActionGUIExit
All Implemented Interfaces:
CmdAction

public class CmdActionGUIExit
extends CmdActionGUI
implements CmdAction

CmdActionGUIExit.java If the end-user clicks on the File->Exit menu item then the cca server breaks its connection with this client. Before severing the connection, the cca server sends a disconnect message to the client. The client responds by closing the application.


Constructor Summary
CmdActionGUIExit()
           
 
Method Summary
 java.lang.String argtype()
          Describes the args Vector wanted by this Command.
 void doIt(CmdContext cc, java.util.Vector args)
          It is not safe to assume the input to this is valid, as the action of the connection already done in the framework may invalidate the ports being connected.
 java.lang.String help()
          Returns a string containing the description of this command.
 java.lang.String[] names()
          name(s) of the function.
 
Methods inherited from class gov.sandia.ccaffeine.dc.user_iface.gui.guicmd.CmdActionGUI
addControllerListener, broadcastAddComponentClass, broadcastAddComponentClassEvent, broadcastAddProvidesPorts, broadcastAddProvidesPorts, broadcastAddUsesPorts, broadcastAddUsesPorts, broadcastConnect, broadcastConnectEvent, broadcastDisconnect, broadcastDisconnectEvent, broadcastExit, broadcastExitEvent, broadcastGetComponentProperty, broadcastGetComponentPropertyEvent, broadcastInstantiate, broadcastInstantiateEvent, broadcastLoad, broadcastLoadEvent, broadcastMessage, broadcastMessageEvent, broadcastParamCurrent, broadcastParamCurrentEvent, broadcastParamDefault, broadcastParamDefaultEvent, broadcastParamDialog, broadcastParamDialogEvent, broadcastParamEndDialog, broadcastParamEndDialogEvent, broadcastParamField, broadcastParamFieldEvent, broadcastParamHelp, broadcastParamHelpEvent, broadcastParamNumberRange, broadcastParamNumberRangeEvent, broadcastParamPrompt, broadcastParamPromptEvent, broadcastParamStringChoice, broadcastParamTabChoice, broadcastRemove, broadcastRemoveEvent, broadcastRevalidate, broadcastRevalidateEvent, broadcastSetComponentProperty, broadcastSetComponentPropertyEvent, broadcastSetPortProperty, broadcastSetPortPropertyEvent, broadcastStringChoiceEvent, broadcastTabEvent, removeControllerListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmdActionGUIExit

public CmdActionGUIExit()
Method Detail

argtype

public java.lang.String argtype()
Description copied from interface: CmdAction
Describes the args Vector wanted by this Command. // This is our hack to get around stupid varargs-lessness in java. // Each character indicates a separate user argument and its type. // Type checked user input: // C --> class named by user. // c --> optional class named by user. // I --> instance named by user. // i --> optional instance named by user. // S --> string token from user. // s --> optional string token from user. // K,k --> Long value, optional Long. // D,d --> Integer value, optional Integer. // B,b --> Boolean value, optional Boolean. // G,g --> Double value, optional Double. // * --> repeat previous character ad infinitum. can only appear last. // Special (cannot be followed directly by *): // A --> all of the line after as a single string. // a --> all of the line (if any) as a single string. // L --> the list of known CmdActions. // P --> the command parser itself. A more extensible scheme of tags for the parser is desirable.

Specified by:
argtype in interface CmdAction

names

public java.lang.String[] names()
Description copied from interface: CmdAction
name(s) of the function.

Specified by:
names in interface CmdAction

help

public java.lang.String help()
Description copied from interface: CmdAction
Returns a string containing the description of this command.

Specified by:
help in interface CmdAction

doIt

public void doIt(CmdContext cc,
                 java.util.Vector args)
It is not safe to assume the input to this is valid, as the action of the connection already done in the framework may invalidate the ports being connected.

Specified by:
doIt in interface CmdAction