Class orion.editor.Editor

An Editor is a user interface for editing text that provides additional features over the basic orion.textview.TextView. Some of Editor's features include:

Additional actions and key bindings for editing text
Content assist
Find and Incremental Find
Rulers for displaying line numbers and annotations
Status reporting

Defined in: </shared/eclipse/e4/orion/I201107200200/plugins/org.eclipse.orion.client.editor/web/orion/editor/editor.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	orion.editor.Editor(options) Creates a new Editor with the given options.

Method Summary
Method Attributes	Method Name and Description
	doFind(str, startIndex, ignoreCase, reverse) Helper for finding occurrences of str in the editor contents.
	doFindRegExp(pattern, flags, startIndex, reverse) Helper for finding regex matches in the editor contents.
	getAnnotationsRuler()
	getContents() Returns the current contents of the editor.
	getTextView() Returns the underlying `TextView` used by this editor.
	installTextView() Creates the underlying TextView and installs the editor's features.
	isDirty() Returns `true` if the editor is dirty; `false` otherwise.
	onDirtyChange(isDirty) Called when the dirty state of the editor is changing.
	onGotoLine(line, column, end) Reveals a line in the editor, and optionally selects a portion of the line.
	onInputChange(title, message, contents, contentsSaved) Called when the editor's contents have changed.
	showSelection(start, end, line, offset, length) Reveals and selects a portion of text.

Class Detail

orion.editor.Editor(options)

Creates a new Editor with the given options.

Parameters:
{Object} options: Options controlling the features of this Editor.
{Object} options.annotationFactory
{Object} options.contentAssistFactory
{Object} options.domNode
{Object} options.keyBindingFactory
{Object} options.lineNumberRulerFactory
{Object} options.statusReporter
{Object} options.syntaxHighlightProviders
{Object} options.textViewFactory
{Object} options.undoStackFactory

Method Detail

{Object} doFind(str, startIndex, ignoreCase, reverse)

Helper for finding occurrences of str in the editor contents.

Parameters:
{String} str
{Number} startIndex
{Boolean} ignoreCase Optional: Default is false.
{Boolean} reverse Optional: Default is false.

Returns:: {Object} An object giving the match details, or null if no match found. The returned object will have the properties:
{Number} index
{Number} length

{Object} doFindRegExp(pattern, flags, startIndex, reverse)

Helper for finding regex matches in the editor contents. Use #doFind for simple string searches.

Parameters:
{String} pattern: A valid regexp pattern.
{String} flags: Valid regexp flags: [is]
{Number} startIndex Optional: Default is false.
{Boolean} reverse Optional: Default is false.

Returns:: {Object} An object giving the match details, or null if no match found. The returned object will have the properties:
{Number} index
{Number} length

{Object} getAnnotationsRuler()

Returns:: {Object}

{String} getContents()

Returns the current contents of the editor.

Returns:: {String}

getTextView()

Returns the underlying TextView used by this editor.

Returns:: orion.textview.TextView

installTextView()

Creates the underlying TextView and installs the editor's features.

{Boolean} isDirty()

Returns true if the editor is dirty; false otherwise.

Returns:: {Boolean}

onDirtyChange(isDirty)

Called when the dirty state of the editor is changing.

Parameters:
{Boolean} isDirty

onGotoLine(line, column, end)

Reveals a line in the editor, and optionally selects a portion of the line.

Parameters:
{Number} line
{Number|String} column
{Number} end Optional

onInputChange(title, message, contents, contentsSaved)

Called when the editor's contents have changed.

Parameters:
{String} title
{String} message
{String} contents
{Boolean} contentsSaved

showSelection(start, end, line, offset, length)

Reveals and selects a portion of text.

Parameters:
{Number} start
{Number} end
{Number} line
{Number} offset
{Number} length

Classes

Class orion.editor.Editor