Class Index | File Index

## Classes

- _global_
- Boolean
- Date
- Object
- orion.breadcrumbs.BreadCrumbs
- orion.cm.Configuration
- orion.cm.ConfigurationAdmin
- orion.cm.ConfigurationProperties
- orion.cm.ManagedService
- orion.commandregistry.CommandRegistry
- orion.commandregistry.ParameterCollector
- orion.commands.Command
- orion.commands.CommandInvocation
- orion.commands.CommandParameter
- orion.commands.ParametersDescription
- orion.commands.URLBinding
- orion.compare.CompareCommandFactory
- orion.compare.CompareOptions
- orion.compare.CompareSyntaxHighlighter
- orion.compare.CompareView
- orion.compare.CompareViewOptions
- orion.compare.DiffProvider
- orion.compare.FileOptions
- orion.compare.rulers.CompareRuler
- orion.compare.rulers.LineNumberCompareRuler
- orion.compare.toggleableCompareView
- orion.compare.TwoWayCompareView
- orion.compareUtils
- orion.core.ContentType
- orion.core.ContentTypeService
- orion.Deferred
- orion.dialogs.DialogService
- orion.DiffTreeNavigator.DiffTreeNavigator
- orion.DiffTreeNavigator.inlineDiffBlockFeeder
- orion.DiffTreeNavigator.TwoWayDiffBlockFeeder
- orion.edit.Dispatcher
- orion.editor.ActionDescription
- orion.editor.Annotation
- orion.editor.AnnotationIterator
- orion.editor.AnnotationModel
- orion.editor.AnnotationRuler
- orion.editor.AnnotationStyler
- orion.editor.AnnotationType
- orion.editor.AnnotationTypeList
- orion.editor.AsyncStyler
- orion.editor.BlurEvent
- orion.editor.ContentAssist
- orion.editor.ContentAssistMode
- orion.editor.ContentAssistProvider
- orion.editor.ContentAssistProvider.Context
- orion.editor.ContentAssistWidget
- orion.editor.ContextMenuEvent
- orion.editor.CssContentAssistProvider
- orion.editor.DestroyEvent
- orion.editor.EditOptions
- orion.editor.Editor
- orion.editor.EventTarget
- orion.editor.FindIterator
- orion.editor.FindOptions
- orion.editor.FocusEvent
- orion.editor.FoldingAnnotation
- orion.editor.HTMLContentAssistProvider
- orion.editor.InputManager
- orion.editor.JSTemplateContentAssistProvider
- orion.editor.KeyEvent
- orion.editor.LineNumberRuler
- orion.editor.LineStyleEvent
- orion.editor.ModelChangedEvent
- orion.editor.ModelChangingEvent
- orion.editor.ModifyEvent
- orion.editor.OverviewRuler
- orion.editor.Projection
- orion.editor.ProjectionTextModel
- orion.editor.regex
- orion.editor.Ruler
- orion.editor.ScrollEvent
- orion.editor.Selection
- orion.editor.SelectionEvent
- orion.editor.Style
- orion.editor.StyleRange
- orion.editor.StyleReadyEvent
- orion.editor.StyleReadyEvent#LineStyle
- orion.editor.TextMateStyler
- orion.editor.TextModel
- orion.editor.TextTheme
- orion.editor.TextView
- orion.editor.TextViewOptions
- orion.editor.ThemeChangedEvent
- orion.editor.ThemeStyleSheet
- orion.editor.UndoStack
- orion.editor.VerifyEvent
- orion.EventTarget
- orion.explorer.Explorer
- orion.explorer.ExplorerFlatModel
- orion.explorer.ExplorerModel
- orion.explorer.FileExplorer
- orion.explorer.FileExplorer.ModelHandler
- orion.explorer.NavigatorRenderer
- orion.explorer.SelectionRenderer
- orion.explorerNavHandler.ExplorerNavDict
- orion.explorerNavHandler.ExplorerNavHandler
- orion.extensionCommands
- orion.favorites.FavoritesService
- orion.fileClient.FileClient
- orion.fileCommands
- orion.fileUtils
- orion.form
- 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.KeyBinding
- orion.KeySequence
- orion.KeyStroke
- 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.objects
- orion.operation
- orion.outliner.Outliner
- orion.outliner.OutlineService
- orion.PageLinks
- 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.Promise
- orion.searchClient.Searcher
- orion.searches.SavedSearches
- orion.Searches.SearchBuilder
- orion.Searches.SearchList
- orion.searchResults.SearchResultsGenerator
- orion.searchUtils
- orion.searchUtils.SearchParams
- 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.sidebar.MiniNavViewMode
- orion.sidebar.Sidebar
- orion.sidebar.ViewMode
- orion.sites.SiteClient
- orion.sites.SiteConfiguration
- orion.sites.SiteEditor
- orion.sites.SiteService
- orion.sites.ViewOnSiteTree
- orion.status.StatusReportingService
- orion.tasks.TaskList
- orion.TreeModelIterator.TreeModelIterator
- orion.treetable.TableTree
- orion.uiUtils
- orion.URITemplate
- orion.util
- orion.webui.dialogs.OpenResourceDialog
- orion.webui.dialogs.OperationsDialog
- orion.webui.littlelib
- orion.widgets.Section
- orion.widgets.settings.SplitSelectionLayout
- orion.xhr
- orion.xhr.Result
- String

# Class orion.Deferred

Provides abstraction over asynchronous operations.
Defined in: </shared/eclipse/e4/orion/I201306251555/plugins/org.eclipse.orion.client.core/web/orion/Deferred.js>.

Class Summary
Constructor Attributes | Constructor Name and Description
--- | ---
| orion.Deferred() Deferred provides abstraction over asynchronous operations.

Field Summary
Field Attributes | Field Name and Description
--- | ---
| promise The promise exposed by this Deferred.

Method Summary
Method Attributes | Method Name and Description
--- | ---
<static> | orion.Deferred.all(promises, optOnError) Returns a promise that represents the outcome of all the input promises.
| cancel(reason, strict) Cancels this promise.
| progress(update, strict) Notifies listeners of progress on this Deferred.
| reject(error, strict) Rejects this Deferred.
| resolve(value, strict) Resolves this Deferred.
| then(onResolve, onReject, onProgress) Adds handlers to be called on fulfillment or progress of this promise.
<static> | orion.Deferred.when(value, onResolve, onReject, onProgress) Applies callbacks to a promise or to a regular object.

Class Detail
orion.Deferred()
Deferred provides abstraction over asynchronous operations.

Because Deferred implements the orion.Promise interface, a Deferred may be used anywhere a Promise is called for. However, in most such cases it is recommended to use the Deferred's #promise field instead, which exposes a simplified, minimally Promises/A+-compliant interface to callers.

Field Detail
{orion.Promise} promise
The promise exposed by this Deferred.
Method Detail
<static> {orion.Promise} orion.Deferred.all(promises, optOnError)
Returns a promise that represents the outcome of all the input promises.

When `all` is called with a single parameter, the returned promise has eager semantics, meaning that if any input promise rejects, the returned promise immediately rejects, without waiting for the rest of the input promises to fulfill.

To obtain lazy semantics (meaning the returned promise waits for every input promise to fulfill), pass the optional parameter `optOnError`.

Parameters:
{orion.Promise[]} promises
  The input promises.
{Function} optOnError Optional
  Handles a rejected input promise. `optOnError` is invoked for every rejected input promise, and is passed the reason the input promise was rejected.

  `optOnError` can return a value, which allows it to act as a transformer: the return value serves as the final fulfillment value of the rejected promise in the results array generated by `all`.

Returns:
  {orion.Promise} A new promise. The returned promise is generally fulfilled to an `Array` whose elements give the fulfillment values of the input promises.

  However, if an input promise rejects and eager semantics is used, the returned promise will instead be fulfilled to a single error value.

cancel(reason, strict)
Cancels this promise.

Parameters:
{Object} reason
  The reason for canceling this promise.
{Boolean} strict Optional

{orion.Promise} progress(update, strict)
Notifies listeners of progress on this Deferred.

Parameters:
{Object} update
  The progress update.
{Boolean} strict Optional

Returns:
  {orion.Promise}

{orion.Promise} reject(error, strict)
Rejects this Deferred.

Parameters:
{Object} error
{Boolean} strict Optional

Returns:
  {orion.Promise}

{orion.Promise} resolve(value, strict)
Resolves this Deferred.

Parameters:
{Object} value
{Boolean} strict Optional

Returns:
  {orion.Promise}

{orion.Promise} then(onResolve, onReject, onProgress)
Adds handlers to be called on fulfillment or progress of this promise.

Parameters:
{Function} onResolve Optional
  Called when this promise is resolved.
{Function} onReject Optional
  Called when this promise is rejected.
{Function} onProgress Optional
  May be called to report progress events on this promise.

Returns:
  {orion.Promise} A new promise that is fulfilled when the given `onResolve` or `onReject` callback is finished. The callback's return value gives the fulfillment value of the returned promise.

<static> {orion.Promise} orion.Deferred.when(value, onResolve, onReject, onProgress)
Applies callbacks to a promise or to a regular object.

Parameters:
{Object|orion.Promise} value
  Either a orion.Promise, or a normal value.
{Function} onResolve
  Called when the `value` promise is resolved. If `value` is not a promise, this function is called immediately.
{Function} onReject
  Called when the `value` promise is rejected. If `value` is not a promise, this function is never called.
{Function} onProgress
  Called when the `value` promise provides a progress update. If `value` is not a promise, this function is never called.

Returns:
  {orion.Promise} A new promise.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Jun 25 2013 15:58:40 GMT-0400 (EDT)