blob: c0531a5907159b297c846522771d9c9ed5ea03ef (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.ui.console;
import org.eclipse.debug.core.model.IProcess;
import org.eclipse.swt.graphics.Color;
/**
* Provides coloring for a console document. When a process is added to a
* registered launch the debug plug-in creates a console document for the
* process. By default, a document is created which is connected to the standard
* input, output, and error streams associated with the process. A client may
* override the default coloring by specifying a custom content provider for a
* process type. A process type is defined via the process attribute
* <code>IProcess. ATTR_PROCESS_TYPE</code>.
* <p>
* A console color provider extension is defined in <code>plugin.xml</code>.
* Following is an example definition of a console color provider extension.
* </p>
*
* <pre>
* <extension point="org.eclipse.debug.ui.consoleColorProviders">
* <consoleColorProvider
* id="com.example.ExampleConsoleColorProvider"
* class="com.example.ExampleConsoleColorProviderClass"
* processType="ExampleProcessType">
* </consoleColorProvider>
* </extension>
* </pre>
*
* The attributes are specified as follows:
* <ul>
* <li><code>id</code> specifies a unique identifier for this color
* provider.</li>
* <li><code>class</code> specifies a fully qualified name of a Java class that
* implements <code>IConsoleColorProvider</code>.</li>
* <li><code>processType</code> specifies the identifier of the process type
* this content provider is associated with (which corresponds to the
* <code>ATTR_PROCESS_TYPE</code> attribute on a process).</li>
* </ul>
* <p>
* Clients may implement this interface.
* </p>
*
* @since 2.1
*/
public interface IConsoleColorProvider {
/**
* Returns 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.
*
* @return whether the console associated with this color provider's
* process can currently accept keyboard input
*/
boolean isReadOnly();
/**
* Returns the color to draw output associated with the given stream.
*
* @param streamIdentifer the identifier of the stream
* @return Color
*/
Color getColor(String streamIdentifer);
/**
* Connects this color provider to the given process and console.
* This color provider should connect its streams to the given console
* document.
*
* @param process the process to connect this color provider to
* @param console the console to connect this color provider to
*/
void connect(IProcess process, IConsole console);
/**
* Disconnects this color provider.
*/
void disconnect();
}
|
