Class CAF.Progress
Object
|
+--CAF.Progress
- class
CAF.Progress
CAF Progress bar utilities.
Defined in hidden.js
Method Summary |
<static> void
|
hide(element)
Hides the progress bar that's been shown over the specified element.
|
<static> void
|
hideAll(element)
Hides the progress bar that's been shown over the specified element and everything
else having a separate progress bar within the element.
|
<static> Object
|
hideFns(id)
|
<static> void
|
insert(element, msg, showEffect, hideEffect)
Replaces the content of the specified element with a progress dialog.
|
<static> void
|
overlay(element, msg, showEffect, hideEffect)
Overlays a progress dialog over the specified element.
|
<static> void
|
show(element, msg, showEffect, hideEffect)
Shows a progress dialog over the specified element,
dynamically deciding whether to overlay or inject the progress bar.
|
CAF.Progress
CAF.Progress()
hide
<static> void hide(element)
Hides the progress bar that's been shown over the specified element.
Parameters:
element
- Element or id of element over which to hide progress bar.
hideAll
<static> void hideAll(element)
Hides the progress bar that's been shown over the specified element and everything
else having a separate progress bar within the element.
Parameters:
element
- Element or id of element over which to hide progress bar.
hideFns
<static> Object hideFns(id)
insert
<static> void insert(element, msg, showEffect, hideEffect)
Replaces the content of the specified element with a progress dialog.
Parameters:
element
- Element or id of element over which to show progress bar.
msg
- (optional) Progress message.
showEffect
- (optional) Effect function to use to show progress bar. Takes one CAF.Progress.argument = the;dom element to show.
hideEffect
- (optional) Effect function to use to hide progress bar. Takes one CAF.Progress.argument = the;dom element to hide.
overlay
<static> void overlay(element, msg, showEffect, hideEffect)
Overlays a progress dialog over the specified element.
Parameters:
element
- Element or id of element over which to show progress bar.
msg
- (optional) Progress message.
showEffect
- (optional) Effect function to use to show progress bar. Takes one CAF.Progress.argument = the;dom element to show.
hideEffect
- (optional) Effect function to use to hide progress bar. Takes one CAF.Progress.argument = the;dom element to hide.
show
<static> void show(element, msg, showEffect, hideEffect)
Shows a progress dialog over the specified element,
dynamically deciding whether to overlay or inject the progress bar.
Parameters:
element
- Element or id of element over which to show progress bar.
msg
- (optional) Progress message.
showEffect
- (optional) Effect function to use to show progress bar. Takes one CAF.Progress.argument = the;dom element to show.
hideEffect
- (optional) Effect function to use to hide progress bar. Takes one CAF.Progress.argument = the;dom element to hide.
Documentation generated by
JSDoc on Mon Aug 30 14:56:06 2021