Package org.eclipse.debug.ui.console
Class ConsoleColorProvider
- java.lang.Object
-
- org.eclipse.debug.ui.console.ConsoleColorProvider
-
- All Implemented Interfaces:
IConsoleColorProvider
public class ConsoleColorProvider extends Object implements IConsoleColorProvider
Default console color provider for a process. Colors output to standard out, in, and error, as specified by user preferences.Clients implementing a console color provider should subclass this class.
- Since:
- 2.1
-
-
Constructor Summary
Constructors Constructor Description ConsoleColorProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidconnect(IProcess process, IConsole console)Connects this color provider to the given process and console.voiddisconnect()Disconnects this color provider.ColorgetColor(String streamIdentifer)Returns the color to draw output associated with the given stream.protected IConsolegetConsole()Returns the console this color provider is connected to, ornullif none.protected IProcessgetProcess()Returns the process this color provider is providing color for, ornullif none.booleanisReadOnly()Returns whether the console associated with this color provider's process can currently accept keyboard input.
-
-
-
Method Detail
-
connect
public void connect(IProcess process, IConsole console)
Description copied from interface:IConsoleColorProviderConnects this color provider to the given process and console. This color provider should connect its streams to the given console document.- Specified by:
connectin interfaceIConsoleColorProvider- Parameters:
process- the process to connect this color provider toconsole- the console to connect this color provider to
-
disconnect
public void disconnect()
Description copied from interface:IConsoleColorProviderDisconnects this color provider.- Specified by:
disconnectin interfaceIConsoleColorProvider
-
isReadOnly
public boolean isReadOnly()
Description copied from interface:IConsoleColorProviderReturns whether the console associated with this color provider's process can currently accept keyboard input. This attribute is dynamic and may change over the lifetime of a process/document.- Specified by:
isReadOnlyin interfaceIConsoleColorProvider- Returns:
- whether the console associated with this color provider's process can currently accept keyboard input
-
getColor
public Color getColor(String streamIdentifer)
Description copied from interface:IConsoleColorProviderReturns the color to draw output associated with the given stream.- Specified by:
getColorin interfaceIConsoleColorProvider- Parameters:
streamIdentifer- the identifier of the stream- Returns:
- Color
-
getProcess
protected IProcess getProcess()
Returns the process this color provider is providing color for, ornullif none.- Returns:
- the process this color provider is providing color for, or
nullif none
-
getConsole
protected IConsole getConsole()
Returns the console this color provider is connected to, ornullif none.- Returns:
- IConsole the console this color provider is connected to, or
nullif none
-
-