|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.sandia.ccaffeine.dc.user_iface.gui.guicmd.Gui
public class Gui
Interface to the GUI.
Constructor Summary | |
---|---|
Gui(GlobalData globalData)
Create a Gui object. |
Method Summary | |
---|---|
void |
addComponentClass(AddComponentClassEvent event)
The cca server added a new class. |
void |
addGuiListener(GuiListener listener)
|
void |
addProvidesPorts(AddProvidesPortsEvent event)
The cca server added one or more Provides Ports to a component. |
void |
addUsesPorts(AddUsesPortsEvent event)
The cca server added one or more Uses Ports to a component. |
void |
connect(ConnectEvent event)
The cca server connected a Provides Port from one component to a Uses Port. |
void |
disconnect(DisconnectEvent event)
The cca server broke a connection between a Provides Port and a Uses Port. |
void |
exit(ExitEvent event)
The cca server has terminated its communication link with this client. |
void |
getComponentClass(QueryEvent event)
The end-user wants to send a query to fetch the class of cca component. |
void |
getComponentInstance(QueryEvent event)
The end-user wants to send a query to fetch a component instance. |
void |
getComponentProperty(GetComponentPropertyEvent event)
The cca server wants the GUI to write, to stdout, the value of a component property. |
void |
getWaitingForPorts(QueryEvent event)
The end-user wants to send a query to fetch the "waitingForPorts" flag. |
void |
instantiate(InstantiateEvent event)
The cca server used a cca component class to instantiate a new cca component object. |
void |
load(LoadEvent event)
The cca server loaded the class of a cca widget. |
void |
message(MessageEvent event)
The cca server sent a message to this client. |
void |
paramCurrent(ParamCurrentEvent event)
The cca server is sending the current value of a data field. |
void |
paramDefault(ParamDefaultEvent event)
The cca server wants to send the default value of a data field. |
void |
paramDialog(ParamDialogEvent event)
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. |
void |
paramEndDialog(ParamEndDialogEvent event)
The cca server has finished sending information for all the data fields that are inside a port. |
void |
paramField(ParamFieldEvent event)
The cca server has sent this client the name of a data field that is inside a port. |
void |
paramHelp(ParamHelpEvent event)
The cca server has sent this client some helpful info about this data field. |
void |
paramNumberRange(ParamNumberRangeEvent event)
The cca server sent the lowest value and the highest value that the current data field can have. |
void |
paramPrompt(ParamPromptEvent event)
The cca server sent us the prompt string for one of the data fields in one of the ports of a cca component. |
void |
paramStringChoice(ParamStringChoiceEvent event)
The cca server is sending one, out of many, possible values that can be inserted into a data field. |
void |
paramTab(ParamTabEvent event)
The cca server is sending the name of tab. |
void |
print(PrintEvent event)
The end-user wants to print a string. |
void |
println(PrintEvent event)
The end-user wants to print a string. |
void |
remove(RemoveEvent event)
The cca server has removed an instantiation of a cca component. |
void |
removeGuiListener(GuiListener listener)
|
void |
revalidate(RevalidateEvent event)
The cca server has revalidated all of the cca ports in a cca component. |
void |
setComponentProperty(SetComponentPropertyEvent event)
The cca server has set the value of a property that is inside a cca component. |
void |
setPortProperty(SetPortPropertyEvent event)
The cca server has set the value of a property that is inside a port of a cca component. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Gui(GlobalData globalData)
globalData
- Global data store.Method Detail |
---|
public void addGuiListener(GuiListener listener)
public void removeGuiListener(GuiListener listener)
public void addComponentClass(AddComponentClassEvent event)
addComponentClass
in interface ControllerListener
event
- The event that is generated
when the cca server adds a new class.public void addProvidesPorts(AddProvidesPortsEvent event)
addProvidesPorts
in interface ControllerListener
event
- The event that is generated whenever
the cca server adds one or more ports to a component.public void addUsesPorts(AddUsesPortsEvent event)
addUsesPorts
in interface ControllerListener
event
- The event that is generated whenever
the cca server adds one or more ports to a component.public void connect(ConnectEvent event)
connect
in interface ControllerListener
event
- The event that is generated whenever
the cca server connects a Provides Port with a Uses Port.public void disconnect(DisconnectEvent event)
disconnect
in interface ControllerListener
event
- The event that is generated whenever
the cca server breaks the connection between a Provides Port
and a Uses Port.public void exit(ExitEvent event)
exit
in interface ControllerListener
event
- The event that is generated whenever
the cca server breaks its communication link
with this client.public void getComponentProperty(GetComponentPropertyEvent event)
getComponentProperty
in interface ControllerListener
event
- The event that is generated whenever
the cca server is querying for the value of a
property inside a cca component.public void instantiate(InstantiateEvent event)
instantiate
in interface ControllerListener
event
- The event that is generated whenever
the cca server used a cca component class to
instantiate a new cca component object.public void load(LoadEvent event)
load
in interface ControllerListener
event
- The event that is generated whenever
the cca server loads the java class of a cca widget.public void message(MessageEvent event)
message
in interface ControllerListener
event
- The event that is created whenever
the cca server sends a message to this client.public void paramCurrent(ParamCurrentEvent event)
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 GUI might respond by displaying the current value on the screen.
paramCurrent
in interface ControllerListener
event
- The event that is created whenever
the cca server wants to send the current value
of a data field.public void paramDefault(ParamDefaultEvent event)
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 GUI 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.
paramDefault
in interface ControllerListener
event
- The event that is created whenever
the cca server sends the default value of a data field.public void paramDialog(ParamDialogEvent event)
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 GUI might respond by creating an empty dialog box.
paramDialog
in interface ControllerListener
event
- The event that is created whenever
the cca server wants the client to create
an empty dialog box.public void paramEndDialog(ParamEndDialogEvent event)
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 GUI might respond by displaying a dialog box that is populated with information from all the data fields.
paramEndDialog
in interface ControllerListener
event
- The event that is created whenever
the cca server wants the client to display
a dialog box that contains the values of all
the data fields inside of a port.public void paramField(ParamFieldEvent event)
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 name of a data field. A GUI might respond by inserting a line of data into a dialog box.
paramField
in interface ControllerListener
event
- The event that is created whenever
the cca server sends the name of a data field.public void paramHelp(ParamHelpEvent event)
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 GUI might respond by setting up a help system inside of a dialog box.
paramHelp
in interface ControllerListener
event
- The event that is generated
whenever the cca server sends this client
helpful info about a data field that is inside
a port.public void paramNumberRange(ParamNumberRangeEvent event)
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 GUI can use to information to might respond by verify that the input values for this data field is within the allowed range.
paramNumberRange
in interface ControllerListener
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.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.dataFieldPrompt
- The prompt string; a view entity
might display the string to prompt the
end-user for the value of this data field.public void paramPrompt(ParamPromptEvent event)
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 GUI might display the string to prompt the end-user for the value of this data field.
paramPrompt
in interface ControllerListener
event
- The event that is generated
whenever the cca server sends this client
the contents of a help string.public void paramStringChoice(ParamStringChoiceEvent event)
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 GUI can display the items in the set as a pull down menu.
paramStringChoice
in interface ControllerListener
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.public void paramTab(ParamTabEvent event)
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 GUI can display each set as a tabbed pane.
paramTab
in interface ControllerListener
public void remove(RemoveEvent event)
remove
in interface ControllerListener
event
- The event that is generated whenever
the cca server removes an instantiation of a cca
component.public void revalidate(RevalidateEvent event)
revalidate
in interface ControllerListener
event
- The event that is generated
whenever the cca server revalidates all of the
cca ports in a cca component.public void setComponentProperty(SetComponentPropertyEvent event)
setComponentProperty
in interface ControllerListener
event
- The event that is generated whenever
the cca server sets the value of a property
that is inside a cca component.public void setPortProperty(SetPortPropertyEvent event)
setPortProperty
in interface ControllerListener
event
- The event that is generated whenever
the cca server sets the value of a property
that is inside a port of a cca component.public void print(PrintEvent event)
print
in interface GuiUserListener
event
- The event that is generated whenever the
end-user wants to print a string.public void println(PrintEvent event)
println
in interface GuiUserListener
event
- The event that is generated whenever
the end-user wants to print a string.public void getComponentInstance(QueryEvent event)
getComponentInstance
in interface GuiUserListener
event
- The event that is created whenever
an entity wants to fetch a component instance.public void getComponentClass(QueryEvent event)
getComponentClass
in interface GuiUserListener
event
- The event that is created whenever
the end-user wants to fetch the class of a component.public void getWaitingForPorts(QueryEvent event)
getWaitingForPorts
in interface GuiUserListener
event
- The event that is created whenever
the end-user wants to fetch the "waitingForPorts" flag.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |