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

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

public class CmdActionGUIParamDefault
extends CmdActionGUI
implements CmdAction

CmdActionGUIParamDefault.java Cca components contain ports. Some of the ports contain data fields. The cca server is sending the default value of one of these data fields. A view entity might respond by checking the state of a data field; if the data field does not have a current value then the default value is displayed on the screen.

Possible Scenario:
An end-user clicks on a blue port inside of a component
client sends "parameters" to server
serer- sends "ParamDialog" to client
client responds by creating an empty dialog box
server sends "ParamTab" to client
client responds by inserting a new tab in the dialog box
server sends "ParamField" to client
client responds by inserting a blank data line into the dialog box
server sends "ParamCurrent" to client
client responds by inserting the data's value into the dialog box
server sends "ParamHelp" to client
client responds by setting the text that is displayed if the help button is clicked
server sends "ParamPrompt" to client
client responds by displaying a prompt to the left of the data's value
server sends "ParamDefault" to client
client responds by setting the data's default value
server sends "ParamStringChoice" to client
client responds by setting an item in the value's choice box
server sends "ParamNumberRange" to client
client responds by setting the data value's range of allowed values
server sends "ParamEndDialog" to client
client responds by displaying the dialog box on the screen


Constructor Summary
CmdActionGUIParamDefault()
           
 
Method Summary
 java.lang.String argtype()
          Describes the args Vector wanted by this Command.
 void doIt(CmdContext cc, java.util.Vector args)
          Does the action, called with the global context of the interpreter // and with a vector that matches the signature given by argtype().
 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

CmdActionGUIParamDefault

public CmdActionGUIParamDefault()
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)
Description copied from interface: CmdAction
Does the action, called with the global context of the interpreter // and with a vector that matches the signature given by argtype(). // The exit Action throws the EOFException.

Specified by:
doIt in interface CmdAction