gov.sandia.ccaffeine.dc.user_iface.MVC.event
Class ParamTabEvent
java.lang.Object
java.util.EventObject
gov.sandia.ccaffeine.dc.user_iface.MVC.event.ParamTabEvent
- All Implemented Interfaces:
- java.io.Serializable
public class ParamTabEvent
- extends java.util.EventObject
Cca components contain ports.
Some of the ports contain data fields.
Sometimes, the data fields are grouped
into sets. This event can be used to notify
components that the cca server is sending the
name of such a set.
A client entity can display each set as a
tabbed pane.
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 |
ParamTabEvent(java.lang.Object source,
java.lang.String componentInstanceName,
java.lang.String portInstanceName,
java.lang.String tabName)
Create a ParamTabEvent. |
Method Summary |
java.lang.String |
getComponentInstanceName()
Get the name of the cca component that contains
the port which contains data fields. |
java.lang.String |
GetPortInstanceName()
Get the name of the port that contains the data field. |
java.lang.String |
getTabName()
|
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
tabName
protected java.lang.String tabName
ParamTabEvent
public ParamTabEvent(java.lang.Object source,
java.lang.String componentInstanceName,
java.lang.String portInstanceName,
java.lang.String tabName)
- Create a ParamTabEvent.
Cca components contain ports.
Some of the ports contain data fields.
Sometimes, the data fields are grouped
into sets. This event can be used to notify
components that the cca server is sending the
name of such a set.
A client entity can display each set as a
tabbed pane.
- Parameters:
source
- The entity that created this event.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.tabName
- The name of the tab.
getComponentInstanceName
public java.lang.String getComponentInstanceName()
- Get the name of the cca component that contains
the port which contains data fields.
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "TimeStamper0"
- Returns:
- The name of the cca component.
GetPortInstanceName
public java.lang.String GetPortInstanceName()
- Get the name of the port that contains the data field.
- Returns:
- The instance name of the port.
getTabName
public java.lang.String getTabName()