|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
gov.sandia.ccaffeine.dc.user_iface.MVC.event.ParamDialogEvent
public class ParamDialogEvent
Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that 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.
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
*
Field Summary | |
---|---|
protected java.lang.String |
componentInstanceName
|
protected java.lang.String |
portInstanceName
The instance name of a port that contains the data fields. |
protected java.lang.String |
titleOfDialogBox
The title of the dialog box. |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
ParamDialogEvent(java.lang.Object source,
java.lang.String componentInstanceName,
java.lang.String portInstanceName,
java.lang.String titleOfDialogBox)
Create a ParamDialogEvent. |
Method Summary | |
---|---|
java.lang.String |
getComponentInstanceName()
|
java.lang.String |
GetPortInstanceName()
Get the instance name of a port that contains the data fields. |
java.lang.String |
getTitleOfDialogBox()
Get the title of the dialog box. |
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 |
Field Detail |
---|
protected java.lang.String componentInstanceName
protected java.lang.String portInstanceName
protected java.lang.String titleOfDialogBox
Constructor Detail |
---|
public ParamDialogEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String titleOfDialogBox)
Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that 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.
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 fields.
Example: "configure_port"titleOfDialogBox
- The title of
the dialog box.Method Detail |
---|
public java.lang.String getComponentInstanceName()
public java.lang.String GetPortInstanceName()
public java.lang.String getTitleOfDialogBox()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |