Class Index | File Index

## Classes

- _global_
- Boolean
- Date
- Function
- Object
- orion.breadcrumbs.BreadCrumbs
- orion.cm.Configuration
- orion.cm.ConfigurationAdmin
- orion.cm.ConfigurationProperties
- orion.cm.ManagedService
- orion.commands.Command
- orion.commands.CommandKeyBinding
- orion.commands.CommandParameter
- orion.commands.CommandService
- orion.commands.ParametersDescription
- orion.commands.URLBinding
- orion.commonHTMLFragments
- orion.compare.DiffProvider
- orion.compare.rulers.CompareRuler
- orion.compare.rulers.LineNumberCompareRuler
- orion.compareUtils
- orion.contentAssist.CssContentAssistProvider
- orion.contentAssist.HTMLContentAssistProvider
- orion.core.ContentType
- orion.core.ContentTypeService
- orion.dialogs.DialogService
- orion.DiffTreeNavigator.DiffTreeNavigator
- orion.DiffTreeNavigator.inlineDiffBlockFeeder
- orion.DiffTreeNavigator.TwoWayDiffBlockFeeder
- orion.edit.Dispatcher
- orion.editor.ContentAssist
- orion.editor.ContentAssistMode
- orion.editor.ContentAssistProvider
- orion.editor.ContentAssistProvider.Context
- orion.editor.ContentAssistWidget
- orion.editor.Editor
- orion.editor.JSTemplateContentAssistProvider
- orion.editor.regex
- orion.editor.StyleReadyEvent
- orion.editor.StyleReadyEvent#LineStyle
- orion.editor.TextMateStyler
- orion.EventTarget
- orion.explorer.Explorer
- orion.explorer.ExplorerFlatModel
- orion.explorer.ExplorerModel
- orion.explorer.SelectionRenderer
- orion.ExplorerNavHandler.ExplorerNavDict
- orion.explorers.explorer-table.FileExplorer
- orion.explorers.ExplorerNavHandler.ExplorerNavHandler
- orion.extensionCommands
- orion.favorites.FavoritesService
- orion.fileClient.FileClient
- orion.fileCommands
- orion.fileUtils
- orion.git.GitCommitExplorer
- orion.git.GitLogExplorer
- orion.git.GitRepositoryExplorer
- orion.git.GitReviewRequestExplorer
- orion.git.GitService
- orion.git.GitStatusExplorer
- orion.git.widgets.OpenCommitDialog
- orion.globalCommands
- orion.highlight.SyntaxHighlighter
- orion.links.TextLinkService
- orion.log.LogService
- orion.metatype.AttributeDefinition
- orion.metatype.MetaTypeRegistry
- orion.metatype.ObjectClassDefinition
- 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.searches.SavedSearches
- orion.Searches.SearchList
- orion.searchResults.SearchResultsGenerator
- orion.searchUtils
- orion.selection.Selection
- orion.serviceregistry.ServiceReference
- orion.serviceregistry.ServiceRegistration
- orion.serviceregistry.ServiceRegistry
- orion.ServiceTracker
- orion.settings.Setting
- orion.settings.SettingsRegistry
- orion.shell.Command
- orion.shell.Parameter
- orion.shell.ParameterType
- orion.shell.Shell
- orion.sites.SiteClient
- orion.sites.SiteConfiguration
- orion.sites.SiteService
- orion.sites.ViewOnSiteTree
- orion.status.StatusReportingService
- orion.tasks.TaskList
- orion.textview.ActionDescription
- orion.textview.Annotation
- orion.textview.AnnotationIterator
- orion.textview.AnnotationModel
- orion.textview.AnnotationRuler
- orion.textview.AnnotationStyler
- orion.textview.AnnotationType
- orion.textview.AnnotationTypeList
- orion.textview.BlurEvent
- orion.textview.ContextMenuEvent
- orion.textview.DestroyEvent
- orion.textview.EventTarget
- orion.textview.FindIterator
- orion.textview.FindOptions
- orion.textview.FocusEvent
- orion.textview.FoldingAnnotation
- orion.textview.KeyBinding
- orion.textview.LineNumberRuler
- orion.textview.LineStyleEvent
- 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.VerifyEvent
- orion.TreeModelIterator.TreeModelIterator
- orion.treetable.TableTree
- orion.uiUtils
- orion.util
- orion.widgets.OpenResourceDialog
- orion.widgets.Section
- orion.widgets.SiteEditor
- orion.xhr
- orion.xhr.Result
- String

# Class orion.editor.ContentAssist

Provides content assist for a TextView.
Defined in: </shared/eclipse/e4/orion/I201210191304/plugins/org.eclipse.orion.client.editor/web/orion/editor/contentAssist.js>.

Class Summary
Constructor Attributes | Constructor Name and Description
--- | ---
| orion.editor.ContentAssist(textView) Creates a `ContentAssist` for a TextView.

Method Summary
Method Attributes | Method Name and Description
--- | ---
| activate()
| addEventListener(type, listener, useCapture) Adds an event listener to this event target.
| apply(proposal) Applies the given proposal to the TextView.
| computeProposals() Computes the proposals at the TextView's current caret offset.
| deactivate()
| dispatchEvent(evt) Dispatches the given event to the listeners added to this event target.
| getTextView()
| handleError(error)
| isActive()
| isDeactivatingChange(event)
| removeEventListener(type, listener, useCapture) Removes an event listener from the event target.
| setProviders(providers) Sets the content assist providers that this ContentAssist will consult to obtain proposals.

Event Summary
Event Attributes | Event Name and Description
--- | ---
| ActivatingEvent() Dispatched when a ContentAssist is about to be activated.
| DeactivatingEvent() Dispatched when a ContentAssist is about to be deactivated.
| ProposalAppliedEvent() Dispatched when a ContentAssist has applied a proposal.
| ProposalsComputedEvent() Dispatched whenever a ContentAssist has obtained proposals from its providers.

Class Detail
orion.editor.ContentAssist(textView)
Creates a `ContentAssist` for a TextView. A ContentAssist consults a set of orion.editor.ContentAssistProviders to obtain proposals for text that may be inserted into a TextView at a given offset.

A ContentAssist is generally activated by its TextView action, at which point it computes the set of proposals available. It will re-compute the proposals in response to subsequent changes on the TextView (for example, user typing) for as long as the ContentAssist is active. A proposal may be applied by calling #apply, after which the ContentAssist becomes deactivated. An active ContentAssist may be deactivated by calling #deactivate.

A ContentAssist dispatches events when it becomes activated or deactivated, and when proposals have been computed.

Parameters:
{orion.textview.TextView} textView
  The TextView to provide content assist for.

Method Detail
activate()

addEventListener(type, listener, useCapture)
Adds an event listener to this event target.
Defined in: </shared/eclipse/e4/orion/I201210191304/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

{Boolean} apply(proposal)
Applies the given proposal to the TextView.

Parameters:
{Object} proposal Optional

Returns:
  {Boolean} `true` if the proposal was applied; `false` if no proposal was provided.

computeProposals()
Computes the proposals at the TextView's current caret offset.

deactivate()

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

Parameters:
{Event} evt
  The event to dispatch.

{orion.textview.TextView} getTextView()

Returns:
  {orion.textview.TextView}

handleError(error)

Parameters:
error

{Boolean} isActive()

Returns:
  {Boolean}

{Boolean} isDeactivatingChange(event)

Parameters:
{orion.textview.ModelChangingEvent} event

Returns:
  {Boolean} `true` if the event describes a change that should deactivate content assist.

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/I201210191304/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

setProviders(providers)
Sets the content assist providers that this ContentAssist will consult to obtain proposals.

Parameters:
{orion.editor.ContentAssistProvider[]} providers
  The providers.

Event Detail
ActivatingEvent()
Dispatched when a ContentAssist is about to be activated.

DeactivatingEvent()
Dispatched when a ContentAssist is about to be deactivated.

ProposalAppliedEvent()
Dispatched when a ContentAssist has applied a proposal.

This event's `data` field gives information about the proposal that was applied.

ProposalsComputedEvent()
Dispatched whenever a ContentAssist has obtained proposals from its providers.

This event's `data` field gives information about the proposals.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Oct 19 2012 13:08:14 GMT-0400 (EDT)