Application programming interfaces for interaction with the Eclipse console.
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 IConsoleA console. IConsoleConstantsConstants relating to the console plug-in. IConsoleDocumentPartitionerA document partitioner for a text console. IConsoleDocumentPartitionerExtensionExtension interface for
IConsoleFactoryA console factory extension is responsible for opening a console in the console view. IConsoleListenerA console listener is notified when consoles are added or removed from the console manager. IConsoleManagerThe console manager manages registered consoles. IConsolePageParticipantA console page participant is notified of page lifecycle events such as creation, activation, deactivation and disposal. IConsoleViewA view that displays consoles registered with the console manager. IHyperlinkA hyperlink in a console. IHyperlink2Optional extension to
IPatternMatchListenerA pattern match listener is registered with a
TextConsole, and is notified when its pattern has been matched to contents in that console.
IPatternMatchListenerDelegateA pattern match listener delegate is notified of regular expression matches in a text console. IScrollLockStateProviderA scroll lock provider allows a client to control the scroll lock state of its container, e.g. a view.
Class Summary Class Description AbstractConsoleCommon function for consoles. ConsolePluginThe console plug-in class. IOConsoleA console that displays text from I/O streams. IOConsoleInputStreamInputStream used to read input from an
IOConsoleOutputStreamOutputStream used to write to an IOConsole. MessageConsoleA console that displays messages. MessageConsoleStreamUsed to write messages to a message console. PatternMatchEventAn event describing a pattern match in a text console. TextConsoleAn abstract text console that supports regular expression matching and hyperlinks. TextConsolePageA page for a text console. TextConsoleViewerDefault viewer used to display a