|
Eclipse Platform Release 3.0 |
||||||||||
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.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 background
thread.
Clients may instantiate this class.
Field Summary | |
static int |
DEFAULT_TAB_SIZE
The default tab size |
static String |
P_FONT
Property constant indicating the font of this console has changed. |
static String |
P_STREAM_COLOR
Property constant indicating the color of a stream has changed. |
static String |
P_TAB_SIZE
Property constant indicating tab size has changed |
Constructor Summary | |
MessageConsole(String name,
ImageDescriptor imageDescriptor)
Constructs a new message console. |
Method Summary | |
protected void |
appendToDocument(String text,
MessageConsoleStream stream)
Appends the given message to this console, from the specified stream. |
IPageBookViewPage |
createPage(IConsoleView view)
Creates and returns a new page for this console. |
protected void |
dispose()
Called when this console is removed from the console manager. |
IDocument |
getDocument()
Returns the document this console writes to. |
Font |
getFont()
Returns the font for this console |
int |
getHighWaterMark()
Returns the maximum number of characters that the console will display at once. |
int |
getLowWaterMark()
Returns the number of characters that will remain in this console when its high water mark is exceeded. |
int |
getTabWidth()
Returns the tab width. |
MessageConsoleStream |
newMessageStream()
Returns a new message stream connected to this console. |
void |
setFont(Font font)
Sets the font used by this console |
void |
setTabWidth(int tabWidth)
Sets the tab width. |
void |
setWaterMarks(int low,
int high)
Sets the text buffer size for this console. |
Methods inherited from class org.eclipse.ui.console.AbstractConsole |
addPropertyChangeListener, firePropertyChange, getImageDescriptor, getName, init, removePropertyChangeListener, setImageDescriptor, setName |
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
public static final String P_STREAM_COLOR
public static final String P_TAB_SIZE
public static final int DEFAULT_TAB_SIZE
Constructor Detail |
public MessageConsole(String name, ImageDescriptor imageDescriptor)
name
- console nameimageDescriptor
- console image descriptor or null
if noneMethod Detail |
public int getHighWaterMark()
public void setWaterMarks(int low, int high)
low
- the number of characters remaining in the buffer when the high
water mark is exceededhigh
- the maximum number of characters this console will cache in
its text buffer
IllegalArgumentException
- if low >= highpublic int getLowWaterMark()
protected void dispose()
AbstractConsole
dispose
in class AbstractConsole
public IPageBookViewPage createPage(IConsoleView view)
IConsole
view
- the view in which the page is to be created
public void setFont(Font font)
font
- fontpublic Font getFont()
public MessageConsoleStream newMessageStream()
protected void appendToDocument(String text, MessageConsoleStream stream)
text
- messagestream
- stream the message belongs topublic IDocument getDocument()
public void setTabWidth(int tabWidth)
public int getTabWidth()
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.