PTP
Release 7.0

org.eclipse.ptp.services.ui.wizards
Class ServiceConfigurationWidget

java.lang.Object
  extended by Wizard
      extended by org.eclipse.ptp.services.ui.wizards.ServiceConfigurationWidget

public class ServiceConfigurationWidget
extends Wizard

Wizard to configure service providers using the wizard supplied by the providerContributer extension point. NOT CURRENTLY USED AND MAY BE DEPRECATED


Nested Class Summary
 class ServiceConfigurationWidget.AddListener
           
 class ServiceConfigurationWidget.ConfigureListener
           
 class ServiceConfigurationWidget.RemoveListener
           
 
Field Summary
protected  Button fAddButton
           
protected  Listener fConfigChangeListener
           
protected  Button fConfigureButton
           
protected  Map<String,IServiceProvider> fProviderIDToProviderMap
           
protected  Button fRemoveButton
           
protected  IStructuredSelection fSelection
           
protected  IServiceConfiguration fServiceConfiguration
           
protected  Set<IServiceConfiguration> fServiceConfigurations
           
protected  Map<String,String> fServiceIDToSelectedProviderID
           
protected  Table fTable
           
protected  IWorkbench fWorkbench
           
protected static String PROVIDER_KEY
           
protected static String SERVICE_KEY
           
 
Constructor Summary
ServiceConfigurationWidget(Set<IServiceConfiguration> serviceConfigurations)
           
 
Method Summary
 Control createContents(Composite parent)
           
protected  void createTableContent()
          Generate the services, providers and provider configuration available for the given configuration in the table Sub-classes may override its behaviour
protected  Listener getAddListener()
           
 Listener getConfigChangeListener()
           
protected  Listener getConfigureListener()
           
protected  Set<IService> getContributedServices(IProject project)
          Find available remote services and service providers for a given project
 Map<String,IServiceProvider> getProviderIDToProviderMap()
           
protected  Listener getRemoveListener()
           
 IServiceConfiguration getServiceConfiguration()
          Get the service configuration for this widget
 Map<String,String> getServiceIDToSelectedProviderID()
           
 Table getTable()
           
 void init(IWorkbench workbench, IStructuredSelection selection)
           
 boolean isConfigured()
          Sub-class may override behaviour
protected  boolean isConfigured(IProject project, Map<String,String> serviceIDToSelectedProviderID, Map<String,IServiceProvider> providerIDToProviderMap)
          Determine if all service providers have been configured
 boolean performFinish()
           
 void setConfigChangeListener(Listener configChangeListener)
          Listens for changes in service provider configuration
 void setProviderIDToProviderMap(Map<String,IServiceProvider> providerIDToProviderMap)
           
 void setServiceIDToSelectedProviderID(Map<String,String> serviceIDToSelectedProviderID)
           
 void setTable(Table table)
           
protected  void updateAddRemoveButtons()
           
protected  void updateConfigureButton(IServiceProviderDescriptor descriptor)
          Enable/disable the configure button in this widget based on the service provider descriptor selected
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROVIDER_KEY

protected static final String PROVIDER_KEY
See Also:
Constant Field Values

SERVICE_KEY

protected static final String SERVICE_KEY
See Also:
Constant Field Values

fServiceConfigurations

protected Set<IServiceConfiguration> fServiceConfigurations

fServiceConfiguration

protected IServiceConfiguration fServiceConfiguration

fServiceIDToSelectedProviderID

protected Map<String,String> fServiceIDToSelectedProviderID

fProviderIDToProviderMap

protected Map<String,IServiceProvider> fProviderIDToProviderMap

fTable

protected Table fTable

fConfigureButton

protected Button fConfigureButton

fAddButton

protected Button fAddButton

fRemoveButton

protected Button fRemoveButton

fConfigChangeListener

protected Listener fConfigChangeListener

fWorkbench

protected IWorkbench fWorkbench

fSelection

protected IStructuredSelection fSelection
Constructor Detail

ServiceConfigurationWidget

public ServiceConfigurationWidget(Set<IServiceConfiguration> serviceConfigurations)
Method Detail

createContents

public Control createContents(Composite parent)

getConfigChangeListener

public Listener getConfigChangeListener()
Returns:
the configuration change listener

getProviderIDToProviderMap

public Map<String,IServiceProvider> getProviderIDToProviderMap()

getServiceConfiguration

public IServiceConfiguration getServiceConfiguration()
Get the service configuration for this widget

Returns:
service configuration

getServiceIDToSelectedProviderID

public Map<String,String> getServiceIDToSelectedProviderID()

getTable

public Table getTable()

init

public void init(IWorkbench workbench,
                 IStructuredSelection selection)

isConfigured

public boolean isConfigured()
Sub-class may override behaviour

Returns:
true if all available services have been configured

performFinish

public boolean performFinish()

setConfigChangeListener

public void setConfigChangeListener(Listener configChangeListener)
Listens for changes in service provider configuration

Parameters:
configChangeListener - the configuration change listener to set

setProviderIDToProviderMap

public void setProviderIDToProviderMap(Map<String,IServiceProvider> providerIDToProviderMap)

setServiceIDToSelectedProviderID

public void setServiceIDToSelectedProviderID(Map<String,String> serviceIDToSelectedProviderID)

setTable

public void setTable(Table table)

createTableContent

protected void createTableContent()
Generate the services, providers and provider configuration available for the given configuration in the table Sub-classes may override its behaviour

Parameters:
project -

getAddListener

protected Listener getAddListener()

getConfigureListener

protected Listener getConfigureListener()

getContributedServices

protected Set<IService> getContributedServices(IProject project)
Find available remote services and service providers for a given project


getRemoveListener

protected Listener getRemoveListener()

isConfigured

protected boolean isConfigured(IProject project,
                               Map<String,String> serviceIDToSelectedProviderID,
                               Map<String,IServiceProvider> providerIDToProviderMap)
Determine if all service providers have been configured

Parameters:
project -
serviceIDToSelectedProviderID -
providerIDToProviderMap -
Returns:
true if all service providers have been configured

updateAddRemoveButtons

protected void updateAddRemoveButtons()

updateConfigureButton

protected void updateConfigureButton(IServiceProviderDescriptor descriptor)
Enable/disable the configure button in this widget based on the service provider descriptor selected

Parameters:
enabled -

PTP
Release 7.0

Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.