Module: alfresco/notifications/ProgressIndicator

alfresco/notifications/ProgressIndicator

A progress indicator.
Since:
  • 1.0.71
Author:
  • Martin Doyle
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Members

_scrollbarWidth :number

The scrollbar width for this browser-environment
Type:
  • number
Default Value:
  • null
Source:

baseClass :string

The base CSS class for the widget
Type:
  • string
Default Value:
  • "alfresco-notifications-ProgressIndicator"
Source:

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/ProgressIndicator.css"}]
Source:

destroyAfterHideMs :number

How many milliseconds to wait before destroying this widget after the indicator has been hidden
Type:
  • number
Default Value:
  • 500
Source:

destroyDeferred :object

Variable to hold the Deferred object that will resolve once this notification is destroyed
Type:
  • object
Default Value:
  • null
Source:

i18nRequirements :object[]

An array of the i18n files to use with this widget.
Type:
  • object[]
Default Value:
  • [{i18nFile: "./i18n/ProgressIndicator.properties"}]
Source:

id :String

The notification ID (helps with customisation)
Type:
  • String
Default Value:
  • null
Source:

loadingMessage :string

The loading message text
Type:
  • string
Default Value:
  • "progress-indicator.loading-message"
Source:

templateString :String

The HTML template to use for the widget.
Type:
  • String
Source:

Methods

_getScrollbarWidth() → {number}

Get the scrollbar width for the current browser environment. This is cached after first retrieval for faster access.
Source:
Returns:
The scrollbar width
Type
number

destroy()

Called when widget is destroyed
Source:

<private> hide() → {Object}

Hide the progress indicator (and destroy it)
Source:
Returns:
A promise that will be resolved when this widget has been destroyed
Type
Object

onCloseClick(evt)

Handle clicks on the close button.
Parameters:
Name Type Description
evt Object The Dojo-normalised event object
Source:

onKeyPress(evt)

Handle keypresses on the document.
Parameters:
Name Type Description
evt Object The Dojo-normalised event object
Source:

postCreate()

Called after widget created, but not sub-widgets
Source:

postMixInProperties()

This is run after the properties have been mixed in, but before the widget is created.
Source: