|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.console.AbstractConsole
org.eclipse.ui.console.TextConsole
org.eclipse.ui.console.IOConsole
org.eclipse.ui.console.MessageConsole
public class MessageConsole
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.
Field Summary | |
---|---|
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 | |
---|---|
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. |
|
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. |
Method Summary | |
---|---|
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 |
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, getEncoding, getHighWaterMark, getLowWaterMark, getPartitioner, newOutputStream, setWaterMarks |
Methods inherited from class org.eclipse.ui.console.TextConsole |
---|
addHyperlink, addPatternMatchListener, getAttribute, getBackground, getConsoleWidth, getDocument, getFont, getHyperlink, getHyperlinks, getRegion, getSchedulingRule, getTabWidth, matcherFinished, partitionerFinished, removePatternMatchListener, setAttribute, setBackgrond, setBackground, setConsoleWidth, setFont, setTabWidth |
Methods inherited from class org.eclipse.ui.console.AbstractConsole |
---|
activate, addPropertyChangeListener, destroy, firePropertyChange, getHelpContextId, getImageDescriptor, getName, getType, init, 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 |
---|
public static final String P_FONT
IConsoleConstants.P_FONT
public static final String P_STREAM_COLOR
IConsoleConstants.P_STREAM_COLOR
public static final String P_TAB_SIZE
IConsoleConstants.P_TAB_SIZE
public static final int DEFAULT_TAB_SIZE
IConsoleConstants.DEFAULT_TAB_SIZE
Constructor Detail |
---|
public MessageConsole(String name, ImageDescriptor imageDescriptor)
name
- console nameimageDescriptor
- console image descriptor or null
public MessageConsole(String name, ImageDescriptor imageDescriptor, boolean autoLifecycle)
name
- console nameimageDescriptor
- console image descriptor or null
autoLifecycle
- whether lifecycle methods should be called automatically
when added and removed from the console managerpublic MessageConsole(String name, String consoleType, ImageDescriptor imageDescriptor, boolean autoLifecycle)
name
- console nameconsoleType
- 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 managerpublic MessageConsole(String name, String consoleType, ImageDescriptor imageDescriptor, String encoding, boolean autoLifecycle)
name
- the name to display for this consoleconsoleType
- 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 usedautoLifecycle
- whether lifecycle methods should be called automatically
when added and removed from the console managerMethod Detail |
---|
public MessageConsoleStream newMessageStream()
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.
public IPageBookViewPage createPage(IConsoleView view)
IConsole
createPage
in interface IConsole
createPage
in class IOConsole
view
- the view in which the page is to be created
public IOConsoleInputStream getInputStream()
IOConsole
getInputStream
in class IOConsole
protected void appendToDocument(String text, MessageConsoleStream stream)
text
- messagestream
- stream the message belongs to
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.