Class Index | File Index

Classes


Class orion.status.StatusReportingService

Service for reporting status
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.ui/web/orion/status.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.status.StatusReportingService(serviceRegistry, operationsClient, domId, progressDomId)
Service for reporting status
Method Summary
Method Attributes Method Name and Description
 
 
createProgressMonitor(deferred, message)
Creates a ProgressMonitor that will be displayed on the status area.
 
setCancelFunction(cancelFunc)
Set a callback function for a cancellation, which can be triggered by the close button
 
Displays an error message to the user.
 
setMessage(msg, timeout, isAccessible)
Displays a status message to the user.
 
Set a message that will be shown in the progress reporting area on the page.
 
setProgressResult(message, cancelMsg)
Set a message that indicates that a long-running (progress) operation is complete.
 
showWhile(deferred, message)
Shows a progress message in the progress area until the given deferred is resolved.
Class Detail
orion.status.StatusReportingService(serviceRegistry, operationsClient, domId, progressDomId)
Service for reporting status
Parameters:
{orion.serviceregistry.ServiceRegistry} serviceRegistry
{orion.operationclient.OperationsClient} operationsClient
{String} domId
ID of the DOM node under which status will be displayed.
{String} progressDomId
ID of the DOM node used to display progress messages.
Method Detail
close()

{ProgressMonitor} createProgressMonitor(deferred, message)
Creates a ProgressMonitor that will be displayed on the status area.
Parameters:
{Deferred} deferred
[optional] that updates this monitor
{String} message
[optional] messaged to be shown until deferred is not resolved
Returns:
{ProgressMonitor}

setCancelFunction(cancelFunc)
Set a callback function for a cancellation, which can be triggered by the close button
Parameters:
{Function} cancelFunc
The callback back function for the cancellation.

setErrorMessage(st)
Displays an error message to the user.
Parameters:
{String|orionError} st
The error to display. Can be a simple String, or an error object from a XHR error callback, or the body of an error response from the Orion server.

setMessage(msg, timeout, isAccessible)
Displays a status message to the user.
Parameters:
{String} msg
Message to display.
{Number} timeout Optional
Time to display the message before hiding it.
{Boolean} isAccessible Optional
If true, a screen reader will read this message. Otherwise defaults to the domNode default.

setProgressMessage(message)
Set a message that will be shown in the progress reporting area on the page.
Parameters:
{String} message
The progress message to display.

setProgressResult(message, cancelMsg)
Set a message that indicates that a long-running (progress) operation is complete.
Parameters:
{String|orionError} message
The error to display. Can be a simple String, or an error object from a XHR error callback, or the body of an error response from the Orion server.
cancelMsg

showWhile(deferred, message)
Shows a progress message in the progress area until the given deferred is resolved.
Parameters:
deferred
message

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Mar 17 2017 08:51:36 GMT-0400 (EDT)