|
Eclipse Platform Release 3.1 |
|||||||||||
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
A console that displays text from I/O streams. An I/O console can have multiple output streams connected to it and provides one input stream connected to the keyboard.
Clients may instantiate and subclass this class.
Constructor Summary | |
---|---|
IOConsole(String name,
ImageDescriptor imageDescriptor)
Constructs a console with the given name and image. |
|
IOConsole(String name,
String consoleType,
ImageDescriptor imageDescriptor)
Constructs a console with the given name, type, and image with the workbench's default encoding. |
|
IOConsole(String name,
String consoleType,
ImageDescriptor imageDescriptor,
boolean autoLifecycle)
Constructs a console with the given name, type, image, and lifecycle, with the workbench's default encoding. |
|
IOConsole(String name,
String consoleType,
ImageDescriptor imageDescriptor,
String encoding,
boolean autoLifecycle)
Constructs a console with the given name, type, image, encoding and lifecycle. |
Method Summary | |
---|---|
void |
clearConsole()
Clears the console. |
IPageBookViewPage |
createPage(IConsoleView view)
Creates and returns a new page for this console. |
protected void |
dispose()
Disposes this console. |
int |
getHighWaterMark()
Returns the maximum number of characters that the console will display at once. |
IOConsoleInputStream |
getInputStream()
Returns the input stream connected to the keyboard. |
int |
getLowWaterMark()
Returns the number of characters that will remain in this console when its high water mark is exceeded. |
protected IConsoleDocumentPartitioner |
getPartitioner()
Returns this console's document partitioner. |
IOConsoleOutputStream |
newOutputStream()
Creates and returns a new output stream which may be used to write to this console. |
void |
setWaterMarks(int low,
int high)
Sets the text buffer size for this console. |
Methods inherited from class org.eclipse.ui.console.TextConsole |
---|
addHyperlink, addPatternMatchListener, getAttribute, getConsoleWidth, getDocument, getFont, getHyperlink, getHyperlinks, getRegion, getSchedulingRule, getTabWidth, matcherFinished, partitionerFinished, removePatternMatchListener, setAttribute, setConsoleWidth, setFont, setTabWidth |
Methods inherited from class org.eclipse.ui.console.AbstractConsole |
---|
activate, addPropertyChangeListener, destroy, firePropertyChange, 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 |
Constructor Detail |
public IOConsole(String name, String consoleType, ImageDescriptor imageDescriptor, boolean autoLifecycle)
name
- name to display for this consoleconsoleType
- console type identifier or null
imageDescriptor
- image to display for this console or null
autoLifecycle
- whether lifecycle methods should be called automatically
when this console is added/removed from the console managerpublic IOConsole(String name, String consoleType, ImageDescriptor imageDescriptor, String encoding, boolean autoLifecycle)
name
- name to display for this consoleconsoleType
- console type identifier or null
imageDescriptor
- image to display for this console or null
autoLifecycle
- whether lifecycle methods should be called automatically
when this console is added/removed from the console managerpublic IOConsole(String name, String consoleType, ImageDescriptor imageDescriptor)
name
- name to display for this consoleconsoleType
- console type identifier or null
imageDescriptor
- image to display for this console or null
public IOConsole(String name, ImageDescriptor imageDescriptor)
null
) type.
name
- name to display for this consoleimageDescriptor
- image to display for this console or null
Method Detail |
public IPageBookViewPage createPage(IConsoleView view)
IConsole
createPage
in interface IConsole
createPage
in class TextConsole
public IOConsoleOutputStream newOutputStream()
public IOConsoleInputStream getInputStream()
protected IConsoleDocumentPartitioner getPartitioner()
getPartitioner
in class TextConsole
public int getHighWaterMark()
public int getLowWaterMark()
public void setWaterMarks(int low, int high)
low
- the number of characters remaining in the buffer when the high
water mark is exceeded (if -1 the console does not limit output)high
- the maximum number of characters this console will cache in
its text buffer (if -1 the console does not limit output)
IllegalArgumentException
- if low >= high & low != -1public void clearConsole()
TextConsole
Since a console may or may not support direct manipulation of its document's contents, this method should be called to clear a text console's document. The default implementation sets this console's document content to the empty string directly. Subclasses should override as required.
clearConsole
in class TextConsole
protected void dispose()
dispose
in class TextConsole
|
Eclipse Platform Release 3.1 |
|||||||||||
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, 2005. All rights reserved.