Class Index | File Index

Classes


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:


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

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a new Editor with the given options.
Method Summary
Method Attributes Method Name and Description
 
doFind(str, searchStart, ignoreCase, reverse)
Helper for finding occurrences of str in the editor contents.
 
doFindRegExp(pattern, flags, searchStart, reverse)
Helper for finding regex matches in the editor contents.
 
 
 
 
 
getText(start, end)
 
Returns the underlying TextView used by this editor.
 
 
 
Creates the underlying TextView and installs the editor's features.
 
Returns true if the editor is dirty; false otherwise.
 
mapOffset(offset, parent)
 
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.
 
setCaretOffset(caretOffset)
 
 
setSelection(start, end, show)
 
setText(text, start, end)
 
showProblems(problems)
 
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, searchStart, ignoreCase, reverse)
Helper for finding occurrences of str in the editor contents.
Parameters:
{String} str
{Number} searchStart
offset in the base model where the search should start
{Boolean} ignoreCase Optional, Default: false
whether or not the search is case sensitive
{Boolean} reverse Optional, Default: false
whether the search should be backwards
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, searchStart, 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} searchStart
offset in the base model where the search should start
{Boolean} reverse Optional, Default: false
whether the search should be backwards
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

{orion.textview.AnnotationModel} getAnnotationModel()
Returns:
{orion.textview.AnnotationModel}

getCaretOffset()

getModel()

getSelection()

getText(start, end)
Parameters:
start
end

getTextView()
Returns the underlying TextView used by this editor.
Returns:
orion.textview.TextView

getTitle()

highlightAnnotations()

installTextView()
Creates the underlying TextView and installs the editor's features.

{Boolean} isDirty()
Returns true if the editor is dirty; false otherwise.
Returns:
{Boolean}

mapOffset(offset, parent)
Parameters:
offset
parent

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
- document base line index
{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

setCaretOffset(caretOffset)
Parameters:
caretOffset

setFoldingEnabled(enabled)
Parameters:
enabled

setSelection(start, end, show)
Parameters:
start
end
show

setText(text, start, end)
Parameters:
text
start
end

showProblems(problems)
Parameters:
problems

showSelection(start, end, line, offset, length)
Reveals and selects a portion of text.
Parameters:
{Number} start
{Number} end
{Number} line
{Number} offset
{Number} length

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Oct 21 2011 14:44:12 GMT-0400 (EDT)