Constructordojox.image.SlideShow

dojo.require("dojox.image.SlideShow");
defined in dojox/image/SlideShow.js

A Slideshow Widget

Usage

function ()
parametertypedescription
paramsObjectOptional.
srcNodeRefDomNode|String 

Jump to PropertiesJump to FunctionsConstructorsBack to top

Constructor_loadImage(index, callbackFn)
Load image at specified index

Jump to PropertiesJump to ConstructorsFunctionsBack to top

Construct the UI for this widget from a template, setting this.domNode.
Functionconnect(obj: Object, event: String, method: String|Function)
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Functioncreate(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Kick off the life-cycle of a widget
Functiondestroy(finalize: Boolean)
Overrides dijit._Widget
Cleans up the widget when it is being destroyed
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Functiondisconnect(handles: Object)
Defined by dijit._Widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
Returns the topic id published to when an image finishes loading.
Returns the topic id published to when an image is shown
Defined by dijit._Widget
Return true if this widget can currently be focused and false if not
Returns true if image at the specified index is loaded, false otherwise.
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
If 'autoload' is true, this tells the widget to start loading images from the specified pointer.
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
Overrides dijit._Widget
Initilizes the widget, sets up listeners and shows the first image
Defined by dijit._Widget
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
Functionpostscript(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Resets the widget to its initial state
FunctionsetAttribute(attr: String, value)
Defined by dijit._Widget
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
FunctionsetDataStore(dataStore, request, paramNames)
Sets the data store and request objects to read data from.
FunctionshowImage(index: Number, callback: Function?)
Shows the image at index 'index'.
FunctionshowNextImage(inTimer: Boolean, forceLoop)
Changes the image being displayed to the next image in the data store
Defined by dijit._Widget
Called after a widget's children, and other widgets on the page, have been created. Provides an opportunity to manipulate any children before they are displayed. This is useful for composite widgets that need to control or layout sub-widgets. Many layout widgets can use this as a wiring phase.
Switches the slideshow mode on and off.
Defined by dijit._Widget
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
Function_attachTemplateNodes(rootNode: DomNode, getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Calculates the dimensions of the navigation controls
Defined by dijit._Templated
relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
Ensures that the image width and height do not exceed the maximum.
Function_fitSize(force: Boolean)
Fits the widget size to the size of the image being shown, or centers the image, depending on the value of 'fixedHeight'
Performs navigation on the images based on users mouse clicks
Hides the navigation controls
Load the next unloaded image.
Show the next image
Defined by dijit._Widget
Defined by dijit._Widget
Function_overElement(element: DomNode, e)
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.
Show the previous image. FIXME: either pull code from showNext/prev, or call it here
Function_setTitle(title: String)
Sets the title of the image to be displayed
Function_showNav(force: Boolean)
Shows the navigation controls
Starts a timeout to show the next image when a slide show is active
Stops a running slide show.
Defined by dijit._Templated

Jump to FunctionsJump to ConstructorsPropertiesBack to top

Defined by dijit._Widget
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
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.
If true, the SlideShow begins playing immediately
Defined by dijit._Widget
HTML class attribute
Defined by dijit._Templated
holds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
If true, the widget does not resize itself to fix the displayed image.
toggle to enable/disable the visual navigation controls
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
Defines the name of the attribute to request from the store to retrieve the URL to the image.
Contains the DOM nodes that individual images are stored in when loaded or loading.
Implementation of the dojo.data.api.Read API, which provides data on the images to be displayed.
The maximum width of an image.
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Defines the name of the attribute to request from the store to retrieve the URL to link to from an image, if any.
true/false - make the slideshow loop
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
The number of images to request each time.
Time, in seconds, between image transitions during a slideshow.
Defined by dijit._Widget
pointer to original dom node
Defined by dijit._Widget
HTML style attribute
Defined by dijit._Templated
a node that represents the widget template. Pre-empts both templateString and templatePath.
Overrides dijit._Templated
Path to template (HTML file) for this widget relative to dojo.baseUrl
Defined by dijit._Templated
a string that represents the widget template. Pre-empts the
Overrides dijit._Widget
the picture, if any.
Defines the name of the attribute to request from the store to retrieve the
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?
Defined by dijit._Templated
should we parse the template to find widgets that might be declared in markup inside it? false by default.
A counter to keep track of which index image is to be loaded next
Defined by dijit._Widget
Implementation of the dojo.data.api.Request API, which defines the query parameters for accessing the store.
URL to the image to display when an image is not yet fully loaded.
The temporary image to show when a picture is loading.