KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > ui > text > IJavaColorConstants


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/

11 package org.eclipse.jdt.ui.text;
12
13 /**
14  * Color keys used for syntax highlighting Java
15  * code and Javadoc compliant comments.
16  * A <code>IColorManager</code> is responsible for mapping
17  * concrete colors to these keys.
18  * <p>
19  * This interface declares static final fields only; it is not intended to be
20  * implemented.
21  * </p>
22  *
23  * @see org.eclipse.jdt.ui.text.IColorManager
24  * @see org.eclipse.jdt.ui.text.IColorManagerExtension
25  */

26 public interface IJavaColorConstants {
27
28     /**
29      * Note: This constant is for internal use only. Clients should not use this constant.
30      * The prefix all color constants start with
31      * (value <code>"java_"</code>).
32      */

33     String JavaDoc PREFIX= "java_"; //$NON-NLS-1$
34

35     /** The color key for multi-line comments in Java code
36      * (value <code>"java_multi_line_comment"</code>).
37      */

38     String JavaDoc JAVA_MULTI_LINE_COMMENT= "java_multi_line_comment"; //$NON-NLS-1$
39

40     /** The color key for single-line comments in Java code
41      * (value <code>"java_single_line_comment"</code>).
42      */

43     String JavaDoc JAVA_SINGLE_LINE_COMMENT= "java_single_line_comment"; //$NON-NLS-1$
44

45     /** The color key for Java keywords in Java code
46      * (value <code>"java_keyword"</code>).
47      */

48     String JavaDoc JAVA_KEYWORD= "java_keyword"; //$NON-NLS-1$
49

50     /** The color key for string and character literals in Java code
51      * (value <code>"java_string"</code>).
52      */

53     String JavaDoc JAVA_STRING= "java_string"; //$NON-NLS-1$
54

55     /** The color key for method names in Java code
56      * (value <code>"java_method_name"</code>).
57      *
58      * @since 3.0
59      * @deprecated replaced as of 3.1 by an equivalent semantic highlighting, see {@link org.eclipse.jdt.internal.ui.javaeditor.SemanticHighlightings#METHOD}
60      */

61     String JavaDoc JAVA_METHOD_NAME= "java_method_name"; //$NON-NLS-1$
62

63     /** The color key for keyword 'return' in Java code
64      * (value <code>"java_keyword_return"</code>).
65      *
66      * @since 3.0
67      */

68     String JavaDoc JAVA_KEYWORD_RETURN= "java_keyword_return"; //$NON-NLS-1$
69

70     /** The color key for operators in Java code
71      * (value <code>"java_operator"</code>).
72      *
73      * @since 3.0
74      */

75     String JavaDoc JAVA_OPERATOR= "java_operator"; //$NON-NLS-1$
76

77     /** The color key for brackets in Java code
78      * (value <code>"java_bracket"</code>).
79      *
80      * @since 3.3
81      */

82     String JavaDoc JAVA_BRACKET= "java_bracket"; //$NON-NLS-1$
83

84     /**
85      * The color key for everything in Java code for which no other color is specified
86      * (value <code>"java_default"</code>).
87      */

88     String JavaDoc JAVA_DEFAULT= "java_default"; //$NON-NLS-1$
89

90     /**
91      * The color key for the Java built-in types such as <code>int</code> and <code>char</code> in Java code
92      * (value <code>"java_type"</code>).
93      *
94      * @deprecated no longer used, replaced by <code>JAVA_KEYWORD</code>
95      */

96     String JavaDoc JAVA_TYPE= "java_type"; //$NON-NLS-1$
97

98     /**
99      * The color key for annotations
100      * (value <code>"java_annotation"</code>).
101      *
102      * @since 3.1
103      * @deprecated replaced as of 3.2 by an equivalent semantic highlighting, see {@link org.eclipse.jdt.internal.ui.javaeditor.SemanticHighlightings#ANNOTATION}
104      */

105     String JavaDoc JAVA_ANNOTATION= "java_annotation"; //$NON-NLS-1$
106

107     /**
108      * The color key for task tags in java comments
109      * (value <code>"java_comment_task_tag"</code>).
110      *
111      * @since 2.1
112      */

113     String JavaDoc TASK_TAG= "java_comment_task_tag"; //$NON-NLS-1$
114

115     /**
116      * The color key for JavaDoc keywords (<code>@foo</code>) in JavaDoc comments
117      * (value <code>"java_doc_keyword"</code>).
118      */

119     String JavaDoc JAVADOC_KEYWORD= "java_doc_keyword"; //$NON-NLS-1$
120

121     /**
122      * The color key for HTML tags (<code>&lt;foo&gt;</code>) in JavaDoc comments
123      * (value <code>"java_doc_tag"</code>).
124      */

125     String JavaDoc JAVADOC_TAG= "java_doc_tag"; //$NON-NLS-1$
126

127     /**
128      * The color key for JavaDoc links (<code>{foo}</code>) in JavaDoc comments
129      * (value <code>"java_doc_link"</code>).
130      */

131     String JavaDoc JAVADOC_LINK= "java_doc_link"; //$NON-NLS-1$
132

133     /**
134      * The color key for everything in JavaDoc comments for which no other color is specified
135      * (value <code>"java_doc_default"</code>).
136      */

137     String JavaDoc JAVADOC_DEFAULT= "java_doc_default"; //$NON-NLS-1$
138

139     //---------- Properties File Editor ----------
140

141     /**
142      * The color key for keys in a properties file
143      * (value <code>"pf_coloring_key"</code>).
144      *
145      * @since 3.1
146      */

147     String JavaDoc PROPERTIES_FILE_COLORING_KEY= "pf_coloring_key"; //$NON-NLS-1$
148

149     /**
150      * The color key for comments in a properties file
151      * (value <code>"pf_coloring_comment"</code>).
152      *
153      * @since 3.1
154      */

155
156     String JavaDoc PROPERTIES_FILE_COLORING_COMMENT= "pf_coloring_comment"; //$NON-NLS-1$
157

158     /**
159      * The color key for values in a properties file
160      * (value <code>"pf_coloring_value"</code>).
161      *
162      * @since 3.1
163      */

164     String JavaDoc PROPERTIES_FILE_COLORING_VALUE= "pf_coloring_value"; //$NON-NLS-1$
165

166     /**
167      * The color key for assignment in a properties file.
168      * (value <code>"pf_coloring_assignment"</code>).
169      *
170      * @since 3.1
171      */

172     String JavaDoc PROPERTIES_FILE_COLORING_ASSIGNMENT= "pf_coloring_assignment"; //$NON-NLS-1$
173

174     /**
175      * The color key for arguments in values in a properties file.
176      * (value <code>"pf_coloring_argument"</code>).
177      *
178      * @since 3.1
179      */

180     String JavaDoc PROPERTIES_FILE_COLORING_ARGUMENT= "pf_coloring_argument"; //$NON-NLS-1$
181
}
182
Popular Tags