Class TKSlideshowController
Extends
TKController
.
A slideshow controller plays through a collection of slides, also allowing to control the playback state and position of the slideshow. Control buttons are easily wired and remote-based navigation is completely automated.
Defined in: SlideshowController.js.
Constructor Attributes | Constructor Name and Description |
---|---|
TKSlideshowController (data)
|
Field Attributes | Field Name and Description |
---|---|
Indicates the index of the current slide.
|
|
Indicates the duration in milliseconds each slide remains on screen.
|
|
Indicates whether the slideshow loops through for constant playback.
|
|
A CSS selector matching a button to be used as the button to increment the
currentSlideIndex . |
|
Indicates how many slides total are in the slideshow.
|
|
Indicates the current playback state of the slideshow, defaults to
true . |
|
A CSS selector matching a button to be used as the button to decrement the
currentSlideIndex . |
|
The set of properties used to set up the contents of the page slider.
|
|
A CSS selector matching a button to be used as the button to control the playback state.
|
- Fields borrowed from class
TKController
: actions
,backButton
,becomesActiveTransition
,becomesInactiveTransition
,id
,navigableElements
,navigatesTo
,outlets
,parentController
,preloads
,scrollableElement
,template
Method Attributes | Method Name and Description |
---|---|
Triggered when the playback state has changed.
|
|
slideDidChange (index)
Triggered when the
currentSlideIndex property has changed. |
|
styleForSlideAtIndex (index)
This method allows to provide custom style rules for a slide programatically any time the
currentSlideIndex property changes. |
- Methods borrowed from class
TKController
: addNavigableElement
,customMetricsForElement
,elementWasActivated
,elementWasHighlighted
,elementWasHovered
,elementWasUnhighlighted
,elementWasUnhovered
,handleEvent
,isDescendentOfController
,isViewLoaded
,keyWasPressed
,preferredElementToHighlightInDirection
,processView
,removeNavigableElement
,viewDidAppear
,viewDidDisappear
,viewDidLoad
,viewWasInsertedIntoDocument
,viewWillAppear
,viewWillDisappear
,wantsToHandleKey
- Methods borrowed from class
TKObject
: addPropertyObserver
,callMethodNameAfterDelay
,callSuper
,notifyPropertyChange
,removePropertyObserver
Class Detail
TKSlideshowController(data)
- Parameters:
- {Object} data
- A hash of properties to use as this object is initialized.
- Since:
- TuneKit 1.0
Field Detail
{int}
currentSlideIndex
Indicates the index of the current slide.
{int}
interval
Indicates the duration in milliseconds each slide remains on screen.
{bool}
loops
Indicates whether the slideshow loops through for constant playback. Defaults to
true
.
{String}
nextSlideButton
A CSS selector matching a button to be used as the button to increment the
currentSlideIndex
.
{int}
numberOfSlides
Indicates how many slides total are in the slideshow.
{bool}
playing
Indicates the current playback state of the slideshow, defaults to
true
.
{String}
previousSlideButton
A CSS selector matching a button to be used as the button to decrement the
currentSlideIndex
.
{
TKSlidingViewData
}
slidingViewData
The set of properties used to set up the contents of the page slider.
{String}
togglePlaybackButton
A CSS selector matching a button to be used as the button to control the playback state.
Method Detail
playbackStateDidChange()
Triggered when the playback state has changed.
slideDidChange(index)
Triggered when the
currentSlideIndex
property has changed.
- Parameters:
- {int} index
- The index of the current slide.
styleForSlideAtIndex(index)
This method allows to provide custom style rules for a slide programatically any time the
currentSlideIndex
property changes. The values in this
array are expected to be individual two-value arrays, where the first index holds the CSS property name, and the second index its value.
- Parameters:
- {Array} index
- The index of the slide for which we are trying to obtain custom styles.