| org.eclipse.ui.console |
|
Eclipse 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.
|
| Java Source File Name | Type | Comment |
| AbstractConsole.java | Class | Common function for consoles. |
| ConsolePlugin.java | Class | The console plug-in class. |
| IConsole.java | Interface | A console. |
| IConsoleConstants.java | Interface | Constants relating to the console plug-in. |
| IConsoleDocumentPartitioner.java | Interface | A document partitioner for a text console. |
| IConsoleFactory.java | Interface | A console factory extension is responsible for opening a console in the console view.
Extensions appear on a menu in the console view, and their openConsole
method is called when the action is invoked. |
| IConsoleListener.java | Interface | A console listener is notified when consoles are added or removed from
the console manager. |
| IConsoleManager.java | Interface | The console manager manages registered consoles. |
| IConsolePageParticipant.java | Interface | A console page participant is notified of page lifecycle events such as
creation, activation, deactivation and disposal. |
| IConsoleView.java | Interface | A view that displays consoles registered with the console manager. |
| IHyperlink.java | Interface | A hyperlink in a console. |
| IHyperlink2.java | Interface | Optional extension to
IHyperlink . |
| IOConsole.java | Class | A console that displays text from I/O streams. |
| IOConsoleInputStream.java | Class | InputStream used to read input from an IOConsole. |
| IOConsoleOutputStream.java | Class | OutputStream used to write to an IOConsole.
Clients are not intended to instantiate this class directly, instead
use IOConsole.newOutputStream(). |
| IPatternMatchListener.java | Interface | A pattern match listener is registered with a TextConsole,
and is notified when its pattern has been matched to contents in
that console. |
| IPatternMatchListenerDelegate.java | Interface | A pattern match listener delegate is notified of regular expression matches
in a text console. |
| MessageConsole.java | Class | A console that displays messages. |
| MessageConsoleStream.java | Class | Used to write messages to a message console. |
| PatternMatchEvent.java | Class | An event describing a pattern match in a text console. |
| TextConsole.java | Class | An abstract text console that supports regular expression matching and
hyperlinks.
Pattern match listeners can be registered with a console programmatically
or via the org.eclipse.ui.console.consolePatternMatchListeners
extension point.
Clients may subclass this class. |
| TextConsolePage.java | Class | A page for a text console.
Clients may contribute actions to the context menu of a text console page
using the org.eclipse.ui.popupMenus extension point. |
| TextConsoleViewer.java | Class | Default viewer used to display a TextConsole. |