|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GuiListener
GuiListeners can respond to events from the GUI.
Method Summary | |
---|---|
void |
componentProperties(ComponentPropertiesEvent event)
The GUI is requesting the cca server to send back or to set the value of a component property. |
void |
connect(ConnectEvent event)
The GUI is asking the cca server to connect the Provides Port of a cca component to a Uses Port. |
void |
disconnect(DisconnectEvent event)
The GUI is asking the cca server to disconnect the connection between a Provides Port of a cca component and a Uses Port. |
void |
display(DisplayEvent event)
Request some information from the server. |
void |
displayComponent(DisplayComponentEvent event)
The GUI is requesting the cca server to send back a cca component. |
void |
displayPalette(DisplayPaletteEvent event)
The GUI is requesting the cca server to send back all of the components that are in the palette. |
void |
displayState(DisplayStateEvent event)
The GUI is requesting the cca server to send back all components that are in the arena and to send back all connections. |
void |
exit(ExitEvent event)
The GUI wants to tell the cca server that the GUI is shutting down. |
void |
getAllInstancesInArena(GetInstancesEvent event)
The GUI is asking the cca server to send back all of the instantiated cca components. |
void |
getComponentProperty(GetComponentPropertyEvent event)
The GUI is requesting the cca server to send back the value of a property that is inside a cca component. |
void |
getPortParameter(ParamGetCurrentEvent event)
The GUI is asking the cca server to send back the value of one of the parameters of a port that is on a cca component. |
void |
go(GoEvent event)
The GUI wants the cca server to launch an application. |
void |
goComponentPort(GoComponentPortEvent event)
The GUI is requesting that the cca server execute the "go" command" on a specific port that is located on a specific component. |
void |
heartbeat(HeartbeatEvent event)
The GUI wants to send a heartbeat to the cca server. |
void |
instantiate(InstantiateEvent event)
The GUI is asking the cca server to retrieve a cca component. |
void |
links(DisplayChainEvent event)
The GUI is requesting the cca server to send back all connections. |
void |
nukeAll(NukeAllEvent event)
The GUI is requesting the cca server to delete all components. |
void |
path(PathEvent event)
The GUI wants to tell the cca server to send back or to set the file path that contains cca components. |
void |
portParameter(ParamEvent event)
The GUI is asking the cca server to get or set one of the parameters of a port that is on a cca port. |
void |
portProperties(PortPropertiesEvent event)
The GUI is requesting the cca server to send back or to set the value of a port property. |
void |
remove(RemoveEvent event)
The GUI wants the cca server to remove an instantiation of a cca component. |
void |
repository(RepositoryEvent event)
The GUI wants the cca server to send back all components that are in the repository or to send back one specific compnonent that is in the repository. |
void |
sendMessage(StringEvent event)
The GUI wants to send a message to the cca server. |
void |
setComponentProperty(SetComponentPropertyEvent event)
The GUI wants the server to set the value of a property that is inside of a cca component. |
void |
setDebug(SetDebugEvent event)
The GUI is asking the cca server to turn on debugging. |
void |
setNoDebug(SetDebugEvent event)
The GUI is asking the cca server to turn off debugging |
void |
setPortParameter(ParamCurrentEvent event)
The GUI is asking the cca server to set one of the parameters of a port that is on a cca component. |
void |
shell(ShellEvent event)
The GUI wants to send an O.S. |
Method Detail |
---|
void remove(RemoveEvent event)
event
- The event that is generated whenever
the GUI wants to remove an instantiation of a cca
component.void go(GoEvent event)
event
- The event that is generated whenever
the GUI wants to launch the application.void instantiate(InstantiateEvent event)
event
- The event that is generated whenever
the GUI wants to retrieve a cca component.void connect(ConnectEvent event)
event
- The event that is sent whenever
the GUI wants to connect a Uses Port with a
Provides Port.void disconnect(DisconnectEvent event)
event
- The event that is sent whenever
the GUI wants to connect a Uses Port with a
Provides Port.void setPortParameter(ParamCurrentEvent event)
event
- The event that is generated
whenever the GUI wants to set the value of
a data field.void getPortParameter(ParamGetCurrentEvent event)
event
- The event that is generated whenever
the GUI wants the value of one of the data fields.void portParameter(ParamEvent event)
event
- The event that is generated whenever
the GUI wants to get or set the value of one
of the data fields.void getAllInstancesInArena(GetInstancesEvent event)
event
- That event that is generated
whenever the GUI wants to get all of the
instantiated cca components.void setDebug(SetDebugEvent event)
void setNoDebug(SetDebugEvent event)
void display(DisplayEvent event)
If the GUI wants to get information on the components that are in the palette, or on the components that are in the arena, or on the connections that are established inside the arena, or on a particular component, or on the components and the connections that are in the arena, then the GUI will encapsulate the request as a DisplayEvent and will then invoke this method. This method will send the request to the cca server.
DisplayEvent
- The event that is
generated whenever an entity is requesting
some information from the server.void displayPalette(DisplayPaletteEvent event)
The cca server will send back all of the components that are in the palette. A GUI might respond by rending an icon, in the palette, for each component.
event
- The event that is generated whenever
the GUI wants to know what components
are in the palette.void links(DisplayChainEvent event)
event
- The event that is created
whenever the GUI wants to know what connections
are in the arena.void displayComponent(DisplayComponentEvent event)
The cca server will respond by sending back one cca component. The GUI might respond by rendering the component in the workspace.
source
- The entity that created this event.componentInstanceName
- The name of the
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"event
- The event that is created whenever
the GUI wants some information on a cca component.void displayState(DisplayStateEvent event)
The cca server will respond by sending back all of the components that are in the workspace and all of the connections. A GUI might respond by rendering an icon, in the work area, for each component and by drawing lines between the components to connect them.
event
- The event that is created whenever
we want to know the state of the arena.void goComponentPort(GoComponentPortEvent event)
event
- The event that is generated whenever
the GUI wants to invoke the "go" command.void nukeAll(NukeAllEvent event)
The server will respond by deleting all components. The GUI might respond by removing all components from the workspace. param event The event that is created whenever the GUI wants to to delete all components.
void portProperties(PortPropertiesEvent event)
event
- The event that is generated
whenever an entity wants to either get or
set the value of a port property.void componentProperties(ComponentPropertiesEvent event)
event
- The event that is generated
whenever the GUI wants to either get or
set the value of a component property.void getComponentProperty(GetComponentPropertyEvent event)
event
- The event that is generated
whenever the GUI wants the value of a
property that is inside a component.void setComponentProperty(SetComponentPropertyEvent event)
event
- The event that is created whenever
the GUI wants to set the value of a property.void sendMessage(StringEvent event)
event
- The event that is created
the GUI wants to send
a string to the cca server.void heartbeat(HeartbeatEvent event)
event
- The event that is fabricated
the GUI wants to emit a heartbeat.void exit(ExitEvent event)
event
- The event that is generated whenever
the GUI wants to exit the application.void path(PathEvent event)
event
- The event that is
generated whenever the GUI
wants either to set the path
to a new value or to query
for the path value.void repository(RepositoryEvent event)
event
- The event that is created whenever
the GUI wants to get one component or all components
from the repository,void shell(ShellEvent event)
event
- The event that is
created whenever the GUI wants
an O.S. command executed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |