Package org.eclipse.ui.console
Interface IConsole
- All Known Implementing Classes:
AbstractConsole
,IOConsole
,MessageConsole
,TextConsole
public interface IConsole
A console. A console is commonly used to display messages such as the output
streams of a system process. A console can be displayed in one or more console
views.
The console implementations provided by this plug-in are textual
(TextConsole
, MessageConsole
and IOConsole
).
However a client can provide alternate presentations since a console implementation
is responsible for providing is page for the page book views in which consoles are
displayed.
Subclass AbstractConsole
when implementing this interface.
- Since:
- 3.0
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a listener for changes to properties of this console.createPage
(IConsoleView view) Creates and returns a new page for this console.Returns an image descriptor for this console, ornull
if none.getName()
Returns the name of this console.getType()
Returns a unique identifier for this console's type, ornull
if unspecified.void
Removes the given property listener from this console page.
-
Method Details
-
getName
String getName()Returns the name of this console.- Returns:
- the name of this console
-
getImageDescriptor
ImageDescriptor getImageDescriptor()Returns an image descriptor for this console, ornull
if none.- Returns:
- an image descriptor for this console, or
null
if none
-
createPage
Creates and returns a new page for this console. The page is displayed for this console in the console given view.- Parameters:
view
- the view in which the page is to be created- Returns:
- a page book view page representation of this console
-
addPropertyChangeListener
Adds a listener for changes to properties of this console. Has no effect if an identical listener is already registered.The changes supported by the console view are as follows:
IBasicPropertyConstants.P_TEXT
- indicates the name of a console has changedIBasicPropertyConstants.P_IMAGE
- indicates the image of a console has changed
Consoles may define additional properties as required.
- Parameters:
listener
- a property change listener
-
removePropertyChangeListener
Removes the given property listener from this console page. Has no effect if an identical listener is not already registered.- Parameters:
listener
- a property listener
-
getType
String getType()Returns a unique identifier for this console's type, ornull
if unspecified.- Returns:
- a unique identifier for this console's type, or
null
- Since:
- 3.1
-