Package com.intellij.openapi.externalSystem.service.settings

Class AbstractImportFromExternalSystemControl<ProjectSettings extends ExternalProjectSettings,L extends ExternalSystemSettingsListener<ProjectSettings>,SystemSettings extends AbstractExternalSystemSettings<SystemSettings,ProjectSettings,L>>

java.lang.Object

com.intellij.openapi.externalSystem.service.settings.AbstractSettingsControl

com.intellij.openapi.externalSystem.service.settings.AbstractImportFromExternalSystemControl<ProjectSettings,L,SystemSettings>

public abstract class AbstractImportFromExternalSystemControl<ProjectSettings extends ExternalProjectSettings,L extends ExternalSystemSettingsListener<ProjectSettings>,SystemSettings extends AbstractExternalSystemSettings<SystemSettings,ProjectSettings,L>>
extends AbstractSettingsControl

A control which knows how to manage settings of external project being imported.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImportFromExternalSystemControl(ProjectSystemId externalSystemId, SystemSettings systemSettings, ProjectSettings projectSettings)
protected	AbstractImportFromExternalSystemControl(ProjectSystemId externalSystemId, SystemSettings systemSettings, ProjectSettings projectSettings, boolean showProjectFormatPanel)

Method Summary

Modifier and Type	Method and Description
void	apply()
protected abstract ExternalSystemSettingsControl<ProjectSettings>	createProjectSettingsControl(ProjectSettings settings) Creates a control for managing given project settings.
protected abstract ExternalSystemSettingsControl<SystemSettings>	createSystemSettingsControl(SystemSettings settings) Creates a control for managing given system-level settings (if any).
javax.swing.JComponent	getComponent()
ProjectFormatPanel	getProjectFormatPanel()
ProjectSettings	getProjectSettings()
ExternalSystemSettingsControl<ProjectSettings>	getProjectSettingsControl()
SystemSettings	getSystemSettings()
ExternalSystemSettingsControl<SystemSettings>	getSystemSettingsControl()
protected abstract void	onLinkedProjectPathChange(java.lang.String path)
void	reset()
void	reset(WizardContext wizardContext, Project project)
void	setCurrentProject(Project currentProject) This control is assumed to be used at least at two circumstances:
void	setLinkedProjectPath(java.lang.String path)
void	setShowProjectFormatPanel(boolean showProjectFormatPanel)
boolean	validate(WizardContext wizardContext, boolean defaultFormat)

Methods inherited from class com.intellij.openapi.externalSystem.service.settings.AbstractSettingsControl

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractImportFromExternalSystemControl

protected AbstractImportFromExternalSystemControl(ProjectSystemId externalSystemId,
                                                  SystemSettings systemSettings,
                                                  ProjectSettings projectSettings)

AbstractImportFromExternalSystemControl

protected AbstractImportFromExternalSystemControl(ProjectSystemId externalSystemId,
                                                  SystemSettings systemSettings,
                                                  ProjectSettings projectSettings,
                                                  boolean showProjectFormatPanel)

Method Detail

setCurrentProject

public void setCurrentProject(Project currentProject)

This control is assumed to be used at least at two circumstances:

 

   
new ide project is being created on the external project basis;
   
new ide module(s) is being added to the existing ide project on the external project basis;
 
 

We need to differentiate these situations, for example, we don't want to allow linking an external project to existing ide project if it's already linked.

This property helps us to achieve that - when an ide project is defined, that means that new modules are being imported to that ide project from external project; when this property is null that means that new ide project is being created on the target external project basis.

Parameters:

currentProject - current ide project (if any)

onLinkedProjectPathChange

protected abstract void onLinkedProjectPathChange(java.lang.String path)

createProjectSettingsControl

protected abstract ExternalSystemSettingsControl<ProjectSettings> createProjectSettingsControl(ProjectSettings settings)

Creates a control for managing given project settings.

Parameters:

settings - target external project settings

Returns:

control for managing given project settings

createSystemSettingsControl

protected abstract ExternalSystemSettingsControl<SystemSettings> createSystemSettingsControl(SystemSettings settings)

Creates a control for managing given system-level settings (if any).

Parameters:

settings - target system settings

Returns:

a control for managing given system-level settings; null if current external system doesn't have system-level settings (only project-level settings)

getComponent

public javax.swing.JComponent getComponent()

getProjectSettingsControl

public ExternalSystemSettingsControl<ProjectSettings> getProjectSettingsControl()

getSystemSettingsControl

public ExternalSystemSettingsControl<SystemSettings> getSystemSettingsControl()

setLinkedProjectPath

public void setLinkedProjectPath(java.lang.String path)

getSystemSettings

public SystemSettings getSystemSettings()

getProjectSettings

public ProjectSettings getProjectSettings()

setShowProjectFormatPanel

public void setShowProjectFormatPanel(boolean showProjectFormatPanel)

reset

public void reset()

reset

public void reset(WizardContext wizardContext,
                  Project project)

Overrides:

reset in class AbstractSettingsControl

apply

public void apply()

getProjectFormatPanel

public ProjectFormatPanel getProjectFormatPanel()

validate

public boolean validate(WizardContext wizardContext,
                        boolean defaultFormat)
                 throws ConfigurationException

Throws:

ConfigurationException