Function
A Slideshow Widget
Number
The maximum height of an image
Number
The maximum width of an image.
String
The initial title of the SlideShow
String
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?
Boolean
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
Boolean
true/false - make the slideshow loop
Boolean
toggle to enable/disable the visual navigation controls
Array
Contains the DOM nodes that individual images are stored in when loaded or loading.
Number
The number of images to request each time.
Boolean
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.
Boolean
If true, the SlideShow begins playing immediately
Boolean
If true, the widget does not resize itself to fix the displayed image.
Object
Implementation of the dojo.data.api.Read API, which provides data on the images to be displayed.
String
Defines the name of the attribute to request from the store to retrieve the URL to link to from an image, if any.
String
Defines the name of the attribute to request from the store to retrieve the URL to the image.
String
Defines the name of the attribute to request from the store to retrieve the title of the picture, if any.
Number
Time, in seconds, between image transitions during a slideshow.
Number
A counter to keep track of which index image is to be loaded next
DomNode
The temporary image to show when a picture is loading.
Object
Implementation of the dojo.data.api.Request API, which defines the query parameters for accessing the store.
Function
Initilizes the widget, sets up listeners and shows the first image
Function
implementation of the dojo.data.api.Read API. This accesses the image data.
implementation of the dojo.data.api.Request API. This specifies the query and paging information to be used by the data store
An object defining the names of the item attributes to fetch from the data store. The three attributes allowed are 'linkAttr', 'imageLargeAttr' and 'titleAttr'
Sets the data store and request objects to read data from.
Function
Resets the widget to its initial state
Removes all previously loaded images, and clears all caches.
Function
number index in the data store to check if it is loaded.
Returns true if image at the specified index is loaded, false otherwise.
Function
number index in the data store to start loading images from.
If 'autoload' is true, this tells the widget to start loading images from the specified pointer.
Function
Cleans up the widget when it is being destroyed
Function
If true, a slideshow is active, otherwise the slideshow is inactive.
Changes the image being displayed to the next image in the data store
Function
Switches the slideshow mode on and off. If the slideshow is already running, stop it.
Function
Returns the topic id published to when an image is shown
The information published is: index, title and url
Function
Returns the topic id published to when an image finishes loading.
The information published is the index position of the image loaded.
Function
The position of the image in the data store to display
Optional callback function to call when the image has finished displaying.
Shows the image at index 'index'.
Function
If true, the widget is always resized, regardless of the value of 'fixedHeight'
Fits the widget size to the size of the image being shown, or centers the image, depending on the value of 'fixedHeight'
Function
Returns the padding to place at the top of the image to center it vertically.
Function
Load the next unloaded image.
Function
position in the data store to load an image from.
optional function to execute when the image has finished loading.
Load image at specified index
This function loads the image at position 'index' into the internal cache of images. This does not cause the image to be displayed.
Function
Stops a running slide show.
Function
Show the previous image. FIXME: either pull code from showNext/prev, or call it here
Function
Show the next image
Function
Starts a timeout to show the next image when a slide show is active
Function
Calculates the dimensions of the navigation controls
Function
The String title of the image
Sets the title to the image being displayed
Function
The image DOM node to optionally resize
Ensures that the image width and height do not exceed the maximum.
Function
An Event object
Performs navigation on the images based on users mouse clicks
Function
If true, the navigation controls are repositioned even if they are currently visible.
Shows the navigation controls
Function
The DOM Event that triggered this function
Hides the navigation controls
Function
Returns whether the mouse is over the passed element. Element must be display:block (ie, not a <span>) When the page is unloading, if this method runs it will throw an exception.
Function
Object
Object