I/O APIs
Official

InputOutputAPI

See:
Description

I/O APIs

org.openide.windows

Interfaces for working with input/output tabs.

InputOutputAPI

Just an API/SPI for defining the output window.

What is New (see all changes)?

• Jun 22 '12 Added IOProvider.getIO variant that takes all 4 possible parameters.

  Added method IOProvider.getIO that takes all 4 supported parameters and that complements other getIO methods. See IOProvider

  The original mapping from IO name to IO object has been replaced with mapping from pair [IO container, IO name] to IO object. This mapping is used for reusing of IO objects.

• May 1 '10 Added API for fine grain control over IO select operation

  Added class for fine control over select: IOSelect

• May 1 '10 Incompatible change to semantics of IOContainer.select()

  After fixing bug#185209 IOContainer.select() no longer performs these operations for us so implementations of IOProvider have to do them: IOContainer.open() , IOContainer.requestVisible() .

  Existing implementation of InputOutput.select() has been adjusted and is still compatible.

• Jul 24 '09 Adding API to have better control of text color and hyperlinks

  Adding class for color printing. IOColorPrint,

• Mar 6 '09 Adding API to control output color and programmatical scrolling

  Adding "feature class" to control output color and programmatical scrolling. IOColorLines, IOColors, IOPosition,

Use Cases

There is an SPI but additional implementations are not expected. The API is most important.

Simple usage example:

InputOutput io = IOProvider.getDefault().getIO("My Window", true);
io.select();
OutputWriter w = io.getOut();
w.println("Line of plain text.");
OutputListener listener = new OutputListener() {
    public void outputLineAction(OutputEvent ev) {
        StatusDisplayer.getDefault().setStatusText("Hyperlink clicked!");
    }
    public void outputLineSelected(OutputEvent ev) {
        // Let's not do anything special.
    }
    public void outputLineCleared(OutputEvent ev) {
        // Leave it blank, no state to remove.
    }
};
w.println("Line of hyperlinked text.", listener, true);

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
InputOutputAPI	Exported	Official	.../org/openide/windows/package-summary.html Just an API/SPI for defining the output window.

Implementation Details

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

You will very likely also want to declare

OpenIDE-Module-Requires: org.openide.windows.IOProvider

to ensure that an Output Window implementation is in fact enabled.

Read more about the implementation in the answers to architecture questions.