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

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      org.eclipse.ptp.services.ui.wizards.ServiceConfigurationWidget

All Implemented Interfaces:

org.eclipse.jface.wizard.IWizard, org.eclipse.ui.INewWizard, org.eclipse.ui.IWorkbenchWizard

public class ServiceConfigurationWidget
extends org.eclipse.jface.wizard.Wizard
implements org.eclipse.ui.INewWizard

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 org.eclipse.swt.widgets.Button	fAddButton
protected org.eclipse.swt.widgets.Listener	fConfigChangeListener
protected org.eclipse.swt.widgets.Button	fConfigureButton
protected Map<String,IServiceProvider>	fProviderIDToProviderMap
protected org.eclipse.swt.widgets.Button	fRemoveButton
protected org.eclipse.jface.viewers.IStructuredSelection	fSelection
protected IServiceConfiguration	fServiceConfiguration
protected Set<IServiceConfiguration>	fServiceConfigurations
protected Map<String,String>	fServiceIDToSelectedProviderID
protected org.eclipse.swt.widgets.Table	fTable
protected org.eclipse.ui.IWorkbench	fWorkbench
protected static String	PROVIDER_KEY
protected static String	SERVICE_KEY

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

ServiceConfigurationWidget(Set<IServiceConfiguration> serviceConfigurations)

Method Summary

org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.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 org.eclipse.swt.widgets.Listener	getAddListener()
org.eclipse.swt.widgets.Listener	getConfigChangeListener()
protected org.eclipse.swt.widgets.Listener	getConfigureListener()
protected Set<IService>	getContributedServices(org.eclipse.core.resources.IProject project) Find available remote services and service providers for a given project
Map<String,IServiceProvider>	getProviderIDToProviderMap()
protected org.eclipse.swt.widgets.Listener	getRemoveListener()
IServiceConfiguration	getServiceConfiguration() Get the service configuration for this widget
Map<String,String>	getServiceIDToSelectedProviderID()
org.eclipse.swt.widgets.Table	getTable()
void	init(org.eclipse.ui.IWorkbench workbench, org.eclipse.jface.viewers.IStructuredSelection selection)
boolean	isConfigured() Sub-class may override behaviour
protected boolean	isConfigured(org.eclipse.core.resources.IProject project, Map<String,String> serviceIDToSelectedProviderID, Map<String,IServiceProvider> providerIDToProviderMap) Determine if all service providers have been configured
boolean	performFinish()
void	setConfigChangeListener(org.eclipse.swt.widgets.Listener configChangeListener) Listens for changes in service provider configuration
void	setProviderIDToProviderMap(Map<String,IServiceProvider> providerIDToProviderMap)
void	setServiceIDToSelectedProviderID(Map<String,String> serviceIDToSelectedProviderID)
void	setTable(org.eclipse.swt.widgets.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 org.eclipse.jface.wizard.Wizard

addPage, addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.wizard.IWizard

addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer

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 org.eclipse.swt.widgets.Table fTable

fConfigureButton

protected org.eclipse.swt.widgets.Button fConfigureButton

fAddButton

protected org.eclipse.swt.widgets.Button fAddButton

fRemoveButton

protected org.eclipse.swt.widgets.Button fRemoveButton

fConfigChangeListener

protected org.eclipse.swt.widgets.Listener fConfigChangeListener

fWorkbench

protected org.eclipse.ui.IWorkbench fWorkbench

fSelection

protected org.eclipse.jface.viewers.IStructuredSelection fSelection

Constructor Detail

ServiceConfigurationWidget

public ServiceConfigurationWidget(Set<IServiceConfiguration> serviceConfigurations)

Method Detail

createContents

public org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)

getConfigChangeListener

public org.eclipse.swt.widgets.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 org.eclipse.swt.widgets.Table getTable()

init

public void init(org.eclipse.ui.IWorkbench workbench,
                 org.eclipse.jface.viewers.IStructuredSelection selection)

Specified by:

init in interface org.eclipse.ui.IWorkbenchWizard

isConfigured

public boolean isConfigured()

Sub-class may override behaviour

Returns:

true if all available services have been configured

performFinish

public boolean performFinish()

Specified by:

performFinish in interface org.eclipse.jface.wizard.IWizard

Specified by:

performFinish in class org.eclipse.jface.wizard.Wizard

setConfigChangeListener

public void setConfigChangeListener(org.eclipse.swt.widgets.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(org.eclipse.swt.widgets.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 org.eclipse.swt.widgets.Listener getAddListener()

getConfigureListener

protected org.eclipse.swt.widgets.Listener getConfigureListener()

getContributedServices

protected Set<IService> getContributedServices(org.eclipse.core.resources.IProject project)

Find available remote services and service providers for a given project

getRemoveListener

protected org.eclipse.swt.widgets.Listener getRemoveListener()

isConfigured

protected boolean isConfigured(org.eclipse.core.resources.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 -