dojox/form/ListInput.js

• Provides:

  • dojox.form.ListInput

• Requires:

  • dijit.form._FormWidget in common
  • dijit.form.ValidationTextBox in common
  • dijit.InlineEditBox in common

• dojox.form.ListInput

  • type

    Function

  • chains:
    • dijit.form._FormValueWidget: (prototype)
    • dijit.form._FormValueWidget: (call)
  • summary

    An automatic list maker

  • description

    you can add value to list with add method.
    you can only remove by clicking close button

• dojox.form.ListInput.constructor

  • constructor - constructor
  • type

    Function

• dojox.form.ListInput.inputClass

  • type

    String

  • summary

    Class which will be used to create the input box. You can implements yours.
    It must be a widget, focusNode or domNode must have "onkeydown" event
    It must have .attr("value") to get value
    It also must impement an (or more) handler for the "onChange" method

• dojox.form.ListInput.inputHandler

  • type

    String

  • summary

    || Array
    The widget will connect on all handler to check input value
    You can use comma separated list

• dojox.form.ListInput.inputProperties

  • type

    String

  • summary

    || Object
    Properties used to create input box
    If String, it must be a valid JSON

• dojox.form.ListInput.inputProperties.minWidth

  • type

    Number

• dojox.form.ListInput.submitOnlyValidValue

  • type

    Boolean

  • summary

    If true, only valid value will be submited with form

• dojox.form.ListInput.useOnBlur

  • type

    Boolean

  • summary

    If true, onBlur event do a validate (like pressing ENTER)

• dojox.form.ListInput.readOnlyInput

  • type

    Boolean

  • summary

    if false, the list will be editable
    Can only be set when instanciate

• dojox.form.ListInput.maxItems

  • type

    Int

  • summary

    Specify max item the list can have
    null = infiny

• dojox.form.ListInput.showCloseButtonWhenValid

  • type

    Boolean

  • summary

    if true, a close button will be added on valid item

• dojox.form.ListInput.showCloseButtonWhenInvalid

  • type

    Boolean

  • summary

    if true, a close button will be added on invalid item

• dojox.form.ListInput.regExp

  • tags: extension
  • type

    String

  • summary

    regular expression string used to validate the input
    Do not specify both regExp and regExpGen
    
    
    "[a-zA-Z.-_]+@[a-zA-Z.-_]+.[a-zA-Z]+",

• dojox.form.ListInput.delimiter

  • type

    String

  • summary

    || Array
    delimiter for the string. Every match will be splitted
    The string can contain only one delimiter

• dojox.form.ListInput.constraints

  • type

    dijit.form.ValidationTextBox.__Constraints

  • summary

    user-defined object needed to pass parameters to the validator functions

• dojox.form.ListInput.baseClass

  • type

    String

• dojox.form.ListInput.type

  • type

    String

• dojox.form.ListInput.value

  • type

    Object

• dojox.form.ListInput.templateString

  • type

    String

• dojox.form.ListInput.useAnim

  • type

    Boolean

  • summary

    If true, then item will use an anime to show hide itself

• dojox.form.ListInput.duration

  • type

    Integer

  • summary

    Animation duration

• dojox.form.ListInput.easingIn

  • type

    function

  • summary

    function used to easing on fadeIn end

• dojox.form.ListInput.easingOut

  • type

    function

  • summary

    function used to easing on fadeOut end

• dojox.form.ListInput.readOnlyItem

  • type

    Boolean

  • summary

    If true, items can be edited
    Can only be set when instanciate

• dojox.form.ListInput.useArrowForEdit

  • type

    Boolean

  • summary

    If true, arraow left and right can be used for editing
    Can only be set when instanciate

• dojox.form.ListInput._items

  • type

    Array

  • summary

    Array of widget.
    Contain all reference to _ListInputInputItem

• dojox.form.ListInput._lastAddedItem

  • type

    Widget

  • summary

    Contain a reference to the last created item

• dojox.form.ListInput._currentItem

  • type

    Widget

  • summary

    Widget currently in edition

• dojox.form.ListInput._input

  • type

    Widget

  • summary

    Widget use for input box

• dojox.form.ListInput._count

  • type

    Int

  • summary

    Count items

• dojox.form.ListInput.postCreate

  • summary

    If closeButton is used, add a class

  • type

    Function

• dojox.form.ListInput._setReadOnlyInputAttr

  • parameters:
    • value: (typeof Boolean)
  • summary

    Change status and if needed, create the inputbox

  • tags:
  • type

    Function

• dojox.form.ListInput._setReadOnlyItemAttr

  • parameters:
    • value: (typeof Boolean)
  • summary

    set read only items

  • tags:
  • type

    Function

• dojox.form.ListInput._createInputBox

  • summary

    Create the input box

  • tags:
  • type

    Function

• dojox.form.ListInput.inputProperties.regExp

  • type

    Object

• dojox.form.ListInput.compare

  • parameters:
    • val1: (typeof Array)
    • val2: (typeof Array)
  • summary

    Compare 2 values (as returned by attr('value') for this widget).

  • tags:
  • type

    Function

• dojox.form.ListInput.add

  • parameters:
    • values: (typeof String)

      || Array

  • summary

    Create new list element

  • type

    Function

• dojox.form.ListInput._lastValueReported

  • type

    Object

• dojox.form.ListInput._lastAddedItem.onClose

  • type

    Object

• dojox.form.ListInput._lastAddedItem.onChange

  • type

    Object

• dojox.form.ListInput._lastAddedItem.onEdit

  • type

    Object

• dojox.form.ListInput._lastAddedItem.onKeyDown

  • type

    Object

• dojox.form.ListInput._setReadOnlyWhenMaxItemsReached

  • summary

    set input to readonly when max is reached

  • tags:
  • type

    Function

• dojox.form.ListInput._setSelectNode

  • summary

    put all item in the select (for a submit)

  • tags:
  • type

    Function

• dojox.form.ListInput._selectNode.options.length

  • type

    Number

• dojox.form.ListInput._placeItem

  • parameters:
    • node: (typeof domNode)
  • summary

    Place item in the list

  • tags:
  • type

    Function

• dojox.form.ListInput._getCursorPos

  • parameters:
    • node: (typeof domNode)
  • summary

    get current cursor pos

  • tags:
  • type

    Function

• dojox.form.ListInput._onItemClose

  • parameters:
    • item: (typeof dijit._Widget)
  • summary

    Destroy a list element when close button is clicked

  • tags:
  • type

    Function

• dojox.form.ListInput._onItemKeyDown

  • parameters:
    • item: (typeof dijit._Widget)
    • e: (typeof Event)
  • summary

    Call when item get a keypress

  • tags:
  • type

    Function

• dojox.form.ListInput._editBefore

  • parameters:
    • item: (typeof widget)
  • summary

    move trough items

  • tags:
  • type

    Function

• dojox.form.ListInput._editAfter

  • parameters:
    • item: (typeof widget)
  • summary

    move trough items

  • tags:
  • type

    Function

• dojox.form.ListInput._onItemChange

  • parameters:
    • item: (typeof dijit._Widget)
    • value: (typeof String)
  • summary

    Call when item value change

  • tags:
  • type

    Function

• dojox.form.ListInput._onItemEdit

  • parameters:
    • item: (typeof dijit._Widget)
  • summary

    Call when item is edited

  • tags:
  • type

    Function

• dojox.form.ListInput._testItem

  • parameters:
    • item: (typeof Object)
    • value: (typeof String)
  • summary

    Change class of item (match, mismatch)

  • tags:
  • type

    Function

• dojox.form.ListInput._getValueAttr

  • summary

    get all value in then list and return an array

  • tags:
  • type

    Function

• dojox.form.ListInput._setValueAttr

  • parameters:
    • newValue: (typeof Array)

      || String

  • summary

    Hook so attr('value', value) works.

  • description

    Sets the value of the widget.
    If the value has changed, then fire onChange event, unless priorityChange
    is specified as null (or false?)

  • type

    Function

• dojox.form.ListInput._parseValue

  • parameters:
    • newValue: (typeof String)
  • summary

    search for delemiters and split if needed

  • tags:
  • type

    Function

• dojox.form.ListInput.regExpGen

  • parameters:
    • constraints: (typeof dijit.form.ValidationTextBox.__Constraints)
  • returns

    String

  • summary

    Overridable function used to generate regExp when dependent on constraints.
    Do not specify both regExp and regExpGen.

  • tags: extension
  • type

    Function

• dojox.form.ListInput._setDisabledAttr

  • parameters:
    • value: (typeof Boolean)
  • summary

    also enable/disable editable items

  • tags:
  • type

    Function

• dojox.form.ListInput._onHandler

  • parameters:
    • value: (typeof String)
  • summary

    When handlers of input are fired, this method check input value and (if needed) modify it

  • tags:
  • type

    Function

• dojox.form.ListInput._onClick

  • parameters:
    • e: (typeof event)
  • summary

    give focus to inputbox

  • tags:
  • type

    Function

• dojox.form.ListInput._focusInput

  • summary

    give focus to input

  • tags:
  • type

    Function

• dojox.form.ListInput._inputOnKeyDown

  • parameters:
    • e: (typeof event)
  • summary

    Used to add keybord interactivity

  • tags:
  • type

    Function

• dojox.form.ListInput._inputOnBlur

  • summary

    Remove focus class and act like pressing ENTER key

  • tags:
  • type

    Function

• dojox.form.ListInput._getMatchedValueAttr

  • summary

    get value that match regexp in then list and return an array

  • tags:
  • type

    Function

• dojox.form.ListInput._getMismatchedValueAttr

  • summary

    get value that mismatch regexp in then list and return an array

  • tags:
  • type

    Function

• dojox.form.ListInput._getValues

  • parameters:
    • validator: (typeof function)
  • summary

    return values with comparator constraint

  • tags:
  • type

    Function

• dojox.form.ListInput._nullValidator

  • parameters:
    • itemValue: (typeof String)
  • summary

    return true or false

  • tags:
  • type

    Function

• dojox.form.ListInput._matchValidator

  • parameters:
    • itemValue: (typeof String)
  • summary

    return true or false

  • tags:
  • type

    Function

• dojox.form.ListInput._mismatchValidator

  • parameters:
    • itemValue: (typeof String)
  • summary

    return true or false

  • tags:
  • type

    Function

• dojox.form.ListInput._getLastItemAttr

  • summary

    return the last item in list

  • tags:
  • type

    Function

• dojox.form.ListInput._getSomeItem

  • parameters:
    • item: (typeof dijit._Widget)
    • position: (typeof String)
  • summary

    return the item before the one in params

  • tags:
  • type

    Function

• dojox.form.ListInput._getPreviousItem

  • parameters:
    • item: (typeof dijit._Widget)
  • summary

    return the item before the one in params

  • tags:
  • type

    Function

• dojox.form.ListInput._getNextItem

  • parameters:
    • item: (typeof dijit._Widget)
  • summary

    return the item before the one in params

  • tags:
  • type

    Function

• dojox.form.ListInput._destroyItem

  • parameters:
    • item: (typeof dijit._Widget)
    • updateValue: (typeof Boolean)
  • summary

    destroy an item

  • tags:
  • type

    Function

• dojox.form.ListInput._updateValues

  • summary

    update this.value and the select node

  • tags:
  • type

    Function

• dojox.form.ListInput._destroyAllItems

  • summary

    destroy all items

  • tags:
  • type

    Function

• dojox.form.ListInput.destroy

  • summary

    Destroy all widget

  • type

    Function

• dojox.form._ListInputInputItem

  • type

    Function

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

    Item created by ListInputInput when delimiter is found

  • description

    Simple <li> with close button added to ListInputInput when delimiter is found

• dojox.form._ListInputInputItem.templateString

  • type

    String

• dojox.form._ListInputInputItem.closeButtonNode

  • type

    domNode

  • summary

    ref to the close button node

• dojox.form._ListInputInputItem.readOnlyItem

  • type

    Boolean

  • summary

    if true, item is editable

• dojox.form._ListInputInputItem.baseClass

  • type

    String

• dojox.form._ListInputInputItem.value

  • type

    String

  • summary

    value of item

• dojox.form._ListInputInputItem.regExp

  • tags: extension
  • type

    String

  • summary

    regular expression string used to validate the input
    Do not specify both regExp and regExpGen

• dojox.form._ListInputInputItem._editBox

  • type

    Widget

  • summary

    inline edit box

• dojox.form._ListInputInputItem._handleKeyDown

  • type

    handle

  • summary

    handle for the keyDown connect

• dojox.form._ListInputInputItem.attributeMap

  • type

    Object

• dojox.form._ListInputInputItem.attributeMap.value

  • type

    Object

• dojox.form._ListInputInputItem.attributeMap.value.node

  • type

    String

• dojox.form._ListInputInputItem.attributeMap.value.type

  • type

    String

• dojox.form._ListInputInputItem.postMixInProperties

  • type

    Function

• dojox.form._ListInputInputItem.postCreate

  • summary

    Create the close button if needed

  • type

    Function

• dojox.form._ListInputInputItem.startup

  • summary

    add the edit box

  • type

    Function

• dojox.form._ListInputInputItem._setReadOnlyItemAttr

  • parameters:
    • value: (typeof Boolean)
  • summary

    change the readonly state

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem._createInlineEditBox

  • summary

    create the inline editbox if needed

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem.edit

  • summary

    enter inline editbox in edit mode

  • type

    Function

• dojox.form._ListInputInputItem._onCloseEdit

  • parameters:
    • value: (typeof String)
  • summary

    call when inline editor close himself

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem._onEdit

  • summary

    call when inline editor start editing

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem._setDisabledAttr

  • parameters:
    • value: (typeof Boolean)
  • summary

    disable inline edit box

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem._getValueAttr

  • summary

    return value

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem.destroy

  • summary

    Destroy the inline editbox

  • type

    Function

• dojox.form._ListInputInputItem._onCloseEnter

  • summary

    Called when user hovers over close icon

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem._onCloseLeave

  • summary

    Called when user stops hovering over close icon

  • tags:
  • type

    Function

• dojox.form._ListInputInputItem.onClose

  • summary

    callback when close button is clicked

  • type

    Function

• dojox.form._ListInputInputItem.onEdit

  • summary

    callback when widget come in edition

  • type

    Function

• dojox.form._ListInputInputItem.onClick

  • summary

    callback when widget is click

  • type

    Function

• dojox.form._ListInputInputItem.onChange

  • parameters:
    • value: (typeof String)
  • summary

    callback when widget change its content

  • type

    Function

• dojox.form._ListInputInputItem.onKeyDown

  • parameters:
    • value: (typeof String)
  • summary

    callback when widget get a KeyDown

  • type

    Function

• dojox.form._ListInputInputBox

  • type

    Function

  • chains:
    • dijit.form.ValidationTextBox: (prototype)
    • dijit.form.ValidationTextBox: (call)
  • summary

    auto-sized text box

  • description

    Auto sized textbox based on dijit.form.TextBox

• dojox.form._ListInputInputBox.minWidth

  • type

    Integer

  • summary

    Min width of the input box

• dojox.form._ListInputInputBox.intermediateChanges

  • type

    Boolean

  • summary

    Fires onChange for each value change or only on demand
    Force to true in order to get onChanged called

• dojox.form._ListInputInputBox.regExp

  • tags: extension
  • type

    String

  • summary

    regular expression string used to validate the input
    Do not specify both regExp and regExpGen

• dojox.form._ListInputInputBox._sizer

  • type

    DomNode

  • summary

    Used to get size of textbox content

• dojox.form._ListInputInputBox.onChange

  • parameters:
    • value: (typeof string)
  • summary

    compute content width

  • type

    Function

• dojox.form._ListInputInputBox._sizer.innerHTML

• dojox.form._ListInputInputBox.destroy

  • summary

    destroy the widget

  • type

    Function

• dojox.form

  • type

    Object

• dojox

  • type

    Object