jsdoc

$.ui.simplicityState

Namespace $.ui.simplicityState

State widget used to gather current selection from multiple input elements
Defined in: ui.simplicityState.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityState.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityState.mergeQueryParams()
Reads the state from the current query string and merges it into the current state.
<static>  
$.ui.simplicityState.reset()
Resets the current state by sending out a simplicityStateReset event which allows any listening widgets to clear out their parameters.
<static>  
$.ui.simplicityState.state(state, triggerChangeEventStyle)
Get or retrieve the current state.
<static>  
$.ui.simplicityState.triggerChangeEvent()
Triggers a simplicityStateChange event with the current state.
Namespace Detail
$.ui.simplicityState
  $('body').simplicityState();
  // Create all simplicityInputs widgets
  $('body')
    .simplicityState('mergeQueryParams')
    .simplicityHistory()
    .simplicityState('triggerChangeEvent')
    .simplicityPageSnapBack()
    .simplicityDiscoverySearch({
      url: '/my_search_controller.php'
    })
    .simplicityDiscoverySearch('search');
Field Detail
<static> $.ui.simplicityState.options
Widget options.
initialState
The initial state of this widget. Defaults to {}.
debug
Enable logging of key events to console.log. Defaults to false.
Method Detail
<static> $.ui.simplicityState.mergeQueryParams()
Reads the state from the current query string and merges it into the current state. Usually called on initial page load.

<static> $.ui.simplicityState.reset()
Resets the current state by sending out a simplicityStateReset event which allows any listening widgets to clear out their parameters.

<static> $.ui.simplicityState.state(state, triggerChangeEventStyle)
Get or retrieve the current state. Returning the state when called with no arguments and setting it otherwise.
Parameters:
state
The new state
triggerChangeEventStyle
Style used to determine when to trigger a simplicityStateChangeEvent. Defaults to undefined. Valid styles are:
undefined
trigger if changed
true
always trigger
false
never trigger

<static> $.ui.simplicityState.triggerChangeEvent()
Triggers a simplicityStateChange event with the current state. Usually called on initial page load.

Documentation generated by JsDoc Toolkit 2.4.0