public interface ProgramNodeContribution
Defines an API required for specifying a URCap Program Node within PolyScope.
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.
|
void openView()
Called when this node is selected in the program tree.
void closeView()
Called when this node is unselected in the program tree or when navigating to another view.
String getTitle()
IllegalStateException
- if the data model or child program sub-tree is modifiedboolean 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.
true
if this program node is complete and otherwise false
.IllegalStateException
- if the data model or child program sub-tree is modifiedvoid generateScript(ScriptWriter writer)
Defines the script code to be generated by this program node within the program.
writer
- serves to add script commands that define the behaviour of
this program nodeCopyright © 2019. All rights reserved.