TextAreaWriter.java

Go to the documentation of this file.

package fi.jyu.mit.fxgui;

import java.io.*;

import javafx.scene.control.TextArea;


/**
 * Simple way to "print" to a JTextArea; just say
 * PrintWriter out = new PrintWriter(new TextAreaWriter(myTextArea));
 * Then out.println() et all will all appear in the TextArea.
 * 
 * Source: http://javacook.darwinsys.com/new_recipes/14.9betterTextToTextArea.jsp
 */
public final class TextAreaWriter extends Writer {

    private final TextArea textArea;

    /**
     * @param textArea area where to write
     * @example
     * <pre name="test">
     * #import java.io.*;
     * #import javax.swing.*;
     *   JTextArea text = new JTextArea();
     *   PrintWriter tw = new PrintWriter(new TextAreaWriter(text));
     *   tw.print("Hello");
     *   tw.print(" ");
     *   tw.print("world!");
     *   text.getText() === "Hello world!";
     *   text.setText("");
     *   tw.println("Hello");
     *   tw.println("world!");
     *   text.getText() =R= "Hello\\r?\\nworld!\\r?\\n";
     * </pre>
     */
    public TextAreaWriter(final TextArea textArea) {
        this.textArea = textArea;
    }

    @Override
    public void flush(){ /* */ }
    
    @Override
    public void close(){ /* */ }

    @Override
    public void write(char[] cbuf, int off, int len) throws IOException {
        textArea.appendText(new String(cbuf, off, len));
    }
    

    /**
     * Factory method for creating a PrintWriter to print to selected TextArea
     * @param textArea area where to print
     * @return created PrintWriter ready to print to TextArea
     * @example
     * <pre name="test">
     * #import java.io.*;
     * #import javax.swing.*;
     *   JTextArea text = new JTextArea();
     *   PrintWriter tw = TextAreaWriter.getTextPrintWriter(text);
     *   tw.print("Hyvää");
     *   tw.print(" ");
     *   tw.print("päivää!");
     *   text.getText() === "Hyvää päivää!";
     * </pre>
     */
    public static PrintWriter getTextPrintWriter(TextArea textArea) {
        return new PrintWriter(new TextAreaWriter(textArea)); 
    }

}