SimpleValueNames


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.api.editor.settings;
21  
22  
23  /** The names of SimpleValuesSettings.
24   *
25   *  @author Martin Roskanin. Miloslav Metelka
26   */
27  public final class SimpleValueNames {
28  
29      /**
30       * Number of spaces to draw when the '\t' character
31       * is found in the text. Better said when the drawing-engine
32       * finds a '\t' character it computes the next multiple
33       * of TAB_SIZE and continues drawing from that position.
34       * Values: java.lang.Integer instances
35       */
36      public static final String   TAB_SIZE = "tab-size"; // NOI18N
37  
38      /**
39       * Whether expand typed tabs to spaces. The number of spaces to substitute
40       * per one typed tab is determined by SPACES_PER_TAB setting.
41       * Values: java.lang.Boolean instances
42       */
43      public static final String   EXPAND_TABS = "expand-tabs"; // NOI18N
44  
45      /**
46       * How many spaces substitute per one typed tab. This parameter has
47       * effect only when EXPAND_TABS setting is set to true.
48       * This parameter has no influence on how
49       * the existing tabs are displayed.
50       * Values: java.lang.Integer instances
51       */
52      public static final String   SPACES_PER_TAB = "spaces-per-tab"; // NOI18N
53  
54      /**
55       * Shift-width says how many spaces should the formatter use
56       * to indent the more inner level of code. This setting is independent of <tt>TAB_SIZE</tt>
57       * and <tt>SPACES_PER_TAB</tt>.
58       * Values: java.lang.Integer instances
59       */
60      public static final String   INDENT_SHIFT_WIDTH = "indent-shift-width"; // NOI18N
61      
62      /**
63       * Type of caret for insert mode.
64       * Values: java.lang.String instances
65       *   Currently supported types are:
66       *     org.netbeans.editor.BaseCaret.LINE_CARET - default 2point caret
67       *     org.netbeans.editor.BaseCaret.THIN_LINE_CARET - swing like thin caret
68       *     org.netbeans.editor.BaseCaret.BLOCK_CARET - block covering whole character
69       */
70      public static final String   CARET_TYPE_INSERT_MODE = "caret-type-insert-mode"; // NOI18N
71  
72      /**
73       * Type of caret for over write mode.
74       * Values: java.lang.String instances
75       *   Currently supported types are:
76       *     org.netbeans.editor.BaseCaret.LINE_CARET - default 2point caret
77       *     org.netbeans.editor.BaseCaret.THIN_LINE_CARET - swing like thin caret
78       *     org.netbeans.editor.BaseCaret.BLOCK_CARET - block covering whole character
79       */
80      public static final String   CARET_TYPE_OVERWRITE_MODE = "caret-type-overwrite-mode"; // NOI18N
81  
82      /**
83       * If true, the insert mode caret will be italicized if the underlying font is italic.
84       * Values: java.lang.Boolean instances
85       */
86      public static final String   CARET_ITALIC_INSERT_MODE = "caret-italic-insert-mode"; // NOI18N
87  
88      /**
89       * If true, the overwrite mode caret will be italicized if the underlying font is italic.
90       * Values: java.lang.Boolean instances
91       */
92      public static final String   CARET_ITALIC_OVERWRITE_MODE = "caret-italic-overwrite-mode"; // NOI18N
93  
94      /**
95       * Caret color for insert mode.
96       * Values: java.awt.Color instances
97       */
98      public static final String   CARET_COLOR_INSERT_MODE = "caret-color-insert-mode"; // NOI18N
99  
100     /**
101      * Caret color for overwrite mode.
102      * Values: java.awt.Color instances
103      */
104     public static final String   CARET_COLOR_OVERWRITE_MODE = "caret-color-overwrite-mode"; // NOI18N
105 
106     /**
107      * Caret blink rate in milliseconds.
108      * Values: java.lang.Integer
109      */
110     public static final String   CARET_BLINK_RATE = "caret-blink-rate"; // NOI18N
111 
112     /**
113      * Whether to display line numbers on the left part of the screen.
114      * Values: java.lang.Boolean instances
115      */
116     public static final String   LINE_NUMBER_VISIBLE = "line-number-visible"; // NOI18N
117 
118     /**
119      * How much should the view jump when scrolling goes off the screen.
120      * Insets are used so that it can be specified for each direction specifically.
121      * Each inset value can be positive or negative. The positive value means
122      * the number of lines for the top and the bottom and the number of characters
123      * for the left and the right. The negative value means percentage of the editor
124      * component height for the top and the bottom and percentage of the editor
125      * component width for the left and the right.
126      * Values: java.awt.Insets instances
127      */
128     public static final String   SCROLL_JUMP_INSETS = "scroll-jump-insets"; // NOI18N
129 
130     /**
131      * How much space must be reserved in each direction for the find operation.
132      * It's here to ensure the found information will be visible in some
133      * context around it.
134      * Insets are used so that it can be specified for each direction specifically.
135      * Each inset value can be positive or negative. The positive value means
136      * the number of lines for the top and the bottom and the number of characters
137      * for the left and the right. The negative value means percentage of the editor
138      * component height for the top and the bottom and percentage of the editor
139      * component width for the left and the right.
140      * Values: java.awt.Insets instances
141      */
142     public static final String   SCROLL_FIND_INSETS = "scroll-find-insets"; // NOI18N
143 
144     /**
145      * Margin for the editor component
146      * Values: java.awt.Insets instances
147      */
148     public static final String   MARGIN = "margin"; // NOI18N
149 
150     /**
151      * Width of the margin on the left side of the text just after the line-number bar.
152      * Values: java.awt.Integer instances
153      */
154     public static final String   TEXT_LEFT_MARGIN_WIDTH = "text-left-margin-width"; // NOI18N
155 
156     /**
157      * Float constant by which the height of the character obtained from
158      * the font is multiplied. It defaults to 1.
159      * Values: java.lang.Float instances
160      */
161     public static final String   LINE_HEIGHT_CORRECTION = "line-height-correction"; // NOI18N
162     
163 
164     /**
165      * Whether status bar should be visible or not.
166      * Values: java.lang.Boolean instances
167      */
168     public static final String   STATUS_BAR_VISIBLE = "status-bar-visible"; // NOI18N
169 
170     /**
171      * Delay for updating information about caret in the status bar.
172      * Values: java.lang.Integer instances
173      */
174     public static final String   STATUS_BAR_CARET_DELAY = "status-bar-caret-delay"; // NOI18N
175 
176     /**
177      * Whether the line displaying the text limit should be displayed.
178      * Values: java.lang.Boolean instances
179      */
180     public static final String   TEXT_LIMIT_LINE_VISIBLE = "text-limit-line-visible"; // NOI18N
181 
182     /**
183      * Which color should be used for the line showing the text limit.
184      * Values: java.awt.Color instances
185      */
186     public static final String   TEXT_LIMIT_LINE_COLOR = "text-limit-line-color"; // NOI18N
187 
188     /**
189      * After how many characters the text limit line should be displayed.
190      * Values: java.awt.Integer instances
191      */
192     public static final String   TEXT_LIMIT_WIDTH = "text-limit-width"; // NOI18N
193     
194     /**
195      * Enable/Disable code folding 
196      * Values: java.lang.Boolean instances
197      */
198     public static final String   CODE_FOLDING_ENABLE = "code-folding-enable"; //NOI18N
199 
200     /**
201      * Highlight the row where the caret currently is. The ExtCaret must be used.
202      * Values: java.lang.Boolean 
203      */
204     public static final String   HIGHLIGHT_CARET_ROW = "highlight-caret-row"; // NOI18N
205 
206     /**
207      * Highlight the matching brace (if the caret currently stands after the brace).
208      * The ExtCaret must be used.
209      * Values: java.lang.Boolean 
210      */
211     public static final String   HIGHLIGHT_MATCH_BRACE = "highlight-match-brace"; // NOI18N
212     
213     /**
214      * Whether the code completion window should popup automatically.
215      * Values: java.lang.Boolean
216      */
217     public static final String   COMPLETION_AUTO_POPUP = "completion-auto-popup"; // NOI18N
218     
219 
220     /**
221      * Whether the code completion query search will be case  sensitive
222      * Values: java.lang.Boolean
223      */
224     public static final String   COMPLETION_CASE_SENSITIVE = "completion-case-sensitive"; // NOI18N
225 
226     /**
227      * Whether the code completion sorting will be natural
228      * Values: java.lang.Boolean
229      */
230     public static final String   COMPLETION_NATURAL_SORT = "completion-natural-sort"; // NOI18N
231     
232     /**
233      * Whether perform instant substitution, if the search result contains only one item
234      * Values: java.lang.Boolean
235      */
236     public static final String   COMPLETION_INSTANT_SUBSTITUTION = "completion-instant-substitution"; // NOI18N
237 
238     /**
239      * The delay after which the completion window is shown automatically.
240      * Values: java.lang.Integer
241      */
242     public static final String   COMPLETION_AUTO_POPUP_DELAY = "completion-auto-popup-delay"; // NOI18N
243 
244     /**
245      * The minimum size of the completion pane component.
246      * Values: java.awt.Dimension
247      */
248     public static final String   COMPLETION_PANE_MIN_SIZE = "completion-pane-min-size"; // NOI18N
249 
250     /**
251      * The maximum size of the completion pane component.
252      * Values: java.awt.Dimension
253      */
254     public static final String   COMPLETION_PANE_MAX_SIZE = "completion-pane-max-size"; // NOI18N
255     
256     /**
257      * Background color of javaDoc popup window 
258      *  Values: java.awt.Color
259      */
260     public static final String   JAVADOC_BG_COLOR = "javadoc-bg-color"; //NOI18N
261     
262     /**
263      * The delay after which the javaDoc window is shown automatically.
264      *   Values: java.lang.Integer
265      */
266     public static final String   JAVADOC_AUTO_POPUP_DELAY = "javadoc-auto-popup-delay"; //NOI18N
267     
268     /**
269      * The preferred size of javaDoc popup window
270      *   Values: java.awt.Dimension
271      */ 
272     public static final String   JAVADOC_PREFERRED_SIZE = "javadoc-preferred-size"; //NOI18N
273 
274     /**
275      * Whether the javaDoc window should popup automatically.
276      * Values: java.lang.Boolean
277      */
278     public static final String   JAVADOC_AUTO_POPUP = "javadoc-auto-popup"; // NOI18N
279     
280     /**
281      * Whether show deprecated members in code completion popup window
282      * Values: java.lang.Boolean
283      */
284     public static final String   SHOW_DEPRECATED_MEMBERS = "show-deprecated-members"; // NOI18N
285 
286     private SimpleValueNames() {
287         // to prevent instantialization
288     }
289 }
290
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags