org.openide.windows
Interface InputOutput

All Known Implementing Classes:

InputOutput.Null

public interface InputOutput

An I/O connection to one tab on the Output Window.

Note: take also a look at the class OutputWriter. The method to clean an Output tab resides there.

See Also:

OutputWriter

Inner Class Summary

static class	InputOutput.Null Deprecated. Use NULL instead.
static class	InputOutput.NullOutputWriter Deprecated. Use NULL instead.

Field Summary

static InputOutput	NULL Null InputOutput
static Reader	nullReader Deprecated. Use NULL instead.
static OutputWriter	nullWriter Deprecated. Use NULL instead.

Method Summary

void	closeInputOutput() Closes this tab.
Reader	flushReader() Flush pending data in the input-line's reader.
OutputWriter	getErr() Get an output writer to write to the tab in error mode.
Reader	getIn() Get a reader to read from the tab.
OutputWriter	getOut() Acquire an output writer to write to the tab.
boolean	isClosed() Test whether this tab is closed.
boolean	isErrSeparated() Test whether the error output is mixed into the regular output or not.
boolean	isFocusTaken() Test whether the output window takes focus when anything is written to it.
void	select() Make this pane visible.
void	setErrSeparated(boolean value) Set whether the error output should be mixed into the regular output or not.
void	setErrVisible(boolean value) Show or hide the error pane.
void	setFocusTaken(boolean value) Set whether the output window should take focus when anything is written to it.
void	setInputVisible(boolean value) Show or hide the input line.
void	setOutputVisible(boolean value) Show or hide the standard output pane.

Field Detail

NULL

public static final InputOutput NULL

Null InputOutput

nullReader

public static final Reader nullReader

Deprecated. Use NULL instead.

nullWriter

public static final OutputWriter nullWriter

Deprecated. Use NULL instead.

Method Detail

getOut

public OutputWriter getOut()

Acquire an output writer to write to the tab. This is the usual use of a tab--it writes to the main output pane.

Returns:

the writer

getIn

public Reader getIn()

Get a reader to read from the tab. If a reader is ever requested, an input line is added to the tab and used to read one line at a time.

Returns:

the reader

getErr

public OutputWriter getErr()

Get an output writer to write to the tab in error mode. This might show up in a different color than the regular output, e.g., or appear in a separate pane.

Returns:

the writer

closeInputOutput

public void closeInputOutput()

Closes this tab.

isClosed

public boolean isClosed()

Test whether this tab is closed.

Returns:

true if it is closed

See Also:

closeInputOutput()

setOutputVisible

public void setOutputVisible(boolean value)

Show or hide the standard output pane.

Parameters:

value - true to show, false to hide

setErrVisible

public void setErrVisible(boolean value)

Show or hide the error pane. If the error is mixed into the output, this may not be useful.

Parameters:

value - true to show, false to hide

setInputVisible

public void setInputVisible(boolean value)

Show or hide the input line.

Parameters:

value - true to show, false to hide

select

public void select()

Make this pane visible. For example, may select this tab in a multi-window.

isErrSeparated

public boolean isErrSeparated()

Test whether the error output is mixed into the regular output or not.

Returns:

true if separate, false if mixed in

setErrSeparated

public void setErrSeparated(boolean value)

Set whether the error output should be mixed into the regular output or not.

Returns:

true to separate, false to mix in

isFocusTaken

public boolean isFocusTaken()

Test whether the output window takes focus when anything is written to it.

Returns:

true if so

setFocusTaken

public void setFocusTaken(boolean value)

Set whether the output window should take focus when anything is written to it.

Returns:

true to take focus

flushReader

public Reader flushReader()

Flush pending data in the input-line's reader. Called when the reader is about to be reused.

Returns:

the flushed reader