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

java.lang.Object
  extended by gov.sandia.ccaffeine.dc.user_iface.gui.guicmd.CmdActionGUI
All Implemented Interfaces:
CmdAction
Direct Known Subclasses:
CmdActionGUIAddComponentClass, CmdActionGUIAddProvidesPorts, CmdActionGUIAddUsesPorts, CmdActionGUIConnect, CmdActionGUIDisconnect, CmdActionGUIExit, CmdActionGUIGetProperty, CmdActionGUIInstantiate, CmdActionGUILoad, CmdActionGUIMessage, CmdActionGUIParamCurrent, CmdActionGUIParamDefault, CmdActionGUIParamDialog, CmdActionGUIParamEndDialog, CmdActionGUIParamField, CmdActionGUIParamHelp, CmdActionGUIParamNumberRange, CmdActionGUIParamPrompt, CmdActionGUIParamStringChoice, CmdActionGUIParamTab, CmdActionGUIRemove, CmdActionGUIRevalidate, CmdActionGUISetPortProperty, CmdActionGUISetProperty

public abstract class CmdActionGUI
extends java.lang.Object
implements CmdAction

Used by the parser to parse String commands from the cca server. The results of a parse are sent to all registered ControllerListeners.


Constructor Summary
CmdActionGUI()
           
 
Method Summary
 void addControllerListener(ControllerListener listener)
          Add a new ControllerListener.
protected  void broadcastAddComponentClass(java.lang.String className)
          Tell all ControllerListeners that the cca server has added a new class.
protected  void broadcastAddComponentClassEvent(AddComponentClassEvent event)
           
protected  void broadcastAddProvidesPorts(AddProvidesPortsEvent event)
          Tell all ControllerListeners that the cca server added one or more Provides Ports to a component.
protected  void broadcastAddProvidesPorts(java.lang.String componentInstanceName, java.util.Vector classNameAndInstanceNameOfAllPorts)
          Tell all ControllerListeners that the cca server added one or more Provides Ports to a component.
protected  void broadcastAddUsesPorts(AddUsesPortsEvent event)
          Tell all ControllerListeners that the cca server added one or more Uses Ports to a component.
protected  void broadcastAddUsesPorts(java.lang.String componentInstanceName, java.util.Vector classNameAndInstanceNameOfAllPorts)
          Tell all ControllerListeners that the cca server added one or more Uses Ports to a component.
protected  void broadcastConnect(java.lang.String sourceComponentName, java.lang.String sourcePortName, java.lang.String targetComponentName, java.lang.String targetPortName)
          Tell all ControllerListeners that the cca server connected a Provides Port from one component to a Uses Port.
protected  void broadcastConnectEvent(ConnectEvent event)
          Tell all ControllerListeners that the cca server connected a Provides Port from one component to a Uses Port.
protected  void broadcastDisconnect(java.lang.String sourceComponentName, java.lang.String sourcePortName, java.lang.String targetComponentName, java.lang.String targetPortName)
          Tell all ControllerListeners that the cca server broke the connection between a Provides Port and a Uses Port.
protected  void broadcastDisconnectEvent(DisconnectEvent event)
          Tell all ControllerListeners that the cca server broke the connection between a Provides Port and a Uses Port.
protected  void broadcastExit()
          Tell all ControllerListeners that the cca server has terminated its communication link with this client.
protected  void broadcastExitEvent(ExitEvent event)
          Tell all ControllerListeners that the cca server has terminated its communication link with this client.
protected  void broadcastGetComponentProperty(java.lang.String componentInstanceName, java.lang.String propertyName)
          Tell all ControllerListeners that the cca server wants the GUI to display the value of a component property.
protected  void broadcastGetComponentPropertyEvent(GetComponentPropertyEvent event)
          Tell all ControllerListeners that the cca server wants the GUI to display the value of a component property.
protected  void broadcastInstantiate(java.lang.String className, java.lang.String instanceName)
          Tell all ControllerListeners that the cca server used a cca component class to instantiate a new cca component object.
protected  void broadcastInstantiateEvent(InstantiateEvent event)
          Tell all ControllerListeners that the cca server used a cca component class to instantiate a new cca component object.
protected  void broadcastLoad(java.lang.String className, java.util.Vector arguments)
          Tell all ControllerListeners that the cca server loaded the class of a cca widget.
protected  void broadcastLoadEvent(LoadEvent event)
          Tell all ControllerListeners that the cca server loaded the class of a cca widget.
protected  void broadcastMessage(java.util.Vector args)
          Tell all ControllerListeners that the cca server sent a message to this client.
protected  void broadcastMessageEvent(MessageEvent event)
          Tell all ControllerListeners that the cca server sent a message to this client.
protected  void broadcastParamCurrent(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldValue)
          Notify all ControllerListeners that the cca server is sending the value of a data field.
protected  void broadcastParamCurrentEvent(ParamCurrentEvent event)
          Notify all ControllerListeners that the cca server is sending the value of a data field.
protected  void broadcastParamDefault(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldDefaultValue)
          Notify all ControllerListeners that the cca server is sending the default value of a data field.
protected  void broadcastParamDefaultEvent(ParamDefaultEvent event)
          Notify all ControllerListeners that the cca server is sending the default value of a data field.
protected  void broadcastParamDialog(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String titleOfDialogBox)
          Tell all ControllerListeners that the cca server wants this client to create (but not display) a dialog box to hold the values of all the data fields that are inside a port.
protected  void broadcastParamDialogEvent(ParamDialogEvent event)
          Tell all ControllerListeners that the cca server wants this client to create (but not display) a dialog box to hold the values of all the data fields that are inside a port.
protected  void broadcastParamEndDialog(java.lang.String componentInstanceName, java.lang.String portInstanceName)
          Tell all ControllerListeners that the cca components contain ports.
protected  void broadcastParamEndDialogEvent(ParamEndDialogEvent event)
          Tell all ControllerListeners that the cca server wants ths client to display a dialog box to allow the end-user to view/edit the current data field values that are stored inside of a port.
protected  void broadcastParamField(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldDataType, java.lang.String dataFieldName)
          Tell all ControllerListeners that the cca server wants to send the name of a data field to this client.
protected  void broadcastParamFieldEvent(ParamFieldEvent event)
          Tell all ControllerListeners that the cca server wants to send the name of a data field to this client.
protected  void broadcastParamHelp(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldHelp)
          Tell all ControllerListeners that the cca server has sent this client some helpful info about this data field.
protected  void broadcastParamHelpEvent(ParamHelpEvent event)
          Tell all ControllerListeners that the cca server has sent this client some helpful info about this data field.
protected  void broadcastParamNumberRange(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldMinValue, java.lang.String dataFieldMaxValue)
          Tell all ControllerListeners that the cca server sent the lowest value and the highest value that the current data field can have.
protected  void broadcastParamNumberRangeEvent(ParamNumberRangeEvent event)
          Tell all ControllerListeners that the cca server sent the lowest value and the highest value that the current data field can have.
protected  void broadcastParamPrompt(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldPrompt)
          Tell all ControllerListeners that the cca server sent us the prompt string for one of the data fields in one of the ports of a cca component.
protected  void broadcastParamPromptEvent(ParamPromptEvent event)
          Tell all ControllerListeners that the cca server sent us the prompt string for one of the data fields in one of the ports of a cca component.
protected  void broadcastParamStringChoice(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldElementInSetOfValues)
          Tell all ControllerListeners that the cca server is sending one, out of many, possible values that can be inserted into a data field.
protected  void broadcastParamTabChoice(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String tabName)
          Tell all ControllerListeners that the cca server is sending the name of tab.
protected  void broadcastRemove(java.lang.String componentInstanceName)
          Tell all ControllerListeners that the cca server has removed an instantiation of a cca component.
protected  void broadcastRemoveEvent(RemoveEvent event)
          Tell all ControllerListeners that the cca server has removed an instantiation of a cca component.
protected  void broadcastRevalidate(java.lang.String componentInstanceName)
          Tell all ControllerListeners that the cca server has revalidated all of the cca ports in a cca component.
protected  void broadcastRevalidateEvent(RevalidateEvent event)
          Tell all ControllerListeners that the cca server has revalidated all of the cca ports in a cca component.
protected  void broadcastSetComponentProperty(java.lang.String componentInstanceName, java.lang.String propertyName, java.lang.String propertyValue)
          Tell all ControllerListeners that the cca server has set the value of a property that is inside a cca component.
protected  void broadcastSetComponentPropertyEvent(SetComponentPropertyEvent event)
          Tell all ControllerListeners that the cca server has set the value of a property that is inside a cca component.
protected  void broadcastSetPortProperty(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String propertyName, java.lang.String dataType, java.lang.String propertyValue)
          Tell all ControllerListeners that the cca server has set the value of a property that is inside a port of a cca component.
protected  void broadcastSetPortPropertyEvent(SetPortPropertyEvent event)
          Tell all ControllerListeners that the cca server has set the value of a property that is inside of a port in a cca component.
protected  void broadcastStringChoiceEvent(ParamStringChoiceEvent event)
          Tell all ControllerListeners that the cca server is sending one, out of many, possible values that can be inserted into a data field.
protected  void broadcastTabEvent(ParamTabEvent event)
          Tell all ControllerListeners that the cca server is sending the name of tab.
 void removeControllerListener(ControllerListener listener)
          Remove a ControllerListener.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.ccaffeine.cmd.CmdAction
argtype, doIt, help, names
 

Constructor Detail

CmdActionGUI

public CmdActionGUI()
Method Detail

addControllerListener

public void addControllerListener(ControllerListener listener)
Add a new ControllerListener. ControllerListeners are notified whenever the cca server makes changes.

Parameters:
listener - The new ControllerListener

removeControllerListener

public void removeControllerListener(ControllerListener listener)
Remove a ControllerListener. The input ControllerListener is no longer notified whenever the cca server makes changes.

Parameters:
listener - The ControllerListener that no lonter wants to be notified when the cca server makes a change.

broadcastAddComponentClass

protected void broadcastAddComponentClass(java.lang.String className)
Tell all ControllerListeners that the cca server has added a new class. The new class can be used to instantiate new cca components. A view might respond by adding a box to a palette.

Parameters:
className - the name of the newly added class. The name is actually the name of the component's java class. For example, the name could be "gov.sandia.ccaffeine.dc.component.PrinterComponent"

broadcastAddComponentClassEvent

protected void broadcastAddComponentClassEvent(AddComponentClassEvent event)

broadcastAddProvidesPorts

protected void broadcastAddProvidesPorts(java.lang.String componentInstanceName,
                                         java.util.Vector classNameAndInstanceNameOfAllPorts)
Tell all ControllerListeners that the cca server added one or more Provides Ports to a component. A view entity might respond by rendering a box for each component. The boxes could be placed on the left side of the component.

Parameters:
componentInstanceName - The name of the cca component that received the newly created ports. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"
classNameAndInstanceNameOfAllPorts - the class name and the instance name of all the ports that were added to a component.
vector[0] contains the instance name of port[0]
vector[1] contains the class name of port[0]
vector[2] contains the instance name of port[1]
vector[3] contains the class name of port[1]
etc.

The class name of a port is the name of the port's java class. The class name may or may not include the package name. Examples of class names are "gov.cca.componentProperties" and "GoPort."

The instance name of a port is the name of an instantiation of the cca port. Examples of instance names are "cProps" and "go_port."


broadcastAddProvidesPorts

protected void broadcastAddProvidesPorts(AddProvidesPortsEvent event)
Tell all ControllerListeners that the cca server added one or more Provides Ports to a component. A view entity might respond by rendering a box for each component. The boxes could be placed on the left side of the component.

Parameters:
event - That event that is generated whenever the cca server adds ports to a component.

broadcastAddUsesPorts

protected void broadcastAddUsesPorts(java.lang.String componentInstanceName,
                                     java.util.Vector classNameAndInstanceNameOfAllPorts)
Tell all ControllerListeners that the cca server added one or more Uses Ports to a component. A view entity might respond by rendering a box for each component. The boxes could be placed on the right side of the component.

Parameters:
componentInstanceName - The name of the cca component that received the newly created ports. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"
classNameAndInstanceNameOfAllPorts - the class name and the instance name of all the ports that were added to a component.
vector[0] contains the instance name of port[0]
vector[1] contains the class name of port[0]
vector[2] contains the instance name of port[1]
vector[3] contains the class name of port[1]
etc.

The class name of a port is the name of the port's java class. The class name may or may not include the package name. Examples of class names are "gov.cca.PrintService" and "StringConsumerPort."

The instance name of a port is the name of an instantiation of the cca port. Examples of instance names are "pSvc" and "out0"


broadcastAddUsesPorts

protected void broadcastAddUsesPorts(AddUsesPortsEvent event)
Tell all ControllerListeners that the cca server added one or more Uses Ports to a component. A view entity might respond by rendering a box for each component. The boxes could be placed on the right side of the component.

Parameters:
event - That event that is generated whenever the cca server adds ports to a component.

broadcastConnect

protected void broadcastConnect(java.lang.String sourceComponentName,
                                java.lang.String sourcePortName,
                                java.lang.String targetComponentName,
                                java.lang.String targetPortName)
Tell all ControllerListeners that the cca server connected a Provides Port from one component to a Uses Port. The Uses Port may be from the same component or may be from a different component. A view entity might respond by drawing a line between the two connected ports.

Parameters:
sourceComponentName - The name of the component that houses the source port. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"
sourcePortName - The name of the source port. Example: "out0"
targetComponentName - The name of the component that houses the target port. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "PrinterComponent0"
targetPortName - the name of the target port. Example: "out0"

broadcastConnectEvent

protected void broadcastConnectEvent(ConnectEvent event)
Tell all ControllerListeners that the cca server connected a Provides Port from one component to a Uses Port. The Uses Port may be from the same component or may be from a different component. A view entity might respond by drawing a line between the two connected ports.

Parameters:
event - That event that is generated whenever the cca server connects a Provides Port with a Uses Port.

broadcastDisconnect

protected void broadcastDisconnect(java.lang.String sourceComponentName,
                                   java.lang.String sourcePortName,
                                   java.lang.String targetComponentName,
                                   java.lang.String targetPortName)
Tell all ControllerListeners that the cca server broke the connection between a Provides Port and a Uses Port. A view entity might respond by drawing a line between the two connected ports.

Parameters:
sourceComponentName - The name of the component that houses the source port. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"
sourcePortName - The name of the source port. Example: "out0"
targetComponentName - The name of the component that houses the target port. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "PrinterComponent0"
targetPortName - the name of the target port. Example: "out0"

broadcastDisconnectEvent

protected void broadcastDisconnectEvent(DisconnectEvent event)
Tell all ControllerListeners that the cca server broke the connection between a Provides Port and a Uses Port. A view entity might respond by drawing a line between the two connected ports.

Parameters:
event - That event that is generated whenever the cca server breaks the connect between a a Provides Port and a Uses Port.

broadcastExit

protected void broadcastExit()
Tell all ControllerListeners that the cca server has terminated its communication link with this client. A client might respond by exiting the program.


broadcastExitEvent

protected void broadcastExitEvent(ExitEvent event)
Tell all ControllerListeners that the cca server has terminated its communication link with this client. A client might respond by exiting the program.

Parameters:
event - That event that is generated whenever the cca server breaks its communication link with this client.

broadcastGetComponentProperty

protected void broadcastGetComponentProperty(java.lang.String componentInstanceName,
                                             java.lang.String propertyName)
Tell all ControllerListeners that the cca server wants the GUI to display the value of a component property. The GUI might respond by writing the value to stdout.

Parameters:
componentName - The name of the component that contains the property.
propertyName - The name of the property.

broadcastGetComponentPropertyEvent

protected void broadcastGetComponentPropertyEvent(GetComponentPropertyEvent event)
Tell all ControllerListeners that the cca server wants the GUI to display the value of a component property. The GUI might respond by writing the value to stdout.

Parameters:
event - The event that is generated whenever the cca server is querying for the value of a property inside a cca component.

broadcastInstantiate

protected void broadcastInstantiate(java.lang.String className,
                                    java.lang.String instanceName)
Tell all ControllerListeners that the cca server used a cca component class to instantiate a new cca component object. A view entity might respond by rendering a box inside of an arena.

Parameters:
className - The name of the class that was used to instantiate a new cca component. The name is actually the name of the component's java class. EXAMPLE: "gov.sandia.ccaffeine.dc.component.PrinterComponent"
instanceName - The name of the newly instantiated cca component object. The instance name is usually the name of the component's java class (without the package name) concatenated with an index number. EXAMPLE: "StarterComponent0"

broadcastInstantiateEvent

protected void broadcastInstantiateEvent(InstantiateEvent event)
Tell all ControllerListeners that the cca server used a cca component class to instantiate a new cca component object. A view entity might respond by rendering a box inside of an arena.

Parameters:
event - The event that is generated whenever the cca server used a cca component class to instantiate a new cca component object.

broadcastLoad

protected void broadcastLoad(java.lang.String className,
                             java.util.Vector arguments)
Tell all ControllerListeners that the cca server loaded the class of a cca widget. The class can be used to instantiate cca widgets. A view might respond by rendering components in the palette. The end-user can drag-and-drop components from the palett to the main workspace (the arena).

Parameters:
className - The name of a cca widget class. The name is actually the name of the widget's java class. EXAMPLE: "gov.sandia.ccaffeine.dc.component.PrinterComponent"
arguments - There must always be one argument: the class name of the widget itself, other special purpose arguments may follow.

broadcastLoadEvent

protected void broadcastLoadEvent(LoadEvent event)
Tell all ControllerListeners that the cca server loaded the class of a cca widget. The class can be used to instantiate cca widgets. A view might respond by rendering components in the palette. The end-user can drag-and-drop components from the palett to the main workspace (the arena).

Parameters:
event - The event that is generated whenever the cca server loads the java class of a cca widget.

broadcastMessage

protected void broadcastMessage(java.util.Vector args)
Tell all ControllerListeners that the cca server sent a message to this client. For example, a server might respond to a "go" command by sending a message. A view entity might respond by printing a string on standard out.

Parameters:
args - The contents of the message

broadcastMessageEvent

protected void broadcastMessageEvent(MessageEvent event)
Tell all ControllerListeners that the cca server sent a message to this client. For example, a server might respond to a "go" command by sending a message. A view entity might respond by printing a string on standard out.

Parameters:
event - The event that is created whenever the cca server sends a message to this client.

broadcastParamCurrent

protected void broadcastParamCurrent(java.lang.String componentInstanceName,
                                     java.lang.String portInstanceName,
                                     java.lang.String dataFieldName,
                                     java.lang.String dataFieldValue)
Notify all ControllerListeners that the cca server is sending the value of a data field.

Cca components contain ports. Some of the ports contain data fields. The cca server is sending the value of one of these data fields. A view entity might respond by displaying the current value on the screen.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The instance name of the port that contains the data field. Example: "configure_port"
dataFieldName - The name of the data field.
dataFieldValue - The value of the data field.

broadcastParamCurrentEvent

protected void broadcastParamCurrentEvent(ParamCurrentEvent event)
Notify all ControllerListeners that the cca server is sending the value of a data field.

Cca components contain ports. Some of the ports contain data fields. The cca server is sending the value of one of these data fields. A view entity might respond by displaying the current value on the screen.

Parameters:
event - The event that is created whenever the cca server sends the value of a data field.

broadcastParamDefault

protected void broadcastParamDefault(java.lang.String componentInstanceName,
                                     java.lang.String portInstanceName,
                                     java.lang.String dataFieldName,
                                     java.lang.String dataFieldDefaultValue)
Notify all ControllerListeners that the cca server is sending the default value of a data field.

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.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The instance name of the port that contains the data field. Example: "configure_port"
dataFieldName - The name of the data field.
dataFieldDefaultValue - The default value of the data field.

broadcastParamDefaultEvent

protected void broadcastParamDefaultEvent(ParamDefaultEvent event)
Notify all ControllerListeners that the cca server is sending the default value of a data field.

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.

Parameters:
event - The event that is created whenever the cca server sends the default value of a data field.

broadcastParamDialog

protected void broadcastParamDialog(java.lang.String componentInstanceName,
                                    java.lang.String portInstanceName,
                                    java.lang.String titleOfDialogBox)
Tell all ControllerListeners that the cca server wants this client to create (but not display) a dialog box to hold the values of all the data fields that are inside a port.

Cca components contain ports. Some of the ports contain data fields. The cca server wants the client to create (but not display) a dialog box that contains the values of all the data fields in the port. A view entity might respond by creating an empty dialog box.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data fields. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The instance name of a port that contains the data fields. Example: "configure_port"
titleOfDialogBox - The title of the dialog box.

broadcastParamDialogEvent

protected void broadcastParamDialogEvent(ParamDialogEvent event)
Tell all ControllerListeners that the cca server wants this client to create (but not display) a dialog box to hold the values of all the data fields that are inside a port.

Cca components contain ports. Some of the ports contain data fields. The cca server wants the client to create (but not display) a dialog box that contains the values of all the data fields in the port. A view entity might respond by creating an empty dialog box.

Parameters:
event - The event that is created whenever the cca server wants the client to display a dialog box.

broadcastParamEndDialog

protected void broadcastParamEndDialog(java.lang.String componentInstanceName,
                                       java.lang.String portInstanceName)
Tell all ControllerListeners that the cca components contain ports. Some of the ports contain data fields. The cca server has finished sending information for all the data fields in a port. A client entity might respond by displaying a dialog box that was already populated with information from all the data fields.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data fields. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The instance name of a port that contains the data fields. Example: "configure_port"

broadcastParamEndDialogEvent

protected void broadcastParamEndDialogEvent(ParamEndDialogEvent event)
Tell all ControllerListeners that the cca server wants ths client to display a dialog box to allow the end-user to view/edit the current data field values that are stored inside of a port.

Parameters:
event - The event that is created whenever the cca server wants the client to display a dialog box.

broadcastParamField

protected void broadcastParamField(java.lang.String componentInstanceName,
                                   java.lang.String portInstanceName,
                                   java.lang.String dataFieldDataType,
                                   java.lang.String dataFieldName)
Tell all ControllerListeners that the cca server wants to send the name of a data field to this client.
Cca components contain ports. Some of the ports contain data fields. The cca server is sending the name of a data field. A client entity might respond by inserting a line of data into a dialog box.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The name of a port that contains the data field. Example: "configure_port"
dataFieldDataType - The data type of the value that is stored in the data field (e.g. STRING).
dataFieldName - The name of the data field.

broadcastParamFieldEvent

protected void broadcastParamFieldEvent(ParamFieldEvent event)
Tell all ControllerListeners that the cca server wants to send the name of a data field to this client.
Cca components contain ports. Some of the ports contain data fields. The cca server is sending the name of a data field. A client entity might respond by inserting a line of data into a dialog box.

Parameters:
event - The event that is created whenever the cca server sends the name of a data field.

broadcastParamHelp

protected void broadcastParamHelp(java.lang.String componentInstanceName,
                                  java.lang.String portInstanceName,
                                  java.lang.String dataFieldName,
                                  java.lang.String dataFieldHelp)
Tell all ControllerListeners that the cca server has sent this client some helpful info about this data field.

Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that the cca server is sending the text that contains helpful information on the data field. A client entity might respond by setting up a help system inside of a dialog box.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The name of a port that contains the data field. Example: "configure_port"
dataFieldName - The name of the data field.
dataFieldHelp - Contains some helpful info on this data field.

broadcastParamHelpEvent

protected void broadcastParamHelpEvent(ParamHelpEvent event)
Tell all ControllerListeners that the cca server has sent this client some helpful info about this data field.

Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that the cca server is sending the text that contains helpful information on the data field. A client entity might respond by setting up a help system inside of a dialog box.

Parameters:
event - The event that is generated whenever the cca server sends this client helpful info about a data field that is inside a port.

broadcastParamNumberRange

protected void broadcastParamNumberRange(java.lang.String componentInstanceName,
                                         java.lang.String portInstanceName,
                                         java.lang.String dataFieldName,
                                         java.lang.String dataFieldMinValue,
                                         java.lang.String dataFieldMaxValue)
Tell all ControllerListeners that the cca server sent the lowest value and the highest value that the current data field can have.

Cca components contain ports. Some of the ports contain data fields. Some of the data fields restrict the range that a value can have. The cca server is sending the lowest value and the highest value that a data field value can have. A client entity might respond by verifying the end-user's input is within the allowed range.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The name of a port that contains the data field. Example: "configure_port"
dataFieldName - The name of the data field.
dataFieldMinValue - The smallest value that can be inserted into the data field.
datafieldMaxValue - The largest value that can be inserted into the data field.

broadcastParamNumberRangeEvent

protected void broadcastParamNumberRangeEvent(ParamNumberRangeEvent event)
Tell all ControllerListeners that the cca server sent the lowest value and the highest value that the current data field can have.

Cca components contain ports. Some of the ports contain data fields. Some of the data fields restrict the range that a value can have. The cca server is sending the lowest value and the highest value that a data field value can have. A client entity might respond by verifying the end-user's input is within the allowed range.

Parameters:
event - The event that is generated whenever the cca server sends this client the lowest value and the highest value the current data field can contain.

broadcastParamPrompt

protected void broadcastParamPrompt(java.lang.String componentInstanceName,
                                    java.lang.String portInstanceName,
                                    java.lang.String dataFieldName,
                                    java.lang.String dataFieldPrompt)
Tell all ControllerListeners that the cca server sent us the prompt string for one of the data fields in one of the ports of a cca component.

Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that the cca server is sending a prompt string for a data field. A client entity might display the string to prompt the end-user for the value of this data field.


broadcastParamPromptEvent

protected void broadcastParamPromptEvent(ParamPromptEvent event)
Tell all ControllerListeners that the cca server sent us the prompt string for one of the data fields in one of the ports of a cca component.

Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that the cca server is sending a prompt string for a data field. A client entity might display the string to prompt the end-user for the value of this data field.

Parameters:
event - The event that is generated whenever the cca server sends this client the contents of a help string.

broadcastParamStringChoice

protected void broadcastParamStringChoice(java.lang.String componentInstanceName,
                                          java.lang.String portInstanceName,
                                          java.lang.String dataFieldName,
                                          java.lang.String dataFieldElementInSetOfValues)
Tell all ControllerListeners that the cca server is sending one, out of many, possible values that can be inserted into a data field.

Cca components contain ports. Some of the ports contain data fields. For some data fields, the value must be one of the items in a set (e.g. "red", "green", "blue"). The cca server is sending one item that belongs in such a set. A client entity can display the items in the set as a pull down menu.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The name of a port that contains the data field. Example: "configure_port"
dataFieldName - The name of the data field.
dataFieldElementInSetOfValues - One of the possible values that can be inserted into this data field.

broadcastStringChoiceEvent

protected void broadcastStringChoiceEvent(ParamStringChoiceEvent event)
Tell all ControllerListeners that the cca server is sending one, out of many, possible values that can be inserted into a data field.

Cca components contain ports. Some of the ports contain data fields. For some data fields, the value must be one of the items in a set (e.g. "red", "green", "blue"). The cca server is sending one item that belongs in such a set. A client entity can display the items in the set as a pull down menu.

Parameters:
event - The event that is generated whenever the cca server sends this client one, out of many, possible values that can be inserted into this data field.

broadcastParamTabChoice

protected void broadcastParamTabChoice(java.lang.String componentInstanceName,
                                       java.lang.String portInstanceName,
                                       java.lang.String tabName)
Tell all ControllerListeners that the cca server is sending the name of tab.

Cca components contain ports. Some of the ports contain data fields. Sometimes, the data fields are grouped into sets. The cca server is sending the name of such a set. A client entity can display each set as a tabbed pane.

Parameters:
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The name of a port that contains the data field. Example: "configure_port"
tabName - The name of the tab.

broadcastTabEvent

protected void broadcastTabEvent(ParamTabEvent event)
Tell all ControllerListeners that the cca server is sending the name of tab.

Cca components contain ports. Some of the ports contain data fields. Sometimes, the data fields are grouped into sets. The cca server is sending the name of such a set. A client entity can display each set as a tabbed pane.


broadcastRemove

protected void broadcastRemove(java.lang.String componentInstanceName)
Tell all ControllerListeners that the cca server has removed an instantiation of a cca component. A view entity might respond by removing the component from the arena.

Parameters:
componentInstanceName - The name of the component that was removed. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"

broadcastRemoveEvent

protected void broadcastRemoveEvent(RemoveEvent event)
Tell all ControllerListeners that the cca server has removed an instantiation of a cca component. A view entity might respond by removing the component from the arena.

Parameters:
event - The event that is generated whenever the cca server removes an instantiation of a cca component.

broadcastRevalidate

protected void broadcastRevalidate(java.lang.String componentInstanceName)
Tell all ControllerListeners that the cca server has revalidated all of the cca ports in a cca component. A view might respond by re-rendering all of the ports that are inside a cca component.

Parameters:
componentInstanceName - The name of the component that was revalidated. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"

broadcastRevalidateEvent

protected void broadcastRevalidateEvent(RevalidateEvent event)
Tell all ControllerListeners that the cca server has revalidated all of the cca ports in a cca component. A view might respond by re-rendering all of the ports that are inside a cca component.

Parameters:
event - The event that is generated whenever the cca server revalidates all of the cca ports in a cca component.

broadcastSetComponentProperty

protected void broadcastSetComponentProperty(java.lang.String componentInstanceName,
                                             java.lang.String propertyName,
                                             java.lang.String propertyValue)
Tell all ControllerListeners that the cca server has set the value of a property that is inside a cca component. A view entity might respond by saving the new value of the property.

Parameters:
componentInstanceName - The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"
propertyName - The name of the property.
propertyValue - The value of the property.

broadcastSetComponentPropertyEvent

protected void broadcastSetComponentPropertyEvent(SetComponentPropertyEvent event)
Tell all ControllerListeners that the cca server has set the value of a property that is inside a cca component. A view entity might respond by saving the new value of the property.

Parameters:
event - The event that is generated whenever the cca server sets the value of property that is inside a cca component.

broadcastSetPortProperty

protected void broadcastSetPortProperty(java.lang.String componentInstanceName,
                                        java.lang.String portInstanceName,
                                        java.lang.String propertyName,
                                        java.lang.String dataType,
                                        java.lang.String propertyValue)
Tell all ControllerListeners that the cca server has set the value of a property that is inside a port of a cca component. A view entity might respond by saving the new value of the property.

Parameters:
componentInstanceName - The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"
portInstanceName -
propertyName - The name of the property.
dataType - The data type of the value
propertyValue - The value of the property.

broadcastSetPortPropertyEvent

protected void broadcastSetPortPropertyEvent(SetPortPropertyEvent event)
Tell all ControllerListeners that the cca server has set the value of a property that is inside of a port in a cca component. A view entity might respond by saving the new value of the property.

Parameters:
event - The event that is generated whenever the cca server sets the value of property that is inside port of a cca component.