org.netbeans.api.io

Class OutputWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

org.netbeans.api.io.OutputWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public abstract class OutputWriter
extends PrintWriter

Extended PrintWriter for writing into output window or similar output GUI component. It can support features like color printing, hyperlinks, or folding.

Methods of this class can be called in any thread.

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Method Summary

Modifier and Type	Method and Description
abstract void	endFold(Fold fold) Finish a fold.
abstract Position	getCurrentPosition() Get current position in the output stream.
abstract void	print(String s, Hyperlink link)
abstract void	print(String s, Hyperlink link, OutputColor color)
abstract void	print(String s, OutputColor color)
abstract void	println(String s, Hyperlink link)
abstract void	println(String s, Hyperlink link, OutputColor color)
abstract void	println(String s, OutputColor color)
abstract Fold	startFold(boolean expanded) Start a new fold.

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Method Detail

getCurrentPosition

public abstract Position getCurrentPosition()

Get current position in the output stream.

Returns:

The position.

startFold

public abstract Fold startFold(boolean expanded)

Start a new fold. If a fold already exists, a nested fold will be created.

Parameters:

expanded - True if the fold should be expanded by default, false if it should be collapsed.

Returns:

The fold handle.

endFold

public abstract void endFold(Fold fold)

Finish a fold. If it contains some unfinished nested folds, they will be finished as well.

Parameters:

fold - The fold to finish.

print

public abstract void print(String s,
                           Hyperlink link,
                           OutputColor color)

print

public abstract void print(String s,
                           Hyperlink link)

print

public abstract void print(String s,
                           OutputColor color)

println

public abstract void println(String s,
                             Hyperlink link,
                             OutputColor color)

println

public abstract void println(String s,
                             Hyperlink link)

println

public abstract void println(String s,
                             OutputColor color)