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.
author: Miloslav Metelka version: 1.00
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.
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.
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.
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.
Field Detail
ABBREV_ACTION_MAP
final public static String ABBREV_ACTION_MAP(Code)
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
ABBREV_ADD_TYPED_CHAR_ACCEPTOR
final public static String ABBREV_ADD_TYPED_CHAR_ACCEPTOR(Code)
Acceptor checking whether typed character that performed abbreviation
expansion should be added to the text or not. Values:
org.netbeans.editor.Acceptor instances
ABBREV_EXPAND_ACCEPTOR
final public static String ABBREV_EXPAND_ACCEPTOR(Code)
Acceptor checking whether abbreviation should be attempted after the
appropriate character was typed. Values: org.netbeans.editor.Acceptor
instances
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
ABBREV_RESET_ACCEPTOR
final public static String ABBREV_RESET_ACCEPTOR(Code)
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
BOOKMARK_COLORING
final public static String BOOKMARK_COLORING(Code)
Caret blink rate in milliseconds. Values: java.lang.Integer
CARET_COLOR_INSERT_MODE
final public static String CARET_COLOR_INSERT_MODE(Code)
Caret color for insert mode. Values: java.awt.Color instances
CARET_COLOR_OVERWRITE_MODE
final public static String CARET_COLOR_OVERWRITE_MODE(Code)
Caret color for overwrite mode. Values: java.awt.Color instances
CARET_ITALIC_INSERT_MODE
final public static String CARET_ITALIC_INSERT_MODE(Code)
Will the insert mode caret be italicized if the underlying font is
italic? Values: java.lang.Boolean instances
CARET_ITALIC_OVERWRITE_MODE
final public static String CARET_ITALIC_OVERWRITE_MODE(Code)
Will the overwrite mode caret be italicized if the underlying font is
italic? Values: java.lang.Boolean instances
CARET_TYPE_INSERT_MODE
final public static String CARET_TYPE_INSERT_MODE(Code)
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
CARET_TYPE_OVERWRITE_MODE
final public static String CARET_TYPE_OVERWRITE_MODE(Code)
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
COLORING_NAME_LIST
final public static String COLORING_NAME_LIST(Code)
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
COLORING_NAME_PRINT_SUFFIX
final public static String COLORING_NAME_PRINT_SUFFIX(Code)
Suffix added to the print coloring settings. The resulting name is used
as the name of the setting.
COLORING_NAME_SUFFIX
final public static String COLORING_NAME_SUFFIX(Code)
Suffix added to the coloring settings. The resulting name is used as the
name of the setting.
COMPONENT_SIZE_INCREMENT
final public static String COMPONENT_SIZE_INCREMENT(Code)
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
CUSTOM_ACTION_LIST
final public static String CUSTOM_ACTION_LIST(Code)
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
final public static String DOC_INSTALL_ACTION_NAME_LIST(Code)
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
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
FIND_BACKWARD_SEARCH
final public static String FIND_BACKWARD_SEARCH(Code)
FIND_HIGHLIGHT_SEARCH
final public static String FIND_HIGHLIGHT_SEARCH(Code)
final public static String HIGHLIGHT_SEARCH_COLORING(Code)
Coloring used for highlight search
HOME_KEY_COLUMN_ONE
final public static String HOME_KEY_COLUMN_ONE(Code)
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
IDENTIFIER_ACCEPTOR
final public static String IDENTIFIER_ACCEPTOR(Code)
Acceptor that recognizes the identifier characters. If set it's used
instead of the default Syntax.isIdentifierPart() call. Values:
org.netbeans.editor.Acceptor instances
IGNORE_VISUAL_CHANGES
final public static String IGNORE_VISUAL_CHANGES(Code)
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.
INC_SEARCH_COLORING
final public static String INC_SEARCH_COLORING(Code)
Coloring used for incremental search
INDENT_SHIFT_WIDTH
final public static String INDENT_SHIFT_WIDTH(Code)
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
INPUT_METHODS_ENABLED
final public static String INPUT_METHODS_ENABLED(Code)
Whether the input-methods should be enabled. Values: java.lang.Boolean
Key binding list for particular kit. Values: java.util.List instances
holding javax.swing.JTextComponent.KeyBinding instances or
org.netbeans.editor.MultiKeyBinding instances
KIT_DEINSTALL_ACTION_NAME_LIST
final public static String KIT_DEINSTALL_ACTION_NAME_LIST(Code)
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
KIT_INSTALL_ACTION_NAME_LIST
final public static String KIT_INSTALL_ACTION_NAME_LIST(Code)
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
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.
LINE_HEIGHT_CORRECTION
final public static String LINE_HEIGHT_CORRECTION(Code)
Float constant by which the height of the character obtained from the
font is multiplied. It defaults to 1. Values: java.lang.Float instances
LINE_NUMBER_COLORING
final public static String LINE_NUMBER_COLORING(Code)
Coloring that will be used for line numbers displayed on the left side on
the screen.
LINE_NUMBER_MARGIN
final public static String LINE_NUMBER_MARGIN(Code)
Margin on the left and right side of the line number. It's used only when
line numbers are visible. The top and bottom values are ignored. Values:
java.awt.Insets instances
LINE_NUMBER_VISIBLE
final public static String LINE_NUMBER_VISIBLE(Code)
Whether to display line numbers on the left part of the screen. Values:
java.lang.Boolean instances
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 - ( '"' |
'\' ) ) | ( '\"' | '\\' ) )*
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
MAX_MARK_DISTANCE
final public static String MAX_MARK_DISTANCE(Code)
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
MIN_MARK_DISTANCE
final public static String MIN_MARK_DISTANCE(Code)
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
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
READ_MARK_DISTANCE
final public static String READ_MARK_DISTANCE(Code)
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
Rendering hints to be used for the painting. Values: java.util.Map
instances
SCROLL_FIND_INSETS
final public static String SCROLL_FIND_INSETS(Code)
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
SCROLL_JUMP_INSETS
final public static String SCROLL_JUMP_INSETS(Code)
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
SELECTION_COLORING
final public static String SELECTION_COLORING(Code)
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
STATUS_BAR_BOLD_COLORING
final public static String STATUS_BAR_BOLD_COLORING(Code)
Coloring used to mark important text in the status bar
STATUS_BAR_CARET_DELAY
final public static String STATUS_BAR_CARET_DELAY(Code)
Delay for updating information about caret in the status bar. Values:
java.lang.Integer instances
STATUS_BAR_COLORING
final public static String STATUS_BAR_COLORING(Code)
Coloring used for the status bar
STATUS_BAR_VISIBLE
final public static String STATUS_BAR_VISIBLE(Code)
Whether status bar should be visible or not. Values: java.lang.Boolean
instances
SYNTAX_UPDATE_BATCH_SIZE
final public static String SYNTAX_UPDATE_BATCH_SIZE(Code)
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
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
TEXT_LEFT_MARGIN_WIDTH
final public static String TEXT_LEFT_MARGIN_WIDTH(Code)
Width of the margin on the left side of the text just after the
line-number bar. Values: java.awt.Integer instances
TEXT_LIMIT_LINE_COLOR
final public static String TEXT_LIMIT_LINE_COLOR(Code)
Which color should be used for the line showing the text limit. Values:
java.awt.Color instances
TEXT_LIMIT_LINE_VISIBLE
final public static String TEXT_LIMIT_LINE_VISIBLE(Code)
Whether the line displaying the text limit should be displayed. Values:
java.lang.Boolean instances
After how many characters the text limit line should be displayed.
Values: java.awt.Integer instances
TOKEN_CONTEXT_LIST
final public static String TOKEN_CONTEXT_LIST(Code)
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.
WHITESPACE_ACCEPTOR
final public static String WHITESPACE_ACCEPTOR(Code)
Acceptor that recognizes the whitespace characters. If set it's used
instead of the default Syntax.isWhitespace() call. Values:
org.netbeans.editor.Acceptor instances
WORD_MATCH_MATCH_CASE
final public static String WORD_MATCH_MATCH_CASE(Code)
Whether to use case sensitive search or not. Values: java.lang.Boolean
instances
WORD_MATCH_MATCH_ONE_CHAR
final public static String WORD_MATCH_MATCH_ONE_CHAR(Code)
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
WORD_MATCH_SEARCH_LEN
final public static String WORD_MATCH_SEARCH_LEN(Code)
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
WORD_MATCH_SMART_CASE
final public static String WORD_MATCH_SMART_CASE(Code)
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
WORD_MATCH_STATIC_WORDS
final public static String WORD_MATCH_STATIC_WORDS(Code)
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
WORD_MATCH_WRAP_SEARCH
final public static String WORD_MATCH_WRAP_SEARCH(Code)
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
WORD_MOVE_NEWLINE_STOP
final public static String WORD_MOVE_NEWLINE_STOP(Code)
Whether the word move should stop on the '\n' character. This setting
affects both the Values: java.lang.Boolean
WRITE_BUFFER_SIZE
final public static String WRITE_BUFFER_SIZE(Code)
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