gov.sandia.ccaffeine.dc.user_iface.MVC.event
Class ParamEndDialogEvent
java.lang.Object
java.util.EventObject
gov.sandia.ccaffeine.dc.user_iface.MVC.event.ParamEndDialogEvent
- All Implemented Interfaces:
- java.io.Serializable
public class ParamEndDialogEvent
- extends java.util.EventObject
Cca components contain ports.
Some of the ports contain data fields.
This event can be used to notify components
that 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.
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
- See Also:
- Serialized Form
Fields inherited from class java.util.EventObject |
source |
Constructor Summary |
ParamEndDialogEvent(java.lang.Object source,
java.lang.String componentInstanceName,
java.lang.String portInstanceName)
Create a ParamDialogEvent. |
Methods inherited from class java.util.EventObject |
getSource, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
componentInstanceName
protected java.lang.String componentInstanceName
portInstanceName
protected java.lang.String portInstanceName
- The instance name of a port
that contains the data field.
Example: "configure_port"
ParamEndDialogEvent
public ParamEndDialogEvent(java.lang.Object source,
java.lang.String componentInstanceName,
java.lang.String portInstanceName)
- Create a ParamDialogEvent.
Cca components contain ports.
Some of the ports contain data fields.
This event can be used to notify components
that 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:
source
- The entity that created this event.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 field.
Example: "configure_port"
getComponentInstanceName
public java.lang.String getComponentInstanceName()
GetPortInstanceName
public java.lang.String GetPortInstanceName()
- Get the instance name of a port
that contains the data field.
Example: "configure_port"
- Returns:
- The instance name of a port.