com.ur.urcap.api.contribution.program

Interface ContributionConfiguration

@ProviderType
public interface ContributionConfiguration

Provides access to configure properties of a program node contribution.

Since:

1.3.0

Method Summary

Modifier and Type	Method and Description
<T extends DeviceRegistrationManager> T	getDeviceRegistrationManager(Class<T> registrationManagerClass) This method can be used to obtain an interface for registering this program node contribution/service as conformant with a specific device type supported by PolyScope.
ProgramDebuggingSupport	getProgramDebuggingSupport() Configure PolyScope program debugging support for this URCap program node and all child nodes in its sub-tree.
void	setChildrenAllowed(boolean childrenAllowed) If set to true it is possible for the program node to have child nodes.
void	setDeprecated(boolean deprecated) If set to true it is not possible for the end user to create new program nodes of this type.
void	setDisplayOrderId(double displayOrderId) Set the display order id for this type of program node contribution.
void	setUserInsertable(boolean userInsertable) If set to false this program node will not appear in the Program Tab in PolyScope and can not be inserted in the program tree by the end user.

Method Detail

setChildrenAllowed

void setChildrenAllowed(boolean childrenAllowed)

If set to true it is possible for the program node to have child nodes.

The default value is false.

Parameters:

childrenAllowed - determines whether this node can have child nodes

setUserInsertable

void setUserInsertable(boolean userInsertable)

If set to false this program node will not appear in the Program Tab in PolyScope and can not be inserted in the program tree by the end user. It can only be inserted programmatically using the ProgramNodeFactory. This also means, it can not be inserted using copy/paste of that node directly. It can however be inserted by copy/paste of an ancestor of such a node.

The default value is true.

Parameters:

userInsertable - determines whether the end user can insert this node

setDeprecated

void setDeprecated(boolean deprecated)

If set to true it is not possible for the end user to create new program nodes of this type. Loading of existing programs will however still be supported for this program node.

The default value is false.

Parameters:

deprecated - determines whether this node is deprecated

setDisplayOrderId

void setDisplayOrderId(double displayOrderId)

Set the display order id for this type of program node contribution. This makes it possible to specify how all the program node contributions from a URCap should be ordered/sorted in PolyScope.

All program node contributions from a URCap will be grouped together and sorted (in ascending order) according to their display order id.

The default value is 0.0. If the display order id for all program node contributions in a URCap have the default value, the standard built-in sorting in PolyScope will be used.

Parameters:

displayOrderId - Determines the display order of the URCap program node type

Since:

1.5.0

getProgramDebuggingSupport

ProgramDebuggingSupport getProgramDebuggingSupport()

Configure PolyScope program debugging support for this URCap program node and all child nodes in its sub-tree.

Note: The configuration values of the ProgramDebuggingSupport instance will be read once immediately after the call to the SwingProgramNodeService.configureContribution(ContributionConfiguration) method has ended. Changing values at a later stage will have no effect, so do not store a reference to the ProgramDebuggingSupport object.

Returns:

an interface for configuring program debugging support for this program node

Since:

1.9.0

getDeviceRegistrationManager

<T extends DeviceRegistrationManager> T getDeviceRegistrationManager(Class<T> registrationManagerClass)

This method can be used to obtain an interface for registering this program node contribution/service as conformant with a specific device type supported by PolyScope.

Type Parameters:

T - The type of the device registration manager to return

Parameters:

registrationManagerClass - The class of the device registration manager to return, not null.

Returns:

A device registration manager for registering a program node contribution/service as a specific device

Since:

1.9.0