org.fujion.codemirror

Class CodeMirrorOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.codemirror.CodeMirrorOptions

All Implemented Interfaces:

org.fujion.ancillary.IOptionMapTransform, org.fujion.client.IClientTransform

Direct Known Subclasses:

CodeMirrorXML.XMLOptions

public class CodeMirrorOptions
extends org.fujion.ancillary.Options

Base options common to all CodeMirror components.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeMirrorOptions.InputStyleEnum

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	addModeClass When enabled, an extra CSS class will be added to each token, indicating the (inner) mode that produced it, prefixed with "cm-m-".
String[]	allowDropFileTypes When set, only files whose type is in the array can be dropped into the editor.
Boolean	autofocus Can be used to make CodeMirror focus itself on initialization.
Boolean	coverGutterNextToScrollbar When fixedGutter is on, and there is a horizontal scrollbar, by default the gutter will be visible to the left of this scrollbar.
Integer	cursorBlinkRate Half-period in milliseconds used for cursor blinking.
Double	cursorHeight Determines the height of the cursor.
Integer	cursorScrollMargin How much extra space to always keep above and below the cursor when approaching the top or bottom of the visible view in a scrollable document.
Boolean	dragDrop Controls whether drag-and-drop is enabled.
Boolean	electricChars Configures whether the editor should re-indent the current line when a character is typed that might change its proper indentation (only works if the mode supports indentation).
Integer	firstLineNumber At which number to start counting lines.
Boolean	fixedGutter Determines whether the gutter scrolls along with the content horizontally (false) or whether it stays fixed (true) during horizontal scrolling.
Boolean	flattenSpans By default, CodeMirror will combine adjacent tokens into a single span if they have the same class.
Integer	historyEventDelay The period of inactivity (in milliseconds) that will cause a new history event to be started when typing or deleting.
Integer	indentUnit How many spaces a block (whatever that means in the edited language) should be indented.
Boolean	indentWithTabs Whether, when indenting, the first N*tabSize spaces should be replaced by N tabs.
CodeMirrorOptions.InputStyleEnum	inputStyle Selects the way CodeMirror handles input and focus.
org.fujion.ancillary.JavaScript	lineNumberFormatter A function used to format line numbers.
Boolean	lineNumbers Whether to show line numbers to the left of the editor.
String	lineSeparator Explicitly set the line separator for the editor.
Boolean	lineWiseCopyCut When enabled, doing copy or cut when there is no selection will copy or cut the whole lines that have cursors on them.
Boolean	lineWrapping Whether CodeMirror should scroll (false) or wrap (true) for long lines.
Integer	maxHighlightLength When highlighting long lines, in order to stay responsive, the editor will give up and simply style the rest of the line as plain text when it reaches a certain position.
protected String	mode The mode to use.
Boolean	pasteLinesPerSelection When pasting something from an external source (not from the editor itself), if the number of lines matches the number of selection, CodeMirror will by default insert one line per selection.
String	placeholder Can be used to make content appear in the editor when it is empty and not focused.
Integer	pollInterval Indicates how quickly (in milliseconds) CodeMirror should poll its input textarea for changes (when focused).
Boolean	readonly This disables editing of the editor content by the user.
Boolean	resetSelectionOnContextMenu Controls whether, when the context menu is opened with a click outside of the current selection, the cursor is moved to the point of the click.
Boolean	rtlMoveVisually Determines whether horizontal cursor movement through right-to-left (Arabic, Hebrew) text is visual (pressing the left arrow moves the cursor left) or logical (pressing the left arrow moves to the next lower index in the string, which is visually right in right-to-left text).
String	scrollbarStyle Chooses a scrollbar implementation.
Boolean	showCursorWhenSelecting Whether the cursor should be drawn when a selection is active.
Boolean	smartIndent Whether to use the context-sensitive indentation that the mode provides (or just indent the same as the line before).
org.fujion.ancillary.JavaScript	specialCharPlaceholder A function that, given a special character identified by the specialChars option, produces a DOM node that is used to represent the character.
Pattern	specialChars A regular expression used to determine which characters should be replaced by a special placeholder.
Integer	tabSize The width of a tab character.
Integer	undoDepth The maximum number of undo levels that the editor stores.
Integer	viewportMargin Specifies the amount of lines that are rendered above and below the part of the document that's currently scrolled into view.
Integer	workDelay Highlighting is done by a pseudo background-thread that will work for workTime milliseconds, and then use timeout to sleep for workDelay milliseconds.
Integer	workTime Highlighting is done by a pseudo background-thread that will work for workTime milliseconds, and then use timeout to sleep for workDelay milliseconds.

Constructor Summary

Constructors

Constructor and Description
CodeMirrorOptions(String mode) Create options instance with specified mode.

Method Summary

Modifier and Type	Method and Description
Object	addKeyBinding(String key, org.fujion.ancillary.JavaScript javascript) Binds a key combination to a JavaScript function.
Object	addKeyBinding(String key, String command) Binds a key combination to a registered command.
Object	getKeyBinding(String key) Returns the current key binding.
Object	removeKeyBinding(String key) Removes the current key binding, if any.

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.IOptionMapTransform

transformForClient

Field Detail

addModeClass

@Option
public Boolean addModeClass

When enabled, an extra CSS class will be added to each token, indicating the (inner) mode that produced it, prefixed with "cm-m-". For example, tokens from the XML mode will get the cm-m-xml class.

Default: false

allowDropFileTypes

@Option
public String[] allowDropFileTypes

When set, only files whose type is in the array can be dropped into the editor. The strings should be MIME types, and will be checked against the type of the File object as reported by the browser.

autofocus

@Option
public Boolean autofocus

Can be used to make CodeMirror focus itself on initialization.

Default: false

coverGutterNextToScrollbar

@Option
public Boolean coverGutterNextToScrollbar

When fixedGutter is on, and there is a horizontal scrollbar, by default the gutter will be visible to the left of this scrollbar. If this option is set to true, it will be covered by an element with class CodeMirror-gutter-filler.

Default: false

cursorBlinkRate

@Option
public Integer cursorBlinkRate

Half-period in milliseconds used for cursor blinking. By setting this to zero, blinking can be disabled. A negative value hides the cursor entirely.

Default: 530

cursorHeight

@Option
public Double cursorHeight

Determines the height of the cursor. Default is 1, meaning it spans the whole height of the line. For some fonts (and by some tastes) a smaller height (for example 0.85), which causes the cursor to not reach all the way to the bottom of the line, looks better.

Default: 1.0

cursorScrollMargin

@Option
public Integer cursorScrollMargin

How much extra space to always keep above and below the cursor when approaching the top or bottom of the visible view in a scrollable document.

Default: 0

dragDrop

@Option
public Boolean dragDrop

Controls whether drag-and-drop is enabled.

Default: true

electricChars

@Option
public Boolean electricChars

Configures whether the editor should re-indent the current line when a character is typed that might change its proper indentation (only works if the mode supports indentation).

Default: true

firstLineNumber

@Option
public Integer firstLineNumber

At which number to start counting lines.

Default: 1

fixedGutter

@Option
public Boolean fixedGutter

Determines whether the gutter scrolls along with the content horizontally (false) or whether it stays fixed (true) during horizontal scrolling.

Default: true

flattenSpans

@Option
public Boolean flattenSpans

By default, CodeMirror will combine adjacent tokens into a single span if they have the same class. This will result in a simpler DOM tree, and thus perform better. With some kinds of styling (such as rounded corners), this will change the way the document looks. You can set this option to false to disable this behavior.

Default: true

historyEventDelay

@Option
public Integer historyEventDelay

The period of inactivity (in milliseconds) that will cause a new history event to be started when typing or deleting.

Default: 1250

indentUnit

@Option
public Integer indentUnit

How many spaces a block (whatever that means in the edited language) should be indented.

Default: 2

indentWithTabs

@Option
public Boolean indentWithTabs

Whether, when indenting, the first N*tabSize spaces should be replaced by N tabs.

Default: false

inputStyle

@Option
public CodeMirrorOptions.InputStyleEnum inputStyle

Selects the way CodeMirror handles input and focus. The core library defines the "textarea" and "contenteditable" input models. On mobile browsers, the default is "contenteditable". On desktop browsers, the default is "textarea". Support for IME and screen readers is better in the "contenteditable" model. The intention is to make it the default on modern desktop browsers in the future.

lineNumberFormatter

@Option
public org.fujion.ancillary.JavaScript lineNumberFormatter

A function used to format line numbers. The function is passed the line number, and should return a string that will be shown in the gutter.

lineNumbers

@Option
public Boolean lineNumbers

Whether to show line numbers to the left of the editor.

lineSeparator

@Option
public String lineSeparator

Explicitly set the line separator for the editor. By default (value null), the document will be split on CRLFs as well as lone CRs and LFs, and a single LF will be used as line separator in all output (such as getValue). When a specific string is given, lines will only be split on that string, and output will, by default, use that same separator.

lineWiseCopyCut

@Option
public Boolean lineWiseCopyCut

When enabled, doing copy or cut when there is no selection will copy or cut the whole lines that have cursors on them.

Default: true

lineWrapping

@Option
public Boolean lineWrapping

Whether CodeMirror should scroll (false) or wrap (true) for long lines.

Default: false

maxHighlightLength

@Option
public Integer maxHighlightLength

When highlighting long lines, in order to stay responsive, the editor will give up and simply style the rest of the line as plain text when it reaches a certain position. You can set this to MaxInt to turn off this behavior.

Default: 10000

mode

@Option
protected String mode

The mode to use. When not given, this will default to the first mode that was loaded. It is a string, which either simply names the mode or is a MIME type associated with the mode.

pasteLinesPerSelection

@Option
public Boolean pasteLinesPerSelection

When pasting something from an external source (not from the editor itself), if the number of lines matches the number of selection, CodeMirror will by default insert one line per selection. You can set this to false to disable that behavior.

Default: true

placeholder

@Option
public String placeholder

Can be used to make content appear in the editor when it is empty and not focused. It gives the editor a CodeMirror-empty CSS class whenever it doesn't contain any text.

pollInterval

@Option
public Integer pollInterval

Indicates how quickly (in milliseconds) CodeMirror should poll its input textarea for changes (when focused). Most input is captured by events, but some things, like IME input on some browsers, don't generate events that allow CodeMirror to properly detect it. Thus, it polls.

Default: 100.

readonly

@Option
public Boolean readonly

This disables editing of the editor content by the user. If the special value "nocursor" is given (instead of simply true), focusing of the editor is also disallowed.

Default: false

resetSelectionOnContextMenu

@Option
public Boolean resetSelectionOnContextMenu

Controls whether, when the context menu is opened with a click outside of the current selection, the cursor is moved to the point of the click.

Default: true

rtlMoveVisually

@Option
public Boolean rtlMoveVisually

Determines whether horizontal cursor movement through right-to-left (Arabic, Hebrew) text is visual (pressing the left arrow moves the cursor left) or logical (pressing the left arrow moves to the next lower index in the string, which is visually right in right-to-left text). Default: false on Windows, and true on other platforms.

scrollbarStyle

@Option
public String scrollbarStyle

Chooses a scrollbar implementation. The default is "native", showing native scrollbars. The core library also provides the "null" style, which completely hides the scrollbars. Addons can implement additional scrollbar models.

Default: "native"

showCursorWhenSelecting

@Option
public Boolean showCursorWhenSelecting

Whether the cursor should be drawn when a selection is active.

Default: false

smartIndent

@Option
public Boolean smartIndent

Whether to use the context-sensitive indentation that the mode provides (or just indent the same as the line before).

Default: true

specialCharPlaceholder

@Option
public org.fujion.ancillary.JavaScript specialCharPlaceholder

A function that, given a special character identified by the specialChars option, produces a DOM node that is used to represent the character.

Default: A red dot (•) is shown, with a title tooltip to indicate the character code.

specialChars

@Option
public Pattern specialChars

A regular expression used to determine which characters should be replaced by a special placeholder. Mostly useful for non-printing special characters.

Default: [--Ÿ­؜-‏

]

tabSize

@Option
public Integer tabSize

The width of a tab character.

Default: 4

undoDepth

@Option
public Integer undoDepth

The maximum number of undo levels that the editor stores. Note that this includes selection change events.

Default: 200

viewportMargin

@Option
public Integer viewportMargin

Specifies the amount of lines that are rendered above and below the part of the document that's currently scrolled into view. This affects the amount of updates needed when scrolling, and the amount of work that such an update does. You should usually leave it at its default, 10. Can be set to MaxInt to make sure the whole document is always rendered, and thus the browser's text search works on it. This will have bad effects on performance of big documents.

Default: 10

workDelay

@Option
public Integer workDelay

Highlighting is done by a pseudo background-thread that will work for workTime milliseconds, and then use timeout to sleep for workDelay milliseconds. You can change these options to make the highlighting more or less aggressive.

Default: 300

workTime

@Option
public Integer workTime

Highlighting is done by a pseudo background-thread that will work for workTime milliseconds, and then use timeout to sleep for workDelay milliseconds. You can change these options to make the highlighting more or less aggressive.

Default: 200

Constructor Detail

CodeMirrorOptions

public CodeMirrorOptions(String mode)

Create options instance with specified mode.

Parameters:

mode - Desired mode.

Method Detail

addKeyBinding

public Object addKeyBinding(String key,
                            String command)

Binds a key combination to a registered command.

Parameters:

key - Key combination mnemonic.

command - Name of registered command.

Returns:

The previous key binding (command or JavaScript object), or null if none.

addKeyBinding

public Object addKeyBinding(String key,
                            org.fujion.ancillary.JavaScript javascript)

Binds a key combination to a JavaScript function.

Parameters:

key - Key combination mnemonic.

javascript - JavaScript code to be invoked.

Returns:

The previous key binding (command or JavaScript object), or null if none.

getKeyBinding

public Object getKeyBinding(String key)

Returns the current key binding.

Parameters:

key - Key combination mnemonic.

Returns:

The existing key binding (command or JavaScript object), or null if none.

removeKeyBinding

public Object removeKeyBinding(String key)

Removes the current key binding, if any.

Parameters:

key - Key combination mnemonic.

Returns:

The previous key binding (command or JavaScript object), or null if none.