EditorProperties (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.4.0)
E17493-05

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.javatools.editor
Class EditorProperties

java.lang.Object
  oracle.javatools.editor.EditorProperties

public final class EditorProperties
extends java.lang.Object
extends java.lang.Object

An EditorProperties class provides a global registry for properties which affect all documents and editor panes of this package. This simply provides a convenient way to allow them to share properties (such as a style table) without having to create a local entry for common properties. This is a singleton class.

Implementation Notes:

We currently employ a hierarchy of properties here based on their scope of coverage to reduce the duplication among hash tables. For example, the StyleRegistry should be a global one here so that all documents and editors share the same one - hence it is stored here in a globally accessible property area.

The particular syntax highlighter of a document should be stored with the document so that if there are multiple editors open on that document, they will share the same syntax highlighter.

Field Summary
`static int`	`GUTTER_COLORS_USE_CUSTOM` Constant to indicate that the gutter should use the configured custom colors.
`static int`	`GUTTER_COLORS_USE_EDITOR` Constant to indicate that the gutter should use the editor background/foreground defaults for its colors.
`static int`	`GUTTER_COLORS_USE_LNF` Constant to indicate that the gutter should use the L&F defaults for its background color.
`static java.lang.String`	`PROPERTY_AUTOINDENT_COPY_PASTE` Name of the property for whether Copy/paste should automaticaly indent properly the pastes block
`static java.lang.String`	`PROPERTY_AUTOREFORMAT_COPY_PASTE` Name of the property for whether Copy/paste should automaticaly reformat properly the pastes block
`static java.lang.String`	`PROPERTY_BRACE_MATCHING_AUTO` Name of the property which determines whether to enable automatic brace matching of braces at the caret.
`static java.lang.String`	`PROPERTY_BRACE_MATCHING_DELAY` Name of the property which determines the delay before performing automatic brace matching.
`static java.lang.String`	`PROPERTY_BRACE_MATCHING_ENCLOSING_BLOCKS` Whether to highlight the braces for the enclosing block.
`static java.lang.String`	`PROPERTY_BRACE_MATCHING_ENCLOSING_PARENS` Whether to highlight the braces for the enclosing parenthesis.
`static java.lang.String`	`PROPERTY_CARET_BLINK_RATE` Property name for the blink rate of the caret, in milliseconds.
`static java.lang.String`	`PROPERTY_CARET_COLOR` Property name for the caret color to use for painting the editor caret.
`static java.lang.String`	`PROPERTY_CARET_EDITOR_SELECTION_TYPE` The property name for the type of selection the editor (e.g.
`static java.lang.String`	`PROPERTY_CARET_ENABLE_BLINK` Property name for whether the caret should blink.
`static java.lang.String`	`PROPERTY_CARET_INSET_COLUMNS` Name of the property which determines the number of columns (+/-) the caret keeps visible when setting the caret position.
`static java.lang.String`	`PROPERTY_CARET_INSET_ROWS` Name of the property which determines the number of rows (+/-) the caret keeps visible when setting the caret position.
`static java.lang.String`	`PROPERTY_CARET_RIGHT_CLICK_SELECTION` The property name for whether right-click will position the caret when clicking outside of a selection.
`static java.lang.String`	`PROPERTY_CARET_SHAPE_INSERT` Property name for the caret shape to use when the editor caret is in insert mode.
`static java.lang.String`	`PROPERTY_CARET_SHAPE_OVERWRITE` Property name for the caret shape to use when the editor caret is in overwrite mode.
`static java.lang.String`	`PROPERTY_CARET_XOR_PAINTING` The property name for whether the caret should use xor painting or regular painting.
`static java.lang.String`	`PROPERTY_CHECK_CLIPBOARD_FOR_PASTE` Property name for whether BasicEditorPane.canPaste() should check the contents of the clipboard to see if it is pasteable.
`static java.lang.String`	`PROPERTY_CHECK_FRAGLIST_RECYCLING` Property name for whether to check if the StyledFragmentsList is being recycled properly.
`static java.lang.String`	`PROPERTY_CHECK_SAME_WIDTH_FACES` Property name for whether the RowMap implementation for BasicView should attempt to determine whether the font styles (normal, bold, italic, bold+italic) of a font are equivalient in widths.
`static java.lang.String`	`PROPERTY_CODE_FOLDING_ENABLED` Name of the property for whether code folding is enabled.
`static java.lang.String`	`PROPERTY_CODE_FOLDING_HIGHLIGHT` Name of the property for whether the active code folding block should be highlighted.
`static java.lang.String`	`PROPERTY_CODE_FOLDING_MARGIN` Name of the property for the `CodeFoldingMargin` instance.
`static java.lang.String`	`PROPERTY_CODE_FOLDING_MARGIN_VISIBLE` Name of the property for whether the code folding left margin should be visible.
`static java.lang.String`	`PROPERTY_CODE_FOLDING_MODEL` Name of the property for the `CodeFoldingModel` instance.
`static java.lang.String`	`PROPERTY_COMPLETION_ENABLE_POPUP` Name of the property for whether completion insight should enable auto-popup based on typed triggers.
`static java.lang.String`	`PROPERTY_COMPLETION_POPUP_DELAY` Name of the property for the auto-popup delay (if enabled) for completion insight.
`static java.lang.String`	`PROPERTY_CONSUME_KEY_RELEASE` Property name for whether the default key handler should eat key release events - this could help performance by not allowing menus a chance to check their accelerators on a key release event.
`static java.lang.String`	`PROPERTY_CUT_COPY_LINE` Name of the property for whether Cut/Copy should operate on the current line when there is no selection in the editor.
`static java.lang.String`	`PROPERTY_DO_BLOCK_INDENTS_ON_SELECTION` Name of the property which determines whether the "insert-tab" and "reverse-tab" commands will perform a block-indent or outdent if there is a selection.
`static java.lang.String`	`PROPERTY_EDIT_MERGE_COUNT` Property name for the number of consecutive edits (of the same type) that should be merged together.
`static java.lang.String`	`PROPERTY_EDITOR_ANTIALIASING` Name of the property for the editor to indicate whether it should use text anti-aliasing for rendering.
`static java.lang.String`	`PROPERTY_EDITOR_ANTIALIASING_SET` Deprecated.
`static java.lang.String`	`PROPERTY_EDITOR_FONT` Name of the property for the base font used for painting the editor pane.
`static java.lang.String`	`PROPERTY_EDITOR_FONT_FAMILY` Name of the property for the font family of the base font.
`static java.lang.String`	`PROPERTY_EDITOR_FONT_HELPER` Name of the property where we are storing the font helper for the global editor font.
`static java.lang.String`	`PROPERTY_EDITOR_FONT_SIZE` Name of the property for the font size of the base font.
`static java.lang.String`	`PROPERTY_EDITOR_ITALIC_ANTIALIASING` Deprecated.
`static java.lang.String`	`PROPERTY_EDITOR_WIDTH` Name of the property for the default editor width in number of columns based on the width of the 'W' character in the current font.
`static java.lang.String`	`PROPERTY_ESCAPESTRING_PASTE` Name of the property for whether Copy/paste should automaticaly escape properly the pastes block in a String literal
`static java.lang.String`	`PROPERTY_GUTTER_COLOR_SOURCE` Name of the property which determines from which source the gutter derives its colors.
`static java.lang.String`	`PROPERTY_GUTTER_CUSTOM_BGCOLOR` Name of the property for the custom background color for the gutter.
`static java.lang.String`	`PROPERTY_GUTTER_CUSTOM_FGCOLOR` Name of the property for the custom foreground color of the gutter.
`static java.lang.String`	`PROPERTY_GUTTER_DEFAULT_BORDERCOLOR` Name of the property for the default border color to use for the line gutter.
`static java.lang.String`	`PROPERTY_GUTTER_ENABLE_DRAGGING` Name of the property for whether click-dragging in the gutter will make a selection in the editor.
`static java.lang.String`	`PROPERTY_GUTTER_SHARED_COLUMN` Name of the property for whether the gutter icons all share a single column or not.
`static java.lang.String`	`PROPERTY_HIGHLIGHT_CHANGED` Name of the pseudo-property that the HighlightRegistry uses to notify listeners (views) that settings in the registry have changed.
`static java.lang.String`	`PROPERTY_HIGHLIGHT_REGISTRY` Name of the property for the HighlightRegistry instance.
`static java.lang.String`	`PROPERTY_IMPORTS_COPY_PASTE` Name of the property for whether Copy/paste should automaticaly collect and add needed import for the copied block.
`static java.lang.String`	`PROPERTY_INDENT_SIZE` Name of the property for the indent size.
`static java.lang.String`	`PROPERTY_INSIGHT_FILTER_MATCHING` Name of the property that controls whether Insight displays the full completion list of items, or only the matching list of items.
`static java.lang.String`	`PROPERTY_INSIGHT_FONT_FAMILY` Name of the property for the font family to use for code insight.
`static java.lang.String`	`PROPERTY_INSIGHT_FONT_SIZE` Name of the property for the font size to use for code insight.
`static java.lang.String`	`PROPERTY_INSIGHT_MANUAL_COMPLETE_SINGLE` Name of the property that controls whether Insight automatically performs a complete when it is invoked and there is only a single matching data item.
`static java.lang.String`	`PROPERTY_INSIGHT_MAX_POPUP_WIDTH` Name of the property that configures the maximum width of an insight popup window - this prevents situations with run-away insight popup windows that are huge.
`static java.lang.String`	`PROPERTY_INSIGHT_NEWDATA_COMPLETE_SINGLE` Name of the property that controls whether Insight automatically performs a complete if the InsightData type changes while Insight is up, and there is only a single matching data item in the new data instance.
`static java.lang.String`	`PROPERTY_INSIGHT_PARTIAL_COMPLETE_SINGLE` Name of the property that controls whether Insight automatically performs a complete when a partial complete is invoked and there is only a single matching data item.
`static java.lang.String`	`PROPERTY_INSIGHT_TYPED_COMPLETE_SINGLE` Name of the property that controls whether Insight automatically performs a complete while the user is typing once there is only a single matching data item.
`static java.lang.String`	`PROPERTY_KEY_HANDLERS` Name of the property for the list of available key handlers installed into the editor framework.
`static java.lang.String`	`PROPERTY_LANGUAGE_SUPPORT` Name of the property for the LanguageSupport instance associated with a document.
`static java.lang.String`	`PROPERTY_MACRO_PLAYBACK_DELAY` The wait delay (in ms) after posting a key event during playback before posting the next key event.
`static java.lang.String`	`PROPERTY_MERGE_DELETE_NEXT` Property name for whether consecutive delete next edits should be allowed to merge.
`static java.lang.String`	`PROPERTY_MERGE_DELETE_PREVIOUS` Property name for whether consecutive delete previous edits should be allowed to merge.
`static java.lang.String`	`PROPERTY_MERGE_NAVIGATION` Property name for whether consecutive navigations should be allowed to merge.
`static java.lang.String`	`PROPERTY_MERGE_TYPED_INSERT` Property name for whether consecutive typed insert edits should be allowed to merge.
`static java.lang.String`	`PROPERTY_MERGE_TYPED_REPLACE` Property name for whether consecutive typed replace edits should be allowed to merge.
`static java.lang.String`	`PROPERTY_MIDDLE_BUTTON_BEHAVIOR` Behavior of the middle button behavior in the code editor.
`static java.lang.String`	`PROPERTY_NAVIGATION_MERGE_COUNT` Property name for the number of consecutive navigations that should be merged together.
`static java.lang.String`	`PROPERTY_PARAMETER_ENABLE_POPUP` Name of the property for whether parameter insight should enable auto-popup based on typed triggers.
`static java.lang.String`	`PROPERTY_PARAMETER_POPUP_DELAY` Name of the property for the auto-popup delay (if enabled) for parameter insight.
`static java.lang.String`	`PROPERTY_REUSE_DOCUMENT_EVENT` Property name for whether DocumentEvent instances are reused for notification - this is a document optimization to help reduce constant object reallocation.
`static java.lang.String`	`PROPERTY_REUSE_UNDOABLE_EDIT` Property name for whether UndoableEditEvent instances are reused for notification - this is a document optimization to help reduce constant object reallocation.
`static java.lang.String`	`PROPERTY_RIGHT_MARGIN_COLOR` Name of the property for the color to paint the right margin with.
`static java.lang.String`	`PROPERTY_RIGHT_MARGIN_COLUMN` Name of the property for where the right margin column should be painted.
`static java.lang.String`	`PROPERTY_RIGHT_MARGIN_VISIBLE` Name of the property for whether the right margin column should be visible or not.
`static java.lang.String`	`PROPERTY_SELECTED_HANDLER` Name of the property for the current key handler used by editor panes in this framework.
`static java.lang.String`	`PROPERTY_SHOW_LINE_NUMBERS` Name of the property which determines whether to show line numbers or not in an associated gutter component.
`static java.lang.String`	`PROPERTY_SHOW_WHITESPACE_CHARS` Name of the property which determines whether to show charaters in place of the [invisible] whitespace characters
`static java.lang.String`	`PROPERTY_STYLE_CHANGED` Name of the pseudo-property that the StyleRegistry uses to notify listeners (views) that settings in the registry have changed.
`static java.lang.String`	`PROPERTY_STYLE_REGISTRY` Name of the property for the StyleRegistry instance.
`static java.lang.String`	`PROPERTY_TAB_SIZE` Name of the property for the tab size (stop.) This is used by the BasicView renderer when painting the editor pane, and also by the InsertTabAction (and others) when inserting a Tab instead of just spaces.
`static java.lang.String`	`PROPERTY_TOGGLE_COMMENTS_ADVANCE` Name of the property for whether toggle comments should advance the caret to the next line if (before toggling comments) the caret was not a selection.
`static java.lang.String`	`PROPERTY_TRAILING_BLANK_COLUMNS` Name of the property which determines the number of additional blank columns to include at the right of an editor view.
`static java.lang.String`	`PROPERTY_TRAILING_BLANK_ROWS` Name of the property which determines the number of additional blank rows to include at the bottom of an editor view.
`static java.lang.String`	`PROPERTY_UNDO_NAVIGATION` Property name for whether UndoableEdits should be generated for navigation.
`static java.lang.String`	`PROPERTY_USE_AUTO_INDENT` Name of the property for whether auto-indentation should be used.
`static java.lang.String`	`PROPERTY_USE_JUMP_SCROLL` Name of the property which determines whether to do jump scrolling.
`static java.lang.String`	`PROPERTY_USE_SMART_END` Name of the property which determines whether the "caret-end" command will be "smart" about finding the end of the line before any trailing whitespace, vs.
`static java.lang.String`	`PROPERTY_USE_SMART_HOME` Name of the property which determines whether the "caret-begin" command will be "smart" about finding the start of the line after the initial indentation, vs.
`static java.lang.String`	`PROPERTY_USE_SMART_INDENT` Name of the property for whether smart-indentation should be enabled globally.
`static java.lang.String`	`PROPERTY_USE_TAB_CHARACTER` Name of the property which determines whether spaces or tab characters are used when the user indents a line.
`static java.lang.String`	`PROPERTY_VALID_OFFSET_END`
`static java.lang.String`	`PROPERTY_VALID_OFFSET_START` Valid limit offsets.
`static java.lang.String`	`PROPERTY_WORD_BOUNDARY_USE_CASE` Name of the property which determines when navigating to word boundaries, whether a change of case should also be included as a boundary.
`static java.lang.String`	`PROPERTY_WORD_BOUNDARY_USE_LINE_END` Name of the property which determines when navigating to word boundaries, whether the end of the word should also be included as a boundary.
`static java.lang.String`	`PROPERTY_WORD_BOUNDARY_USE_LINE_START` Name of the property which determines when navigating to word boundaries, whether the start of the line should also be included as a boundary.

Method Summary
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Add a PropertyChangeListener to the listener list.
`void`	`firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)` Report a bound property update to any registered listeners.
`java.awt.Font`	`getBaseFont()` Convenience method for getting the current base font.
`boolean`	`getBooleanProperty(java.lang.String key)` Fetch the boolean property stored by the given key.
`static oracle.javatools.resource.BundleHelper`	`getEditorBundle()` Public utility routine for editor framework to fetch editor resources.
`FontHelper`	`getFontHelper()` Convenience method for getting the current font helper.
`java.lang.String`	`getHandlerName()` Gets the name of the current handler to use.
`HighlightRegistry`	`getHighlightRegistry()` Fetch the global highlight registry used for all editor panes.
`int`	`getIntegerProperty(java.lang.String key)` Fetch the integer property stored by the given key.
`static EditorProperties`	`getProperties()` Fetches the singleton instance of the EditorProperties table.
`java.lang.Object`	`getProperty(java.lang.String key)` Fetch the property stored by the given key.
`StyleRegistry`	`getStyleRegistry()` Fetch the global style registry used for all editor panes.
`void`	`putBooleanProperty(java.lang.String key, boolean value)` Sets the boolean property and value in the property table.
`void`	`putIntegerProperty(java.lang.String key, int value)` Sets the integer property and value in the property table.
`void`	`putProperty(java.lang.String key, java.lang.Object value)` Stores a property and value in the property table.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Remove a PropertyChangeListener from the listener list.
`void`	`setBaseFont(java.lang.String familyName, int fontSize)` Utility routine to set the base font used by all editor panes in this framework.
`void`	`setHandlerName(java.lang.String handlerName)` Changes the name of the default handler used.
`void`	`setHighlightRegistry(HighlightRegistry registry)` Replace the global highlight registry used for all editor panes.
`void`	`setStyleRegistry(StyleRegistry registry)` Replace the global style registry used for all editor panes.

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

Field Detail

PROPERTY_STYLE_REGISTRY

public static final java.lang.String PROPERTY_STYLE_REGISTRY

Name of the property for the StyleRegistry instance. The property name is used internally by the editor framework, and should not be needed by clients. Use getStyleRegistry() to get the global registry, or BasicEditorPane.getStyleRegistry() to get a editor-specific style registry.

See Also:: Constant Field Values

PROPERTY_STYLE_CHANGED

public static final java.lang.String PROPERTY_STYLE_CHANGED

Name of the pseudo-property that the StyleRegistry uses to notify listeners (views) that settings in the registry have changed.

See Also:: Constant Field Values

PROPERTY_LANGUAGE_SUPPORT

public static final java.lang.String PROPERTY_LANGUAGE_SUPPORT

Name of the property for the LanguageSupport instance associated with a document. A property change event is fired by the document when the language support is changed programmatically.

See Also:: Constant Field Values

PROPERTY_EDITOR_ANTIALIASING

public static final java.lang.String PROPERTY_EDITOR_ANTIALIASING

Name of the property for the editor to indicate whether it should use text anti-aliasing for rendering.

See Also:: Constant Field Values

PROPERTY_EDITOR_ITALIC_ANTIALIASING

@Deprecated
public static final java.lang.String PROPERTY_EDITOR_ITALIC_ANTIALIASING

Deprecated.

Name of the property for the editor to indicate whether it should use text anti-aliasing for italic text rendering.

See Also:: Constant Field Values

PROPERTY_EDITOR_ANTIALIASING_SET

@Deprecated
public static final java.lang.String PROPERTY_EDITOR_ANTIALIASING_SET

Deprecated.

Name of the property indicating that the Java property for editor anti-aliasing, or Swing anti-aliasing was set.

See Also:: Constant Field Values

PROPERTY_EDITOR_WIDTH

public static final java.lang.String PROPERTY_EDITOR_WIDTH

Name of the property for the default editor width in number of columns based on the width of the 'W' character in the current font. The calculation to get an accurate width for the editor is expensive, so we just use a fixed horizontal width instead. The BasicEditorPane implementation now auto-sizes, so this property is obselete.

See Also:: Constant Field Values

PROPERTY_HIGHLIGHT_REGISTRY

public static final java.lang.String PROPERTY_HIGHLIGHT_REGISTRY

Name of the property for the HighlightRegistry instance. The property name is used internally by the editor framework, and should not be needed by clients. Use getHighlightRegistry() to get the global registry, or BasicEditorPane.getHighlightRegistry() to get a editor-specific highlight registry.

See Also:: Constant Field Values

PROPERTY_HIGHLIGHT_CHANGED

public static final java.lang.String PROPERTY_HIGHLIGHT_CHANGED

Name of the pseudo-property that the HighlightRegistry uses to notify listeners (views) that settings in the registry have changed.

See Also:: Constant Field Values

PROPERTY_EDITOR_FONT_HELPER

public static final java.lang.String PROPERTY_EDITOR_FONT_HELPER

Name of the property where we are storing the font helper for the global editor font. This property name is used internally by the editor framework, and should not be needed by clients. If it is necessary, clients should use getFontHelper() instead to retrieve the font helper.

See Also:: Constant Field Values

PROPERTY_EDITOR_FONT

public static final java.lang.String PROPERTY_EDITOR_FONT

Name of the property for the base font used for painting the editor pane. This is an instance of the Font class. Note that this property name is public for read and notification purposes. To change the editor font, call setBaseFont() instead.

See Also:: Constant Field Values

PROPERTY_EDITOR_FONT_FAMILY

public static final java.lang.String PROPERTY_EDITOR_FONT_FAMILY

Name of the property for the font family of the base font. Note that this property name is public for retrieval purposes only. To change the editor font, call setBaseFont instead.

See Also:: Constant Field Values

PROPERTY_EDITOR_FONT_SIZE

public static final java.lang.String PROPERTY_EDITOR_FONT_SIZE

Name of the property for the font size of the base font. Note that this property name is public for retrieval purposes only. To change the editor font, call setBaseFont instead.

See Also:: Constant Field Values

PROPERTY_RIGHT_MARGIN_COLUMN

public static final java.lang.String PROPERTY_RIGHT_MARGIN_COLUMN

Name of the property for where the right margin column should be painted.

See Also:: Constant Field Values

PROPERTY_RIGHT_MARGIN_VISIBLE

public static final java.lang.String PROPERTY_RIGHT_MARGIN_VISIBLE

Name of the property for whether the right margin column should be visible or not.

See Also:: Constant Field Values

PROPERTY_RIGHT_MARGIN_COLOR

public static final java.lang.String PROPERTY_RIGHT_MARGIN_COLOR

Name of the property for the color to paint the right margin with.

See Also:: Constant Field Values

PROPERTY_TRAILING_BLANK_ROWS

public static final java.lang.String PROPERTY_TRAILING_BLANK_ROWS

Name of the property which determines the number of additional blank rows to include at the bottom of an editor view.

See Also:: Constant Field Values

PROPERTY_TRAILING_BLANK_COLUMNS

public static final java.lang.String PROPERTY_TRAILING_BLANK_COLUMNS

Name of the property which determines the number of additional blank columns to include at the right of an editor view.

See Also:: Constant Field Values

PROPERTY_SHOW_WHITESPACE_CHARS

public static final java.lang.String PROPERTY_SHOW_WHITESPACE_CHARS

Name of the property which determines whether to show charaters in place of the [invisible] whitespace characters

See Also:: Constant Field Values

PROPERTY_BRACE_MATCHING_AUTO

public static final java.lang.String PROPERTY_BRACE_MATCHING_AUTO

Name of the property which determines whether to enable automatic brace matching of braces at the caret.

See Also:: Constant Field Values

PROPERTY_BRACE_MATCHING_ENCLOSING_BLOCKS

public static final java.lang.String PROPERTY_BRACE_MATCHING_ENCLOSING_BLOCKS

Whether to highlight the braces for the enclosing block.

See Also:: Constant Field Values

PROPERTY_BRACE_MATCHING_ENCLOSING_PARENS

public static final java.lang.String PROPERTY_BRACE_MATCHING_ENCLOSING_PARENS

Whether to highlight the braces for the enclosing parenthesis.

See Also:: Constant Field Values

PROPERTY_BRACE_MATCHING_DELAY

public static final java.lang.String PROPERTY_BRACE_MATCHING_DELAY

Name of the property which determines the delay before performing automatic brace matching. This is in milliseconds, and should range from 100 to 2000.

See Also:: Constant Field Values

PROPERTY_SHOW_LINE_NUMBERS

public static final java.lang.String PROPERTY_SHOW_LINE_NUMBERS

Name of the property which determines whether to show line numbers or not in an associated gutter component.

See Also:: Constant Field Values

GUTTER_COLORS_USE_LNF

public static final int GUTTER_COLORS_USE_LNF

Constant to indicate that the gutter should use the L&F defaults for its background color.

See Also:: Constant Field Values

GUTTER_COLORS_USE_EDITOR

public static final int GUTTER_COLORS_USE_EDITOR

Constant to indicate that the gutter should use the editor background/foreground defaults for its colors.

See Also:: Constant Field Values

GUTTER_COLORS_USE_CUSTOM

public static final int GUTTER_COLORS_USE_CUSTOM

Constant to indicate that the gutter should use the configured custom colors.

See Also:: Constant Field Values

PROPERTY_GUTTER_COLOR_SOURCE

public static final java.lang.String PROPERTY_GUTTER_COLOR_SOURCE

Name of the property which determines from which source the gutter derives its colors. The value should be GUTTER_COLORS_USE_LNF, GUTTER_COLORS_USE_EDITOR, or COLORS_USE_CUSTOM.

See Also:: Constant Field Values

PROPERTY_GUTTER_CUSTOM_BGCOLOR

public static final java.lang.String PROPERTY_GUTTER_CUSTOM_BGCOLOR

Name of the property for the custom background color for the gutter.

See Also:: Constant Field Values

PROPERTY_GUTTER_CUSTOM_FGCOLOR

public static final java.lang.String PROPERTY_GUTTER_CUSTOM_FGCOLOR

Name of the property for the custom foreground color of the gutter.

See Also:: Constant Field Values

PROPERTY_GUTTER_DEFAULT_BORDERCOLOR

public static final java.lang.String PROPERTY_GUTTER_DEFAULT_BORDERCOLOR

Name of the property for the default border color to use for the line gutter. Currently, this is used regardless of the source that the gutter derives its colors. In the future, it may be desirable to add an additional property for configuring the border color for the custom case to let the user choose. Then this default would be used only for the L&F and editor color choices. If this property is not defined, then the gutter will just the line number color for the border color.

See Also:: Constant Field Values

PROPERTY_GUTTER_SHARED_COLUMN

public static final java.lang.String PROPERTY_GUTTER_SHARED_COLUMN

Name of the property for whether the gutter icons all share a single column or not.

See Also:: Constant Field Values

PROPERTY_GUTTER_ENABLE_DRAGGING

public static final java.lang.String PROPERTY_GUTTER_ENABLE_DRAGGING

Name of the property for whether click-dragging in the gutter will make a selection in the editor.

See Also:: Constant Field Values

PROPERTY_CODE_FOLDING_MODEL

public static final java.lang.String PROPERTY_CODE_FOLDING_MODEL

Name of the property for the CodeFoldingModel instance.

See Also:: Constant Field Values

PROPERTY_CODE_FOLDING_MARGIN

public static final java.lang.String PROPERTY_CODE_FOLDING_MARGIN

Name of the property for the CodeFoldingMargin instance.

See Also:: Constant Field Values

PROPERTY_CODE_FOLDING_MARGIN_VISIBLE

public static final java.lang.String PROPERTY_CODE_FOLDING_MARGIN_VISIBLE

Name of the property for whether the code folding left margin should be visible.

See Also:: Constant Field Values

PROPERTY_CODE_FOLDING_HIGHLIGHT

public static final java.lang.String PROPERTY_CODE_FOLDING_HIGHLIGHT

Name of the property for whether the active code folding block should be highlighted.

See Also:: Constant Field Values

PROPERTY_CODE_FOLDING_ENABLED

public static final java.lang.String PROPERTY_CODE_FOLDING_ENABLED

Name of the property for whether code folding is enabled.

See Also:: Constant Field Values

PROPERTY_INDENT_SIZE

public static final java.lang.String PROPERTY_INDENT_SIZE

Name of the property for the indent size.

See Also:: Constant Field Values

PROPERTY_TAB_SIZE

public static final java.lang.String PROPERTY_TAB_SIZE

Name of the property for the tab size (stop.) This is used by the BasicView renderer when painting the editor pane, and also by the InsertTabAction (and others) when inserting a Tab instead of just spaces.

See Also:: Constant Field Values

PROPERTY_USE_AUTO_INDENT

public static final java.lang.String PROPERTY_USE_AUTO_INDENT

Name of the property for whether auto-indentation should be used. This is used by the InsertBreakAction for determining whether to automatically add indentation after the new line.

See Also:: Constant Field Values

PROPERTY_USE_SMART_INDENT

public static final java.lang.String PROPERTY_USE_SMART_INDENT

Name of the property for whether smart-indentation should be enabled globally. This is used by the InsertBreakAction for determining whether to use smart indentation when inserting a new line.

See Also:: Constant Field Values

PROPERTY_USE_TAB_CHARACTER

public static final java.lang.String PROPERTY_USE_TAB_CHARACTER

Name of the property which determines whether spaces or tab characters are used when the user indents a line. This only affects new indents, and does not change existing indentations.

See Also:: Constant Field Values

PROPERTY_USE_SMART_HOME

public static final java.lang.String PROPERTY_USE_SMART_HOME

Name of the property which determines whether the "caret-begin" command will be "smart" about finding the start of the line after the initial indentation, vs. always going to the beginning of the line. If the line contains only whitespace, this will always go to the beginning of the line.

See Also:: Constant Field Values

PROPERTY_USE_SMART_END

public static final java.lang.String PROPERTY_USE_SMART_END

Name of the property which determines whether the "caret-end" command will be "smart" about finding the end of the line before any trailing whitespace, vs. always going to the end of the line. If the line contains only whitespace, this will always go to the end of the line.

See Also:: Constant Field Values

PROPERTY_DO_BLOCK_INDENTS_ON_SELECTION

public static final java.lang.String PROPERTY_DO_BLOCK_INDENTS_ON_SELECTION

Name of the property which determines whether the "insert-tab" and "reverse-tab" commands will perform a block-indent or outdent if there is a selection.

See Also:: Constant Field Values

PROPERTY_WORD_BOUNDARY_USE_CASE

public static final java.lang.String PROPERTY_WORD_BOUNDARY_USE_CASE

Name of the property which determines when navigating to word boundaries, whether a change of case should also be included as a boundary.

See Also:: Constant Field Values

PROPERTY_WORD_BOUNDARY_USE_LINE_START

public static final java.lang.String PROPERTY_WORD_BOUNDARY_USE_LINE_START

Name of the property which determines when navigating to word boundaries, whether the start of the line should also be included as a boundary.

See Also:: Constant Field Values

PROPERTY_WORD_BOUNDARY_USE_LINE_END

public static final java.lang.String PROPERTY_WORD_BOUNDARY_USE_LINE_END

Name of the property which determines when navigating to word boundaries, whether the end of the word should also be included as a boundary.

See Also:: Constant Field Values

PROPERTY_USE_JUMP_SCROLL

public static final java.lang.String PROPERTY_USE_JUMP_SCROLL

Name of the property which determines whether to do jump scrolling. This means that when moving the cursor, if the new cursor position is off-screen, it is centered in the viewport.

See Also:: Constant Field Values

PROPERTY_CARET_INSET_ROWS

public static final java.lang.String PROPERTY_CARET_INSET_ROWS

Name of the property which determines the number of rows (+/-) the caret keeps visible when setting the caret position. This is useful, for example, at editor visible view boundaries when scrolling or typing, to keep a extra row or two visible for context. This property is ignored if jump scrolling is enabled.

See Also:: Constant Field Values

PROPERTY_CARET_INSET_COLUMNS

public static final java.lang.String PROPERTY_CARET_INSET_COLUMNS

Name of the property which determines the number of columns (+/-) the caret keeps visible when setting the caret position. This is useful, for example, at editor visible view boundaries when scrolling or typing, to keep a few extra columns visible for context. This property is ignored if jump scrolling is enabled.

See Also:: Constant Field Values

PROPERTY_COMPLETION_ENABLE_POPUP

public static final java.lang.String PROPERTY_COMPLETION_ENABLE_POPUP

Name of the property for whether completion insight should enable auto-popup based on typed triggers.

See Also:: Constant Field Values

PROPERTY_COMPLETION_POPUP_DELAY

public static final java.lang.String PROPERTY_COMPLETION_POPUP_DELAY

Name of the property for the auto-popup delay (if enabled) for completion insight.

See Also:: Constant Field Values

PROPERTY_PARAMETER_ENABLE_POPUP

public static final java.lang.String PROPERTY_PARAMETER_ENABLE_POPUP

Name of the property for whether parameter insight should enable auto-popup based on typed triggers.

See Also:: Constant Field Values

PROPERTY_PARAMETER_POPUP_DELAY

public static final java.lang.String PROPERTY_PARAMETER_POPUP_DELAY

Name of the property for the auto-popup delay (if enabled) for parameter insight.

See Also:: Constant Field Values

PROPERTY_INSIGHT_FONT_FAMILY

public static final java.lang.String PROPERTY_INSIGHT_FONT_FAMILY

Name of the property for the font family to use for code insight.

See Also:: Constant Field Values

PROPERTY_INSIGHT_FONT_SIZE

public static final java.lang.String PROPERTY_INSIGHT_FONT_SIZE

Name of the property for the font size to use for code insight.

See Also:: Constant Field Values

PROPERTY_INSIGHT_PARTIAL_COMPLETE_SINGLE

public static final java.lang.String PROPERTY_INSIGHT_PARTIAL_COMPLETE_SINGLE

Name of the property that controls whether Insight automatically performs a complete when a partial complete is invoked and there is only a single matching data item.

See Also:: Constant Field Values

PROPERTY_INSIGHT_MANUAL_COMPLETE_SINGLE

public static final java.lang.String PROPERTY_INSIGHT_MANUAL_COMPLETE_SINGLE

Name of the property that controls whether Insight automatically performs a complete when it is invoked and there is only a single matching data item.

See Also:: Constant Field Values

PROPERTY_INSIGHT_TYPED_COMPLETE_SINGLE

public static final java.lang.String PROPERTY_INSIGHT_TYPED_COMPLETE_SINGLE

Name of the property that controls whether Insight automatically performs a complete while the user is typing once there is only a single matching data item.

See Also:: Constant Field Values

PROPERTY_INSIGHT_NEWDATA_COMPLETE_SINGLE

public static final java.lang.String PROPERTY_INSIGHT_NEWDATA_COMPLETE_SINGLE

Name of the property that controls whether Insight automatically performs a complete if the InsightData type changes while Insight is up, and there is only a single matching data item in the new data instance.

See Also:: Constant Field Values

PROPERTY_INSIGHT_FILTER_MATCHING

public static final java.lang.String PROPERTY_INSIGHT_FILTER_MATCHING

Name of the property that controls whether Insight displays the full completion list of items, or only the matching list of items.

See Also:: Constant Field Values

PROPERTY_INSIGHT_MAX_POPUP_WIDTH

public static final java.lang.String PROPERTY_INSIGHT_MAX_POPUP_WIDTH

Name of the property that configures the maximum width of an insight popup window - this prevents situations with run-away insight popup windows that are huge. A reasonable default seems to be about 640 pixels. Additionally, the insight implementation may cap the width below this to ensure that the entire popup remains visible on screen.

See Also:: Constant Field Values

PROPERTY_CHECK_FRAGLIST_RECYCLING

public static final java.lang.String PROPERTY_CHECK_FRAGLIST_RECYCLING

Property name for whether to check if the StyledFragmentsList is being recycled properly. This just enables error reporting via System.out console if there are too many StyledFragmentsList being allocated in the language framework, resulting in over-allocation of memory.

See Also:: Constant Field Values

PROPERTY_REUSE_UNDOABLE_EDIT

public static final java.lang.String PROPERTY_REUSE_UNDOABLE_EDIT

Property name for whether UndoableEditEvent instances are reused for notification - this is a document optimization to help reduce constant object reallocation. To disable this optimization, just set this property with the value Boolean.FALSE on startup. To enable this optimization, leave the property unset, or set it to Boolean.TRUE

See Also:: Constant Field Values

PROPERTY_REUSE_DOCUMENT_EVENT

public static final java.lang.String PROPERTY_REUSE_DOCUMENT_EVENT

Property name for whether DocumentEvent instances are reused for notification - this is a document optimization to help reduce constant object reallocation. To disable this optimization, just set this property with the value Boolean.FALSE on startup. To enable this optimization, leave the property unset, or set it to Boolean.TRUE

See Also:: Constant Field Values

PROPERTY_CHECK_CLIPBOARD_FOR_PASTE

public static final java.lang.String PROPERTY_CHECK_CLIPBOARD_FOR_PASTE

Property name for whether BasicEditorPane.canPaste() should check the contents of the clipboard to see if it is pasteable. Note that this can be an expensive operation to perform, the default perhaps is just to check if the editor is editable.

See Also:: Constant Field Values

PROPERTY_CONSUME_KEY_RELEASE

public static final java.lang.String PROPERTY_CONSUME_KEY_RELEASE

Property name for whether the default key handler should eat key release events - this could help performance by not allowing menus a chance to check their accelerators on a key release event.

See Also:: Constant Field Values

PROPERTY_CHECK_SAME_WIDTH_FACES

public static final java.lang.String PROPERTY_CHECK_SAME_WIDTH_FACES

Property name for whether the RowMap implementation for BasicView should attempt to determine whether the font styles (normal, bold, italic, bold+italic) of a font are equivalient in widths. That is, is the width of 'm' the same in all font styles? The view renderer does a quick check of the editor font by comparing widths of a few different characters in plain vs. bold-italic styles. For fonts that satisfy this check, the RowMap implementation enables an optimization that avoids having to use the DocumentRenderer or font Highlight rendering for computing text widths. If this optimization interferes with view renderer display, then it can be disabled by setting this property with a false boolean value.

See Also:: Constant Field Values

PROPERTY_CUT_COPY_LINE

public static final java.lang.String PROPERTY_CUT_COPY_LINE

Name of the property for whether Cut/Copy should operate on the current line when there is no selection in the editor.

See Also:: Constant Field Values

PROPERTY_IMPORTS_COPY_PASTE

public static final java.lang.String PROPERTY_IMPORTS_COPY_PASTE

Name of the property for whether Copy/paste should automaticaly collect and add needed import for the copied block.

See Also:: Constant Field Values

PROPERTY_AUTOINDENT_COPY_PASTE

public static final java.lang.String PROPERTY_AUTOINDENT_COPY_PASTE

Name of the property for whether Copy/paste should automaticaly indent properly the pastes block

See Also:: Constant Field Values

PROPERTY_AUTOREFORMAT_COPY_PASTE

public static final java.lang.String PROPERTY_AUTOREFORMAT_COPY_PASTE

Name of the property for whether Copy/paste should automaticaly reformat properly the pastes block

See Also:: Constant Field Values

PROPERTY_ESCAPESTRING_PASTE

public static final java.lang.String PROPERTY_ESCAPESTRING_PASTE

Name of the property for whether Copy/paste should automaticaly escape properly the pastes block in a String literal

See Also:: Constant Field Values

PROPERTY_TOGGLE_COMMENTS_ADVANCE

public static final java.lang.String PROPERTY_TOGGLE_COMMENTS_ADVANCE

Name of the property for whether toggle comments should advance the caret to the next line if (before toggling comments) the caret was not a selection.

See Also:: Constant Field Values

PROPERTY_CARET_COLOR

public static final java.lang.String PROPERTY_CARET_COLOR

Property name for the caret color to use for painting the editor caret.

See Also:: Constant Field Values

PROPERTY_CARET_SHAPE_INSERT

public static final java.lang.String PROPERTY_CARET_SHAPE_INSERT

Property name for the caret shape to use when the editor caret is in insert mode.

See Also:: Constant Field Values

PROPERTY_CARET_SHAPE_OVERWRITE

public static final java.lang.String PROPERTY_CARET_SHAPE_OVERWRITE

Property name for the caret shape to use when the editor caret is in overwrite mode.

See Also:: Constant Field Values

PROPERTY_CARET_ENABLE_BLINK

public static final java.lang.String PROPERTY_CARET_ENABLE_BLINK

Property name for whether the caret should blink.

See Also:: Constant Field Values

PROPERTY_CARET_BLINK_RATE

public static final java.lang.String PROPERTY_CARET_BLINK_RATE

Property name for the blink rate of the caret, in milliseconds.

See Also:: Constant Field Values

PROPERTY_CARET_XOR_PAINTING

public static final java.lang.String PROPERTY_CARET_XOR_PAINTING

The property name for whether the caret should use xor painting or regular painting. XOR painting does not work on some platforms it seems (Macintosh.)

See Also:: Constant Field Values

PROPERTY_CARET_RIGHT_CLICK_SELECTION

public static final java.lang.String PROPERTY_CARET_RIGHT_CLICK_SELECTION

The property name for whether right-click will position the caret when clicking outside of a selection. If true, right-click will position the caret when clicking outside the selection. If false, right-click will never position the caret if there is a selection.

See Also:: Constant Field Values

PROPERTY_CARET_EDITOR_SELECTION_TYPE

public static final java.lang.String PROPERTY_CARET_EDITOR_SELECTION_TYPE

The property name for the type of selection the editor (e.g. wrap, columns)

See Also:: Constant Field Values

PROPERTY_MERGE_TYPED_INSERT

public static final java.lang.String PROPERTY_MERGE_TYPED_INSERT

Property name for whether consecutive typed insert edits should be allowed to merge.

See Also:: Constant Field Values

PROPERTY_MERGE_TYPED_REPLACE

public static final java.lang.String PROPERTY_MERGE_TYPED_REPLACE

Property name for whether consecutive typed replace edits should be allowed to merge.

See Also:: Constant Field Values

PROPERTY_MERGE_DELETE_NEXT

public static final java.lang.String PROPERTY_MERGE_DELETE_NEXT

Property name for whether consecutive delete next edits should be allowed to merge.

See Also:: Constant Field Values

PROPERTY_MERGE_DELETE_PREVIOUS

public static final java.lang.String PROPERTY_MERGE_DELETE_PREVIOUS

Property name for whether consecutive delete previous edits should be allowed to merge.

See Also:: Constant Field Values

PROPERTY_EDIT_MERGE_COUNT

public static final java.lang.String PROPERTY_EDIT_MERGE_COUNT

Property name for the number of consecutive edits (of the same type) that should be merged together. If undefined, edit merges will be disabled.

See Also:: Constant Field Values

PROPERTY_MERGE_NAVIGATION

public static final java.lang.String PROPERTY_MERGE_NAVIGATION

Property name for whether consecutive navigations should be allowed to merge.

See Also:: Constant Field Values

PROPERTY_UNDO_NAVIGATION

public static final java.lang.String PROPERTY_UNDO_NAVIGATION

Property name for whether UndoableEdits should be generated for navigation.

See Also:: Constant Field Values

PROPERTY_NAVIGATION_MERGE_COUNT

public static final java.lang.String PROPERTY_NAVIGATION_MERGE_COUNT

Property name for the number of consecutive navigations that should be merged together. If undefined, navigation merges will be disabled.

See Also:: Constant Field Values

PROPERTY_KEY_HANDLERS

public static final java.lang.String PROPERTY_KEY_HANDLERS

Name of the property for the list of available key handlers installed into the editor framework.

See Also:: Constant Field Values

PROPERTY_SELECTED_HANDLER

public static final java.lang.String PROPERTY_SELECTED_HANDLER

Name of the property for the current key handler used by editor panes in this framework.

See Also:: Constant Field Values

PROPERTY_MACRO_PLAYBACK_DELAY

public static final java.lang.String PROPERTY_MACRO_PLAYBACK_DELAY

The wait delay (in ms) after posting a key event during playback before posting the next key event. Valid range is from 10 to 100. Note that the delay for KEY_RELEASE events are always 10 ms, since release events are typically ignored.

See Also:: Constant Field Values

PROPERTY_VALID_OFFSET_START

public static final java.lang.String PROPERTY_VALID_OFFSET_START

Valid limit offsets. When set editing is not permitted via the editor outside of these offsets. -1 indicates theeditor isn't limited and editing can occur anywhere (its natural state). Direct editing of the document or text buffer is not restricted.

See Also:: Constant Field Values

PROPERTY_VALID_OFFSET_END

public static final java.lang.String PROPERTY_VALID_OFFSET_END

See Also:: Constant Field Values

PROPERTY_MIDDLE_BUTTON_BEHAVIOR

public static final java.lang.String PROPERTY_MIDDLE_BUTTON_BEHAVIOR

Behavior of the middle button behavior in the code editor. One of the BasicCaret.MiddleButtonBehaviour enum choices.

See Also:: Constant Field Values

Method Detail

getProperties

public static EditorProperties getProperties()

Fetches the singleton instance of the EditorProperties table.

getProperty

public java.lang.Object getProperty(java.lang.String key)

Fetch the property stored by the given key.

Parameters:: key - the property to get
Returns:: the value associated with the given property

putProperty

public void putProperty(java.lang.String key,
                        java.lang.Object value)

Stores a property and value in the property table.

Parameters:: key - the property name; value - the property value

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key)

Fetch the boolean property stored by the given key. This may throw a ClassCastException if the property is not a boolean property

Parameters:: key - the property to get
Throws:: java.lang.ClassCastException - if the property is not a boolean property

putBooleanProperty

public void putBooleanProperty(java.lang.String key,
                               boolean value)

Sets the boolean property and value in the property table.

Parameters:: key - the property name; value - the property value

getIntegerProperty

public int getIntegerProperty(java.lang.String key)

Fetch the integer property stored by the given key. This may throw a ClassCastException if the property is not a integer property

Parameters:: key - the property to get
Throws:: java.lang.ClassCastException - if the property is not a integer property

putIntegerProperty

public void putIntegerProperty(java.lang.String key,
                               int value)

Sets the integer property and value in the property table.

Parameters:: key - the property name; value - the property value

getStyleRegistry

public StyleRegistry getStyleRegistry()

Fetch the global style registry used for all editor panes.

Returns:: the global style registry

setStyleRegistry

public void setStyleRegistry(StyleRegistry registry)

Replace the global style registry used for all editor panes.

Parameters:: registry - the new registry to use

getHighlightRegistry

public HighlightRegistry getHighlightRegistry()

Fetch the global highlight registry used for all editor panes.

Returns:: the global highlight registry

setHighlightRegistry

public void setHighlightRegistry(HighlightRegistry registry)

Replace the global highlight registry used for all editor panes.

Parameters:: registry - the new registry to use

getEditorBundle

public static oracle.javatools.resource.BundleHelper getEditorBundle()

Public utility routine for editor framework to fetch editor resources. This is so that we only have to specify the resource name from one place.

Returns:: the helper for the editor resources

getFontHelper

public FontHelper getFontHelper()

Convenience method for getting the current font helper.

Returns:: the current FontHelper instance

getBaseFont

public java.awt.Font getBaseFont()

Convenience method for getting the current base font.

Returns:: the current baes font

setBaseFont

public void setBaseFont(java.lang.String familyName,
                        int fontSize)

Utility routine to set the base font used by all editor panes in this framework.

Parameters:: familyName - the name of the font family to use; fontSize - the font size to use

setHandlerName

public void setHandlerName(java.lang.String handlerName)

Changes the name of the default handler used.

Parameters:: handlerName - the name of the handler to use (from KeyHandlerFactory)

getHandlerName

public java.lang.String getHandlerName()

Gets the name of the current handler to use.

Returns:: the name of the handler to use

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list. The listener is registered for all properties.

Note that this listener is stored using a WeakReference. This is intentional as part of the editor framework design, to avoid pinning certain UI objects in memory permanently.

Parameters:: listener - The PropertyChangeListener to be added

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:: listener - The PropertyChangeListener to be removed

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)

Report a bound property update to any registered listeners. No event is fired if old and new are equal and non-null.

Parameters:: propertyName - The programmatic name of the property that was changed.; oldValue - The old value of the property.; newValue - The new value of the property.