org.processmining.plugins.tracealignment.swingx

Class DocumentWriter

java.lang.Object

java.io.Writer

org.processmining.plugins.tracealignment.swingx.DocumentWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class DocumentWriter
extends java.io.Writer

An Writer implementation that places it's output in a swing text model (Document). The Document can be either a plain text or styled document implementation. If styled, the attributes assigned to the output stream will be used in the display of the output.

Version:

$Revision: 1.2 $, $Date: 2004/11/04 02:46:46 $

Author:

Timothy Prinzing

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
DocumentWriter(javax.swing.text.Document doc) Constructs an output stream that will output to the given document with whatever the default attributes are.
DocumentWriter(javax.swing.text.Document doc, javax.swing.text.AttributeSet a) Constructs an output stream that will output to the given document with the given set of character attributes.

Method Summary

Modifier and Type	Method and Description
void	close() Close the stream, flushing it first.
void	flush() Flush the stream.
void	write(char[] cbuf, int off, int len) Write a portion of an array of characters.
void	write(java.lang.String str) Write a string.
void	write(java.lang.String str, int off, int len) Write a portion of a string.

Methods inherited from class java.io.Writer

append, append, append, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentWriter

public DocumentWriter(javax.swing.text.Document doc,
                      javax.swing.text.AttributeSet a)

Constructs an output stream that will output to the given document with the given set of character attributes.

Parameters:

doc - the document to write to.

a - the character attributes to use for the written text.

DocumentWriter

public DocumentWriter(javax.swing.text.Document doc)

Constructs an output stream that will output to the given document with whatever the default attributes are.

Parameters:

doc - the document to write to.

Method Detail

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException

Write a portion of an array of characters.

Specified by:

write in class java.io.Writer

Parameters:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

java.io.IOException - If an I/O error occurs

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Write a portion of a string.

Overrides:

write in class java.io.Writer

Parameters:

str - A String

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

java.io.IOException - If an I/O error occurs

write

public void write(java.lang.String str)
           throws java.io.IOException

Write a string.

Overrides:

write in class java.io.Writer

Parameters:

str - String to be written

Throws:

java.io.IOException - If an I/O error occurs

flush

public void flush()
           throws java.io.IOException

Flush the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException - If an I/O error occurs

close

public void close()
           throws java.io.IOException

Close the stream, flushing it first. Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously-closed stream, however, has no effect.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException - If an I/O error occurs