com.github.fracpete.wekavirtualenv.gui.env.EnvironmentAction Maven / Gradle / Ivy

Go to download
/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 * EnvironmentAction.java
 * Copyright (C) 2017 University of Waikato, Hamilton, NZ
 */

package com.github.fracpete.wekavirtualenv.gui.env;

import com.github.fracpete.wekavirtualenv.env.Environment;
import com.github.fracpete.wekavirtualenv.gui.action.AbstractAction;
import com.github.fracpete.wekavirtualenv.gui.action.AbstractEnvironmentAction;
import nz.ac.waikato.cms.gui.core.GUIHelper;

import javax.swing.JTabbedPane;
import javax.swing.SwingUtilities;
import javax.swing.SwingWorker;
import java.awt.event.ActionEvent;
import java.util.HashMap;
import java.util.Map;

/**
 * Actions for environments.
 *
 * @author FracPete (fracpete at waikato dot ac dot nz)
 */
public class EnvironmentAction
  extends javax.swing.AbstractAction {

  /** the owner. */
  protected AbstractAction m_Owner;

  /** the environment. */
  protected Environment m_Environment;

  /** the tabbed pane for output. */
  protected JTabbedPane m_TabbedPane;

  /** the environments panel. */
  protected EnvironmentsPanel m_EnvironmentsPanel;

  /** the launch counter. */
  protected Map m_Counter;

  public EnvironmentAction() {
    super();
    m_Owner             = null;
    m_TabbedPane        = null;
    m_EnvironmentsPanel = null;
    m_Counter           = new HashMap<>();
    m_Environment       = null;
  }

  /**
   * Sets the owner.
   *
   * @param value	the owner
   */
  public void setOwner(AbstractAction value) {
    m_Owner = value;
  }

  /**
   * Returns the owner.
   *
   * @return		the owner
   */
  public AbstractAction getOwner() {
    return m_Owner;
  }

  /**
   * Sets the tabbed pane for output.
   *
   * @param value	the pane
   */
  public void setTabbedPane(JTabbedPane value) {
    m_TabbedPane = value;
  }

  /**
   * Returns the tabbed pane for output.
   *
   * @return		the pane
   */
  public JTabbedPane getTabbedPane() {
    return m_TabbedPane;
  }

  /**
   * Sets the environments panel.
   *
   * @param value	the panel
   */
  public void setEnvironmentsPanel(EnvironmentsPanel value) {
    m_EnvironmentsPanel = value;
  }

  /**
   * Returns the environments panel.
   *
   * @return		the panel
   */
  public EnvironmentsPanel getEnvironmentsPanel() {
    return m_EnvironmentsPanel;
  }

  /**
   * Sets the environment.
   *
   * @param value	the environment to use
   */
  public void setEnvironment(Environment value) {
    m_Environment = value;
    if (m_Owner instanceof AbstractEnvironmentAction)
      ((AbstractEnvironmentAction) m_Owner).setEnvironment(value);
  }

  /**
   * Returns the environment.
   *
   * @return		the environment
   */
  public Environment getEnvironment() {
    return m_Environment;
  }

  /**
   * Returns whether the action generates console output.
   *
   * @return		true if the action generates console output
   */
  public boolean generatesOutput() {
    return m_Owner.generatesOutput();
  }

  /**
   * Generates the tab name.
   *
   * @return		the tab name
   */
  protected String getTabName() {
    String	result;
    String	key;

    key = getEnvironment().name + ":" + m_Owner.getName();
    if (!m_Counter.containsKey(key))
      m_Counter.put(key, 0);
    m_Counter.put(key, m_Counter.get(key) + 1);

    result = key + " (" + m_Counter.get(key) + ")";

    return result;
  }

  /**
   * Executes the action.
   *
   * @param e		the event
   */
  @Override
  public void actionPerformed(ActionEvent e) {
    ActionOutputPanel	panel;
    SwingWorker		worker;

    if (m_Owner.generatesOutput()) {
      panel = new ActionOutputPanel();
      panel.setTabbedPane(m_TabbedPane);
      panel.setAction(this);
      m_TabbedPane.addTab(getTabName(), panel);
      m_Owner.addOutputListener(panel);
    }

    worker = new SwingWorker() {
      @Override
      protected Object doInBackground() throws Exception {
	String msg = m_Owner.execute();
	SwingUtilities.invokeLater(() -> m_EnvironmentsPanel.reload());
	if (msg != null)
	  GUIHelper.showErrorMessage(null, "Failed to execute " + m_Owner.getName() + ":\n" + msg);
	return null;
      }
    };
    worker.execute();
  }
}