|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ControllerListener
ControllerListeners can respond to events from the client side controller. The controller intercepts messages from the cca server, parses the messages, and responds to the messages by sending events to a ControllerListener. A GUI class usually implements the ControllerListener.
Method Summary | |
---|---|
void |
addComponentClass(AddComponentClassEvent event)
The cca server added a new component class. |
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 to a Uses Port. |
void |
disconnect(DisconnectEvent event)
The cca server broke the connection between a Provides Port to a Uses Port. |
void |
exit(ExitEvent event)
The cca server has terminated its communication link with this client. |
void |
getComponentProperty(GetComponentPropertyEvent event)
The cca server wants the GUI to write, to stdout, the value of a component property. |
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, to the client, the current value of a parameter that is contained inside the port of a component. |
void |
paramDefault(ParamDefaultEvent event)
The cca server is sending the default value of a parameter that is contained inside the port of a component. |
void |
paramDialog(ParamDialogEvent event)
The cca server wants the client to create an empty dialog box. |
void |
paramEndDialog(ParamEndDialogEvent event)
The cca server has finished sending, to the client, information for all the parameters that are inside a specific port. |
void |
paramField(ParamFieldEvent event)
The cca server has sent this client the name of a parameter that is inside a port. |
void |
paramHelp(ParamHelpEvent event)
The cca server has sent this client some helpful info about the current port parameter. |
void |
paramNumberRange(ParamNumberRangeEvent event)
The cca server sent the lowest value and the highest value that the current port parameter can have. |
void |
paramPrompt(ParamPromptEvent event)
The cca server sent us the prompt string for one of the parameters 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 |
remove(RemoveEvent event)
The cca server has removed an instantiation of a cca component. |
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. |
Method Detail |
---|
void addComponentClass(AddComponentClassEvent event)
event
- The event that is generated
when the cca server adds a new class.void addProvidesPorts(AddProvidesPortsEvent event)
event
- The event that is generated whenever
the cca server adds one or more ports to a component.void addUsesPorts(AddUsesPortsEvent event)
event
- The event that is generated whenever
the cca server adds one or more ports to a component.void connect(ConnectEvent event)
event
- The event that is generated whenever
the cca server connects a Provides Port with a Uses Port.void disconnect(DisconnectEvent event)
event
- The event that is generated whenever
the cca server breaks the connection between a Provides Port
and a Uses Port.void exit(ExitEvent event)
event
- The event that is generated whenever
the cca server breaks its communication link
with this client.void getComponentProperty(GetComponentPropertyEvent event)
event
- The event that is generated whenever
the cca server wants the GUI to write,
to stdout, the value of a component property.void instantiate(InstantiateEvent event)
event
- The event that is generated whenever
the cca server used a cca component class to
instantiate a new cca component object.void load(LoadEvent event)
event
- The event that is generated whenever
the cca server loads the java class of a cca widget.void message(MessageEvent event)
event
- The event that is created whenever
the cca server wants the client to display
a message on stdout.void paramCurrent(ParamCurrentEvent event)
event
- The event that is created whenever
the cca server wants to send the current value
of a data field.void paramDefault(ParamDefaultEvent event)
event
- The event that is created whenever
the cca server sends the default value of a data field.void paramDialog(ParamDialogEvent event)
event
- The event that is created whenever
the cca server wants the client to create
an empty dialog box.void paramEndDialog(ParamEndDialogEvent event)
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.void paramField(ParamFieldEvent event)
event
- The event that is created whenever
the cca server sends the name of a data field.void paramHelp(ParamHelpEvent event)
event
- The event that is generated
whenever the cca server sends this client
helpful info about a data field that is inside
a port.void paramNumberRange(ParamNumberRangeEvent event)
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.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.
event
- The event that is generated
whenever the cca server sends this client
the contents of a help string.void paramStringChoice(ParamStringChoiceEvent event)
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.void paramTab(ParamTabEvent event)
void remove(RemoveEvent event)
event
- The event that is generated whenever
the cca server removes an instantiation of a cca
component.void revalidate(RevalidateEvent event)
event
- The event that is generated
whenever the cca server revalidates all of the
cca ports in a cca component.void setComponentProperty(SetComponentPropertyEvent event)
event
- The event that is generated whenever
the cca server sets the value of a property
that is inside a cca component.void setPortProperty(SetPortPropertyEvent event)
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |