dojox/image/SlideShow.js

• Provides:

  • dojox.image.SlideShow

• Requires:

  • dojo.string in common
  • dojo.fx in common
  • dijit._Widget in common
  • dijit._Templated in common

• dojox.image.SlideShow

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    A Slideshow Widget

• dojox.image.SlideShow.imageHeight

  • type

    Number

  • summary

    The maximum height of an image

• dojox.image.SlideShow.imageWidth

  • type

    Number

  • summary

    The maximum width of an image.

• dojox.image.SlideShow.title

  • type

    String

  • summary

    The initial title of the SlideShow

• dojox.image.SlideShow.titleTemplate

  • type

    String

  • summary

    a way to customize the wording in the title. supported parameters to be populated are:
    ${title} = the passed title of the image
    ${current} = the current index of the image
    ${total} = the total number of images in the SlideShow
    
    should add more?

• dojox.image.SlideShow.noLink

  • type

    Boolean

  • summary

    Prevents the slideshow from putting an anchor link around the displayed image
    enables if true, though still will not link in absence of a url to link to

• dojox.image.SlideShow.loop

  • type

    Boolean

  • summary

    true/false - make the slideshow loop

• dojox.image.SlideShow.hasNav

  • type

    Boolean

  • summary

    toggle to enable/disable the visual navigation controls

• dojox.image.SlideShow.images

  • type

    Array

  • summary

    Contains the DOM nodes that individual images are stored in when loaded or loading.

• dojox.image.SlideShow.pageSize

  • type

    Number

  • summary

    The number of images to request each time.

• dojox.image.SlideShow.autoLoad

  • type

    Boolean

  • summary

    If true, then images are preloaded, before the user navigates to view them.
    If false, an image is not loaded until the user views it.

• dojox.image.SlideShow.autoStart

  • type

    Boolean

  • summary

    If true, the SlideShow begins playing immediately

• dojox.image.SlideShow.fixedHeight

  • type

    Boolean

  • summary

    If true, the widget does not resize itself to fix the displayed image.

• dojox.image.SlideShow.imageStore

  • type

    Object

  • summary

    Implementation of the dojo.data.api.Read API, which provides data on the images
    to be displayed.

• dojox.image.SlideShow.linkAttr

  • type

    String

  • summary

    Defines the name of the attribute to request from the store to retrieve the
    URL to link to from an image, if any.

• dojox.image.SlideShow.imageLargeAttr

  • type

    String

  • summary

    Defines the name of the attribute to request from the store to retrieve the
    URL to the image.

• dojox.image.SlideShow.titleAttr

  • type

    String

  • summary

    Defines the name of the attribute to request from the store to retrieve the
    title of the picture, if any.

• dojox.image.SlideShow.slideshowInterval

  • type

    Number

  • summary

    Time, in seconds, between image transitions during a slideshow.

• dojox.image.SlideShow.templateString

  • type

    Object

• dojox.image.SlideShow._imageCounter

  • type

    Number

  • summary

    A counter to keep track of which index image is to be loaded next

• dojox.image.SlideShow._tmpImage

  • type

    DomNode

  • summary

    The temporary image to show when a picture is loading.

• dojox.image.SlideShow._request

  • type

    Object

  • summary

    Implementation of the dojo.data.api.Request API, which defines the query
    parameters for accessing the store.

• dojox.image.SlideShow.postCreate

  • summary

    Initilizes the widget, sets up listeners and shows the first image

  • type

    Function

• dojox.image.SlideShow.outerNode.style.width

  • type

    String

• dojox.image.SlideShow._currentImage

• dojox.image.SlideShow.setDataStore

  • parameters:
    • dataStore: (typeof An)

      implementation of the dojo.data.api.Read API. This accesses the image
      data.

    • request: (typeof An)

      implementation of the dojo.data.api.Request API. This specifies the
      query and paging information to be used by the data store

    • paramNames: (typeof optional)

      An object defining the names of the item attributes to fetch from the
      data store.  The three attributes allowed are 'linkAttr', 'imageLargeAttr' and 'titleAttr'

  • summary

    Sets the data store and request objects to read data from.

  • type

    Function

• dojox.image.SlideShow._request.onComplete

  • parameters:
    • items
  • type

    Function

• dojox.image.SlideShow._request.start

  • type

    Number

• dojox.image.SlideShow.reset

  • summary

    Resets the widget to its initial state

  • description

    Removes all previously loaded images, and clears all caches.

  • type

    Function

• dojox.image.SlideShow.isInitialized

  • type

    bool

• dojox.image.SlideShow.isImageLoaded

  • parameters:
    • index: (typeof The)

      number index in the data store to check if it is loaded.

  • summary

    Returns true if image at the specified index is loaded, false otherwise.

  • type

    Function

• dojox.image.SlideShow.moveImageLoadingPointer

  • parameters:
    • index: (typeof The)

      number index in the data store to start loading images from.

  • summary

    If 'autoload' is true, this tells the widget to start loading
    images from the specified pointer.

  • type

    Function

• dojox.image.SlideShow.destroy

  • summary

    Cleans up the widget when it is being destroyed

  • type

    Function

• dojox.image.SlideShow.showNextImage

  • parameters:
    • inTimer: (typeof Boolean)

      If true, a slideshow is active, otherwise the slideshow is inactive.

    • forceLoop
  • summary

    Changes the image being displayed to the next image in the data store

  • type

    Function

• dojox.image.SlideShow.imageIndex

  • type

    Number

• dojox.image.SlideShow.toggleSlideShow

  • summary

    Switches the slideshow mode on and off.

  • type

    Function

• dojox.image.SlideShow._timerCancelled

  • type

    Object

• dojox.image.SlideShow.getShowTopicName

  • summary

    Returns the topic id published to when an image is shown

  • description

    The information published is: index, title and url

  • type

    Function

• dojox.image.SlideShow.getLoadTopicName

  • summary

    Returns the topic id published to when an image finishes loading.

  • description

    The information published is the index position of the image loaded.

  • type

    Function

• dojox.image.SlideShow.showImage

  • parameters:
    • index: (typeof Number)

      The position of the image in the data store to display

    • callback: (typeof Function)

      Optional callback function to call when the image has finished displaying.

  • summary

    Shows the image at index 'index'.

  • type

    Function

• dojox.image.SlideShow._fitSize

  • parameters:
    • force: (typeof Boolean)

      If true, the widget is always resized, regardless of the value of 'fixedHeight'

  • summary

    Fits the widget size to the size of the image being shown,
    or centers the image, depending on the value of 'fixedHeight'

  • type

    Function

• dojox.image.SlideShow._getTopPadding

  • summary

    Returns the padding to place at the top of the image to center it vertically.

  • type

    Function

• dojox.image.SlideShow._loadNextImage

  • summary

    Load the next unloaded image.

  • type

    Function

• dojox.image.SlideShow._loadImage

  • parameters:
    • index: (typeof The)

      position in the data store to load an image from.

    • callbackFn: (typeof An)

      optional function to execute when the image has finished loading.

  • summary

    Load image at specified index

  • description

    This function loads the image at position 'index' into the
    internal cache of images.  This does not cause the image to be displayed.

  • type

    Function

• dojox.image.SlideShow._stop

  • summary

    Stops a running slide show.

  • type

    Function

• dojox.image.SlideShow._slideId

  • type

    Object

• dojox.image.SlideShow._prev

  • summary

    Show the previous image.
    FIXME: either pull code from showNext/prev, or call it here

  • type

    Function

• dojox.image.SlideShow._next

  • summary

    Show the next image

  • type

    Function

• dojox.image.SlideShow._startTimer

  • summary

    Starts a timeout to show the next image when a slide show is active

  • type

    Function

• dojox.image.SlideShow.id

• dojox.image.SlideShow._calcNavDimensions

  • summary

    Calculates the dimensions of the navigation controls

  • type

    Function

• dojox.image.SlideShow.navPlay._size

  • type

    Object

• dojox.image.SlideShow.navPrev._size

  • type

    Object

• dojox.image.SlideShow.navNext._size

  • type

    Object

• dojox.image.SlideShow._setTitle

  • parameters:
    • title: (typeof String)

      The String title of the image

  • summary

    Sets the title to the image being displayed

  • type

    Function

• dojox.image.SlideShow.titleNode.innerHTML

  • type

    Object

• dojox.image.SlideShow._fitImage

  • parameters:
    • img: (typeof Node)

      The image DOM node to optionally resize

  • summary

    Ensures that the image width and height do not exceed the maximum.

  • type

    Function

• dojox.image.SlideShow._handleClick

  • parameters:
    • e: (typeof Event)

      An Event object

  • summary

    Performs navigation on the images based on users mouse clicks

  • type

    Function

• dojox.image.SlideShow._showNav

  • parameters:
    • force: (typeof Boolean)

      If true, the navigation controls are repositioned even if they are
      currently visible.

  • summary

    Shows the navigation controls

  • type

    Function

• dojox.image.SlideShow._navAnim

  • type

    Object

• dojox.image.SlideShow._navShowing

  • type

    bool

• dojox.image.SlideShow._hideNav

  • parameters:
    • e: (typeof Event)

      The DOM Event that triggered this function

  • summary

    Hides the navigation controls

  • type

    Function

• dojox.image.SlideShow._overElement

  • parameters:
    • element: (typeof DomNode)
    • e: (typeof Event)
  • summary

    Returns whether the mouse is over the passed element.
    Element must be display:block (ie, not a <span>)

  • type

    Function

• dojox.image

  • type

    Object

• dojox

  • type

    Object