Class Index | File Index

## Classes

- _global_
- Boolean
- Date
- eclipse.sites
- eclipse.sites.SiteRenderer
- eclipse.sites.SiteTreeModel
- exports.GitCommitExplorer-GitCommitExplorer
- exports.GitRepositoryExplorer-GitRepositoryExplorer
- Object
- orion.breadcrumbs.BreadCrumbs
- orion.commands.Command
- orion.commands.CommandService
- orion.commonHTMLFragments
- orion.compare.DiffProvider
- orion.compare.rulers.CompareOverviewRuler
- orion.compare.rulers.CompareRuler
- orion.compare.rulers.LineNumberCompareRuler
- orion.compareUtils
- orion.console.Console
- orion.console.ConsoleInput
- orion.contentAssist.CssContentAssistProvider
- orion.contentAssist.HTMLContentAssistProvider
- orion.dialogs.DialogService
- orion.edit.Dispatcher
- orion.editor.ContentAssist
- orion.editor.Editor
- orion.editor.JavaScriptContentAssistProvider
- orion.editor.regex
- orion.editor.StyleReadyEvent
- orion.editor.StyleReadyEvent#LineStyle
- orion.editor.TextMateStyler
- orion.editor.util
- orion.explorer-table.FileExplorer
- orion.explorer.Explorer
- orion.explorer.ExplorerFlatModel
- orion.explorer.ExplorerModel
- orion.explorer.SelectionRenderer
- orion.ExplorerNavHandler.ExplorerNavHandler
- orion.extensionCommands
- orion.favorites.FavoritesService
- orion.file.ContentType
- orion.file.ContentTypeService
- orion.fileClient.FileClient
- orion.fileCommands
- orion.git.GitClonesExplorer
- orion.git.GitClonesModel
- orion.git.GitCommitNavigator
- orion.git.GitService
- orion.git.widgets.OpenCommitDialog
- orion.globalCommands
- orion.highlight.SyntaxHighlighter
- orion.links.TextLinkService
- orion.log.LogService
- orion.mirror.CodeMirrorStyler
- orion.mirror.Mirror
- orion.mirror.MirrorLineStyle
- orion.mirror.ModeApplier
- orion.navoutliner.NavigationOutliner
- orion.outliner.Outliner
- orion.outliner.OutlineService
- orion.parameterCollectors.CommandParameterCollector
- orion.pluginregistry.Plugin
- orion.pluginregistry.PluginRegistry
- orion.preferences.Preferences
- orion.preferences.PreferencesService
- orion.problems.ProblemService
- orion.profile.usersClient.UsersClient
- orion.progress.ProgressService
- orion.searchClient.Searcher
- orion.searchResults.SearchResultsGenerator
- orion.searchUtils
- orion.selection.Selection
- orion.serviceregistry.EventTarget
- orion.serviceregistry.Service
- orion.serviceregistry.ServiceReference
- orion.serviceregistry.ServiceRegistration
- orion.serviceregistry.ServiceRegistry
- orion.siteService.SiteConfiguration
- orion.siteService.SiteService
- orion.status.StatusReportingService
- orion.textview.Annotation
- orion.textview.AnnotationIterator
- orion.textview.AnnotationModel
- orion.textview.AnnotationRuler
- orion.textview.AnnotationStyler
- orion.textview.AnnotationTypeList
- orion.textview.BlurEvent
- orion.textview.ContextMenuEvent
- orion.textview.DestroyEvent
- orion.textview.EventTarget
- orion.textview.FocusEvent
- orion.textview.FoldingAnnotation
- orion.textview.KeyBinding
- orion.textview.LineNumberRuler
- orion.textview.LineStyleEvent
- orion.textview.LoadEvent
- orion.textview.ModelChangedEvent
- orion.textview.ModelChangingEvent
- orion.textview.ModifyEvent
- orion.textview.OverviewRuler
- orion.textview.Projection
- orion.textview.ProjectionTextModel
- orion.textview.Ruler
- orion.textview.ScrollEvent
- orion.textview.Selection
- orion.textview.SelectionEvent
- orion.textview.Style
- orion.textview.StyleRange
- orion.textview.TextModel
- orion.textview.TextView
- orion.textview.TextViewOptions
- orion.textview.UndoStack
- orion.textview.UnloadEvent
- orion.textview.VerifyEvent
- orion.TreeModelIterator.TreeModelIterator
- orion.treetable.TableTree
- orion.util
- orion.widgets.DirectoryTreeModel
- orion.widgets.OpenResourceDialog
- orion.widgets.SiteEditor
- String

# 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/I201202282230/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
--- | ---
| addEventListener(type, listener, useCapture) Adds an event listener to this event target.
| dispatchEvent(evt) Dispatches the given event to the listeners added to this event target.
| 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.
| getAnnotationModel()
| getCaretOffset()
| getModel()
| getSelection()
| getText(start, end)
| getTextView() Returns the underlying `TextView` used by this editor.
| getTitle()
| highlightAnnotations()
| installTextView() Creates the underlying TextView and installs the editor's features.
| isDirty() Returns `true` if the editor is dirty; `false` otherwise.
| mapOffset(offset, parent)
| onDirtyChanged(dirtyChangedEvent) Called when the dirty state of the editor changes.
| onGotoLine(line, column, end) Reveals a line in the editor, and optionally selects a portion of the line.
| onInputChanged(inputChangedEvent) Called when the editor's contents have changed.
| removeEventListener(type, listener, useCapture) Removes an event listener from the event target.
| setCaretOffset(caretOffset)
| setDirty(dirty) Sets whether the editor is dirty.
| setFoldingEnabled(enabled)
| setInput(title, message, contents, contentsSaved) Sets the editor's contents.
| 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
{Object} options.textDNDFactory

Method Detail
addEventListener(type, listener, useCapture)
Adds an event listener to this event target.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.

Parameters:
{String} type
  The event type.
{Function|EventListener} listener
  The function or the EventListener that will be executed when the event happens.
{Boolean} useCapture Optional, Default: false
  `true` if the listener should be trigged in the capture phase.

See:
  #removeEventListener

dispatchEvent(evt)
Dispatches the given event to the listeners added to this event target.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.

Parameters:
{Event} evt
  The event to dispatch.

{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

onDirtyChanged(dirtyChangedEvent)
Called when the dirty state of the editor changes.

Parameters:
{Event} dirtyChangedEvent

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

onInputChanged(inputChangedEvent)
Called when the editor's contents have changed.

Parameters:
{Event} inputChangedEvent

removeEventListener(type, listener, useCapture)
Removes an event listener from the event target.

All the parameters must be the same ones used to add the listener.

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

Parameters:
{String} type
  The event type
{Function|EventListener} listener
  The function or the EventListener that will be executed when the event happens.
{Boolean} useCapture Optional, Default: false
  `true` if the listener should be trigged in the capture phase.

See:
  #addEventListener

setCaretOffset(caretOffset)

Parameters:
caretOffset

setDirty(dirty)
Sets whether the editor is dirty.

Parameters:
{Boollean} dirty

setFoldingEnabled(enabled)

Parameters:
enabled

setInput(title, message, contents, contentsSaved)
Sets the editor's contents.

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

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 Tue Feb 28 2012 22:34:47 GMT-0500 (EST)