dojox/image/ThumbnailPicker.js

• Provides:

  • dojox.image.ThumbnailPicker

• Requires:

  • dojox.fx.scroll in common
  • dojo.fx.easing in common
  • dojo.fx in common
  • dijit._Widget in common
  • dijit._Templated in common

• dojox.image.ThumbnailPicker

  • type

    Function

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

    A scrolling Thumbnail Picker widget

• dojox.image.ThumbnailPicker.imageStore

  • type

    Object

  • summary

    A data store that implements the dojo.data Read API.

• dojox.image.ThumbnailPicker.request

  • type

    Object

  • summary

    A dojo.data Read API Request object.

• dojox.image.ThumbnailPicker.size

  • type

    Number

  • summary

    Width or height in pixels, depending if horizontal or vertical.
    
    
    FIXME: use CSS?

• dojox.image.ThumbnailPicker.thumbHeight

  • type

    Number

  • summary

    Default height of a thumbnail image
    
    
    FIXME: use CSS?

• dojox.image.ThumbnailPicker.thumbWidth

  • type

    Number

  • summary

    Default width of an image
    
    
    FIXME: use CSS?

• dojox.image.ThumbnailPicker.useLoadNotifier

  • type

    Boolean

  • summary

    Setting useLoadNotifier to true makes a colored DIV appear under each
    thumbnail image, which is used to display the loading status of each
    image in the data store.

• dojox.image.ThumbnailPicker.useHyperlink

  • type

    boolean

  • summary

    Setting useHyperlink to true causes a click on a thumbnail to open a link.

• dojox.image.ThumbnailPicker.hyperlinkTarget

  • type

    String

  • summary

    If hyperlinkTarget is set to "new", clicking on a thumb will open a new window
    If it is set to anything else, clicking a thumbnail will open the url in the
    current window.

• dojox.image.ThumbnailPicker.isClickable

  • type

    Boolean

  • summary

    When set to true, the cursor over a thumbnail changes.

• dojox.image.ThumbnailPicker.isScrollable

  • type

    Boolean

  • summary

    When true, uses smoothScroll to move between pages

• dojox.image.ThumbnailPicker.isHorizontal

  • type

    Boolean

  • summary

    If true, the thumbnails are displayed horizontally. Otherwise they are displayed
    vertically

• dojox.image.ThumbnailPicker.autoLoad

  • type

    Boolean

• dojox.image.ThumbnailPicker.linkAttr

  • type

    String

  • summary

    The attribute name for accessing the url from the data store

• dojox.image.ThumbnailPicker.imageThumbAttr

  • type

    String

  • summary

    The attribute name for accessing the thumbnail image url from the data store

• dojox.image.ThumbnailPicker.imageLargeAttr

  • type

    String

  • summary

    The attribute name for accessing the large image url from the data store

• dojox.image.ThumbnailPicker.pageSize

  • type

    Number

  • summary

    The number of images to request each time.

• dojox.image.ThumbnailPicker.titleAttr

  • type

    String

  • summary

    The attribute name for accessing the title from the data store

• dojox.image.ThumbnailPicker.templateString

  • type

    Object

• dojox.image.ThumbnailPicker._thumbs

  • type

    Array

• dojox.image.ThumbnailPicker._thumbIndex

  • type

    Number

  • summary

    The index of the first thumbnail shown

• dojox.image.ThumbnailPicker._maxPhotos

  • type

    Number

  • summary

    The total number of photos in the image store

• dojox.image.ThumbnailPicker._loadedImages

  • type

    Object

  • summary

    Stores the indices of images that have been marked as loaded using the
    markImageLoaded function.

• dojox.image.ThumbnailPicker.postCreate

  • summary

    Initializes styles and listeners

  • type

    Function

• dojox.image.ThumbnailPicker.widgetid

• dojox.image.ThumbnailPicker._scrollerSize

  • type

    Number

• dojox.image.ThumbnailPicker._sizeProperty

• dojox.image.ThumbnailPicker._totalSize

  • type

    Number

• dojox.image.ThumbnailPicker.init

  • summary

    Creates DOM nodes for thumbnail images and initializes their listeners

  • type

    Function

• dojox.image.ThumbnailPicker.isInitialized

  • type

    bool

• dojox.image.ThumbnailPicker._offsetAttr

  • type

    String

• dojox.image.ThumbnailPicker._sizeAttr

  • type

    String

• dojox.image.ThumbnailPicker._scrollAttr

  • type

    String

• dojox.image.ThumbnailPicker.getClickTopicName

  • returns

    String

  • summary

    Returns the name of the dojo topic that can be
    subscribed to in order to receive notifications on
    which thumbnail was selected.

  • type

    Function

• dojox.image.ThumbnailPicker.getShowTopicName

  • returns

    String

  • summary

    Returns the name of the dojo topic that can be
    subscribed to in order to receive notifications on
    which thumbnail is now visible

  • type

    Function

• dojox.image.ThumbnailPicker.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 four attributes allowed are 'linkAttr', 'imageLargeAttr',
      'imageThumbAttr' and 'titleAttr'

  • summary

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

  • type

    Function

• dojox.image.ThumbnailPicker.request.start

  • type

    Number

• dojox.image.ThumbnailPicker.request.count

• dojox.image.ThumbnailPicker._loadInProgress

  • type

    Object

• dojox.image.ThumbnailPicker.setDataStore.request

  • type

    An

  • summary

    implementation of the dojo.data.api.Request API. This specifies the
    query and paging information to be used by the data store
    paramNames:
    An object defining the names of the item attributes to fetch from the
    data store.  The four attributes allowed are 'linkAttr', 'imageLargeAttr',
    'imageThumbAttr' and 'titleAttr'

• dojox.image.ThumbnailPicker.reset

  • summary

    Resets the widget back to its original state.

  • type

    Function

• dojox.image.ThumbnailPicker._noImages

  • type

    bool

• dojox.image.ThumbnailPicker.isVisible

  • parameters:
    • index
  • summary

    Returns true if the image at the specified index is currently visible. False otherwise.

  • type

    Function

• dojox.image.ThumbnailPicker.resize

  • parameters:
    • dim
  • type

    Function

• dojox.image.ThumbnailPicker._next

  • summary

    Displays the next page of images

  • type

    Function

• dojox.image.ThumbnailPicker._prev

  • summary

    Displays the next page of images

  • type

    Function

• dojox.image.ThumbnailPicker._checkLoad

  • parameters:
    • img
    • index
  • summary

    Checks if an image is loaded.

  • type

    Function

• dojox.image.ThumbnailPicker._loadingImages

  • type

    Object

• dojox.image.ThumbnailPicker._showThumbs

  • parameters:
    • index: (typeof Number)

      The index of the first thumbnail

  • summary

    Displays thumbnail images, starting at position 'index'

  • type

    Function

• dojox.image.ThumbnailPicker.thumbScroller.scrollLeft

• dojox.image.ThumbnailPicker.thumbScroller.scrollTop

• dojox.image.ThumbnailPicker.markImageLoaded

  • parameters:
    • index
  • summary

    Changes a visual cue to show the image is loaded

  • description

    If 'useLoadNotifier' is set to true, then a visual cue is
    given to state whether the image is loaded or not.	Calling this function
    marks an image as loaded.

  • type

    Function

• dojox.image.ThumbnailPicker._setThumbClass

  • parameters:
    • thumb: (typeof DomNode)

      The thumbnail DOM node to set the class on

    • className: (typeof String)

      The CSS class to add to the DOM node.

  • summary

    Adds a CSS class to a thumbnail, only if 'autoLoad' is true

  • type

    Function

• dojox.image.ThumbnailPicker._loadNextPage

  • summary

    Loads the next page of thumbnail images

  • type

    Function

• dojox.image.ThumbnailPicker.request.onComplete

  • type

    Object

• dojox.image.ThumbnailPicker.request.onError

  • type

    Object

• dojox.image.ThumbnailPicker._loadImage

  • parameters:
    • data
    • index
    • callback
  • summary

    Loads an image.

  • type

    Function

• dojox.image.ThumbnailPicker._updateNavControls

  • summary

    Updates the navigation controls to hide/show them when at
    the first or last images.

  • type

    Function

• dojox.image

  • type

    Object

• dojox

  • type

    Object