dojox/form/FilePickerTextBox.js

• Provides:

  • dojox.form.FilePickerTextBox

• Requires:

  • dojo.window in common in project dojo
  • dijit.form.ValidationTextBox in common in project dijit
  • dijit._HasDropDown in common in project dijit
  • dojox.widget.FilePicker in common

• dojox.form.FilePickerTextBox

  • type

    Function

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

    A validating text box tied to a file picker popup

• dojox.form.FilePickerTextBox.baseClass

  • summary

• dojox.form.FilePickerTextBox.templateString

  • summary

• dojox.form.FilePickerTextBox.searchDelay

  • type

    Integer

  • summary

    Delay in milliseconds between when user types something and we start
    searching based on that value

• dojox.form.FilePickerTextBox.valueItem

  • type

    item

  • summary

    The item, in our store, of the directory relating to our value

• dojox.form.FilePickerTextBox.numPanes

  • type

    number

  • summary

    The number of panes to display in our box (if we don't have any
    minPaneWidth specified by our constraints)

• dojox.form.FilePickerTextBox.postMixInProperties

  • type

    Function

  • source: [view]
       this.inherited(arguments);
       this.dropDown = new dojox.widget.FilePicker(this.constraints);
  • summary

• dojox.form.FilePickerTextBox.postCreate

  • type

    Function

  • source: [view]
       this.inherited(arguments);
       // Make our connections we want
       this.connect(this.dropDown, "onChange", this._onWidgetChange);
       this.connect(this.focusNode, "onblur", "_focusBlur");
       this.connect(this.focusNode, "onfocus", "_focusFocus");
       this.connect(this.focusNode, "ondblclick", function(){
        dijit.selectInputText(this.focusNode);
       });
  • summary

• dojox.form.FilePickerTextBox._setValueAttr

  • type

    Function

  • parameters:
    • value: (typeof string)
    • priorityChange: (typeof )
    • fromWidget: (typeof )
  • source: [view]
       if(!this._searchInProgress){
        this.inherited(arguments);
        value = value || "";
        var tVal = this.dropDown.get("pathValue") || "";
        if(value !== tVal){
         this._skip = true;
         var fx = dojo.hitch(this, "_setBlurValue");
         this.dropDown._setPathValueAttr(value, !fromWidget,
               this._settingBlurValue ? fx : null);
        }
       }
  • summary

    sets the value of this widget

• dojox.form.FilePickerTextBox._onWidgetChange

  • type

    Function

  • parameters:
    • item: (typeof item)
  • source: [view]
       if(!item && this.focusNode.value){
        this._hasValidPath = false;
        this.focusNode.value = "";
       }else{
        this.valueItem = item;
        var value = this.dropDown._getPathValueAttr(item);
        if(value){
         this._hasValidPath = true;
        }
        if(!this._skip){
         this._setValueAttr(value, undefined, true);
        }
        delete this._skip;
       }
       this.validate();
  • summary

    called when the path gets changed in the dropdown

• dojox.form.FilePickerTextBox.startup

  • type

    Function

  • source: [view]
       if(!this.dropDown._started){
        this.dropDown.startup();
       }
       this.inherited(arguments);
  • summary

• dojox.form.FilePickerTextBox.openDropDown

  • type

    Function

  • source: [view]
    dojo.provide("dojox.form.FilePickerTextBox");
    
    
    dojo.require("dojo.window");
    dojo.require("dijit.form.ValidationTextBox");
    dojo.require("dijit._HasDropDown");
    dojo.require("dojox.widget.FilePicker");
    
    
    dojo.declare(
     "dojox.form.FilePickerTextBox",
     [dijit.form.ValidationTextBox, dijit._HasDropDown],
     {
      // summary:
      //  A validating text box tied to a file picker popup
    
      
      baseClass: "dojoxFilePickerTextBox",
    
      
      templateString: dojo.cache("dojox.form", "resources/FilePickerTextBox.html"),
    
      
      // searchDelay: Integer
      //  Delay in milliseconds between when user types something and we start
      //  searching based on that value
      searchDelay: 500,
    
      
      // valueItem: item
      //  The item, in our store, of the directory relating to our value
      valueItem: null,
    
      
      // numPanes: number
      // The number of panes to display in our box (if we don't have any
      // minPaneWidth specified by our constraints)
      numPanes: 2.25,
    
      
      postMixInProperties: function(){
       this.inherited(arguments);
       this.dropDown = new dojox.widget.FilePicker(this.constraints);
      },
    
    
      postCreate: function(){
       this.inherited(arguments);
       // Make our connections we want
       this.connect(this.dropDown, "onChange", this._onWidgetChange);
       this.connect(this.focusNode, "onblur", "_focusBlur");
       this.connect(this.focusNode, "onfocus", "_focusFocus");
       this.connect(this.focusNode, "ondblclick", function(){
        dijit.selectInputText(this.focusNode);
       });
      },
    
      
      _setValueAttr: function(/*string*/value, priorityChange, fromWidget){
       // summary: sets the value of this widget
       if(!this._searchInProgress){
        this.inherited(arguments);
        value = value || "";
        var tVal = this.dropDown.get("pathValue") || "";
        if(value !== tVal){
         this._skip = true;
         var fx = dojo.hitch(this, "_setBlurValue");
         this.dropDown._setPathValueAttr(value, !fromWidget,
               this._settingBlurValue ? fx : null);
        }
       }
      },
    
      
      _onWidgetChange: function(/*item*/item){
       // summary: called when the path gets changed in the dropdown
       if(!item && this.focusNode.value){
        this._hasValidPath = false;
        this.focusNode.value = "";
       }else{
        this.valueItem = item;
        var value = this.dropDown._getPathValueAttr(item);
        if(value){
         this._hasValidPath = true;
        }
        if(!this._skip){
         this._setValueAttr(value, undefined, true);
        }
        delete this._skip;
       }
       this.validate();
      },
    
      
      startup: function(){
       if(!this.dropDown._started){
        this.dropDown.startup();
       }
       this.inherited(arguments);
      },
    
    
      openDropDown: function(){
       // set width to 0 so that it will resize automatically
       this.dropDown.domNode.style.width="0px";
       if(!("minPaneWidth" in (this.constraints||{}))){
        this.dropDown.set("minPaneWidth", (this.domNode.offsetWidth / this.numPanes));
       }
       this.inherited(arguments);
  • summary

• dojox.form.FilePickerTextBox.toggleDropDown

  • type

    Function

  • source: [view]
       this.inherited(arguments);
       // Make sure our display is up-to-date with our value
       if(this._opened){
        this.dropDown.set("pathValue", this.get("value"));
       }
  • summary

• dojox.form.FilePickerTextBox._focusBlur

  • type

    Function

  • parameters:
    • e: (typeof Event)
  • source: [view]
       if(e.explicitOriginalTarget == this.focusNode && !this._allowBlur){
        window.setTimeout(dojo.hitch(this, function(){
         if(!this._allowBlur){
          this.focus();
         }
        }), 1);
       }else if(this._menuFocus){
        this.dropDown._updateClass(this._menuFocus, "Item", {"Hover": false});
        delete this._menuFocus;
       }
  • summary

    called when the focus node gets blurred

• dojox.form.FilePickerTextBox._focusFocus

  • type

    Function

  • parameters:
    • e: (typeof Event)
  • source: [view]
       if(this._menuFocus){
        this.dropDown._updateClass(this._menuFocus, "Item", {"Hover": false});
       }
       delete this._menuFocus;
       var focusNode = dijit.getFocus(this);
       if(focusNode && focusNode.node){
        focusNode = dijit.byNode(focusNode.node);
        if(focusNode){
         this._menuFocus = focusNode.domNode;
        }
       }
       if(this._menuFocus){
        this.dropDown._updateClass(this._menuFocus, "Item", {"Hover": true});
       }
       delete this._allowBlur;
  • summary

    called when the focus node gets focus

• dojox.form.FilePickerTextBox._onBlur

  • type

    Function

  • source: [view]
       this._allowBlur = true;
       delete this.dropDown._savedFocus;
       this.inherited(arguments);
  • summary

    called when focus is shifted away from this widget

• dojox.form.FilePickerTextBox._setBlurValue

  • type

    Function

  • source: [view]
       if(this.dropDown && !this._settingBlurValue){
        this._settingBlurValue = true;
        this.set("value", this.focusNode.value);
       }else{
        delete this._settingBlurValue;
        this.inherited(arguments);
       }
  • summary

    sets the value of the widget once focus has left

• dojox.form.FilePickerTextBox.parse

  • type

    Function

  • parameters:
    • value: (typeof String)
    • constraints: (typeof Object)
  • source: [view]
       if(this._hasValidPath || this._hasSelection){
        return value;
       }
       var dd = this.dropDown, topDir = dd.topDir, sep = dd.pathSeparator;
       var ddVal = dd.get("pathValue");
       var norm = function(v){
        if(topDir.length && v.indexOf(topDir) === 0){
         v = v.substring(topDir.length);
        }
        if(sep && v[v.length - 1] == sep){
         v = v.substring(0, v.length - 1);
        }
        return v;
       };
       ddVal = norm(ddVal);
       var val = norm(value);
       if(val == ddVal){
        return value;
       }
       return undefined;
  • summary

    Function to convert a formatted string to a value - we use
    it to verify that it *really* is a valid value

• dojox.form.FilePickerTextBox._startSearchFromInput

  • type

    Function

  • source: [view]
       var dd = this.dropDown, fn = this.focusNode;
       var val = fn.value, oVal = val, topDir = dd.topDir;
       if(this._hasSelection){
        dijit.selectInputText(fn, oVal.length);
       }
       this._hasSelection = false;
       if(topDir.length && val.indexOf(topDir) === 0){
        val = val.substring(topDir.length);
       }
       var dirs = val.split(dd.pathSeparator);
       var setFromChain = dojo.hitch(this, function(idx){
        var dir = dirs[idx];
        var child = dd.getChildren()[idx];
        var conn;
        this._searchInProgress = true;
        var _cleanup = dojo.hitch(this, function(){
         delete this._searchInProgress;
        });
        if((dir || child) && !this._opened){
         this.toggleDropDown();
        }
        if(dir && child){
         var fx = dojo.hitch(this, function(){
          if(conn){
           this.disconnect(conn);
          }
          delete conn;
          var children = child._menu.getChildren();
          var exact = dojo.filter(children, function(i){
           return i.label == dir;
          })[0];
          var first = dojo.filter(children, function(i){
           return (i.label.indexOf(dir) === 0);
          })[0];
          if(exact &&
           ((dirs.length > idx + 1 && exact.children) ||
           (!exact.children))){
           idx++;
           child._menu.onItemClick(exact, {type: "internal",
                 stopPropagation: function(){},
                 preventDefault: function(){}});
           if(dirs[idx]){
            setFromChain(idx);
           }else{
            _cleanup();
           }
          }else{
           child._setSelected(null);
           if(first && dirs.length === idx + 1){
            dd._setInProgress = true;
            dd._removeAfter(child);
            delete dd._setInProgress;
            var targetString = first.label;
            if(first.children){
             targetString += dd.pathSeparator;
            }
            targetString = targetString.substring(dir.length);
            window.setTimeout(function(){
             dojo.window.scrollIntoView(first.domNode);
            }, 1);
            fn.value = oVal + targetString;
            dijit.selectInputText(fn, oVal.length);
            this._hasSelection = true;
            try{first.focusNode.focus();}catch(e){}
           }else{
            if(this._menuFocus){
             this.dropDown._updateClass(this._menuFocus, "Item", {"Hover": false, "Focus": false});
            }
            delete this._menuFocus;
           }
           _cleanup();
          }
         });
         if(!child.isLoaded){
          conn = this.connect(child, "onLoad", fx);
         }else{
          fx();
         }
        }else{
         if(child){
          child._setSelected(null);
          dd._setInProgress = true;
          dd._removeAfter(child);
          delete dd._setInProgress;
         }
         _cleanup();
        }
       });
       setFromChain(0);
  • summary

    kicks off a search based off the current text value of the widget

• dojox.form.FilePickerTextBox._onKey

  • type

    Function

  • parameters:
    • e: (typeof Event)
  • source: [view]
       if(this.disabled || this.readOnly){ return; }
       var dk = dojo.keys;
       var c = e.charOrCode;
       if(c==dk.DOWN_ARROW){
        this._allowBlur = true;
       }
       if(c==dk.ENTER && this._opened){
        this.dropDown.onExecute();
        dijit.selectInputText(this.focusNode, this.focusNode.value.length);
        this._hasSelection = false;
        dojo.stopEvent(e);
        return;
       }
       if((c==dk.RIGHT_ARROW || c==dk.LEFT_ARROW || c==dk.TAB) && this._hasSelection){
        this._startSearchFromInput();
        dojo.stopEvent(e);
        return;
       }
       this.inherited(arguments);
       var doSearch = false;
       if((c==dk.BACKSPACE || c==dk.DELETE) && this._hasSelection){
        this._hasSelection = false;
       }else if(c==dk.BACKSPACE || c==dk.DELETE || c==" "){
        doSearch = true;
       }else{
        doSearch = e.keyChar !== "";
       }
       if(this._searchTimer){
        window.clearTimeout(this._searchTimer);
       }
       delete this._searchTimer;
       if(doSearch){
        this._hasValidPath = false;
        this._hasSelection = false;
        this._searchTimer = window.setTimeout(dojo.hitch(this, "_startSearchFromInput"), this.searchDelay + 1);
       }
  • summary

    callback when the user presses a key on menu popup node

• dojox.form.FilePickerTextBox.dropDown

  • summary

• dojox.form.FilePickerTextBox._skip

  • summary

• dojox.form.FilePickerTextBox._hasValidPath

  • summary

• dojox.form.FilePickerTextBox.focusNode.value

  • summary

• dojox.form.FilePickerTextBox.dropDown.domNode.style.width

  • summary

• dojox.form.FilePickerTextBox._menuFocus

  • summary

• dojox.form.FilePickerTextBox._allowBlur

  • summary

• dojox.form.FilePickerTextBox._settingBlurValue

  • summary

• dojox.form.FilePickerTextBox._hasSelection

  • summary

• dojox.form.FilePickerTextBox._searchInProgress

  • summary

• dojox.form.FilePickerTextBox._searchTimer

  • summary

• dojox.form

  • type

    Object

  • summary

• dojox

  • type

    Object

  • summary