com.ur.urcap.api.contribution

Interface ProgramNodeService

All Superinterfaces:

URCapProgramNodeService

public interface ProgramNodeService
extends URCapProgramNodeService

Defines an API required for adding a new type of program node to PolyScope.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
ProgramNodeContribution	createNode(URCapAPI api, DataModel model) Creates a new program node contribution instance.
InputStream	getHTML()
String	getId() Get the unique identifier for this kind of program node.
String	getTitle()
boolean	isChildrenAllowed() By returning true it is possible for the program node to have child nodes. NOTE: This method is only called once when the URCap is activated and never called again afterwards.
boolean	isDeprecated() By returning true it is not possible for the user to create new program nodes of this type.

Method Detail

getId

String getId()

Get the unique identifier for this kind of program node. The identifier will be used when storing programs that use the program node.

Returns:

the unique identifier.

isDeprecated

boolean isDeprecated()

By returning true it is not possible for the user to create new program nodes of this type. Loading of existing programs will however still be supported for this program node.
NOTE: This method is only called once when the URCap is activated and never called again afterwards.

Returns:

true if deprecated, false otherwise.

isChildrenAllowed

boolean isChildrenAllowed()

By returning true it is possible for the program node to have child nodes.
NOTE: This method is only called once when the URCap is activated and never called again afterwards.

Returns:

true if children are allowed, false otherwise.

getTitle

String getTitle()

Returns:

The text displayed in the Structure Tab for program nodes created by this factory.

getHTML

InputStream getHTML()

Returns:

Return an input stream with the HTML contents of the node.

createNode

ProgramNodeContribution createNode(URCapAPI api,
                                   DataModel model)

Creates a new program node contribution instance.

The returned node must use the supplied data model object to retrieve and store the data contained in it. All modifications to the supplied data model from the program node constructor are ignored when an existing program node is loaded or copy/pasted. Every change to the model object is registered as a separate undo/redo event in the program tree.

Parameters:

api - the URCap API object with access to domain data

model - object where all configuration data of the new program node instance is to be stored in and retrieved from

Returns:

the newly constructed program node contribution instance