KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > editor > SettingsNames


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.editor;
21
22 /**
23 * Names of the base settings defined in the editor. The other packages
24 * related to the editor can define their own extensions to these basic
25 * names. The extension class can be inherited from this class
26 * so that the extension class contains all the available names.
27 *
28 * @author Miloslav Metelka
29 * @version 1.00
30 */

31
32 public class SettingsNames {
33
34     /** Number of spaces to draw when the '\t' character
35     * is found in the text. Better said when the drawing-engine
36     * finds a '\t' character it computes the next multiple
37     * of TAB_SIZE and continues drawing from that position.
38     * Values: java.lang.Integer instances
39     */

40     public static final String JavaDoc TAB_SIZE = "tab-size"; // NOI18N
41

42     /** Whether expand typed tabs to spaces. The number of spaces to substitute
43     * per one typed tab is determined by SPACES_PER_TAB setting.
44     * Values: java.lang.Boolean instances
45     */

46     public static final String JavaDoc EXPAND_TABS = "expand-tabs"; // NOI18N
47

48     /** How many spaces substitute per one typed tab. This parameter has
49     * effect only when EXPAND_TABS setting is set to true.
50     * This parameter has no influence on how
51     * the existing tabs are displayed.
52     * Values: java.lang.Integer instances
53     */

54     public static final String JavaDoc SPACES_PER_TAB = "spaces-per-tab"; // NOI18N
55

56     /** Shift-width says how many spaces should the formatter use
57     * to indent the more inner level of code. This setting is independent of <tt>TAB_SIZE</tt>
58     * and <tt>SPACES_PER_TAB</tt>.
59     * Values: java.lang.Integer instances
60     */

61     public static final String JavaDoc INDENT_SHIFT_WIDTH = "indent-shift-width"; // NOI18N
62

63     /** Acceptor that recognizes the identifier characters.
64     * If set it's used instead of the default Syntax.isIdentifierPart() call.
65     * Values: org.netbeans.editor.Acceptor instances
66     */

67     public static final String JavaDoc IDENTIFIER_ACCEPTOR = "identifier-acceptor"; // NOI18N
68

69     /** Acceptor that recognizes the whitespace characters.
70     * If set it's used instead of the default Syntax.isWhitespace() call.
71     * Values: org.netbeans.editor.Acceptor instances
72     */

73     public static final String JavaDoc WHITESPACE_ACCEPTOR = "whitespace-acceptor"; // NOI18N
74

75     /** Map of the string abbreviations. The second string (value) means
76     * the full version of the first string (key).
77     * Values: java.util.Map instances holding
78     * [abbrev-string, expanded-abbrev-string] pairs
79     */

80     public static final String JavaDoc ABBREV_MAP = "abbrev-map"; // NOI18N
81

82     /** Map of macro definitions. The second string (value) contains
83      * encoded functionality of the macro in the following notation:
84      * Macro ::= S? Element (S Element)* S?
85      * Element ::= Action | '"' Text '"'
86      * Action ::= ( ( ( char - ( S | '\' ) ) | '\\' | ( '\' S ) )+
87      * Text ::= ( ( char - ( '"' | '\' ) ) | ( '\"' | '\\' ) )*
88     */

89     public static final String JavaDoc MACRO_MAP = "macro-map"; // NOI18N
90

91     /** Map of the action abbreviations. The second string (value) is
92     * the name of the action to execute. The action must be available
93     * in the kit actions. It can be added through <tt>CUSTOM_ACTION_LIST</tt>.
94     * The original abbreviation string
95     * is first removed from the text before the action is executed.
96     * If there is the same abbreviation in the <tt>ABBREV_MAP</tt> map
97     * it has a precedence over the <tt>ABBREV_ACTION_MAP</tt>.
98     * Values: java.util.Map instances holding
99     * [abbrev-string, name-of-the-action-to-execute] pairs
100     */

101     public static final String JavaDoc ABBREV_ACTION_MAP = "abbrev-action-map"; // NOI18N
102

103     /** Acceptor checking whether abbreviation should be attempted
104     * after the appropriate character was typed.
105     * Values: org.netbeans.editor.Acceptor instances
106     */

107     public static final String JavaDoc ABBREV_EXPAND_ACCEPTOR = "abbrev-expand-acceptor"; // NOI18N
108

109     /** Acceptor checking whether typed character that performed
110     * abbreviation expansion should be added to the text or not.
111     * Values: org.netbeans.editor.Acceptor instances
112     */

113     public static final String JavaDoc ABBREV_ADD_TYPED_CHAR_ACCEPTOR
114     = "abbrev-add-typed-char-acceptor"; // NOI18N
115

116     /** Acceptor checking whether typed character should reset
117     * abbreviation accounting. By default all non-letterOrDigit chars
118     * reset the abbreviation accounting.
119     * Values: org.netbeans.editor.Acceptor instances
120     */

121     public static final String JavaDoc ABBREV_RESET_ACCEPTOR = "abbrev-reset-acceptor"; // NOI18N
122

123     /** Type of caret for insert mode.
124     * Values: java.lang.String instances
125     * Currently supported types are:
126     * org.netbeans.editor.BaseCaret.LINE_CARET - default 2point caret
127     * org.netbeans.editor.BaseCaret.THIN_LINE_CARET - swing like thin caret
128     * org.netbeans.editor.BaseCaret.BLOCK_CARET - block covering whole character
129     */

130     public static final String JavaDoc CARET_TYPE_INSERT_MODE = "caret-type-insert-mode"; // NOI18N
131

132     /** Type of caret for over write mode.
133     * Values: java.lang.String instances
134     * Currently supported types are:
135     * org.netbeans.editor.BaseCaret.LINE_CARET - default 2point caret
136     * org.netbeans.editor.BaseCaret.THIN_LINE_CARET - swing like thin caret
137     * org.netbeans.editor.BaseCaret.BLOCK_CARET - block covering whole character
138     */

139     public static final String JavaDoc CARET_TYPE_OVERWRITE_MODE = "caret-type-overwrite-mode"; // NOI18N
140

141     /** Will the insert mode caret be italicized if the underlying font
142     * is italic?
143     * Values: java.lang.Boolean instances
144     */

145     public static final String JavaDoc CARET_ITALIC_INSERT_MODE = "caret-italic-insert-mode"; // NOI18N
146

147     /** Will the overwrite mode caret be italicized if the underlying font
148     * is italic?
149     * Values: java.lang.Boolean instances
150     */

151     public static final String JavaDoc CARET_ITALIC_OVERWRITE_MODE = "caret-italic-overwrite-mode"; // NOI18N
152

153     /** Caret color for insert mode.
154     * Values: java.awt.Color instances
155     */

156     public static final String JavaDoc CARET_COLOR_INSERT_MODE = "caret-color-insert-mode"; // NOI18N
157

158     /** Caret color for overwrite mode.
159     * Values: java.awt.Color instances
160     */

161     public static final String JavaDoc CARET_COLOR_OVERWRITE_MODE = "caret-color-overwrite-mode"; // NOI18N
162

163     /** Caret blink rate in milliseconds.
164     * Values: java.lang.Integer
165     */

166     public static final String JavaDoc CARET_BLINK_RATE = "caret-blink-rate"; // NOI18N
167

168     /** Whether to display line numbers on the left part of the screen.
169     * Values: java.lang.Boolean instances
170     */

171     public static final String JavaDoc LINE_NUMBER_VISIBLE = "line-number-visible"; // NOI18N
172

173     /** Completion of { } [ ] " " ' ' and tags */
174     public static final String JavaDoc PAIR_CHARACTERS_COMPLETION
175       = "pair-characters-completion"; // NOI18N
176

177     /** Whether to display line numbers when printing to the printer.
178     * Values: java.lang.Boolean instances
179     */

180     public static final String JavaDoc PRINT_LINE_NUMBER_VISIBLE = "print-line-number-visible"; // NOI18N
181

182     /** How much should the view jump when scrolling goes off the screen.
183     * Insets are used so that it can be specified for each direction specifically.
184     * Each inset value can be positive or negative. The positive value means
185     * the number of lines for the top and the bottom and the number of characters
186     * for the left and the right. The negative value means percentage of the editor
187     * component height for the top and the bottom and percentage of the editor
188     * component width for the left and the right.
189     * Values: java.awt.Insets instances
190     * @deprecated value of this property is ignored.
191     */

192     public static final String JavaDoc SCROLL_JUMP_INSETS = "scroll-jump-insets"; // NOI18N
193

194     /** How much space must be reserved in each direction for the find operation.
195     * It's here to ensure the found information will be visible in some
196     * context around it.
197     * Insets are used so that it can be specified for each direction specifically.
198     * Each inset value can be positive or negative. The positive value means
199     * the number of lines for the top and the bottom and the number of characters
200     * for the left and the right. The negative value means percentage of the editor
201     * component height for the top and the bottom and percentage of the editor
202     * component width for the left and the right.
203     * Values: java.awt.Insets instances
204     */

205     public static final String JavaDoc SCROLL_FIND_INSETS = "scroll-find-insets"; // NOI18N
206

207     /** How much space will be added additionaly when the component needs to be
208     * resized.
209     * Each dimension value can be positive or negative. The positive value means
210     * the number of lines for the height and the number of characters
211     * for the width. The negative value means percentage of the editor
212     * component height for the height and percentage of the editor
213     * component width for the width.
214     * Values: java.awt.Dimension instances
215     */

216     public static final String JavaDoc COMPONENT_SIZE_INCREMENT = "component-size-increment"; // NOI18N
217

218     /** Margin for the editor component
219     * Values: java.awt.Insets instances
220     */

221     public static final String JavaDoc MARGIN = "margin"; // NOI18N
222

223     /** Width of the margin on the left side of the text just after the line-number bar.
224     * Values: java.awt.Integer instances
225     */

226     public static final String JavaDoc TEXT_LEFT_MARGIN_WIDTH = "text-left-margin-width"; // NOI18N
227

228     /** Rendering hints to be used for the painting.
229     * Values: java.util.Map instances
230     */

231     public static final String JavaDoc RENDERING_HINTS = "rendering-hints"; // NOI18N
232

233     /** Key binding list for particular kit.
234     * Values: java.util.List instances holding
235     * javax.swing.JTextComponent.KeyBinding instances
236     * or org.netbeans.editor.MultiKeyBinding instances
237     */

238     public static final String JavaDoc KEY_BINDING_LIST = "key-bindings"; // NOI18N
239

240     /** Whether the input-methods should be enabled.
241     * Values: java.lang.Boolean
242     */

243     public static final String JavaDoc INPUT_METHODS_ENABLED = "input-methods-enabled"; // NOI18N
244

245     /** Float constant by which the height of the character obtained from
246     * the font is multiplied. It defaults to 1.
247     * Values: java.lang.Float instances
248     */

249     public static final String JavaDoc LINE_HEIGHT_CORRECTION = "line-height-correction"; // NOI18N
250

251     /* Find properties.
252     * They are read by FindSupport when its instance is being initialized.
253     * FIND_WHAT: java.lang.String - search expression
254     * FIND_REPLACE_BY: java.lang.String - replace string
255     * FIND_HIGHLIGHT_SEARCH: java.lang.Boolean - highlight matching strings in text
256     * FIND_INC_SEARCH: java.lang.Boolean - show matching strings immediately
257     * FIND_BACKWARD_SEARCH: java.lang.Boolean - search in backward direction
258     * FIND_WRAP_SEARCH: java.lang.Boolean - if end of doc reached, start from begin
259     * FIND_MATCH_CASE: java.lang.Boolean - match case of letters
260     * FIND_SMART_CASE: java.lang.Boolean - case insensitive search if FIND_MATCH_CASE
261     * is false and all letters of FIND_WHAT are small, case sensitive otherwise
262     * FIND_WHOLE_WORDS: java.lang.Boolean - match only whole words
263     * FIND_REG_EXP: java.lang.Boolean - use regular expressions in search expr
264     * FIND_HISTORY: java.util.List - History of search expressions
265     * FIND_HISTORY_SIZE: java.lang.Integer - Maximum size of the history
266     * FIND_BLOCK_SEARCH: java.lang.Boolean - search in block
267     * FIND_BLOCK_SEARCH_START: java.lang.Integer - start offset of the block
268     * FIND_BLOCK_SEARCH_END: java.lang.Integer - end offset of the block
269     *
270     */

271     public static final String JavaDoc FIND_WHAT = "find-what"; // NOI18N
272
public static final String JavaDoc FIND_REPLACE_WITH = "find-replace-with"; // NOI18N
273
public static final String JavaDoc FIND_HIGHLIGHT_SEARCH = "find-highlight-search"; // NOI18N
274
public static final String JavaDoc FIND_INC_SEARCH = "find-inc-search"; // NOI18N
275
public static final String JavaDoc FIND_INC_SEARCH_DELAY = "find-inc-search-delay"; // NOI18N
276
public static final String JavaDoc FIND_BACKWARD_SEARCH = "find-backward-search"; // NOI18N
277
public static final String JavaDoc FIND_WRAP_SEARCH = "find-wrap-search"; // NOI18N
278
public static final String JavaDoc FIND_MATCH_CASE = "find-match-case"; // NOI18N
279
public static final String JavaDoc FIND_SMART_CASE = "find-smart-case"; // NOI18N
280
public static final String JavaDoc FIND_WHOLE_WORDS = "find-whole-words"; // NOI18N
281
public static final String JavaDoc FIND_REG_EXP = "find-reg-exp"; // NOI18N
282
public static final String JavaDoc FIND_HISTORY = "find-history"; // NOI18N
283
public static final String JavaDoc FIND_HISTORY_SIZE = "find-history-size"; // NOI18N
284
public static final String JavaDoc FIND_BLOCK_SEARCH = "find-block-search"; //NOI18N
285
public static final String JavaDoc FIND_BLOCK_SEARCH_START = "find-block-search-start"; //NOI18N
286
public static final String JavaDoc FIND_BLOCK_SEARCH_END = "find-block-search-end"; //NOI18N
287

288
289     /** Number of characters that can be searched. If the value is larger
290     * than the document size, the document is used but the next document
291     * will not be used. The zero value disables the word match completely.
292     * Specify Integer.MAX_VALUE to search all the documents regardless
293     * of the size.
294     * Values: java.lang.Integer instances
295     */

296     public static final String JavaDoc WORD_MATCH_SEARCH_LEN = "word-match-search-len"; // NOI18N
297

298     /** Wrap the word match searching
299     * on current document after it reaches the end/begining of
300     * current document. All the other documents except the current (first) one
301     * are searched from begining in forward direction.
302     * Values: java.lang.Boolean instances
303     */

304     public static final String JavaDoc WORD_MATCH_WRAP_SEARCH = "word-match-wrap-search"; // NOI18N
305

306     /** Word list that is searched as last resort in word matching.
307     * It can contain the words that are used often by the user.
308     * If this property is set, these words are searched regardless
309     * of WORD_MATCH_SEARCH_LEN setting.
310     * Values: java.lang.String instances
311     */

312     public static final String JavaDoc WORD_MATCH_STATIC_WORDS = "word-match-static-words"; // NOI18N
313

314     /** Whether to use case sensitive search or not.
315     * Values: java.lang.Boolean instances
316     */

317     public static final String JavaDoc WORD_MATCH_MATCH_CASE = "word-match-match-case"; // NOI18N
318

319     /** Whether to use case insensitive search if all the letters are small
320     * and case sensitive search if at least one letter is capital.
321     * Values: java.lang.Boolean instances
322     */

323     public static final String JavaDoc WORD_MATCH_SMART_CASE = "word-match-smart-case"; // NOI18N
324

325     /** Whether the word matching should return the match even if the matching
326     * word has only one char. The WORD_MATCH_MATCH_CASE setting is ignored
327     * in case this setting is on.
328     * Values: java.lang.Boolean instances
329     */

330     public static final String JavaDoc WORD_MATCH_MATCH_ONE_CHAR = "word-match-match-one-char"; // NOI18N
331

332     /** List of actions that will be added to the standard list of actions
333     * for the particular kit. Using this mechanism, user can add actions
334     * and possibly map them to the keys without overriding kit classes.
335     * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
336     * all the super kit lists are used. For example if there is a list of actions
337     * both for JavaKit and BaseKit classes, both list of actions will be added
338     * and BaseKit actions will be added first.
339     * Values: java.util.List instances
340     */

341     public static final String JavaDoc CUSTOM_ACTION_LIST = "custom-action-list"; // NOI18N
342

343     /** List of actions which is executed when
344     * editor kit is installed into component. Actions are executed one by one
345     * in the order they occur in the list.
346     * At the time the kit is installed, the document is not yet assigned.
347     * To perform some actions on document, use the DOC_INSTALL_ACTION_LIST.
348     * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
349     * all the super kit lists are used. For example if there is a list of actions
350     * both for JavaKit and BaseKit classes, both list of actions will be executed
351     * and JavaKit actions will be executed first.
352     * Values: java.util.List instances
353     */

354     public static final String JavaDoc KIT_INSTALL_ACTION_NAME_LIST = "kit-install-action-name-list"; // NOI18N
355

356     /** List of actions that are executed when
357     * editor kit is being removed from component. Actions are executed one by one
358     * in the order they occur in the list.
359     * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
360     * all the super kit lists are used. For example if there is a list of actions
361     * both for JavaKit and BaseKit classes, both list of actions will be executed
362     * and JavaKit actions will be executed first.
363     * Values: java.util.List instances
364     */

365     public static final String JavaDoc KIT_DEINSTALL_ACTION_NAME_LIST = "kit-deinstall-action-name-list"; // NOI18N
366

367     /** List of actions which is executed when
368     * the new document is installed into component. Actions are executed one by one
369     * in the order they occur in the list.
370     * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
371     * all the super kit lists are used. For example if there is a list of actions
372     * both for JavaKit and BaseKit classes, both list of actions will be executed
373     * and JavaKit actions will be executed first.
374     * Values: java.util.List instances
375     */

376     public static final String JavaDoc DOC_INSTALL_ACTION_NAME_LIST = "doc-install-action-name-list"; // NOI18N
377

378     /** Whether status bar should be visible or not.
379     * Values: java.lang.Boolean instances
380     */

381     public static final String JavaDoc STATUS_BAR_VISIBLE = "status-bar-visible"; // NOI18N
382

383     /** Delay for updating information about caret in the status bar.
384     * Values: java.lang.Integer instances
385     */

386     public static final String JavaDoc STATUS_BAR_CARET_DELAY = "status-bar-caret-delay"; // NOI18N
387

388     /** Whether the line displaying the text limit should be displayed.
389     * Values: java.lang.Boolean instances
390     */

391     public static final String JavaDoc TEXT_LIMIT_LINE_VISIBLE = "text-limit-line-visible"; // NOI18N
392

393     /** Which color should be used for the line showing the text limit.
394     * Values: java.awt.Color instances
395     */

396     public static final String JavaDoc TEXT_LIMIT_LINE_COLOR = "text-limit-line-color"; // NOI18N
397

398     /** After how many characters the text limit line should be displayed.
399     * Values: java.awt.Integer instances
400     */

401     public static final String JavaDoc TEXT_LIMIT_WIDTH = "text-limit-width"; // NOI18N
402

403     /** Whether the home key should go to column 1 or first go to text start
404     * on the given line and then to the column 1.
405     * Values: java.lang.Boolean
406     * @deprecated As of 05/09/2001
407     */

408     public static final String JavaDoc HOME_KEY_COLUMN_ONE = "home-key-column-one"; // NOI18N
409

410     /** Finder for finding the next word. If it's not set,
411     * the <tt>FinderFactory.NextWordFwdFinder</tt> is used.
412     * Values: org.netbeans.editor.Finder
413     */

414     public static final String JavaDoc NEXT_WORD_FINDER = "next-word-finder"; // NOI18N
415

416     /** Finder for finding the previous word. If it's not set,
417     * the <tt>FinderFactory.WordStartBwdFinder</tt> is used.
418     * Values: org.netbeans.editor.Finder
419     */

420     public static final String JavaDoc PREVIOUS_WORD_FINDER = "previous-word-finder"; // NOI18N
421

422     /** Whether the word move should stop on the '\n' character. This setting
423     * affects both the
424     * Values: java.lang.Boolean
425     */

426     public static final String JavaDoc WORD_MOVE_NEWLINE_STOP = "word-move-newline-stop"; // NOI18N
427

428     /** Whether to trim the white space characters (except '\n') from
429     * the end of the line.
430     * Values: java.lang.Boolean instances
431     */

432     // public static final String TRIM_SPACES = "trim-spaces"; // NOI18N
433

434     /** Buffer size for reading into the document from input stream or reader.
435     * Values: java.lang.Integer
436     * WARNING! This is critical parameter for editor functionality.
437     * Please see DefaultSettings.java for values of this setting
438     */

439     public static final String JavaDoc READ_BUFFER_SIZE = "read-buffer-size"; // NOI18N
440

441     /** Buffer size for writing from the document to output stream or writer.
442     * Values: java.lang.Integer instances
443     * WARNING! This is critical parameter for editor functionality.
444     * Please see DefaultSettings.java for values of this setting
445     */

446     public static final String JavaDoc WRITE_BUFFER_SIZE = "write-buffer-size"; // NOI18N
447

448     /** Read mark distance is used when performing initial read
449     * of the document. It denotes the distance in chars of two adjacent
450     * syntax marks inserted into the document.
451     * Values: java.lang.Integer instances
452     * WARNING! This is critical parameter for editor functionality.
453     * Please see DefaultSettings.java for values of this setting
454     */

455     public static final String JavaDoc READ_MARK_DISTANCE = "read-mark-distance"; // NOI18N
456

457     /** Implicit mark distance for inserting to the document.
458     * If the insert is made then the distance between nearest syntax
459     * marks around insertion point is checked and if it's greater
460     * than the max mark distance then another mark(s) are inserted
461     * automatically with the distance given by this setting.
462     * Values: java.lang.Integer instances instances
463     * WARNING! This is critical parameter for editor functionality.
464     * Please see DefaultSettings.java for values of this setting
465     */

466     public static final String JavaDoc MARK_DISTANCE = "mark-distance"; // NOI18N
467

468     /** Maximum mark distance. When there is an insertion done in document
469     * and the distance between marks gets greater than this setting, another
470     * mark will be inserted automatically.
471     * Values: java.lang.Integer instances
472     * WARNING! This is critical parameter for editor functionality.
473     * Please see DefaultSettings.java for values of this setting
474     */

475     public static final String JavaDoc MAX_MARK_DISTANCE = "max-mark-distance"; // NOI18N
476

477     /** Minimum mark distance for removals. When there is a removal done
478     * in document and it makes the marks to get closer than this value, then
479     * the marks the additional marks that are closer than the distance
480     * given by this setting are removed automatically.
481     * Values: java.lang.Integer instances
482     * WARNING! This is critical parameter for editor functionality.
483     * Please see DefaultSettings.java for values of this setting
484     */

485     public static final String JavaDoc MIN_MARK_DISTANCE = "min-mark-distance"; // NOI18N
486

487     /** Size of one batch of characters loaded into syntax segment
488     * when updating syntax marks. It prevents checking and loading
489     * of syntax segment at every syntax mark. Instead it loads
490     * at least the amount of characters given by this setting.
491     * This whole process is done only in case the changes in syntax
492     * extend the end of current line. If the syntax changes don't
493     * extend to the next line, this setting has no effect.
494     * Values: java.lang.Integer instances
495     * WARNING! This is critical parameter for editor functionality.
496     * Please see DefaultSettings.java for values of this setting
497     */

498     public static final String JavaDoc SYNTAX_UPDATE_BATCH_SIZE = "syntax-update-batch-size"; // NOI18N
499

500     /** How many lines should be processed at once in the various text
501     * processing. This is used for example when processing the text
502     * by syntax scanner.
503     */

504     public static final String JavaDoc LINE_BATCH_SIZE = "line-batch-size"; // NOI18N
505

506     /** Ignore the changes made to the settings through the visual property editors
507     * working over the methods manipulating the settings. Generally there can be
508     * two ways to change the settings in the IDE. One way is to directly
509     * call the appropriate methods. The other way can be through some visual
510     * property editors. This flag should be checked by the property editors
511     * and if set to true, no changes to the settings should be performed.
512     * This allows advanced users to completely control the settings through code
513     * without any external undesired changes.
514     */

515     public static final String JavaDoc IGNORE_VISUAL_CHANGES = "ignore-visual-changes"; // NOI18N
516

517     /** List of the names of the additional colorings that need to be taken
518     * into account for the particular kit. The colorings that come from
519     * syntax coloring need not be specified here. Instead
520     * the <tt>TOKEN_CONTEXT_LIST</tt> holds the list of token contexts
521     * that can be used by the given kit.
522     * The coloring names are without the suffix just like the predefined coloring names.
523     * Values: java.util.List instances
524     */

525     public static final String JavaDoc COLORING_NAME_LIST = "coloring-name-list"; // NOI18N
526

527     /** The list of the token contexts that the kit can use.
528     * The editor-ui uses this setting to determine all the token-ids
529     * and token-categories for the colorings.
530     */

531     public static final String JavaDoc TOKEN_CONTEXT_LIST = "token-context-list"; // NOI18N
532

533     /** Suffix added to the coloring settings. The resulting name is used
534     * as the name of the setting.
535     */

536     public static final String JavaDoc COLORING_NAME_SUFFIX = "-coloring"; // NOI18N
537

538     /** Suffix added to the print coloring settings. The resulting name is used
539     * as the name of the setting.
540     */

541     public static final String JavaDoc COLORING_NAME_PRINT_SUFFIX = "-print-coloring"; // NOI18N
542

543
544     /** Default coloring for the drawing. */
545     public static final String JavaDoc DEFAULT_COLORING = "default"; // NOI18N
546

547     /** Coloring that will be used for line numbers displayed on the left
548     * side on the screen.
549     */

550     public static final String JavaDoc LINE_NUMBER_COLORING = "line-number"; // NOI18N
551

552     /** Coloring used for guarded blocks */
553     public static final String JavaDoc GUARDED_COLORING = "guarded"; // NOI18N
554

555     /** Coloring that will be used for code folding icons displayed in editor
556      */

557     public static final String JavaDoc CODE_FOLDING_COLORING = "code-folding"; // NOI18N
558

559     /** Coloring that will be used for code folding side bar
560      */

561     public static final String JavaDoc CODE_FOLDING_BAR_COLORING = "code-folding-bar"; // NOI18N
562

563     /** Coloring used for selection */
564     public static final String JavaDoc SELECTION_COLORING = "selection"; // NOI18N
565

566     /** Coloring used for highlight search */
567     public static final String JavaDoc HIGHLIGHT_SEARCH_COLORING = "highlight-search"; // NOI18N
568

569     /** Coloring used for incremental search */
570     public static final String JavaDoc INC_SEARCH_COLORING = "inc-search"; // NOI18N
571

572     /** Coloring used for block search */
573     public static final String JavaDoc BLOCK_SEARCH_COLORING = "block-search"; // NOI18N
574

575     /** Coloring used for the status bar */
576     public static final String JavaDoc STATUS_BAR_COLORING = "status-bar"; // NOI18N
577

578     /** Coloring used to mark important text in the status bar */
579     public static final String JavaDoc STATUS_BAR_BOLD_COLORING = "status-bar-bold"; // NOI18N
580

581     /** Enable/Disable code folding */
582     public static final String JavaDoc CODE_FOLDING_ENABLE = "code-folding-enable"; //NOI18N
583

584     /**Modifiers for which the hyperlinks should be enabled.
585      */

586     public static final String JavaDoc HYPERLINK_ACTIVATION_MODIFIERS = "hyperlink-activation-modifiers"; //NOI18N
587

588 }
589
Popular Tags