com.ur.urcap.api.contribution.installation.swing

Interface SwingInstallationNodeService<C extends InstallationNodeContribution,V extends SwingInstallationNodeView<C>>

Type Parameters:

C - the (generic) type parameter for the interface representing the type of InstallationNodeContribution created by this SwingInstallationNodeService

V - the (generic) type parameter for the interface representing the type of the view used by the InstallationNodeContribution created by this service

public interface SwingInstallationNodeService<C extends InstallationNodeContribution,V extends SwingInstallationNodeView<C>>

Defines an API required for defining and adding to PolyScope an installation node and corresponding screen where the user interface is Swing-based.

Since:

1.3.0

Method Summary

Modifier and Type	Method and Description
void	configureContribution(ContributionConfiguration configuration) This method is called once after this service is registered.
C	createInstallationNode(InstallationAPIProvider apiProvider, V view, DataModel model, CreationContext context) Creates a new installation node instance.
V	createView(ViewAPIProvider apiProvider) Creates a new View instance which implements the UI for your installation node screen.
String	getTitle(Locale locale)

Method Detail

configureContribution

void configureContribution(ContributionConfiguration configuration)

This method is called once after this service is registered. Modify the configuration parameter to configure your contribution. The configuration object will already have default values for its properties matching most use cases.

The values of the ContributionConfiguration object will be read once immediately after this method call. Changing values at a later stage will have no effect, so do not store a reference to the configuration object.

If the default values are appropriate, leave this method empty.

Parameters:

configuration - a modifiable ContributionConfiguration with default values

getTitle

String getTitle(Locale locale)

Parameters:

locale - the current locale of PolyScope. Can be used for supporting titles in several languages.

Returns:

The text displayed for this installation contribution in the left-hand side navigation of the Installation Tab as well as the title of the corresponding installation node screen. Called once at start up.

createView

V createView(ViewAPIProvider apiProvider)

Creates a new View instance which implements the UI for your installation node screen. Called once when a new installation is loaded or created.

Parameters:

apiProvider - Provides access to functionality and services available from within PolyScope related to user interface and end user interaction

Returns:

the view

createInstallationNode

C createInstallationNode(InstallationAPIProvider apiProvider,
                         V view,
                         DataModel model,
                         CreationContext context)

Creates a new installation node 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 installation node constructor are ignored when an existing installation is loaded. The data model object is shared between all installation nodes contributed by the same URCap.

Parameters:

apiProvider - Provides access to functionality and services available from within PolyScope relevant for the installation node

view - the View created by createView(ViewAPIProvider)

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

context - the context in which this node is created

Returns:

the newly constructed installation node contribution instance