dojox/mobile/bookmarkable (version 1.10)

Summary

Utilities to make the view transitions bookmarkable.

See the dojox/mobile/bookmarkable reference documentation for more information.

Property Summary

  • settingHashWhether the browser URL needs to be updated to include the hash.
  • transitionInfoAn array containing information about the transition.

Method Summary

  • addTransitionInfo(fromViewId,toViewId,args) Adds transition information.
  • findTransitionViews(moveTo) Searches for a starting view and a destination view.
  • getTransitionInfo(fromViewId,toViewId) Returns an array containing the transition information.
  • handleFragIds(fragIds) Analyzes the given hash (fragment id).
  • setFragIds(toView) Updates the hash (fragment id) in the browser URL.

Event Summary

Properties

settingHash

Whether the browser URL needs to be updated to include the hash.

transitionInfo

An array containing information about the transition.

Methods

addTransitionInfo(fromViewId,toViewId,args)

Adds transition information.

Parameter Type Description
fromViewId String
toViewId String
args Object
findTransitionViews(moveTo)

Searches for a starting view and a destination view.

Parameter Type Description
moveTo String
Returns:Array
getTransitionInfo(fromViewId,toViewId)

Returns an array containing the transition information.

Parameter Type Description
fromViewId String
toViewId String
Returns:undefined
handleFragIds(fragIds)

Analyzes the given hash (fragment id).

Given a comma-separated list of view IDs, this method searches for a transition destination, and makes all the views in the hash visible.

Parameter Type Description
fragIds String
Returns:object
setFragIds(toView)

Updates the hash (fragment id) in the browser URL.

The hash value consists of one or more visible view ids separated with commas.

Parameter Type Description
toView Widget

Events

onHashChange(value)

Called on "/dojo/hashchange" events.

Parameter Type Description
value undefined
Error in the documentation? Can’t find what you are looking for? Let us know!