jsdoc

$.ui.simplicityInputs

Namespace $.ui.simplicityInputs

An input element that has 2-way state sync support. This widget should either be applied directly to an input or to any DOM element that contains inputs. Most Simplicity widgets that gather or record user selections require to be bound to a simplicity widget. The values of the bound simplicityInputs are managed by a simplicityState widget.
Defined in: ui.simplicityInputs.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityInputs.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<private> <static>  
$.ui.simplicityInputs._changeHandler()
Handler for change events.
<private> <static>  
$.ui.simplicityInputs._reset()
Implementation of reset, used by reset and _stateResetHandler.
<private> <static>  
$.ui.simplicityInputs._stateChangeHandler()
Handler for simplicityStateChange events.
<private> <static>  
$.ui.simplicityInputs._stateResetHandler()
Handler for simplicityStateReset events.
<static>  
$.ui.simplicityInputs.inputs()
Returns the wrapped input or inputs.
<static>  
$.ui.simplicityInputs.reset()
Resets the input(s) to an empty state by altering the current state and triggering a state change.
Namespace Detail
$.ui.simplicityInputs
Field Detail
<static> $.ui.simplicityInputs.options
Widget options.
stateElement
The location of the simplicityState widget. Defaults to 'body'.
changeEvent
The event to bind when listening for change events. Defaults to 'change'.
handleChildChange
When this widget is attached to a non-input element this option decides whether change events from child elements are handled. When true they are processed causing the state to change. When false they are not processed and the event is terminated so that it no longer bubbles up the DOM. Defaults to true. Prior to release 3.2 this option defaulted to false.
quietStateChange
When set to true cause change events to not propagate past the simplicityState widget. This allows for incremental, partial updates of the shared state. Defaults to false.
exportStateOnCreate
If the underlying input has a non empty state, export that to the simplicityState widget. Defaults to true.
supportsReset
When truesimplicityStateReset event to remove it's parameter from the state object. Defaults to true.
trim
When true causes leading and trailing whitespace to be removed from the wrapped input(s) value when applying it to the state. Defaults to true.
debug
Enable logging of key events to console.log. Defaults to false.
Method Detail
<private> <static> $.ui.simplicityInputs._changeHandler()
Handler for change events. When the underlying input is changed this handler updates the state of the associated simplicityState widget with this data.

<private> <static> $.ui.simplicityInputs._reset()
Implementation of reset, used by reset and _stateResetHandler.

<private> <static> $.ui.simplicityInputs._stateChangeHandler()
Handler for simplicityStateChange events. When the associated simplicityState widget gets a new state this handler updates the underlying input to reflect the new state.

<private> <static> $.ui.simplicityInputs._stateResetHandler()
Handler for simplicityStateReset events. When the option supportsReset is true this handler will reset the bound parameters.

<static> $.ui.simplicityInputs.inputs()
Returns the wrapped input or inputs.

<static> $.ui.simplicityInputs.reset()
Resets the input(s) to an empty state by altering the current state and triggering a state change.

Documentation generated by JsDoc Toolkit 2.4.0