com.github.croesch.micro_debug.gui.components.basic.AStreamTextArea Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micro-debug-gui Show documentation

A GUI for the micro-debug - a debugger for (micro-)assembler-programs for the Mic-1.

The newest version!

/*
 * Copyright (C) 2011-2012  Christian Roesch
 * 
 * This file is part of micro-debug-gui.
 * 
 * micro-debug-gui 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.
 * 
 * micro-debug-gui 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 micro-debug-gui.  If not, see .
 */
package com.github.croesch.micro_debug.gui.components.basic;

import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;

import javax.swing.SwingUtilities;

import com.github.croesch.micro_debug.annotation.NotNull;

/**
 * A text area that has a {@link PrintStream} to append content to the text area.
 * 
 * @author croesch
 * @since Date: Mar 17, 2012
 */
public abstract class AStreamTextArea extends MDTextArea {

  /** generated serial version UID */
  private static final long serialVersionUID = -1970161406114775052L;

  /** the {@link PrintStream} that is able to append text to this text area */
  @NotNull
  private final transient PrintStream stream;

  /**
   * Constructs a new text area, without activating it. To see get the {@link PrintStream} working see
   * {@link #activate()}.
   * 
   * @since Date: Mar 14, 2012
   * @param name the name of this text area
   * @see #activate()
   */
  public AStreamTextArea(final String name) {
    super(name);
    setEditable(false);

    this.stream = new PrintStream(new OutputStream() {
      @Override
      public void write(final int b) throws IOException {
        SwingUtilities.invokeLater(new Runnable() {
          public void run() {
            AStreamTextArea.this.append(String.valueOf((char) b));
          }
        });
      }
    });
  }

  /**
   * Activates this text area and its stream.
   * 
   * @since Date: Mar 14, 2012
   */
  public abstract void activate();

  /**
   * Deletes the text of this text area.
   * 
   * @since Date: Mar 14, 2012
   */
  public final void reset() {
    setText(null);
  }

  /**
   * Returns the {@link PrintStream} that prints content to this text area.
   * 
   * @since Date: Mar 17, 2012
   * @return the {@link PrintStream} to write to that text area.
   */
  @NotNull
  protected final PrintStream getStream() {
    return this.stream;
  }
}