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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weka-virtualenv Show documentation
Virtual environment managment for Weka.
The newest version!
/*
 *   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 .
 */

/*
 * CommandOutputPanel.java
 * Copyright (C) 2018 University of Waikato, Hamilton, NZ
 */

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

import com.github.fracpete.jclipboardhelper.ClipboardHelper;
import com.github.fracpete.wekavirtualenv.command.Command;
import com.github.fracpete.wekavirtualenv.command.OutputListener;
import com.github.fracpete.wekavirtualenv.gui.core.FileChooser;
import com.github.fracpete.wekavirtualenv.gui.core.IconHelper;
import nz.ac.waikato.cms.core.FileUtils;
import nz.ac.waikato.cms.gui.core.BasePanel;
import nz.ac.waikato.cms.gui.core.BaseTextPaneWithWordWrap;
import nz.ac.waikato.cms.gui.core.ExtensionFileFilter;
import nz.ac.waikato.cms.gui.core.GUIHelper;

import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JPanel;
import javax.swing.JTabbedPane;
import javax.swing.text.SimpleAttributeSet;
import javax.swing.text.StyleConstants;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.event.ActionEvent;

/**
 * For capturing output from a command.
 *
 * @author FracPete (fracpete at waikato dot ac dot nz)
 */
public class CommandOutputPanel
  extends BasePanel
  implements OutputListener {

  /** the tabbed pane this panel belongs to. */
  protected JTabbedPane m_TabbedPane;

  /** the owner of the panel. */
  protected Command m_Owner;

  /** the text area. */
  protected BaseTextPaneWithWordWrap m_TextArea;

  /** the buttons on the left. */
  protected JPanel m_PanelButtonsLeft;

  /** the buttons on the right. */
  protected JPanel m_PanelButtonsRight;

  /** the button for clearing the output. */
  protected JButton m_ButtonClear;

  /** the button for copying the output. */
  protected JButton m_ButtonCopy;

  /** the button for saving the output. */
  protected JButton m_ButtonSave;

  /** the button for closing the output. */
  protected JButton m_ButtonClose;

  /** whether to enable word wrap. */
  protected JCheckBox m_CheckBoxLineWrap;

  /** the file chooser. */
  protected FileChooser m_FileChooser;

  /** the attribute set for stdout. */
  protected SimpleAttributeSet m_StdOutAttributeSet;

  /** the attribute set for stderr. */
  protected SimpleAttributeSet m_StdErrAttributeSet;

  /**
   * Initializes the members.
   */
  @Override
  protected void initialize() {
    super.initialize();

    m_StdOutAttributeSet = new SimpleAttributeSet();
    StyleConstants.setForeground(m_StdOutAttributeSet, Color.BLACK);
    StyleConstants.setFontFamily(m_StdOutAttributeSet, "monospaced");

    m_StdErrAttributeSet = new SimpleAttributeSet();
    StyleConstants.setForeground(m_StdErrAttributeSet, Color.RED.darker());
    StyleConstants.setFontFamily(m_StdErrAttributeSet, "monospaced");
  }

  /**
   * Initializes the widgets;
   */
  @Override
  protected void initGUI() {
    JPanel	panel;

    super.initGUI();

    setLayout(new BorderLayout());
    m_TextArea = new BaseTextPaneWithWordWrap();
    m_TextArea.setFont(Font.decode("monospaced"));
    add(m_TextArea);

    // buttons
    panel = new JPanel(new BorderLayout());
    add(panel, BorderLayout.SOUTH);
    m_PanelButtonsLeft = new JPanel(new FlowLayout(FlowLayout.LEFT));
    panel.add(m_PanelButtonsLeft, BorderLayout.WEST);
    m_PanelButtonsRight = new JPanel(new FlowLayout(FlowLayout.RIGHT));
    panel.add(m_PanelButtonsRight, BorderLayout.EAST);

    m_ButtonClear = new JButton(IconHelper.getIcon("Clear"));
    m_ButtonClear.setToolTipText("Clears the output");
    m_ButtonClear.addActionListener((ActionEvent e) -> clear());
    m_PanelButtonsLeft.add(m_ButtonClear);

    m_ButtonCopy = new JButton(IconHelper.getIcon("Copy"));
    m_ButtonCopy.setToolTipText("Copies the output to the clipboard");
    m_ButtonCopy.addActionListener((ActionEvent e) -> copy());
    m_PanelButtonsLeft.add(m_ButtonCopy);

    m_ButtonSave = new JButton(IconHelper.getIcon("Save"));
    m_ButtonSave.setToolTipText("Saves the output to a file");
    m_ButtonSave.addActionListener((ActionEvent e) -> save());
    m_PanelButtonsLeft.add(m_ButtonSave);

    m_CheckBoxLineWrap = new JCheckBox("Line wrap");
    m_CheckBoxLineWrap.setSelected(m_TextArea.getWordWrap());
    m_CheckBoxLineWrap.addActionListener((ActionEvent e) -> {
      m_TextArea.setWordWrap(!m_TextArea.getWordWrap());
    });
    m_PanelButtonsLeft.add(m_CheckBoxLineWrap);

    m_ButtonClose = new JButton(IconHelper.getIcon("Close"));
    m_ButtonClose.setToolTipText("Closes the tab");
    m_ButtonClose.addActionListener((ActionEvent e) -> close());
    m_PanelButtonsRight.add(m_ButtonClose);
  }

  /**
   * Finishes the initialization.
   */
  @Override
  protected void finishInit() {
    super.finishInit();
    updateButtons();
  }

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

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

  /**
   * Sets the owner that generated the output.
   *
   * @param value	the owner
   */
  public void setOwner(Command value) {
    m_Owner = value;
    m_Owner.addOutputListener(this);
  }

  /**
   * Returns the owner that generated the output.
   *
   * @return		the owner
   */
  public Command getOwner() {
    return m_Owner;
  }

  /**
   * Gets called when output was produced.
   *
   * @param line	the line to process
   * @param stdout	whether stdout or stderr
   */
  public void outputOccurred(String line, boolean stdout) {
    boolean 	atEnd;

    atEnd = (m_TextArea.getCaretPosition() == m_TextArea.getText().length());
    m_TextArea.append(line + "\n", stdout ? m_StdOutAttributeSet : m_StdErrAttributeSet);
    if (atEnd)
      m_TextArea.setCaretPositionLast();

    updateButtons();
  }

  /**
   * Clears the output.
   */
  public void clear() {
    m_TextArea.setText("");
    updateButtons();
  }

  /**
   * Copies the output to the clipboard.
   */
  public void copy() {
    if (m_TextArea.getSelectedText() == null)
      ClipboardHelper.copyToClipboard(m_TextArea.getText());
    else
      ClipboardHelper.copyToClipboard(m_TextArea.getSelectedText());
  }

  /**
   * Saves the output.
   */
  public void save() {
    int		retVal;
    String	msg;

    if (m_FileChooser == null) {
      m_FileChooser = new FileChooser();
      m_FileChooser.addChoosableFileFilter(new ExtensionFileFilter("Text file", "txt"));
      m_FileChooser.setAcceptAllFileFilterUsed(true);
    }

    retVal = m_FileChooser.showSaveDialog(this);
    if (retVal != FileChooser.APPROVE_OPTION)
      return;

    msg = FileUtils.writeToFileMsg(m_FileChooser.getSelectedFile().getAbsolutePath(), m_TextArea.getText(), false, null);
    if (msg != null)
      GUIHelper.showErrorMessage(this, msg);
  }

  /**
   * Removes itself from the tabbed pane.
   */
  public void close() {
    m_TabbedPane.remove(this);
  }

  /**
   * Updates the enabled state of the buttons.
   */
  protected void updateButtons() {
    boolean	hasText;

    hasText = (m_TextArea.getText().length() > 0);
    m_ButtonClear.setEnabled(hasText);
    m_ButtonCopy.setEnabled(hasText);
    m_ButtonSave.setEnabled(hasText);
  }
}