001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.editor;
043:
044: /**
045: * Names of the base settings defined in the editor. The other packages
046: * related to the editor can define their own extensions to these basic
047: * names. The extension class can be inherited from this class
048: * so that the extension class contains all the available names.
049: *
050: * @author Miloslav Metelka
051: * @version 1.00
052: */
053:
054: public class SettingsNames {
055:
056: /** Number of spaces to draw when the '\t' character
057: * is found in the text. Better said when the drawing-engine
058: * finds a '\t' character it computes the next multiple
059: * of TAB_SIZE and continues drawing from that position.
060: * Values: java.lang.Integer instances
061: */
062: public static final String TAB_SIZE = "tab-size"; // NOI18N
063:
064: /** Whether expand typed tabs to spaces. The number of spaces to substitute
065: * per one typed tab is determined by SPACES_PER_TAB setting.
066: * Values: java.lang.Boolean instances
067: */
068: public static final String EXPAND_TABS = "expand-tabs"; // NOI18N
069:
070: /** How many spaces substitute per one typed tab. This parameter has
071: * effect only when EXPAND_TABS setting is set to true.
072: * This parameter has no influence on how
073: * the existing tabs are displayed.
074: * Values: java.lang.Integer instances
075: */
076: public static final String SPACES_PER_TAB = "spaces-per-tab"; // NOI18N
077:
078: /** Shift-width says how many spaces should the formatter use
079: * to indent the more inner level of code. This setting is independent of <tt>TAB_SIZE</tt>
080: * and <tt>SPACES_PER_TAB</tt>.
081: * Values: java.lang.Integer instances
082: */
083: public static final String INDENT_SHIFT_WIDTH = "indent-shift-width"; // NOI18N
084:
085: /** Acceptor that recognizes the identifier characters.
086: * If set it's used instead of the default Syntax.isIdentifierPart() call.
087: * Values: org.netbeans.editor.Acceptor instances
088: */
089: public static final String IDENTIFIER_ACCEPTOR = "identifier-acceptor"; // NOI18N
090:
091: /** Acceptor that recognizes the whitespace characters.
092: * If set it's used instead of the default Syntax.isWhitespace() call.
093: * Values: org.netbeans.editor.Acceptor instances
094: */
095: public static final String WHITESPACE_ACCEPTOR = "whitespace-acceptor"; // NOI18N
096:
097: /** Map of the string abbreviations. The second string (value) means
098: * the full version of the first string (key).
099: * Values: java.util.Map instances holding
100: * [abbrev-string, expanded-abbrev-string] pairs
101: *
102: * @deprecated Use Editor Settings and Editor Settings Storage APIs instead.
103: */
104: public static final String ABBREV_MAP = "abbrev-map"; // NOI18N
105:
106: /** Map of macro definitions. The second string (value) contains
107: * encoded functionality of the macro in the following notation:
108: * Macro ::= S? Element (S Element)* S?
109: * Element ::= Action | '"' Text '"'
110: * Action ::= ( ( ( char - ( S | '\' ) ) | '\\' | ( '\' S ) )+
111: * Text ::= ( ( char - ( '"' | '\' ) ) | ( '\"' | '\\' ) )*
112: *
113: * @deprecated Not supported anymore. There is no public API for accessing
114: * editor macros.
115: */
116: public static final String MACRO_MAP = "macro-map"; // NOI18N
117:
118: /** Map of the action abbreviations. The second string (value) is
119: * the name of the action to execute. The action must be available
120: * in the kit actions. It can be added through <tt>CUSTOM_ACTION_LIST</tt>.
121: * The original abbreviation string
122: * is first removed from the text before the action is executed.
123: * If there is the same abbreviation in the <tt>ABBREV_MAP</tt> map
124: * it has a precedence over the <tt>ABBREV_ACTION_MAP</tt>.
125: * Values: java.util.Map instances holding
126: * [abbrev-string, name-of-the-action-to-execute] pairs
127: *
128: * @deprecated Not supported anymore. For code templates use
129: * Editor Settings, Editor Settings Storage and Editor Code Templates APIs.
130: */
131: public static final String ABBREV_ACTION_MAP = "abbrev-action-map"; // NOI18N
132:
133: /** Acceptor checking whether abbreviation should be attempted
134: * after the appropriate character was typed.
135: * Values: org.netbeans.editor.Acceptor instances
136: */
137: public static final String ABBREV_EXPAND_ACCEPTOR = "abbrev-expand-acceptor"; // NOI18N
138:
139: /** Acceptor checking whether typed character that performed
140: * abbreviation expansion should be added to the text or not.
141: * Values: org.netbeans.editor.Acceptor instances
142: */
143: public static final String ABBREV_ADD_TYPED_CHAR_ACCEPTOR = "abbrev-add-typed-char-acceptor"; // NOI18N
144:
145: /** Acceptor checking whether typed character should reset
146: * abbreviation accounting. By default all non-letterOrDigit chars
147: * reset the abbreviation accounting.
148: * Values: org.netbeans.editor.Acceptor instances
149: */
150: public static final String ABBREV_RESET_ACCEPTOR = "abbrev-reset-acceptor"; // NOI18N
151:
152: /** Type of caret for insert mode.
153: * Values: java.lang.String instances
154: * Currently supported types are:
155: * org.netbeans.editor.BaseCaret.LINE_CARET - default 2point caret
156: * org.netbeans.editor.BaseCaret.THIN_LINE_CARET - swing like thin caret
157: * org.netbeans.editor.BaseCaret.BLOCK_CARET - block covering whole character
158: */
159: public static final String CARET_TYPE_INSERT_MODE = "caret-type-insert-mode"; // NOI18N
160:
161: /** Type of caret for over write mode.
162: * Values: java.lang.String instances
163: * Currently supported types are:
164: * org.netbeans.editor.BaseCaret.LINE_CARET - default 2point caret
165: * org.netbeans.editor.BaseCaret.THIN_LINE_CARET - swing like thin caret
166: * org.netbeans.editor.BaseCaret.BLOCK_CARET - block covering whole character
167: */
168: public static final String CARET_TYPE_OVERWRITE_MODE = "caret-type-overwrite-mode"; // NOI18N
169:
170: /** Will the insert mode caret be italicized if the underlying font
171: * is italic?
172: * Values: java.lang.Boolean instances
173: */
174: public static final String CARET_ITALIC_INSERT_MODE = "caret-italic-insert-mode"; // NOI18N
175:
176: /** Will the overwrite mode caret be italicized if the underlying font
177: * is italic?
178: * Values: java.lang.Boolean instances
179: */
180: public static final String CARET_ITALIC_OVERWRITE_MODE = "caret-italic-overwrite-mode"; // NOI18N
181:
182: /** Caret color for insert mode.
183: * Values: java.awt.Color instances
184: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
185: */
186: public static final String CARET_COLOR_INSERT_MODE = "caret-color-insert-mode"; // NOI18N
187:
188: /** Caret color for overwrite mode.
189: * Values: java.awt.Color instances
190: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
191: */
192: public static final String CARET_COLOR_OVERWRITE_MODE = "caret-color-overwrite-mode"; // NOI18N
193:
194: /** Caret blink rate in milliseconds.
195: * Values: java.lang.Integer
196: */
197: public static final String CARET_BLINK_RATE = "caret-blink-rate"; // NOI18N
198:
199: /** Whether to display line numbers on the left part of the screen.
200: * Values: java.lang.Boolean instances
201: */
202: public static final String LINE_NUMBER_VISIBLE = "line-number-visible"; // NOI18N
203:
204: /** Completion of { } [ ] " " ' ' and tags */
205: public static final String PAIR_CHARACTERS_COMPLETION = "pair-characters-completion"; // NOI18N
206:
207: /** Whether to display line numbers when printing to the printer.
208: * Values: java.lang.Boolean instances
209: */
210: public static final String PRINT_LINE_NUMBER_VISIBLE = "print-line-number-visible"; // NOI18N
211:
212: /** How much should the view jump when scrolling goes off the screen.
213: * Insets are used so that it can be specified for each direction specifically.
214: * Each inset value can be positive or negative. The positive value means
215: * the number of lines for the top and the bottom and the number of characters
216: * for the left and the right. The negative value means percentage of the editor
217: * component height for the top and the bottom and percentage of the editor
218: * component width for the left and the right.
219: * Values: java.awt.Insets instances
220: * @deprecated value of this property is ignored.
221: */
222: public static final String SCROLL_JUMP_INSETS = "scroll-jump-insets"; // NOI18N
223:
224: /** How much space must be reserved in each direction for the find operation.
225: * It's here to ensure the found information will be visible in some
226: * context around it.
227: * Insets are used so that it can be specified for each direction specifically.
228: * Each inset value can be positive or negative. The positive value means
229: * the number of lines for the top and the bottom and the number of characters
230: * for the left and the right. The negative value means percentage of the editor
231: * component height for the top and the bottom and percentage of the editor
232: * component width for the left and the right.
233: * Values: java.awt.Insets instances
234: */
235: public static final String SCROLL_FIND_INSETS = "scroll-find-insets"; // NOI18N
236:
237: /** How much space will be added additionaly when the component needs to be
238: * resized.
239: * Each dimension value can be positive or negative. The positive value means
240: * the number of lines for the height and the number of characters
241: * for the width. The negative value means percentage of the editor
242: * component height for the height and percentage of the editor
243: * component width for the width.
244: * Values: java.awt.Dimension instances
245: */
246: public static final String COMPONENT_SIZE_INCREMENT = "component-size-increment"; // NOI18N
247:
248: /** Margin for the editor component
249: * Values: java.awt.Insets instances
250: */
251: public static final String MARGIN = "margin"; // NOI18N
252:
253: /** Width of the margin on the left side of the text just after the line-number bar.
254: * Values: java.awt.Integer instances
255: */
256: public static final String TEXT_LEFT_MARGIN_WIDTH = "text-left-margin-width"; // NOI18N
257:
258: /** Rendering hints to be used for the painting.
259: * Values: java.util.Map instances
260: */
261: public static final String RENDERING_HINTS = "rendering-hints"; // NOI18N
262:
263: /** Key binding list for particular kit.
264: * Values: java.util.List instances holding
265: * javax.swing.JTextComponent.KeyBinding instances
266: * or org.netbeans.editor.MultiKeyBinding instances
267: * @deprecated Use Editor Settings and Editor Settings Storage APIs instead.
268: */
269: public static final String KEY_BINDING_LIST = "key-bindings"; // NOI18N
270:
271: /** Whether the input-methods should be enabled.
272: * Values: java.lang.Boolean
273: */
274: public static final String INPUT_METHODS_ENABLED = "input-methods-enabled"; // NOI18N
275:
276: /** Float constant by which the height of the character obtained from
277: * the font is multiplied. It defaults to 1.
278: * Values: java.lang.Float instances
279: */
280: public static final String LINE_HEIGHT_CORRECTION = "line-height-correction"; // NOI18N
281:
282: /* Find properties.
283: * They are read by FindSupport when its instance is being initialized.
284: * FIND_WHAT: java.lang.String - search expression
285: * FIND_REPLACE_BY: java.lang.String - replace string
286: * FIND_HIGHLIGHT_SEARCH: java.lang.Boolean - highlight matching strings in text
287: * FIND_INC_SEARCH: java.lang.Boolean - show matching strings immediately
288: * FIND_BACKWARD_SEARCH: java.lang.Boolean - search in backward direction
289: * FIND_WRAP_SEARCH: java.lang.Boolean - if end of doc reached, start from begin
290: * FIND_MATCH_CASE: java.lang.Boolean - match case of letters
291: * FIND_SMART_CASE: java.lang.Boolean - case insensitive search if FIND_MATCH_CASE
292: * is false and all letters of FIND_WHAT are small, case sensitive otherwise
293: * FIND_WHOLE_WORDS: java.lang.Boolean - match only whole words
294: * FIND_REG_EXP: java.lang.Boolean - use regular expressions in search expr
295: * FIND_HISTORY: java.util.List - History of search expressions
296: * FIND_HISTORY_SIZE: java.lang.Integer - Maximum size of the history
297: * FIND_BLOCK_SEARCH: java.lang.Boolean - search in block
298: * FIND_BLOCK_SEARCH_START: java.lang.Integer - start offset of the block
299: * FIND_BLOCK_SEARCH_END: java.lang.Integer - end offset of the block
300: *
301: */
302: public static final String FIND_WHAT = "find-what"; // NOI18N
303: public static final String FIND_REPLACE_WITH = "find-replace-with"; // NOI18N
304: public static final String FIND_HIGHLIGHT_SEARCH = "find-highlight-search"; // NOI18N
305: public static final String FIND_INC_SEARCH = "find-inc-search"; // NOI18N
306: public static final String FIND_INC_SEARCH_DELAY = "find-inc-search-delay"; // NOI18N
307: public static final String FIND_BACKWARD_SEARCH = "find-backward-search"; // NOI18N
308: public static final String FIND_WRAP_SEARCH = "find-wrap-search"; // NOI18N
309: public static final String FIND_MATCH_CASE = "find-match-case"; // NOI18N
310: public static final String FIND_SMART_CASE = "find-smart-case"; // NOI18N
311: public static final String FIND_WHOLE_WORDS = "find-whole-words"; // NOI18N
312: public static final String FIND_REG_EXP = "find-reg-exp"; // NOI18N
313: public static final String FIND_HISTORY = "find-history"; // NOI18N
314: public static final String FIND_HISTORY_SIZE = "find-history-size"; // NOI18N
315: public static final String FIND_BLOCK_SEARCH = "find-block-search"; //NOI18N
316: public static final String FIND_BLOCK_SEARCH_START = "find-block-search-start"; //NOI18N
317: public static final String FIND_BLOCK_SEARCH_END = "find-block-search-end"; //NOI18N
318:
319: /** Number of characters that can be searched. If the value is larger
320: * than the document size, the document is used but the next document
321: * will not be used. The zero value disables the word match completely.
322: * Specify Integer.MAX_VALUE to search all the documents regardless
323: * of the size.
324: * Values: java.lang.Integer instances
325: */
326: public static final String WORD_MATCH_SEARCH_LEN = "word-match-search-len"; // NOI18N
327:
328: /** Wrap the word match searching
329: * on current document after it reaches the end/begining of
330: * current document. All the other documents except the current (first) one
331: * are searched from begining in forward direction.
332: * Values: java.lang.Boolean instances
333: */
334: public static final String WORD_MATCH_WRAP_SEARCH = "word-match-wrap-search"; // NOI18N
335:
336: /** Word list that is searched as last resort in word matching.
337: * It can contain the words that are used often by the user.
338: * If this property is set, these words are searched regardless
339: * of WORD_MATCH_SEARCH_LEN setting.
340: * Values: java.lang.String instances
341: */
342: public static final String WORD_MATCH_STATIC_WORDS = "word-match-static-words"; // NOI18N
343:
344: /** Whether to use case sensitive search or not.
345: * Values: java.lang.Boolean instances
346: */
347: public static final String WORD_MATCH_MATCH_CASE = "word-match-match-case"; // NOI18N
348:
349: /** Whether to use case insensitive search if all the letters are small
350: * and case sensitive search if at least one letter is capital.
351: * Values: java.lang.Boolean instances
352: */
353: public static final String WORD_MATCH_SMART_CASE = "word-match-smart-case"; // NOI18N
354:
355: /** Whether the word matching should return the match even if the matching
356: * word has only one char. The WORD_MATCH_MATCH_CASE setting is ignored
357: * in case this setting is on.
358: * Values: java.lang.Boolean instances
359: */
360: public static final String WORD_MATCH_MATCH_ONE_CHAR = "word-match-match-one-char"; // NOI18N
361:
362: /** List of actions that will be added to the standard list of actions
363: * for the particular kit. Using this mechanism, user can add actions
364: * and possibly map them to the keys without overriding kit classes.
365: * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
366: * all the super kit lists are used. For example if there is a list of actions
367: * both for JavaKit and BaseKit classes, both list of actions will be added
368: * and BaseKit actions will be added first.
369: * Values: java.util.List instances
370: */
371: public static final String CUSTOM_ACTION_LIST = "custom-action-list"; // NOI18N
372:
373: /** List of actions which is executed when
374: * editor kit is installed into component. Actions are executed one by one
375: * in the order they occur in the list.
376: * At the time the kit is installed, the document is not yet assigned.
377: * To perform some actions on document, use the DOC_INSTALL_ACTION_LIST.
378: * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
379: * all the super kit lists are used. For example if there is a list of actions
380: * both for JavaKit and BaseKit classes, both list of actions will be executed
381: * and JavaKit actions will be executed first.
382: * Values: java.util.List instances
383: */
384: public static final String KIT_INSTALL_ACTION_NAME_LIST = "kit-install-action-name-list"; // NOI18N
385:
386: /** List of actions that are executed when
387: * editor kit is being removed from component. Actions are executed one by one
388: * in the order they occur in the list.
389: * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
390: * all the super kit lists are used. For example if there is a list of actions
391: * both for JavaKit and BaseKit classes, both list of actions will be executed
392: * and JavaKit actions will be executed first.
393: * Values: java.util.List instances
394: */
395: public static final String KIT_DEINSTALL_ACTION_NAME_LIST = "kit-deinstall-action-name-list"; // NOI18N
396:
397: /** List of actions which is executed when
398: * the new document is installed into component. Actions are executed one by one
399: * in the order they occur in the list.
400: * NOTICE!: This option has INCREMENTAL HANDLING, i.e. current kit list but also
401: * all the super kit lists are used. For example if there is a list of actions
402: * both for JavaKit and BaseKit classes, both list of actions will be executed
403: * and JavaKit actions will be executed first.
404: * Values: java.util.List instances
405: */
406: public static final String DOC_INSTALL_ACTION_NAME_LIST = "doc-install-action-name-list"; // NOI18N
407:
408: /** Whether status bar should be visible or not.
409: * Values: java.lang.Boolean instances
410: */
411: public static final String STATUS_BAR_VISIBLE = "status-bar-visible"; // NOI18N
412:
413: /** Delay for updating information about caret in the status bar.
414: * Values: java.lang.Integer instances
415: */
416: public static final String STATUS_BAR_CARET_DELAY = "status-bar-caret-delay"; // NOI18N
417:
418: /** Whether the line displaying the text limit should be displayed.
419: * Values: java.lang.Boolean instances
420: */
421: public static final String TEXT_LIMIT_LINE_VISIBLE = "text-limit-line-visible"; // NOI18N
422:
423: /** Which color should be used for the line showing the text limit.
424: * Values: java.awt.Color instances
425: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
426: */
427: public static final String TEXT_LIMIT_LINE_COLOR = "text-limit-line-color"; // NOI18N
428:
429: /** After how many characters the text limit line should be displayed.
430: * Values: java.awt.Integer instances
431: */
432: public static final String TEXT_LIMIT_WIDTH = "text-limit-width"; // NOI18N
433:
434: /** Whether the home key should go to column 1 or first go to text start
435: * on the given line and then to the column 1.
436: * Values: java.lang.Boolean
437: * @deprecated As of 05/09/2001
438: */
439: public static final String HOME_KEY_COLUMN_ONE = "home-key-column-one"; // NOI18N
440:
441: /** Finder for finding the next word. If it's not set,
442: * the <tt>FinderFactory.NextWordFwdFinder</tt> is used.
443: * Values: org.netbeans.editor.Finder
444: */
445: public static final String NEXT_WORD_FINDER = "next-word-finder"; // NOI18N
446:
447: /** Finder for finding the previous word. If it's not set,
448: * the <tt>FinderFactory.WordStartBwdFinder</tt> is used.
449: * Values: org.netbeans.editor.Finder
450: */
451: public static final String PREVIOUS_WORD_FINDER = "previous-word-finder"; // NOI18N
452:
453: /** Whether the word move should stop on the '\n' character. This setting
454: * affects both the
455: * Values: java.lang.Boolean
456: */
457: public static final String WORD_MOVE_NEWLINE_STOP = "word-move-newline-stop"; // NOI18N
458:
459: /** Whether to trim the white space characters (except '\n') from
460: * the end of the line.
461: * Values: java.lang.Boolean instances
462: */
463: // public static final String TRIM_SPACES = "trim-spaces"; // NOI18N
464: /** Buffer size for reading into the document from input stream or reader.
465: * Values: java.lang.Integer
466: * WARNING! This is critical parameter for editor functionality.
467: * Please see DefaultSettings.java for values of this setting
468: */
469: public static final String READ_BUFFER_SIZE = "read-buffer-size"; // NOI18N
470:
471: /** Buffer size for writing from the document to output stream or writer.
472: * Values: java.lang.Integer instances
473: * WARNING! This is critical parameter for editor functionality.
474: * Please see DefaultSettings.java for values of this setting
475: */
476: public static final String WRITE_BUFFER_SIZE = "write-buffer-size"; // NOI18N
477:
478: /** Read mark distance is used when performing initial read
479: * of the document. It denotes the distance in chars of two adjacent
480: * syntax marks inserted into the document.
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 READ_MARK_DISTANCE = "read-mark-distance"; // NOI18N
486:
487: /** Implicit mark distance for inserting to the document.
488: * If the insert is made then the distance between nearest syntax
489: * marks around insertion point is checked and if it's greater
490: * than the max mark distance then another mark(s) are inserted
491: * automatically with the distance given by this setting.
492: * Values: java.lang.Integer instances instances
493: * WARNING! This is critical parameter for editor functionality.
494: * Please see DefaultSettings.java for values of this setting
495: */
496: public static final String MARK_DISTANCE = "mark-distance"; // NOI18N
497:
498: /** Maximum mark distance. When there is an insertion done in document
499: * and the distance between marks gets greater than this setting, another
500: * mark will be inserted automatically.
501: * Values: java.lang.Integer instances
502: * WARNING! This is critical parameter for editor functionality.
503: * Please see DefaultSettings.java for values of this setting
504: */
505: public static final String MAX_MARK_DISTANCE = "max-mark-distance"; // NOI18N
506:
507: /** Minimum mark distance for removals. When there is a removal done
508: * in document and it makes the marks to get closer than this value, then
509: * the marks the additional marks that are closer than the distance
510: * given by this setting are removed automatically.
511: * Values: java.lang.Integer instances
512: * WARNING! This is critical parameter for editor functionality.
513: * Please see DefaultSettings.java for values of this setting
514: */
515: public static final String MIN_MARK_DISTANCE = "min-mark-distance"; // NOI18N
516:
517: /** Size of one batch of characters loaded into syntax segment
518: * when updating syntax marks. It prevents checking and loading
519: * of syntax segment at every syntax mark. Instead it loads
520: * at least the amount of characters given by this setting.
521: * This whole process is done only in case the changes in syntax
522: * extend the end of current line. If the syntax changes don't
523: * extend to the next line, this setting has no effect.
524: * Values: java.lang.Integer instances
525: * WARNING! This is critical parameter for editor functionality.
526: * Please see DefaultSettings.java for values of this setting
527: */
528: public static final String SYNTAX_UPDATE_BATCH_SIZE = "syntax-update-batch-size"; // NOI18N
529:
530: /** How many lines should be processed at once in the various text
531: * processing. This is used for example when processing the text
532: * by syntax scanner.
533: */
534: public static final String LINE_BATCH_SIZE = "line-batch-size"; // NOI18N
535:
536: /** Ignore the changes made to the settings through the visual property editors
537: * working over the methods manipulating the settings. Generally there can be
538: * two ways to change the settings in the IDE. One way is to directly
539: * call the appropriate methods. The other way can be through some visual
540: * property editors. This flag should be checked by the property editors
541: * and if set to true, no changes to the settings should be performed.
542: * This allows advanced users to completely control the settings through code
543: * without any external undesired changes.
544: */
545: public static final String IGNORE_VISUAL_CHANGES = "ignore-visual-changes"; // NOI18N
546:
547: /** List of the names of the additional colorings that need to be taken
548: * into account for the particular kit. The colorings that come from
549: * syntax coloring need not be specified here. Instead
550: * the <tt>TOKEN_CONTEXT_LIST</tt> holds the list of token contexts
551: * that can be used by the given kit.
552: * The coloring names are without the suffix just like the predefined coloring names.
553: * Values: java.util.List instances
554: * @deprecated Use Editor Settings and Editor Settings Storage APIs instead.
555: */
556: public static final String COLORING_NAME_LIST = "coloring-name-list"; // NOI18N
557:
558: /** The list of the token contexts that the kit can use.
559: * The editor-ui uses this setting to determine all the token-ids
560: * and token-categories for the colorings.
561: */
562: public static final String TOKEN_CONTEXT_LIST = "token-context-list"; // NOI18N
563:
564: /** Suffix added to the coloring settings. The resulting name is used
565: * as the name of the setting.
566: * @deprecated Use Editor Settings and Editor Settings Storage APIs instead.
567: */
568: public static final String COLORING_NAME_SUFFIX = "-coloring"; // NOI18N
569:
570: /** Suffix added to the print coloring settings. The resulting name is used
571: * as the name of the setting.
572: * @deprecated Use Editor Settings and Editor Settings Storage APIs instead.
573: */
574: public static final String COLORING_NAME_PRINT_SUFFIX = "-print-coloring"; // NOI18N
575:
576: /** Default coloring for the drawing.
577: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
578: */
579: public static final String DEFAULT_COLORING = "default"; // NOI18N
580:
581: /** Coloring that will be used for line numbers displayed on the left
582: * side on the screen.
583: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
584: */
585: public static final String LINE_NUMBER_COLORING = "line-number"; // NOI18N
586:
587: /** Coloring used for guarded blocks
588: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
589: */
590: public static final String GUARDED_COLORING = "guarded"; // NOI18N
591:
592: /** Coloring that will be used for code folding icons displayed in editor
593: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
594: */
595: public static final String CODE_FOLDING_COLORING = "code-folding"; // NOI18N
596:
597: /** Coloring that will be used for code folding side bar
598: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
599: */
600: public static final String CODE_FOLDING_BAR_COLORING = "code-folding-bar"; // NOI18N
601:
602: /** Coloring used for selection
603: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
604: */
605: public static final String SELECTION_COLORING = "selection"; // NOI18N
606:
607: /** Coloring used for highlight search
608: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
609: */
610: public static final String HIGHLIGHT_SEARCH_COLORING = "highlight-search"; // NOI18N
611:
612: /** Coloring used for incremental search
613: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
614: */
615: public static final String INC_SEARCH_COLORING = "inc-search"; // NOI18N
616:
617: /** Coloring used for block search
618: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
619: */
620: public static final String BLOCK_SEARCH_COLORING = "block-search"; // NOI18N
621:
622: /** Coloring used for the status bar
623: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
624: */
625: public static final String STATUS_BAR_COLORING = "status-bar"; // NOI18N
626:
627: /** Coloring used to mark important text in the status bar
628: * @deprecated Use {@link org.netbeans.api.editor.settings.FontColorNames} instead.
629: */
630: public static final String STATUS_BAR_BOLD_COLORING = "status-bar-bold"; // NOI18N
631:
632: /** Enable/Disable code folding */
633: public static final String CODE_FOLDING_ENABLE = "code-folding-enable"; //NOI18N
634:
635: /**Modifiers for which the hyperlinks should be enabled.
636: */
637: public static final String HYPERLINK_ACTIVATION_MODIFIERS = "hyperlink-activation-modifiers"; //NOI18N
638:
639: }
|