CKEDITOR.plugins.imagebase.progressReporter
class
This is the base type for progress reporters.
A progress reporter can be updated:
- Automatically, by binding it to an existing CKEDITOR.fileTools.fileLoader instance.
- Manually, using the updated, done, failed and aborted methods.
Filtering
Properties
-
wrapper : element
CKEDITOR.plugins.imagebase.progressReporter#wrapper
An element created for wrapping the progress bar.
Methods
-
constructor( [ wrapperHtml ] ) → progressReporter
CKEDITOR.plugins.imagebase.progressReporter#constructor
Parameters
[ wrapperHtml ] : String
-
Defaults to
'<div class="cke_loader"></div>'
Returns
progressReporter
-
aborted()
CKEDITOR.plugins.imagebase.progressReporter#aborted
Marks the progress reporter as aborted.
-
bindLoader( loader )
CKEDITOR.plugins.imagebase.progressReporter#bindLoader
Binds this progress reporter to a given
loader
.It will automatically remove its listeners when the
loader
has triggered one of the following events:- CKEDITOR.fileTools.fileLoader.abort
- CKEDITOR.fileTools.fileLoader.error
- CKEDITOR.fileTools.fileLoader.uploaded
Parameters
loader : fileLoader
The loader that should be observed.
-
done()
CKEDITOR.plugins.imagebase.progressReporter#done
Marks the progress reporter as complete.
-
failed()
CKEDITOR.plugins.imagebase.progressReporter#failed
Marks the progress reporter as failed.
-
remove()
CKEDITOR.plugins.imagebase.progressReporter#remove
Removes the progress reporter from the DOM.
-
updated( progress )
CKEDITOR.plugins.imagebase.progressReporter#updated
Method to be called in order to refresh the progress.
Parameters
progress : Number
Progress representation where
1.0
means "complete" and0
means "no progress".