| org.openide.windows.InputOutput
| InputOutput | | public interface InputOutput (Code) | | An I/O connection to one tab on the Output Window. To acquire an instance
to write to, call, e.g.,
IOProvider.getDefault().getInputOutput("someName", false).
To get actual streams to write to, call getOut() or
getErr() on the returned instance.
Generally it is preferable not to hold a reference to an instance of
org.openide.windows.InputOutput , but rather to fetch it by name from
org.openide.windows.IOProvider as
needed.
Note: For historical reasons, the mechanism to clear an output tab
is via the method
org.openide.windows.OutputWriter.reset , though it would have
made more sense implemented here.
See Also: OutputWriter
author:
Ian Formanek, Jaroslav Tulach, Petr Hamernik, Ales Novak, Jan Jancura |
| Method Summary | |
| public void | closeInputOutput()
Closes this tab. | | public Reader | flushReader()
Flush pending data in the input-line's reader. | | public OutputWriter | getErr()
Get an output writer to write to the tab in error mode. | | public Reader | getIn()
Get a reader to read from the tab. | | public OutputWriter | getOut()
Acquire an output writer to write to the tab. | | public boolean | isClosed()
Test whether this tab has been closed, either by a call to closeInputOutput()
or by the user closing the tab in the UI. | | public boolean | isErrSeparated()
Test whether the error output is mixed into the regular output or not. | | public boolean | isFocusTaken()
Test whether the output window takes focus when anything is written to it. | | public void | select()
Ensure this pane is visible. | | public void | setErrSeparated(boolean value)
Set whether the error output should be mixed into the regular output or not. | | public void | setErrVisible(boolean value)
Show or hide the error pane, if separated. | | public void | setFocusTaken(boolean value)
Set whether the output window should take focus when anything is written to it.
Note that this really means the output window will steal keyboard
focus whenever a line of output is written. | | public void | setInputVisible(boolean value)
Show or hide the input line. | | public void | setOutputVisible(boolean value)
Show or hide the standard output pane, if separated. |
| closeInputOutput | | public void closeInputOutput()(Code) | | Closes this tab. The effect of calling any method on an instance
of InputOutput after calling closeInputOutput() on it is undefined.
|
| flushReader | | public Reader flushReader()(Code) | | Flush pending data in the input-line's reader.
Called when the reader is about to be reused.
the flushed reader |
| getErr | | public OutputWriter getErr()(Code) | | 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.
the writer |
| getIn | | public Reader getIn()(Code) | | 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.
the reader |
| getOut | | public OutputWriter getOut()(Code) | | Acquire an output writer to write to the tab.
This is the usual use of a tab--it writes to the main output pane.
the writer |
| isClosed | | public boolean isClosed()(Code) | | Test whether this tab has been closed, either by a call to closeInputOutput()
or by the user closing the tab in the UI.
See Also: InputOutput.closeInputOutput true if it is closed |
| isErrSeparated | | public boolean isErrSeparated()(Code) | | Test whether the error output is mixed into the regular output or not.
Always true for both available implementations of this API.
true if separate, false if mixed in |
| isFocusTaken | | public boolean isFocusTaken()(Code) | | Test whether the output window takes focus when anything is written to it.
true if any write to the tab should cause it to gainkeyboard focus (not recommended) |
| select | | public void select()(Code) | | Ensure this pane is visible.
|
| setErrSeparated | | public void setErrSeparated(boolean value)(Code) | | Set whether the error output should be mixed into the regular output or not.
Note that this method is optional and is not supported by either of the
current implementations of InputOutput (core/output and core/output2).
Parameters:
value - true to separate, false to mix in |
| setErrVisible | | public void setErrVisible(boolean value)(Code) | | Show or hide the error pane, if separated. Does nothing in either
of the available implementations of this API.
Parameters:
value - true to show, false to hide |
| setFocusTaken | | public void setFocusTaken(boolean value)(Code) | | Set whether the output window should take focus when anything is written to it.
Note that this really means the output window will steal keyboard
focus whenever a line of output is written. This is generally an extremely
bad idea and strongly recommended against by most UI guidelines.
Parameters:
value - true to take focus |
| setInputVisible | | public void setInputVisible(boolean value)(Code) | | Show or hide the input line.
Parameters:
value - true to show, false to hide |
| setOutputVisible | | public void setOutputVisible(boolean value)(Code) | | Show or hide the standard output pane, if separated. Does nothing in either
of the available implementations of this API.
Parameters:
value - true to show, false to hide |
|
|