SettingsNames (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class SettingsNames

java.lang.Object
  org.netbeans.editor.SettingsNames

Direct Known Subclasses:: ExtSettingsNames

public class SettingsNames
extends Object
extends Object

Names of the base settings defined in the editor. The other packages related to the editor can define their own extensions to these basic names. The extension class can be inherited from this class so that the extension class contains all the available names.

Field Summary

static String ABBREV_ACTION_MAP
          Map of the action abbreviations.

static String ABBREV_ADD_TYPED_CHAR_ACCEPTOR
          Acceptor checking whether typed character that performed abbreviation expansion should be added to the text or not.

static String ABBREV_EXPAND_ACCEPTOR
          Acceptor checking whether abbreviation should be attempted after the appropriate character was typed.

static String ABBREV_MAP
          Map of the string abbreviations.

static String ABBREV_RESET_ACCEPTOR
          Acceptor checking whether typed character should reset abbreviation accounting.

static String BLOCK_SEARCH_COLORING
          Deprecated. Use FontColorNames instead.

static String CARET_BLINK_RATE
          Caret blink rate in milliseconds.

static String CARET_COLOR_INSERT_MODE
          Deprecated. Use FontColorNames instead.

static String CARET_COLOR_OVERWRITE_MODE
          Deprecated. Use FontColorNames instead.

static String CARET_ITALIC_INSERT_MODE
          Will the insert mode caret be italicized if the underlying font is italic? Values: java.lang.Boolean instances

static String CARET_ITALIC_OVERWRITE_MODE
          Will the overwrite mode caret be italicized if the underlying font is italic? Values: java.lang.Boolean instances

static String CARET_TYPE_INSERT_MODE
          Type of caret for insert mode.

static String CARET_TYPE_OVERWRITE_MODE
          Type of caret for over write mode.

static String CODE_FOLDING_BAR_COLORING
          Deprecated. Use FontColorNames instead.

static String CODE_FOLDING_COLORING
          Deprecated. Use FontColorNames instead.

static String CODE_FOLDING_ENABLE
          Enable/Disable code folding

static String COLORING_NAME_LIST
          Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

static String COLORING_NAME_PRINT_SUFFIX
          Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

static String COLORING_NAME_SUFFIX
          Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

static String COMPONENT_SIZE_INCREMENT
          How much space will be added additionaly when the component needs to be resized.

static String CUSTOM_ACTION_LIST
          List of actions that will be added to the standard list of actions for the particular kit.

static String DEFAULT_COLORING
          Deprecated. Use FontColorNames instead.

static String DOC_INSTALL_ACTION_NAME_LIST
          List of actions which is executed when the new document is installed into component.

static String EXPAND_TABS
          Whether expand typed tabs to spaces.

static String FIND_BACKWARD_SEARCH


static String FIND_BLOCK_SEARCH


static String FIND_BLOCK_SEARCH_END


static String FIND_BLOCK_SEARCH_START


static String FIND_HIGHLIGHT_SEARCH


static String FIND_HISTORY


static String FIND_HISTORY_SIZE


static String FIND_INC_SEARCH


static String FIND_INC_SEARCH_DELAY


static String FIND_MATCH_CASE


static String FIND_REG_EXP


static String FIND_REPLACE_WITH


static String FIND_SMART_CASE


static String FIND_WHAT


static String FIND_WHOLE_WORDS


static String FIND_WRAP_SEARCH


static String GUARDED_COLORING
          Deprecated. Use FontColorNames instead.

static String HIGHLIGHT_SEARCH_COLORING
          Deprecated. Use FontColorNames instead.

static String HOME_KEY_COLUMN_ONE
          Deprecated. As of 05/09/2001

static String HYPERLINK_ACTIVATION_MODIFIERS
          Modifiers for which the hyperlinks should be enabled.

static String IDENTIFIER_ACCEPTOR
          Acceptor that recognizes the identifier characters.

static String IGNORE_VISUAL_CHANGES
          Ignore the changes made to the settings through the visual property editors working over the methods manipulating the settings.

static String INC_SEARCH_COLORING
          Deprecated. Use FontColorNames instead.

static String INDENT_SHIFT_WIDTH
          Shift-width says how many spaces should the formatter use to indent the more inner level of code.

static String INPUT_METHODS_ENABLED
          Whether the input-methods should be enabled.

static String KEY_BINDING_LIST
          Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

static String KIT_DEINSTALL_ACTION_NAME_LIST
          List of actions that are executed when editor kit is being removed from component.

static String KIT_INSTALL_ACTION_NAME_LIST
          List of actions which is executed when editor kit is installed into component.

static String LINE_BATCH_SIZE
          How many lines should be processed at once in the various text processing.

static String LINE_HEIGHT_CORRECTION
          Float constant by which the height of the character obtained from the font is multiplied.

static String LINE_NUMBER_COLORING
          Deprecated. Use FontColorNames instead.

static String LINE_NUMBER_VISIBLE
          Whether to display line numbers on the left part of the screen.

static String MACRO_MAP
          Map of macro definitions.

static String MARGIN
          Margin for the editor component Values: java.awt.Insets instances

static String MARK_DISTANCE
          Implicit mark distance for inserting to the document.

static String MAX_MARK_DISTANCE
          Maximum mark distance.

static String MIN_MARK_DISTANCE
          Minimum mark distance for removals.

static String NEXT_WORD_FINDER
          Finder for finding the next word.

static String PAIR_CHARACTERS_COMPLETION
          Completion of { } [ ] " " ' ' and tags

static String PREVIOUS_WORD_FINDER
          Finder for finding the previous word.

static String PRINT_LINE_NUMBER_VISIBLE
          Whether to display line numbers when printing to the printer.

static String READ_BUFFER_SIZE
          Buffer size for reading into the document from input stream or reader.

static String READ_MARK_DISTANCE
          Read mark distance is used when performing initial read of the document.

static String RENDERING_HINTS
          Rendering hints to be used for the painting.

static String SCROLL_FIND_INSETS
          How much space must be reserved in each direction for the find operation.

static String SCROLL_JUMP_INSETS
          Deprecated. value of this property is ignored.

static String SELECTION_COLORING
          Deprecated. Use FontColorNames instead.

static String SPACES_PER_TAB
          How many spaces substitute per one typed tab.

static String STATUS_BAR_BOLD_COLORING
          Deprecated. Use FontColorNames instead.

static String STATUS_BAR_CARET_DELAY
          Delay for updating information about caret in the status bar.

static String STATUS_BAR_COLORING
          Deprecated. Use FontColorNames instead.

static String STATUS_BAR_VISIBLE
          Whether status bar should be visible or not.

static String SYNTAX_UPDATE_BATCH_SIZE
          Size of one batch of characters loaded into syntax segment when updating syntax marks.

static String TAB_SIZE
          Number of spaces to draw when the '\t' character is found in the text.

static String TEXT_LEFT_MARGIN_WIDTH
          Width of the margin on the left side of the text just after the line-number bar.

static String TEXT_LIMIT_LINE_COLOR
          Deprecated. Use FontColorNames instead.

static String TEXT_LIMIT_LINE_VISIBLE
          Whether the line displaying the text limit should be displayed.

static String TEXT_LIMIT_WIDTH
          After how many characters the text limit line should be displayed.

static String TOKEN_CONTEXT_LIST
          The list of the token contexts that the kit can use.

static String WHITESPACE_ACCEPTOR
          Acceptor that recognizes the whitespace characters.

static String WORD_MATCH_MATCH_CASE
          Whether to use case sensitive search or not.

static String WORD_MATCH_MATCH_ONE_CHAR
          Whether the word matching should return the match even if the matching word has only one char.

static String WORD_MATCH_SEARCH_LEN
          Number of characters that can be searched.

static String WORD_MATCH_SMART_CASE
          Whether to use case insensitive search if all the letters are small and case sensitive search if at least one letter is capital.

static String WORD_MATCH_STATIC_WORDS
          Word list that is searched as last resort in word matching.

static String WORD_MATCH_WRAP_SEARCH
          Wrap the word match searching on current document after it reaches the end/begining of current document.

static String WORD_MOVE_NEWLINE_STOP
          Whether the word move should stop on the '\n' character.

static String WRITE_BUFFER_SIZE
          Buffer size for writing from the document to output stream or writer.

Constructor Summary

SettingsNames()


Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
`static String`	`ABBREV_ACTION_MAP` Map of the action abbreviations.
`static String`	`ABBREV_ADD_TYPED_CHAR_ACCEPTOR` Acceptor checking whether typed character that performed abbreviation expansion should be added to the text or not.
`static String`	`ABBREV_EXPAND_ACCEPTOR` Acceptor checking whether abbreviation should be attempted after the appropriate character was typed.
`static String`	`ABBREV_MAP` Map of the string abbreviations.
`static String`	`ABBREV_RESET_ACCEPTOR` Acceptor checking whether typed character should reset abbreviation accounting.
`static String`	`BLOCK_SEARCH_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`CARET_BLINK_RATE` Caret blink rate in milliseconds.
`static String`	`CARET_COLOR_INSERT_MODE` Deprecated. Use `FontColorNames` instead.
`static String`	`CARET_COLOR_OVERWRITE_MODE` Deprecated. Use `FontColorNames` instead.
`static String`	`CARET_ITALIC_INSERT_MODE` Will the insert mode caret be italicized if the underlying font is italic? Values: java.lang.Boolean instances
`static String`	`CARET_ITALIC_OVERWRITE_MODE` Will the overwrite mode caret be italicized if the underlying font is italic? Values: java.lang.Boolean instances
`static String`	`CARET_TYPE_INSERT_MODE` Type of caret for insert mode.
`static String`	`CARET_TYPE_OVERWRITE_MODE` Type of caret for over write mode.
`static String`	`CODE_FOLDING_BAR_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`CODE_FOLDING_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`CODE_FOLDING_ENABLE` Enable/Disable code folding
`static String`	`COLORING_NAME_LIST` Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.
`static String`	`COLORING_NAME_PRINT_SUFFIX` Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.
`static String`	`COLORING_NAME_SUFFIX` Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.
`static String`	`COMPONENT_SIZE_INCREMENT` How much space will be added additionaly when the component needs to be resized.
`static String`	`CUSTOM_ACTION_LIST` List of actions that will be added to the standard list of actions for the particular kit.
`static String`	`DEFAULT_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`DOC_INSTALL_ACTION_NAME_LIST` List of actions which is executed when the new document is installed into component.
`static String`	`EXPAND_TABS` Whether expand typed tabs to spaces.
`static String`	`FIND_BACKWARD_SEARCH`
`static String`	`FIND_BLOCK_SEARCH`
`static String`	`FIND_BLOCK_SEARCH_END`
`static String`	`FIND_BLOCK_SEARCH_START`
`static String`	`FIND_HIGHLIGHT_SEARCH`
`static String`	`FIND_HISTORY`
`static String`	`FIND_HISTORY_SIZE`
`static String`	`FIND_INC_SEARCH`
`static String`	`FIND_INC_SEARCH_DELAY`
`static String`	`FIND_MATCH_CASE`
`static String`	`FIND_REG_EXP`
`static String`	`FIND_REPLACE_WITH`
`static String`	`FIND_SMART_CASE`
`static String`	`FIND_WHAT`
`static String`	`FIND_WHOLE_WORDS`
`static String`	`FIND_WRAP_SEARCH`
`static String`	`GUARDED_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`HIGHLIGHT_SEARCH_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`HOME_KEY_COLUMN_ONE` Deprecated. As of 05/09/2001
`static String`	`HYPERLINK_ACTIVATION_MODIFIERS` Modifiers for which the hyperlinks should be enabled.
`static String`	`IDENTIFIER_ACCEPTOR` Acceptor that recognizes the identifier characters.
`static String`	`IGNORE_VISUAL_CHANGES` Ignore the changes made to the settings through the visual property editors working over the methods manipulating the settings.
`static String`	`INC_SEARCH_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`INDENT_SHIFT_WIDTH` Shift-width says how many spaces should the formatter use to indent the more inner level of code.
`static String`	`INPUT_METHODS_ENABLED` Whether the input-methods should be enabled.
`static String`	`KEY_BINDING_LIST` Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.
`static String`	`KIT_DEINSTALL_ACTION_NAME_LIST` List of actions that are executed when editor kit is being removed from component.
`static String`	`KIT_INSTALL_ACTION_NAME_LIST` List of actions which is executed when editor kit is installed into component.
`static String`	`LINE_BATCH_SIZE` How many lines should be processed at once in the various text processing.
`static String`	`LINE_HEIGHT_CORRECTION` Float constant by which the height of the character obtained from the font is multiplied.
`static String`	`LINE_NUMBER_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`LINE_NUMBER_VISIBLE` Whether to display line numbers on the left part of the screen.
`static String`	`MACRO_MAP` Map of macro definitions.
`static String`	`MARGIN` Margin for the editor component Values: java.awt.Insets instances
`static String`	`MARK_DISTANCE` Implicit mark distance for inserting to the document.
`static String`	`MAX_MARK_DISTANCE` Maximum mark distance.
`static String`	`MIN_MARK_DISTANCE` Minimum mark distance for removals.
`static String`	`NEXT_WORD_FINDER` Finder for finding the next word.
`static String`	`PAIR_CHARACTERS_COMPLETION` Completion of { } [ ] " " ' ' and tags
`static String`	`PREVIOUS_WORD_FINDER` Finder for finding the previous word.
`static String`	`PRINT_LINE_NUMBER_VISIBLE` Whether to display line numbers when printing to the printer.
`static String`	`READ_BUFFER_SIZE` Buffer size for reading into the document from input stream or reader.
`static String`	`READ_MARK_DISTANCE` Read mark distance is used when performing initial read of the document.
`static String`	`RENDERING_HINTS` Rendering hints to be used for the painting.
`static String`	`SCROLL_FIND_INSETS` How much space must be reserved in each direction for the find operation.
`static String`	`SCROLL_JUMP_INSETS` Deprecated. value of this property is ignored.
`static String`	`SELECTION_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`SPACES_PER_TAB` How many spaces substitute per one typed tab.
`static String`	`STATUS_BAR_BOLD_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`STATUS_BAR_CARET_DELAY` Delay for updating information about caret in the status bar.
`static String`	`STATUS_BAR_COLORING` Deprecated. Use `FontColorNames` instead.
`static String`	`STATUS_BAR_VISIBLE` Whether status bar should be visible or not.
`static String`	`SYNTAX_UPDATE_BATCH_SIZE` Size of one batch of characters loaded into syntax segment when updating syntax marks.
`static String`	`TAB_SIZE` Number of spaces to draw when the '\t' character is found in the text.
`static String`	`TEXT_LEFT_MARGIN_WIDTH` Width of the margin on the left side of the text just after the line-number bar.
`static String`	`TEXT_LIMIT_LINE_COLOR` Deprecated. Use `FontColorNames` instead.
`static String`	`TEXT_LIMIT_LINE_VISIBLE` Whether the line displaying the text limit should be displayed.
`static String`	`TEXT_LIMIT_WIDTH` After how many characters the text limit line should be displayed.
`static String`	`TOKEN_CONTEXT_LIST` The list of the token contexts that the kit can use.
`static String`	`WHITESPACE_ACCEPTOR` Acceptor that recognizes the whitespace characters.
`static String`	`WORD_MATCH_MATCH_CASE` Whether to use case sensitive search or not.
`static String`	`WORD_MATCH_MATCH_ONE_CHAR` Whether the word matching should return the match even if the matching word has only one char.
`static String`	`WORD_MATCH_SEARCH_LEN` Number of characters that can be searched.
`static String`	`WORD_MATCH_SMART_CASE` Whether to use case insensitive search if all the letters are small and case sensitive search if at least one letter is capital.
`static String`	`WORD_MATCH_STATIC_WORDS` Word list that is searched as last resort in word matching.
`static String`	`WORD_MATCH_WRAP_SEARCH` Wrap the word match searching on current document after it reaches the end/begining of current document.
`static String`	`WORD_MOVE_NEWLINE_STOP` Whether the word move should stop on the '\n' character.
`static String`	`WRITE_BUFFER_SIZE` Buffer size for writing from the document to output stream or writer.

Constructor Summary
`SettingsNames()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

TAB_SIZE

public static final String TAB_SIZE

Number of spaces to draw when the '\t' character is found in the text. Better said when the drawing-engine finds a '\t' character it computes the next multiple of TAB_SIZE and continues drawing from that position. Values: java.lang.Integer instances

See Also:: Constant Field Values

EXPAND_TABS

public static final String EXPAND_TABS

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

See Also:: Constant Field Values

SPACES_PER_TAB

public static final String SPACES_PER_TAB

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

See Also:: Constant Field Values

INDENT_SHIFT_WIDTH

public static final String INDENT_SHIFT_WIDTH

Shift-width says how many spaces should the formatter use to indent the more inner level of code. This setting is independent of TAB_SIZE and SPACES_PER_TAB. Values: java.lang.Integer instances

See Also:: Constant Field Values

IDENTIFIER_ACCEPTOR

public static final String IDENTIFIER_ACCEPTOR

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

See Also:: Constant Field Values

WHITESPACE_ACCEPTOR

public static final String WHITESPACE_ACCEPTOR

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

See Also:: Constant Field Values

ABBREV_MAP

public static final String ABBREV_MAP

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

See Also:: Constant Field Values

MACRO_MAP

public static final String MACRO_MAP

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

See Also:: Constant Field Values

ABBREV_ACTION_MAP

public static final String ABBREV_ACTION_MAP

Map of the action abbreviations. The second string (value) is the name of the action to execute. The action must be available in the kit actions. It can be added through CUSTOM_ACTION_LIST. The original abbreviation string is first removed from the text before the action is executed. If there is the same abbreviation in the ABBREV_MAP map it has a precedence over the ABBREV_ACTION_MAP. Values: java.util.Map instances holding [abbrev-string, name-of-the-action-to-execute] pairs

See Also:: Constant Field Values

ABBREV_EXPAND_ACCEPTOR

public static final String ABBREV_EXPAND_ACCEPTOR

Acceptor checking whether abbreviation should be attempted after the appropriate character was typed. Values: org.netbeans.editor.Acceptor instances

See Also:: Constant Field Values

ABBREV_ADD_TYPED_CHAR_ACCEPTOR

public static final String ABBREV_ADD_TYPED_CHAR_ACCEPTOR

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

See Also:: Constant Field Values

ABBREV_RESET_ACCEPTOR

public static final String ABBREV_RESET_ACCEPTOR

Acceptor checking whether typed character should reset abbreviation accounting. By default all non-letterOrDigit chars reset the abbreviation accounting. Values: org.netbeans.editor.Acceptor instances

See Also:: Constant Field Values

CARET_TYPE_INSERT_MODE

public static final String CARET_TYPE_INSERT_MODE

Type of caret for insert mode. Values: java.lang.String instances Currently supported types are: org.netbeans.editor.BaseCaret.LINE_CARET - default 2point caret org.netbeans.editor.BaseCaret.THIN_LINE_CARET - swing like thin caret org.netbeans.editor.BaseCaret.BLOCK_CARET - block covering whole character

See Also:: Constant Field Values

CARET_TYPE_OVERWRITE_MODE

public static final String CARET_TYPE_OVERWRITE_MODE

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

See Also:: Constant Field Values

CARET_ITALIC_INSERT_MODE

public static final String CARET_ITALIC_INSERT_MODE

Will the insert mode caret be italicized if the underlying font is italic? Values: java.lang.Boolean instances

See Also:: Constant Field Values

CARET_ITALIC_OVERWRITE_MODE

public static final String CARET_ITALIC_OVERWRITE_MODE

Will the overwrite mode caret be italicized if the underlying font is italic? Values: java.lang.Boolean instances

See Also:: Constant Field Values

CARET_COLOR_INSERT_MODE

public static final String CARET_COLOR_INSERT_MODE

Deprecated. Use FontColorNames instead.

Caret color for insert mode. Values: java.awt.Color instances

See Also:: Constant Field Values

CARET_COLOR_OVERWRITE_MODE

public static final String CARET_COLOR_OVERWRITE_MODE

Deprecated. Use FontColorNames instead.

Caret color for overwrite mode. Values: java.awt.Color instances

See Also:: Constant Field Values

CARET_BLINK_RATE

public static final String CARET_BLINK_RATE

Caret blink rate in milliseconds. Values: java.lang.Integer

See Also:: Constant Field Values

LINE_NUMBER_VISIBLE

public static final String LINE_NUMBER_VISIBLE

Whether to display line numbers on the left part of the screen. Values: java.lang.Boolean instances

See Also:: Constant Field Values

PAIR_CHARACTERS_COMPLETION

public static final String PAIR_CHARACTERS_COMPLETION

Completion of { } [ ] " " ' ' and tags

See Also:: Constant Field Values

PRINT_LINE_NUMBER_VISIBLE

public static final String PRINT_LINE_NUMBER_VISIBLE

Whether to display line numbers when printing to the printer. Values: java.lang.Boolean instances

See Also:: Constant Field Values

SCROLL_JUMP_INSETS

public static final String SCROLL_JUMP_INSETS

Deprecated. value of this property is ignored.

How much should the view jump when scrolling goes off the screen. Insets are used so that it can be specified for each direction specifically. Each inset value can be positive or negative. The positive value means the number of lines for the top and the bottom and the number of characters for the left and the right. The negative value means percentage of the editor component height for the top and the bottom and percentage of the editor component width for the left and the right. Values: java.awt.Insets instances

See Also:: Constant Field Values

SCROLL_FIND_INSETS

public static final String SCROLL_FIND_INSETS

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

See Also:: Constant Field Values

COMPONENT_SIZE_INCREMENT

public static final String COMPONENT_SIZE_INCREMENT

How much space will be added additionaly when the component needs to be resized. Each dimension value can be positive or negative. The positive value means the number of lines for the height and the number of characters for the width. The negative value means percentage of the editor component height for the height and percentage of the editor component width for the width. Values: java.awt.Dimension instances

See Also:: Constant Field Values

MARGIN

public static final String MARGIN

Margin for the editor component Values: java.awt.Insets instances

See Also:: Constant Field Values

TEXT_LEFT_MARGIN_WIDTH

public static final String TEXT_LEFT_MARGIN_WIDTH

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

See Also:: Constant Field Values

RENDERING_HINTS

public static final String RENDERING_HINTS

Rendering hints to be used for the painting. Values: java.util.Map instances

See Also:: Constant Field Values

KEY_BINDING_LIST

public static final String KEY_BINDING_LIST

Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

Key binding list for particular kit. Values: java.util.List instances holding javax.swing.JTextComponent.KeyBinding instances or org.netbeans.editor.MultiKeyBinding instances

See Also:: Constant Field Values

INPUT_METHODS_ENABLED

public static final String INPUT_METHODS_ENABLED

Whether the input-methods should be enabled. Values: java.lang.Boolean

See Also:: Constant Field Values

LINE_HEIGHT_CORRECTION

public static final String LINE_HEIGHT_CORRECTION

Float constant by which the height of the character obtained from the font is multiplied. It defaults to 1. Values: java.lang.Float instances

See Also:: Constant Field Values

FIND_WHAT

public static final String FIND_WHAT

See Also:: Constant Field Values

FIND_REPLACE_WITH

public static final String FIND_REPLACE_WITH

See Also:: Constant Field Values

FIND_HIGHLIGHT_SEARCH

public static final String FIND_HIGHLIGHT_SEARCH

See Also:: Constant Field Values

FIND_INC_SEARCH

public static final String FIND_INC_SEARCH

See Also:: Constant Field Values

FIND_INC_SEARCH_DELAY

public static final String FIND_INC_SEARCH_DELAY

See Also:: Constant Field Values

FIND_BACKWARD_SEARCH

public static final String FIND_BACKWARD_SEARCH

See Also:: Constant Field Values

FIND_WRAP_SEARCH

public static final String FIND_WRAP_SEARCH

See Also:: Constant Field Values

FIND_MATCH_CASE

public static final String FIND_MATCH_CASE

See Also:: Constant Field Values

FIND_SMART_CASE

public static final String FIND_SMART_CASE

See Also:: Constant Field Values

FIND_WHOLE_WORDS

public static final String FIND_WHOLE_WORDS

See Also:: Constant Field Values

FIND_REG_EXP

public static final String FIND_REG_EXP

See Also:: Constant Field Values

FIND_HISTORY

public static final String FIND_HISTORY

See Also:: Constant Field Values

FIND_HISTORY_SIZE

public static final String FIND_HISTORY_SIZE

See Also:: Constant Field Values

FIND_BLOCK_SEARCH

public static final String FIND_BLOCK_SEARCH

See Also:: Constant Field Values

FIND_BLOCK_SEARCH_START

public static final String FIND_BLOCK_SEARCH_START

See Also:: Constant Field Values

FIND_BLOCK_SEARCH_END

public static final String FIND_BLOCK_SEARCH_END

See Also:: Constant Field Values

WORD_MATCH_SEARCH_LEN

public static final String WORD_MATCH_SEARCH_LEN

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

See Also:: Constant Field Values

WORD_MATCH_WRAP_SEARCH

public static final String WORD_MATCH_WRAP_SEARCH

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

See Also:: Constant Field Values

WORD_MATCH_STATIC_WORDS

public static final String WORD_MATCH_STATIC_WORDS

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

See Also:: Constant Field Values

WORD_MATCH_MATCH_CASE

public static final String WORD_MATCH_MATCH_CASE

Whether to use case sensitive search or not. Values: java.lang.Boolean instances

See Also:: Constant Field Values

WORD_MATCH_SMART_CASE

public static final String WORD_MATCH_SMART_CASE

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

See Also:: Constant Field Values

WORD_MATCH_MATCH_ONE_CHAR

public static final String WORD_MATCH_MATCH_ONE_CHAR

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

See Also:: Constant Field Values

CUSTOM_ACTION_LIST

public static final String CUSTOM_ACTION_LIST

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

See Also:: Constant Field Values

KIT_INSTALL_ACTION_NAME_LIST

public static final String KIT_INSTALL_ACTION_NAME_LIST

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

See Also:: Constant Field Values

KIT_DEINSTALL_ACTION_NAME_LIST

public static final String KIT_DEINSTALL_ACTION_NAME_LIST

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

See Also:: Constant Field Values

DOC_INSTALL_ACTION_NAME_LIST

public static final String DOC_INSTALL_ACTION_NAME_LIST

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

See Also:: Constant Field Values

STATUS_BAR_VISIBLE

public static final String STATUS_BAR_VISIBLE

Whether status bar should be visible or not. Values: java.lang.Boolean instances

See Also:: Constant Field Values

STATUS_BAR_CARET_DELAY

public static final String STATUS_BAR_CARET_DELAY

Delay for updating information about caret in the status bar. Values: java.lang.Integer instances

See Also:: Constant Field Values

TEXT_LIMIT_LINE_VISIBLE

public static final String TEXT_LIMIT_LINE_VISIBLE

Whether the line displaying the text limit should be displayed. Values: java.lang.Boolean instances

See Also:: Constant Field Values

TEXT_LIMIT_LINE_COLOR

public static final String TEXT_LIMIT_LINE_COLOR

Deprecated. Use FontColorNames instead.

Which color should be used for the line showing the text limit. Values: java.awt.Color instances

See Also:: Constant Field Values

TEXT_LIMIT_WIDTH

public static final String TEXT_LIMIT_WIDTH

After how many characters the text limit line should be displayed. Values: java.awt.Integer instances

See Also:: Constant Field Values

HOME_KEY_COLUMN_ONE

public static final String HOME_KEY_COLUMN_ONE

Deprecated. As of 05/09/2001

Whether the home key should go to column 1 or first go to text start on the given line and then to the column 1. Values: java.lang.Boolean

See Also:: Constant Field Values

NEXT_WORD_FINDER

public static final String NEXT_WORD_FINDER

Finder for finding the next word. If it's not set, the FinderFactory.NextWordFwdFinder is used. Values: org.netbeans.editor.Finder

See Also:: Constant Field Values

PREVIOUS_WORD_FINDER

public static final String PREVIOUS_WORD_FINDER

Finder for finding the previous word. If it's not set, the FinderFactory.WordStartBwdFinder is used. Values: org.netbeans.editor.Finder

See Also:: Constant Field Values

WORD_MOVE_NEWLINE_STOP

public static final String WORD_MOVE_NEWLINE_STOP

Whether the word move should stop on the '\n' character. This setting affects both the Values: java.lang.Boolean

See Also:: Constant Field Values

READ_BUFFER_SIZE

public static final String READ_BUFFER_SIZE

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

See Also:: Constant Field Values

WRITE_BUFFER_SIZE

public static final String WRITE_BUFFER_SIZE

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

See Also:: Constant Field Values

READ_MARK_DISTANCE

public static final String READ_MARK_DISTANCE

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

See Also:: Constant Field Values

MARK_DISTANCE

public static final String MARK_DISTANCE

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

See Also:: Constant Field Values

MAX_MARK_DISTANCE

public static final String MAX_MARK_DISTANCE

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

See Also:: Constant Field Values

MIN_MARK_DISTANCE

public static final String MIN_MARK_DISTANCE

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

See Also:: Constant Field Values

SYNTAX_UPDATE_BATCH_SIZE

public static final String SYNTAX_UPDATE_BATCH_SIZE

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

See Also:: Constant Field Values

LINE_BATCH_SIZE

public static final String LINE_BATCH_SIZE

How many lines should be processed at once in the various text processing. This is used for example when processing the text by syntax scanner.

See Also:: Constant Field Values

IGNORE_VISUAL_CHANGES

public static final String IGNORE_VISUAL_CHANGES

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

See Also:: Constant Field Values

COLORING_NAME_LIST

public static final String COLORING_NAME_LIST

Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

List of the names of the additional colorings that need to be taken into account for the particular kit. The colorings that come from syntax coloring need not be specified here. Instead the TOKEN_CONTEXT_LIST holds the list of token contexts that can be used by the given kit. The coloring names are without the suffix just like the predefined coloring names. Values: java.util.List instances

See Also:: Constant Field Values

TOKEN_CONTEXT_LIST

public static final String TOKEN_CONTEXT_LIST

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

See Also:: Constant Field Values

COLORING_NAME_SUFFIX

public static final String COLORING_NAME_SUFFIX

Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

Suffix added to the coloring settings. The resulting name is used as the name of the setting.

See Also:: Constant Field Values

COLORING_NAME_PRINT_SUFFIX

public static final String COLORING_NAME_PRINT_SUFFIX

Deprecated. Use Editor Settings and Editor Settings Storage APIs instead.

Suffix added to the print coloring settings. The resulting name is used as the name of the setting.

See Also:: Constant Field Values

DEFAULT_COLORING

public static final String DEFAULT_COLORING

Deprecated. Use FontColorNames instead.

Default coloring for the drawing.

See Also:: Constant Field Values

LINE_NUMBER_COLORING

public static final String LINE_NUMBER_COLORING

Deprecated. Use FontColorNames instead.

Coloring that will be used for line numbers displayed on the left side on the screen.

See Also:: Constant Field Values

GUARDED_COLORING

public static final String GUARDED_COLORING

Deprecated. Use FontColorNames instead.

Coloring used for guarded blocks

See Also:: Constant Field Values

CODE_FOLDING_COLORING

public static final String CODE_FOLDING_COLORING

Deprecated. Use FontColorNames instead.

Coloring that will be used for code folding icons displayed in editor

See Also:: Constant Field Values

CODE_FOLDING_BAR_COLORING

public static final String CODE_FOLDING_BAR_COLORING

Deprecated. Use FontColorNames instead.

Coloring that will be used for code folding side bar

See Also:: Constant Field Values

SELECTION_COLORING

public static final String SELECTION_COLORING

Deprecated. Use FontColorNames instead.

Coloring used for selection

See Also:: Constant Field Values

HIGHLIGHT_SEARCH_COLORING

public static final String HIGHLIGHT_SEARCH_COLORING

Deprecated. Use FontColorNames instead.

Coloring used for highlight search

See Also:: Constant Field Values

INC_SEARCH_COLORING

public static final String INC_SEARCH_COLORING

Deprecated. Use FontColorNames instead.

Coloring used for incremental search

See Also:: Constant Field Values

BLOCK_SEARCH_COLORING

public static final String BLOCK_SEARCH_COLORING

Deprecated. Use FontColorNames instead.

Coloring used for block search

See Also:: Constant Field Values

STATUS_BAR_COLORING

public static final String STATUS_BAR_COLORING

Deprecated. Use FontColorNames instead.

Coloring used for the status bar

See Also:: Constant Field Values

STATUS_BAR_BOLD_COLORING

public static final String STATUS_BAR_BOLD_COLORING

Deprecated. Use FontColorNames instead.

Coloring used to mark important text in the status bar

See Also:: Constant Field Values

CODE_FOLDING_ENABLE

public static final String CODE_FOLDING_ENABLE

Enable/Disable code folding

See Also:: Constant Field Values

HYPERLINK_ACTIVATION_MODIFIERS

public static final String HYPERLINK_ACTIVATION_MODIFIERS

Modifiers for which the hyperlinks should be enabled.

See Also:: Constant Field Values

Constructor Detail

SettingsNames

public SettingsNames()

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

SettingsNames (Editor Library) - NetBeans API Javadoc (Current Development Version)

org.netbeans.editor Class SettingsNames

TAB_SIZE

EXPAND_TABS

SPACES_PER_TAB

INDENT_SHIFT_WIDTH

IDENTIFIER_ACCEPTOR

WHITESPACE_ACCEPTOR

ABBREV_MAP

MACRO_MAP

ABBREV_ACTION_MAP

ABBREV_EXPAND_ACCEPTOR

ABBREV_ADD_TYPED_CHAR_ACCEPTOR

ABBREV_RESET_ACCEPTOR

CARET_TYPE_INSERT_MODE

CARET_TYPE_OVERWRITE_MODE

CARET_ITALIC_INSERT_MODE

CARET_ITALIC_OVERWRITE_MODE

CARET_COLOR_INSERT_MODE

CARET_COLOR_OVERWRITE_MODE

CARET_BLINK_RATE

LINE_NUMBER_VISIBLE

PAIR_CHARACTERS_COMPLETION

PRINT_LINE_NUMBER_VISIBLE

SCROLL_JUMP_INSETS

SCROLL_FIND_INSETS

COMPONENT_SIZE_INCREMENT

MARGIN

TEXT_LEFT_MARGIN_WIDTH

RENDERING_HINTS

KEY_BINDING_LIST

INPUT_METHODS_ENABLED

LINE_HEIGHT_CORRECTION

FIND_WHAT

FIND_REPLACE_WITH

FIND_HIGHLIGHT_SEARCH

FIND_INC_SEARCH

FIND_INC_SEARCH_DELAY

FIND_BACKWARD_SEARCH

FIND_WRAP_SEARCH

FIND_MATCH_CASE

FIND_SMART_CASE

FIND_WHOLE_WORDS

FIND_REG_EXP

FIND_HISTORY

FIND_HISTORY_SIZE

FIND_BLOCK_SEARCH

FIND_BLOCK_SEARCH_START

FIND_BLOCK_SEARCH_END

WORD_MATCH_SEARCH_LEN

WORD_MATCH_WRAP_SEARCH

WORD_MATCH_STATIC_WORDS

WORD_MATCH_MATCH_CASE

WORD_MATCH_SMART_CASE

WORD_MATCH_MATCH_ONE_CHAR

CUSTOM_ACTION_LIST

KIT_INSTALL_ACTION_NAME_LIST

KIT_DEINSTALL_ACTION_NAME_LIST

DOC_INSTALL_ACTION_NAME_LIST

STATUS_BAR_VISIBLE

STATUS_BAR_CARET_DELAY

TEXT_LIMIT_LINE_VISIBLE

TEXT_LIMIT_LINE_COLOR

TEXT_LIMIT_WIDTH

HOME_KEY_COLUMN_ONE

NEXT_WORD_FINDER

PREVIOUS_WORD_FINDER

WORD_MOVE_NEWLINE_STOP

READ_BUFFER_SIZE

WRITE_BUFFER_SIZE

READ_MARK_DISTANCE

MARK_DISTANCE

MAX_MARK_DISTANCE

MIN_MARK_DISTANCE

SYNTAX_UPDATE_BATCH_SIZE

LINE_BATCH_SIZE

IGNORE_VISUAL_CHANGES

COLORING_NAME_LIST

TOKEN_CONTEXT_LIST

COLORING_NAME_SUFFIX

org.netbeans.editor
Class SettingsNames