dijit/form/MultiSelect.js

• Provides:

  • dijit.form.MultiSelect

• dijit.form.MultiSelect

  • type

    Function

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

    Widget version of a <select multiple=true> element,
    for selecting multiple options.

• dijit.form.MultiSelect.size

  • type

    Number

  • summary

    Number of elements to display on a page
    NOTE: may be removed in version 2.0, since elements may have variable height;
    set the size via style="..." or CSS class names instead.

• dijit.form.MultiSelect.templateString

  • summary

• dijit.form.MultiSelect.attributeMap

  • summary

• dijit.form.MultiSelect.reset

  • type

    Function

  • source: [view]
    define("dijit/form/MultiSelect", ["dojo", "dijit", "dijit/form/_FormWidget"], function(dojo, dijit) {
    
    
    dojo.declare("dijit.form.MultiSelect", dijit.form._FormValueWidget, {
     // summary:
     //  Widget version of a element,
     //  for selecting multiple options.
    
    
     // size: Number
     //  Number of elements to display on a page
     //  NOTE: may be removed in version 2.0, since elements may have variable height;
     //  set the size via style="..." or CSS class names instead.
     size: 7,
    
    
     templateString: "",
    
    
     attributeMap: dojo.delegate(dijit.form._FormWidget.prototype.attributeMap, {
      size: "focusNode"
     }),
    
    
     reset: function(){
      // summary:
      //  Reset the widget's value to what it was at initialization time
    
    
      // TODO: once we inherit from FormValueWidget this won't be needed
      this._hasBeenBlurred = false;
      this._setValueAttr(this._resetValue, true);
  • summary

• dijit.form.MultiSelect.addSelected

  • type

    Function

  • parameters:
    • select: (typeof dijit.form.MultiSelect)
  • source: [view]
      select.getSelected().forEach(function(n){
       this.containerNode.appendChild(n);
       // scroll to bottom to see item
       // cannot use scrollIntoView since tags don't support all attributes
       // does not work on IE due to a bug where always shows scrollTop = 0
       this.domNode.scrollTop = this.domNode.offsetHeight; // overshoot will be ignored
       // scrolling the source select is trickier esp. on safari who forgets to change the scrollbar size
       var oldscroll = select.domNode.scrollTop;
       select.domNode.scrollTop = 0;
       select.domNode.scrollTop = oldscroll;
      },this);

    summary

    Move the selected nodes of a passed Select widget
    instance to this Select widget.

    example

    
    	// move all the selected values from "bar" to "foo"
     	dijit.byId("foo").addSelected(dijit.byId("bar"));

    dijit.form.MultiSelect.getSelected

    • type

      Function

    • source: [view]
        return dojo.query("option",this.containerNode).filter(function(n){
         return n.selected; // Boolean
        }); // dojo.NodeList
    • summary

      Access the NodeList of the selected options directly

    • returns

      Boolean

    dijit.form.MultiSelect._getValueAttr

    • type

      Function

    • source: [view]
        return this.getSelected().map(function(n){
         return n.value;
        });
    • summary

      Hook so get('value') works.

    • description

      Returns an array of the selected options' values.

    dijit.form.MultiSelect.multiple

    • summary

    dijit.form.MultiSelect._setValueAttr

    • type

      Function

    • parameters:
      • values: (typeof Array)
    • source: [view]
        dojo.query("option",this.containerNode).forEach(function(n){
         n.selected = (dojo.indexOf(values,n.value) != -1);
        });
    • summary

      Hook so set('value', values) works.

    • description

      Set the value(s) of this Select based on passed values

    dijit.form.MultiSelect.invertSelection

    • type

      Function

    • parameters:
      • onChange: (typeof Boolean)

        If null, onChange is not fired.

    • source: [view]
        dojo.query("option",this.containerNode).forEach(function(n){
         n.selected = !n.selected;
        });
        this._handleOnChange(this.get('value'), onChange == true);
    • summary

      Invert the selection

    dijit.form.MultiSelect._onChange

    • type

      Function

    • parameters:
      • e: (typeof Event)
    • source: [view]
        this._handleOnChange(this.get('value'), true);
    • summary

    dijit.form.MultiSelect.resize

    • type

      Function

    • parameters:
      • size: (typeof Object)
    • source: [view]
        if(size){
         dojo.marginBox(this.domNode, size);
        }
    • summary

    dijit.form.MultiSelect.postCreate

    • type

      Function

    • source: [view]
        this._onChange();
    • summary

    dijit.form.MultiSelect._hasBeenBlurred

    • summary

    dijit.form.MultiSelect.domNode.scrollTop

    • summary

    dijit.form

    • type

      Object

    • summary

    dijit

    • type

      Object

    • summary