Control the running of a app.Screensaver
- Source:
Members
-
<private, static, constant> _VARS :Object
-
Instance variables
Type:
- Object
- Source:
Properties:
Name Type Description startedboolean true if slideshow started
replaceIdxint page to replace with next photo
lastSelectedint last selected page
waitTimeint wait time when looking for photo in milliSecs
interactiveboolean is interaction allowed
pausedboolean is screensaver paused
timeOutIdnumber id of setTimeout
Methods
-
<private, static> _restart( [newIdx])
-
Restart the slideshow
Parameters:
Name Type Argument Default Description newIdxint <optional>
<nullable>
null optional idx to use for current idx
- Source:
-
<private, static> _runShow( [newIdx])
-
Self called at fixed time intervals to cycle through the photos
Parameters:
Name Type Argument Default Description newIdxint <optional>
<nullable>
null override selected
- Source:
-
<private, static> _step( [newIdx])
-
Increment the slide show manually
Parameters:
Name Type Argument Default Description newIdxint <optional>
<nullable>
null optional idx to use for current idx
- Source:
-
<private, static> _stop()
-
Stop the animation
- Source:
-
<static> back()
-
Backup one slide
- Source:
-
<static> forward()
-
Forward one slide
- Source:
-
<static> getWaitTime() → {int}
-
Get wait time between _runShow calls
- Source:
Returns:
current wait time
- Type
- int
-
<static> isCurrentPair(idx) → {boolean}
-
Is the given idx a part of the current animation pair
Parameters:
Name Type Description idxint index into app.SSViews
- Source:
Returns:
if selected or last selected
- Type
- boolean
-
<static> isInteractive() → {boolean}
-
Is interactive mode allowed
- Source:
Returns:
true if allowed
- Type
- boolean
-
<static> isPaused() → {boolean}
-
Are we paused
- Source:
Returns:
true if paused
- Type
- boolean
-
<static> isStarted() → {boolean}
-
Has the first page run
- Source:
Returns:
if animation has started
- Type
- boolean
-
<static> setLastSelected(lastSelected)
-
Set last selected index
Parameters:
Name Type Description lastSelectedint last index in app.SSViews
- Source:
-
<static> setReplaceIdx(idx)
-
Set last selected index
Parameters:
Name Type Description idxint replace index in app.SSViews
- Source:
-
<static> setWaitTime(waitTime)
-
Set wait time between _runShow calls in milliSecs
Parameters:
Name Type Description waitTimeint wait time for next attempt to get photo
- Source:
-
<static> start( [delay])
-
Start the slideshow
Parameters:
Name Type Argument Default Description delayint <optional>
2000 delay before start
- Source:
-
<static> togglePaused( [newIdx])
-
Toggle paused state of the slideshow
Parameters:
Name Type Argument Default Description newIdxint <optional>
<nullable>
null optional idx to use for current idx
- Source: