TextEditorPreferenceConstants


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.ui.editors.text;
12  
13  import org.eclipse.jface.preference.IPreferenceStore;
14  
15  import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants;
16  
17  
18  /**
19   * Preference constants used in the default text editor preference store.
20   * @since 2.1
21    */
22  public class TextEditorPreferenceConstants {
23  
24      /**
25       * Prevent initialization.
26       */
27      private TextEditorPreferenceConstants() {
28      }
29  
30      /**
31       * A named preference that controls whether the current line highlighting is turned on or off
32       * (value <code>"currentLine"</code>).
33       * <p>
34       * The preference value is of type <code>Boolean</code>.
35       * </p>
36       * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
37       */
38      public final static String   EDITOR_CURRENT_LINE= "currentLine"; //$NON-NLS-1$
39  
40      /**
41       * A named preference that holds the color used to highlight the current line
42       * (value <code>"currentLineColor"</code>).
43       * <p>
44       * The preference value is of type <code>String</code>. A RGB color value encoded as a string
45       * using class <code>PreferenceConverter</code>.
46       * </p>
47       * @see org.eclipse.jface.resource.StringConverter
48       * @see org.eclipse.jface.preference.PreferenceConverter
49       * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
50       */
51      public final static String   EDITOR_CURRENT_LINE_COLOR= "currentLineColor"; //$NON-NLS-1$
52  
53      /**
54       * A named preference that controls whether the print margin is turned on or off
55       * (value <code>"printMargin"</code>).
56       * <p>
57       * The preference value is of type <code>Boolean</code>.
58       * </p>
59       * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
60       */
61      public final static String   EDITOR_PRINT_MARGIN= "printMargin"; //$NON-NLS-1$
62  
63      /**
64       * A named preference that holds the color used to render the print margin
65       * (value <code>"printMarginColor"</code>).
66       * <p>
67       * The preference value is of type <code>String</code>. A RGB color value encoded as a string
68       * using class <code>PreferenceConverter</code>.
69       * </p>
70       * @see org.eclipse.jface.resource.StringConverter
71       * @see org.eclipse.jface.preference.PreferenceConverter
72       * @deprecated As of 3.0,, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
73       */
74      public final static String   EDITOR_PRINT_MARGIN_COLOR= "printMarginColor"; //$NON-NLS-1$
75  
76      /**
77       * Print margin column
78       * (value <code>"printMarginColumn"</code>).
79       * <p>
80       * The preference value is of type <code>int</code>.
81       * </p>
82       * @deprecated As of 3.0,, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
83       */
84      public final static String   EDITOR_PRINT_MARGIN_COLUMN= "printMarginColumn"; //$NON-NLS-1$
85  
86      /**
87       * A named preference that controls whether the editor shows unknown
88       * indicators in text (squiggly lines).
89       * (value <code>"othersIndication"</code>).
90       * <p>
91       * The preference value is of type <code>Boolean</code>.
92       * </p>
93       * @since 2.1
94       * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
95       */
96      public final static String   EDITOR_UNKNOWN_INDICATION= "othersIndication"; //$NON-NLS-1$
97  
98      /**
99       * A named preference that holds the color used to render unknown indicators
100      * (value <code>"othersIndicationColor"</code>).
101      * <p>
102      * The preference value is of type <code>String</code>. A RGB color value encoded as a string
103      * using class <code>PreferenceConverter</code>.
104      * </p>
105      * @see #EDITOR_UNKNOWN_INDICATION
106      * @see org.eclipse.jface.resource.StringConverter
107      * @see org.eclipse.jface.preference.PreferenceConverter
108      * @since 2.1
109      * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
110      */
111     public final static String   EDITOR_UNKNOWN_INDICATION_COLOR= "othersIndicationColor"; //$NON-NLS-1$
112 
113     /**
114      * A named preference that controls whether the overview ruler shows unknown indicators
115      * (value <code>"othersIndicationInOverviewRuler"</code>).
116      * <p>
117      * The preference value is of type <code>Boolean</code>.
118      * </p>
119      * @since 2.1
120      * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
121      */
122     public final static String   EDITOR_UNKNOWN_INDICATION_IN_OVERVIEW_RULER= "othersIndicationInOverviewRuler"; //$NON-NLS-1$
123 
124     /**
125      * A named preference that controls if the overview ruler is shown in the UI
126      * (value <code>"overviewRuler"</code>).
127      * <p>
128      * The preference value is of type <code>Boolean</code>.
129      * </p>
130      * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
131      */
132     public final static String   EDITOR_OVERVIEW_RULER= "overviewRuler"; //$NON-NLS-1$
133 
134     /**
135      * A named preference that controls if the line number ruler is shown in the UI
136      * (value <code>"lineNumberRuler"</code>).
137      * <p>
138      * The preference value is of type <code>Boolean</code>.
139      * </p>
140      * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
141      */
142     public final static String   EDITOR_LINE_NUMBER_RULER= "lineNumberRuler"; //$NON-NLS-1$
143 
144     /**
145      * A named preference that holds the color used to render line numbers inside the line number ruler
146      * (value <code>"lineNumberColor"</code>).
147      * <p>
148      * The preference value is of type <code>String</code>. A RGB color value encoded as a string
149      * using class <code>PreferenceConverter</code>.
150      * </p>
151      * @see org.eclipse.jface.resource.StringConverter
152      * @see org.eclipse.jface.preference.PreferenceConverter
153      * @see #EDITOR_LINE_NUMBER_RULER
154      * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
155      */
156     public final static String   EDITOR_LINE_NUMBER_RULER_COLOR= "lineNumberColor"; //$NON-NLS-1$
157 
158     /**
159      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
160      */
161     public final static String   EDITOR_PROBLEM_INDICATION= "problemIndication"; //$NON-NLS-1$
162 
163     /**
164      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
165      */
166     public final static String   EDITOR_PROBLEM_INDICATION_COLOR= "problemIndicationColor"; //$NON-NLS-1$
167 
168     /**
169      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
170      */
171     public final static String   EDITOR_WARNING_INDICATION= "warningIndication"; //$NON-NLS-1$
172 
173     /**
174      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
175      */
176     public final static String   EDITOR_WARNING_INDICATION_COLOR= "warningIndicationColor"; //$NON-NLS-1$
177 
178     /**
179      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
180      */
181     public final static String   EDITOR_INFO_INDICATION= "infoIndication"; //$NON-NLS-1$
182 
183     /**
184      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
185      */
186     public final static String   EDITOR_INFO_INDICATION_COLOR= "infoIndicationColor"; //$NON-NLS-1$
187 
188     /**
189      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
190      */
191     public final static String   EDITOR_TASK_INDICATION= "taskIndication"; //$NON-NLS-1$
192 
193     /**
194      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
195      */
196     public final static String   EDITOR_TASK_INDICATION_COLOR= "taskIndicationColor"; //$NON-NLS-1$
197 
198     /**
199      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
200      */
201     public final static String   EDITOR_BOOKMARK_INDICATION= "bookmarkIndication"; //$NON-NLS-1$
202 
203     /**
204      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
205      */
206     public final static String   EDITOR_BOOKMARK_INDICATION_COLOR= "bookmarkIndicationColor"; //$NON-NLS-1$
207 
208     /**
209      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
210      */
211     public final static String   EDITOR_SEARCH_RESULT_INDICATION= "searchResultIndication"; //$NON-NLS-1$
212 
213     /**
214      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
215      */
216     public final static String   EDITOR_SEARCH_RESULT_INDICATION_COLOR= "searchResultIndicationColor"; //$NON-NLS-1$
217 
218     /**
219      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
220      */
221     public final static String   EDITOR_ERROR_INDICATION_IN_OVERVIEW_RULER= "errorIndicationInOverviewRuler"; //$NON-NLS-1$
222 
223     /**
224      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
225      */
226     public final static String   EDITOR_WARNING_INDICATION_IN_OVERVIEW_RULER= "warningIndicationInOverviewRuler"; //$NON-NLS-1$
227 
228     /**
229      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
230      */
231     public final static String   EDITOR_INFO_INDICATION_IN_OVERVIEW_RULER= "infoIndicationInOverviewRuler"; //$NON-NLS-1$
232 
233     /**
234      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
235      */
236     public final static String   EDITOR_TASK_INDICATION_IN_OVERVIEW_RULER= "taskIndicationInOverviewRuler"; //$NON-NLS-1$
237 
238     /**
239      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
240      */
241     public final static String   EDITOR_BOOKMARK_INDICATION_IN_OVERVIEW_RULER= "bookmarkIndicationInOverviewRuler"; //$NON-NLS-1$
242 
243     /**
244      * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
245      */
246     public final static String   EDITOR_SEARCH_RESULT_INDICATION_IN_OVERVIEW_RULER= "searchResultIndicationInOverviewRuler"; //$NON-NLS-1$
247 
248     /**
249     * Initializes the given preference store with the default values.
250      *
251     * @param store the preference store to be initialized
252     */
253     public static void initializeDefaultValues(IPreferenceStore store) {
254 
255         // set defaults from AbstractDecoratedTextEditor
256         AbstractDecoratedTextEditorPreferenceConstants.initializeDefaultValues(store);
257 
258         store.setDefault(AbstractDecoratedTextEditorPreferenceConstants.EDITOR_USE_CUSTOM_CARETS, true);
259     }
260 }
261
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags