|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IConsole
A console that displays output and writes input to a process. Implementors of
IConsoleColorProvider
should connect streams to a console
document when connected to.
Clients are not intended to implement this interface.
IConsoleColorProvider
Method Summary | |
---|---|
void |
addLink(IConsoleHyperlink link,
int offset,
int length)
Deprecated. replaced with addLink(IHyperlink link, int offset, int length) |
void |
addLink(IHyperlink link,
int offset,
int length)
Adds the given hyperlink to this console. |
void |
addPatternMatchListener(IPatternMatchListener matchListener)
Adds the given pattern match listener to this console. |
void |
connect(IStreamMonitor streamMonitor,
java.lang.String streamIdentifer)
Connects this console to the given stream monitor, uniquely identified by the given identifier. |
void |
connect(IStreamsProxy streamsProxy)
Connects this console to the given streams proxy. |
IDocument |
getDocument()
Returns the document associated with this console. |
IProcess |
getProcess()
Returns the process associated with this console. |
IRegion |
getRegion(IConsoleHyperlink link)
Deprecated. replaced with getRegion(IHyperlink link) instead |
IRegion |
getRegion(IHyperlink link)
Returns the region of text associated with the given hyperlink, or null if the given hyperlink is not contained in this
console. |
IOConsoleOutputStream |
getStream(java.lang.String streamIdentifier)
Returns the stream associated with the specified stream identifier. |
void |
removePatternMatchListener(IPatternMatchListener matchListener)
Removes the given pattern match listener from this console. |
Method Detail |
---|
void connect(IStreamsProxy streamsProxy)
streamsProxy
- void connect(IStreamMonitor streamMonitor, java.lang.String streamIdentifer)
streamMonitor
- streamIdentifer
- void addLink(IConsoleHyperlink link, int offset, int length)
If the link's region (offset/length) is within the console's document current bounds, it is added immediately. Otherwise, the link is added when the console's document grows to contain the link's region.
link
- the hyperlink to addoffset
- the character offset within the console document where the
text associated with the hyperlink beginslength
- the length of the associated hyperlink textvoid addLink(IHyperlink link, int offset, int length)
If the link's region (offset/length) is within the console's document current bounds, it is added immediately. Otherwise, the link is added when the console's document grows to contain the link's region.
link
- the hyperlink to addoffset
- the character offset within the console document where the
text associated with the hyperlink beginslength
- the length of the associated hyperlink textIRegion getRegion(IConsoleHyperlink link)
null
if the given hyperlink is not contained in this
console.
link
- a console hyperlink
null
IRegion getRegion(IHyperlink link)
null
if the given hyperlink is not contained in this
console.
link
- a console hyperlink
null
IDocument getDocument()
IProcess getProcess()
void addPatternMatchListener(IPatternMatchListener matchListener)
matchListener
- the listener to addvoid removePatternMatchListener(IPatternMatchListener matchListener)
matchListener
- the pattern match listener to remove.IOConsoleOutputStream getStream(java.lang.String streamIdentifier)
streamIdentifier
- Uniquely identifies the required stream
null
if none found with matching streamIdentifier
|
Eclipse Platform Release 3.2 |
|||||||||
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, 2006. All rights reserved.