com.ur.urcap.api.contribution

Interface ProgramNodeConfiguration

@ProviderType
public interface ProgramNodeConfiguration

Provides access to configure additional properties of a program node contribution with a HTML-based user interface.

Since:

1.5.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	setDisplayOrderId(double displayOrderId) Set the display order id for this type of program node contribution.

Method Detail

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.

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 ProgramNodeServiceConfigurable.configureContribution(ProgramNodeConfiguration) 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

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