org.eclipse.ptp.services.ui.widgets
Class ServiceProviderConfigurationWidget

java.lang.Object
  Composite
      org.eclipse.ptp.services.ui.widgets.ServiceProviderConfigurationWidget

public class ServiceProviderConfigurationWidget
extends Composite

A widget for configuring the services providers for a given service configuration. Displays a table containing the service providers grouped by category on the left part of the widget. When a provider is selected, the right hand part of the widget will display the provider configuration along with a check box to enable/disable the provider and a combo to select a different provider for the service. The configuration UI for the selected provider is supplied by the providerContributor extension point.

Constructor Summary

ServiceProviderConfigurationWidget(Composite parent, int style)

Method Summary

void	addSelectionListener(SelectionListener listener) Adds the listener to the collection of listeners who will be notified when the users selects a service configuration
void	applyChangesToConfiguration()
protected void	changeServiceState(boolean disabled)
IServiceConfiguration	getServiceConfiguration() Returns the service configuration object that is being displayed by this widget.
void	removeSelectionListener(SelectionListener listener) Removes the listener from the collection of listeners who will be notified when a service configuration is selected by the user.
void	setServiceConfiguration(IServiceConfiguration conf) Causes the tree to display all the services that are available in the system.
void	setServiceConfiguration(IServiceConfiguration configuration, java.util.Set<java.lang.String> natureIds) Causes the tree to display all the services that are available in the system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceProviderConfigurationWidget

public ServiceProviderConfigurationWidget(Composite parent,
                                          int style)

Method Detail

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the users selects a service configuration

Parameters:

listener - the listener that will be notified of the selection

applyChangesToConfiguration

public void applyChangesToConfiguration()

getServiceConfiguration

public IServiceConfiguration getServiceConfiguration()

Returns the service configuration object that is being displayed by this widget. In order for the changes made by the user to be reflected in the configuration the applyChangesToConfiguration() method must be called first.

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when a service configuration is selected by the user.

Parameters:

listener - the listener which will no longer be notified

setServiceConfiguration

public void setServiceConfiguration(IServiceConfiguration conf)

Causes the tree to display all the services that are available in the system. Services that are not part of the given service configuration will be shown as disabled. Services that are part of the given configuration will show as enabled. Any changes made by the user will only be applied to the given configuration when the applyChangesToConfiguration() method is called.

setServiceConfiguration

public void setServiceConfiguration(IServiceConfiguration configuration,
                                    java.util.Set<java.lang.String> natureIds)

Causes the tree to display all the services that are available in the system. Services that are not part of the given service configuration will be shown as disabled. Services that are part of the given configuration will show as enabled. Any changes made by the user will only be applied to the given configuration when the applyChangesToConfiguration() method is called. Additionally the services tree will be filtered to exclude services that do not apply to the given set of project nature IDs. This is useful when the widget is used as part of a project properties page as only the services that apply to the project will be shown.

changeServiceState

protected void changeServiceState(boolean disabled)