Package org.eclipse.ui.console

Application programming interfaces for interaction with the Eclipse console.

Package Specification

The Eclipse platform UI console plug-in provides a set of classes and interfaces to facilitate the creation and display of consoles in the ConsoleView. This package contains a generic abstract console (AbstractConsole) that provides some basic functionality as well as two complete implementations of consoles that may be subclassed.

The class TextConsole supports regular expression matching and hyperlinks. Clients must provide their own document partitioner.

IOConsole extends TextConsole and provides support for creating consoles based upon input and output streams via the use of IOConsoleOutputStream and IOConsoleInputStream. IOConsole is not an abstract class, it may be used as is or subclassed.

A console manager (IConsoleManager) manages all active consoles, and provides notification of consoles which are added and removed. Consoles are displayed in a page book view. Each console implementation is reponsible for creating its page (IPageBookView), which provides freedom of presentation to the console implementation. A single console may be displayed simultaneously in multiple console views, in different workbench windows.

Interface Summary

Interface	Description
IConsole	A console.
IConsoleConstants	Constants relating to the console plug-in.
IConsoleDocumentPartitioner	A document partitioner for a text console.
IConsoleDocumentPartitionerExtension	Extension interface for IConsoleDocumentPartitioner.
IConsoleFactory	A console factory extension is responsible for opening a console in the console view.
IConsoleListener	A console listener is notified when consoles are added or removed from the console manager.
IConsoleManager	The console manager manages registered consoles.
IConsolePageParticipant	A console page participant is notified of page lifecycle events such as creation, activation, deactivation and disposal.
IConsoleView	A view that displays consoles registered with the console manager.
IHyperlink	A hyperlink in a console.
IHyperlink2	Optional extension to IHyperlink.
IPatternMatchListener	A pattern match listener is registered with a TextConsole, and is notified when its pattern has been matched to contents in that console.
IPatternMatchListenerDelegate	A pattern match listener delegate is notified of regular expression matches in a text console.
IScrollLockStateProvider	A scroll lock provider allows a client to control the scroll lock state of its container, e.g. a view.

Class Summary

Class	Description
AbstractConsole	Common function for consoles.
ConsolePlugin	The console plug-in class.
IOConsole	A console that displays text from I/O streams.
IOConsoleInputStream	InputStream used to read input from an IOConsole.
IOConsoleOutputStream	OutputStream used to write to an IOConsole.
MessageConsole	A console that displays messages.
MessageConsoleStream	Used to write messages to a message console.
PatternMatchEvent	An event describing a pattern match in a text console.
TextConsole	An abstract text console that supports regular expression matching and hyperlinks.
TextConsolePage	A page for a text console.
TextConsoleViewer	Default viewer used to display a TextConsole.