blob: b42fc64914d7d3cdb82bcab254f98d6728680979 [file] [log] [blame]
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>README Console Content Providers Extension Point</title>
</head>
<body link="#0000FF" vlink="#800080">
<h1 align="center">Console Color Providers</h1>
<p><b><i>Identifier: </i></b>org.eclipse.debug.ui.consoleColorProviders</p>
<p><b><i>Description: </i></b>This extension point provides a mechanism for contributing
a console document coloring scheme for a process. The color provider will be
used to color output in the console.</p>
<p><b><i>Configuration Markup:</i></b> </p>
<pre>
<tt>&nbsp;&nbsp; &lt;!ELEMENT consoleColorProvider</tt>&gt;
<tt>&nbsp;&nbsp; &lt;!ATTLIST consoleColorProvider</tt> <br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</tt><br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED
processType CDATA #REQUIRED</tt>&gt;
</pre>
<ul>
<li><code>id</code> specifies a unique identifier for this console color provider.</li>
<li><code>class</code> specifies a fully qualified name of a Java class that
implements <code>IConsoleColorProvdider</code>.</li>
<li><font face="Courier New, Courier, mono">processType</font> specifies the
type of process this color provider is for. This attribute corresponds to
the process attribute <font face="Courier New, Courier, mono">IProcess.ATTR_PROCESS_TYPE</font>.</li>
</ul>
<p><b><i>Examples:</i></b> </p>
<p>The following is an example of a console color provider extension point: </p>
<pre>
&lt;extension point="org.eclipse.debug.ui.consoleColorProviders"&gt;
&lt;consoleColorProvider
id="com.example.ExampleConsoleColorProvider"
class="com.example.ExampleConsoleColorProvider"
processType=&quot;ExampleProcessType&quot;&gt;
&lt;/consoleColorProvider&gt;
&lt;/extension&gt;
</pre>
<p>In the above example, the contributed color provider will be used for processes
of type &quot;ExampleProcessType&quot;, which corresponds to the process attribute
<font face="Courier New, Courier, mono">IProcess.ATTR_PROCESS_TYPE</font>. Process
types are client defined, and are set by clients that create processes.</p>
<p><b><i>API Information: </i></b>Value of the attribute <b>class</b> must be
a fully qualified name of a Java class that implements the interface <b> org.eclipse.debug.ui.console.IConsoleColorProvider</b>.
</p>
<p><a href="hglegal.htm"><img src="ngibmcpy.gif" alt="Copyright IBM Corp. 2000, 2001. All Rights Reserved."
border="0" width="195" height="12"></a></p>
</body>
</html>