src/jalview/gui/JalviewAppender.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import javax.swing.JTextArea;
  24 import javax.swing.SwingUtilities;
  25
  26 import org.apache.log4j.WriterAppender;
  27 import org.apache.log4j.spi.LoggingEvent;
  28
  29 /**
  30  * From http://textareaappender.zcage.com/ the means to capture the logs, too.
  31  * Simple example of creating a Log4j appender that will write to a JTextArea.
  32  */
  33 public class JalviewAppender extends WriterAppender
  34 {
  35
  36   // BH 2019 was static
  37
  38   private JTextArea jTextArea = null;
  39
  40   /** Set the target JTextArea for the logging information to appear. */
  41   public void setTextArea(JTextArea jTextArea)
  42   {
  43     this.jTextArea = jTextArea;
  44   }
  45
  46   /**
  47    * Format and then append the loggingEvent to the stored JTextArea.
  48    */
  49   @Override
  50   public void append(LoggingEvent loggingEvent)
  51   {
  52     final String message = this.layout.format(loggingEvent);
  53
  54     // Append formatted message to textarea using the Swing Thread.
  55     SwingUtilities.invokeLater(new Runnable()
  56     {
  57       @Override
  58       public void run()
  59       {
  60         if (jTextArea != null)
  61         {
  62           jTextArea.append(message);
  63         }
  64       }
  65     });
  66   }
  67 }