Class Index | File Index

Classes


Class AjaxSolr.ParameterHistoryStore


Extends AjaxSolr.ParameterStore.
ParameterHistoryStore
Defined in: ParameterHistoryStore.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
A parameter store that stores the values of exposed parameters in the URL via History.js to maintain the application's state.
Method Summary
Method Attributes Method Name and Description
 
init()
 
save()
Stores the values of the exposed parameters in both the local hash and History.js No other code should be made to change these two values.
 
Called when History.js detects a state change.
 
Methods borrowed from class AjaxSolr.ParameterStore:
add, addByValue, constructor, exposedReset, exposedString, find, get, isMultiple, load, parseString, remove, removeByValue, string, values
Class Detail
AjaxSolr.ParameterHistoryStore()
A parameter store that stores the values of exposed parameters in the URL via History.js to maintain the application's state. This uses the HTML5 History API for newer browsers, and falls back to using the hash in older browsers. Don't forget to add the following (or similar) inside your head tag:

Configure the manager with:
Manager.setStore(new AjaxSolr.ParameterHistoryStore());
See:
https://github.com/browserstate/history.js
http://www.whatwg.org/specs/web-apps/current-work/multipage/history.html
Method Detail
init()

save()
Stores the values of the exposed parameters in both the local hash and History.js No other code should be made to change these two values.

stateChangeFunction(self)
Called when History.js detects a state change. Checks if state is different to previous state, and if so, sends a request to Solr. This needs to check if the state has changed since it also gets called when we call pushState above.
Parameters:
self

storedString()
See:
ParameterStore#storedString()

Documentation generated by JsDoc Toolkit 2.3.0 on Mon Apr 29 2013 14:55:21 GMT-0400 (EDT)