# com.bea.ide.ui.output
OutputSvc.IOutputWindow Interface

public static interface OutputSvc.IOutputWindow

This is the interface exposed by the output window objects. It can be used to add text to the windows as well as enable the ability to stop background tasks.

Enclosing class
  `OutputSvc`

## Method Summary

`public void` | `addMessage`(`OutputMessage` message) Adds to the current output window, can be called from any thread.
`public void` | `addMessage`(`String` message) Output simple string w/ default formatting
`public void` | `clear`() Clear all contents and reset any user selection.
`public `PrintStream`` | `getPrintStream`() Write text to the OutputWindow using a stream.
`public `IActionProxy`` | `getStopAction`() Return associated stop action.
`public `String`` | `getTitle`() Returns the display string used as the title of this output window.
`public void` | `nextItem`(int increment) Navigate to next message with a action.
`public void` | `setAutoScroll`() ask window to start auto-scrolling again, regarless of current state
`public void` | `setDefaultOutputMessage`(`OutputMessage` message) The default OutputMessage is used to format String messages.
`public void` | `setStopAction`(`IActionProxy` stop) Associate stop action with the current output window (e.g. stop find, or stop ant)

## Method Detail

### addMessage(OutputMessage) Method

    public void addMessage(OutputMessage message)

Adds to the current output window, can be called from any thread. OutputMessage can be used to customize the display.

### addMessage(String) Method

    public void addMessage(String message)

Output simple string w/ default formatting

### clear() Method

    public void clear()

Clear all contents and reset any user selection.

### getPrintStream() Method

    public PrintStream getPrintStream()

Write text to the OutputWindow using a stream. `addMessage()` is the preferred way to write to the OutputWindow, however, it can be useful to redirect a stream to using this method. Note, text is only output by `flush()` and `close()`.

### getStopAction() Method

    public IActionProxy getStopAction()

Return associated stop action.

### getTitle() Method

    public String getTitle()

Returns the display string used as the title of this output window.

### nextItem(int) Method

    public void nextItem(int increment)

Navigate to next message with a action.

#### Parameters

increment
  Set to 1 or -1 to search forward or backward

### setAutoScroll() Method

    public void setAutoScroll()

ask window to start auto-scrolling again, regarless of current state

### setDefaultOutputMessage(OutputMessage) Method

    public void setDefaultOutputMessage(OutputMessage message)

The default OutputMessage is used to format String messages. This can be useful if you need to output a lot of text with no associated action.

Related Topics

``OutputSvc.IOutputWindow.addMessage(String)``

### setStopAction(IActionProxy) Method

    public void setStopAction(IActionProxy stop)

Associate stop action with the current output window (e.g. stop find, or stop ant)