com.ur.urcap.api.contribution

Interface ProgramNodeContribution

public interface ProgramNodeContribution

Defines an API required for specifying a URCap Program Node within PolyScope.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
void	closeView() Called when this node is unselected in the program tree or when navigating to another view.
void	generateScript(ScriptWriter writer) Defines the script code to be generated by this program node within the program.
String	getTitle()
boolean	isDefined() Should return true if this program node is complete, and false otherwise.
void	openView() Called when this node is selected in the program tree.

Method Detail

openView

void openView()

Called when this node is selected in the program tree.

closeView

void closeView()

Called when this node is unselected in the program tree or when navigating to another view.

getTitle

String getTitle()

Returns:

The text displayed in the Program Tree for the program node.

Throws:

IllegalStateException - if the data model or child program sub-tree is modified

isDefined

boolean isDefined()

Should return true if this program node is complete, and false otherwise.

Undefined program nodes will be marked with yellow in the program tree. The user cannot start the program as long as it contains one or more undefined program nodes.

If this program node stores an unresolvable entity (e.g. PersistedVariable or TCP) in its DataModel, the program node will be treated as undefined.

Returns:

true if this program node is complete and otherwise false.

Throws:

IllegalStateException - if the data model or child program sub-tree is modified.

generateScript

void generateScript(ScriptWriter writer)

Defines the script code to be generated by this program node within the program.

Parameters:

writer - serves to add script commands that define the behaviour of this program node.