Package org.eclipse.ui.console

Class MessageConsole

java.lang.Object

org.eclipse.ui.console.AbstractConsole

org.eclipse.ui.console.TextConsole

org.eclipse.ui.console.IOConsole

org.eclipse.ui.console.MessageConsole

All Implemented Interfaces:

IConsole

public class MessageConsole
extends IOConsole

A console that displays messages. A message console may have one or more streams connected to it (MessageConsoleStream). Text written to streams is buffered and processed in a Job by the console's document partitioner.

Clients may instantiate this class.

Since:

3.0

Restriction:

This class is not intended to be subclassed by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_TAB_SIZE	Deprecated. use IConsoleConstants.DEFAULT_TAB_SIZE
static String	P_FONT	Deprecated. use IConsoleConstants.P_FONT
static String	P_STREAM_COLOR	Deprecated. use IConsoleConstants.P_STREAM_COLOR
static String	P_TAB_SIZE	Deprecated. use IConsoleConstants.P_TAB_SIZE

Constructor Summary

Constructors

Constructor	Description
MessageConsole(String name, String consoleType, ImageDescriptor imageDescriptor, boolean autoLifecycle)	Constructs a message console with the given name, type, image, and lifecycle.
MessageConsole(String name, String consoleType, ImageDescriptor imageDescriptor, String encoding, boolean autoLifecycle)	Constructs a message console with the given name, type, image, encoding, and lifecycle specification.
MessageConsole(String name, ImageDescriptor imageDescriptor)	Constructs a message console with the given name and image.
MessageConsole(String name, ImageDescriptor imageDescriptor, boolean autoLifecycle)	Constructs a message console.

Method Summary

Modifier and Type	Method	Description
protected void	appendToDocument(String text, MessageConsoleStream stream)	Deprecated. since 3.1, this method should no longer be called, and has no effect.
IPageBookViewPage	createPage(IConsoleView view)	Creates and returns a new page for this console.
IOConsoleInputStream	getInputStream()	Returns the input stream connected to the keyboard.
MessageConsoleStream	newMessageStream()	Returns a new message stream connected to this console.

Methods inherited from class org.eclipse.ui.console.IOConsole

clearConsole, dispose, getCharset, getEncoding, getHighWaterMark, getLowWaterMark, getPartitioner, isCarriageReturnAsControlCharacter, isHandleControlCharacters, newOutputStream, setCarriageReturnAsControlCharacter, setHandleControlCharacters, setInputStream, setWaterMarks

Methods inherited from class org.eclipse.ui.console.TextConsole

addHyperlink, addPatternMatchListener, getAttribute, getBackground, getConsoleWidth, getDocument, getFont, getHyperlink, getHyperlinks, getRegion, getSchedulingRule, getTabWidth, init, isConsoleAutoScrollLock, matcherFinished, partitionerFinished, removePatternMatchListener, setAttribute, setBackgrond, setBackground, setConsoleAutoScrollLock, setConsoleWidth, setFont, setTabWidth

Methods inherited from class org.eclipse.ui.console.AbstractConsole

activate, addPropertyChangeListener, destroy, firePropertyChange, getHelpContextId, getImageDescriptor, getName, getType, initialize, removePropertyChangeListener, setImageDescriptor, setName, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

P_FONT

@Deprecated
public static final String P_FONT

Deprecated.

use IConsoleConstants.P_FONT

Property constant indicating the font of this console has changed.

P_STREAM_COLOR

@Deprecated
public static final String P_STREAM_COLOR

Deprecated.

use IConsoleConstants.P_STREAM_COLOR

Property constant indicating the color of a stream has changed.

P_TAB_SIZE

@Deprecated
public static final String P_TAB_SIZE

Deprecated.

use IConsoleConstants.P_TAB_SIZE

Property constant indicating tab size has changed

DEFAULT_TAB_SIZE

@Deprecated
public static final int DEFAULT_TAB_SIZE

Deprecated.

use IConsoleConstants.DEFAULT_TAB_SIZE

The default tab size

See Also:

Constant Field Values

Constructor Detail

MessageConsole

public MessageConsole(String name,
                      ImageDescriptor imageDescriptor)

Constructs a message console with the given name and image.

Parameters:

name - console name

imageDescriptor - console image descriptor or null

MessageConsole

public MessageConsole(String name,
                      ImageDescriptor imageDescriptor,
                      boolean autoLifecycle)

Constructs a message console.

Parameters:

name - console name

imageDescriptor - console image descriptor or null

autoLifecycle - whether lifecycle methods should be called automatically when added and removed from the console manager

Since:

3.1

MessageConsole

public MessageConsole(String name,
                      String consoleType,
                      ImageDescriptor imageDescriptor,
                      boolean autoLifecycle)

Constructs a message console with the given name, type, image, and lifecycle.

Parameters:

name - console name

consoleType - console type identifier or null

imageDescriptor - console image descriptor or null

autoLifecycle - whether lifecycle methods should be called automatically when added and removed from the console manager

Since:

3.4

MessageConsole

public MessageConsole(String name,
                      String consoleType,
                      ImageDescriptor imageDescriptor,
                      String encoding,
                      boolean autoLifecycle)

Constructs a message console with the given name, type, image, encoding, and lifecycle specification.

Parameters:

name - the name to display for this console

consoleType - console type identifier or null

imageDescriptor - console image descriptor or null

encoding - the encoding that should be used to render the text, or null if the system default encoding should be used

autoLifecycle - whether lifecycle methods should be called automatically when added and removed from the console manager

Since:

3.5

Method Detail

newMessageStream

public MessageConsoleStream newMessageStream()

Returns a new message stream connected to this console.

Clients should avoid writing large amounts of output to this stream in the UI thread. The console needs to process the output in the UI thread and if the client hogs the UI thread writing output to the console, the console will not be able to process the output.

Returns:

a new message stream connected to this console

createPage

public IPageBookViewPage createPage(IConsoleView view)

Description copied from interface: IConsole

Creates and returns a new page for this console. The page is displayed for this console in the console given view.

Specified by:

createPage in interface IConsole

Overrides:

createPage in class IOConsole

Parameters:

view - the view in which the page is to be created

Returns:

a page book view page representation of this console

getInputStream

public IOConsoleInputStream getInputStream()

Description copied from class: IOConsole

Returns the input stream connected to the keyboard.

Note: It returns the stream connected to keyboard. There is no guarantee to get the stream last set with IOConsole.setInputStream(InputStream). The return value might be null if the current input stream is not connected to the keyboard.

Overrides:

getInputStream in class IOConsole

Returns:

the input stream connected to the keyboard.

appendToDocument

@Deprecated
protected void appendToDocument(String text,
                                MessageConsoleStream stream)

Deprecated.

since 3.1, this method should no longer be called, and has no effect. Writing to a message console stream updates the document

Appends the given message to this console, from the specified stream.

Parameters:

text - message

stream - stream the message belongs to