python/src/com/jetbrains/python/buildout/BuildoutFacetConfiguration.java

/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.jetbrains.python.buildout;

import com.intellij.facet.FacetConfiguration;
import com.intellij.facet.ui.FacetEditorContext;
import com.intellij.facet.ui.FacetEditorTab;
import com.intellij.facet.ui.FacetValidatorsManager;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.options.ConfigurationException;
import com.intellij.openapi.util.InvalidDataException;
import com.intellij.openapi.util.JDOMExternalizerUtil;
import com.intellij.openapi.util.WriteExternalException;
import org.jdom.Element;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.Nullable;

import javax.swing.*;
import java.util.ArrayList;
import java.util.List;

/**
 * Stores buildout facet config data.
 * <br/>
 * User: dcheryasov
 * Date: Jul 25, 2010
 */
public class BuildoutFacetConfiguration implements FacetConfiguration {

  public final static String ATTR_SCRIPT = "script";

  private String myScriptName;
  private List<String> myPaths;

  public BuildoutFacetConfiguration(String scriptName) {
    myScriptName = scriptName;
  }

  @Override
  public FacetEditorTab[] createEditorTabs(FacetEditorContext editorContext, FacetValidatorsManager validatorsManager) {
    return new FacetEditorTab[] {new Tab(editorContext.getModule())};
  }

  public String getScriptName() {
    return myScriptName;
  }

  @Override
  public void readExternal(Element element) throws InvalidDataException {
    myScriptName = JDOMExternalizerUtil.readField(element, ATTR_SCRIPT);
  }

  @Override
  public void writeExternal(Element element) throws WriteExternalException {
    JDOMExternalizerUtil.writeField(element, ATTR_SCRIPT, myScriptName);
  }

  /**
   * Sets the paths to be prepended to pythonpath, taken from a buildout script.
   * @param paths what to store; the list will be copied. 
   */
  void setPaths(@Nullable List<String> paths) {
    if (paths != null) {
      myPaths = new ArrayList<String>(paths.size());
      for (String s : paths) myPaths.add(s);
    }
    else myPaths = null;                   
  }

  public List<String> getPaths() {
    return myPaths;
  }

  public void setScriptName(String scriptName) {
    myScriptName = scriptName;
  }

  private class Tab extends FacetEditorTab {

    private BuildoutConfigPanel myPanel;

    private Tab(Module module) {
      myPanel = new BuildoutConfigPanel(module, BuildoutFacetConfiguration.this);
    }

    @Nls
    @Override
    public String getDisplayName() {
      return "Buildout";
    }

    @Override
    public JComponent createComponent() {
      return myPanel;
    }

    @Override
    public boolean isModified() {
      return myPanel.isModified(BuildoutFacetConfiguration.this);
    }

    @Override
    public void reset() {
      myPanel.reset();
    }

    @Override
    public void apply() throws ConfigurationException {
      myPanel.apply();
    }

    @Override
    public void disposeUIResources() { }

    @Override
    public String getHelpTopic() {
      return "reference-python-buildout";
    }
  }
}