src/widgets/form/TriggerField.js

   1 /*!
   2  * Ext JS Library 3.2.2
   3  * Copyright(c) 2006-2010 Ext JS, Inc.
   4  * licensing@extjs.com
   5  * http://www.extjs.com/license
   6  */
   7 /**
   8  * @class Ext.form.TriggerField
   9  * @extends Ext.form.TextField
  10  * Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).
  11  * The trigger has no default action, so you must assign a function to implement the trigger click handler by
  12  * overriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox
  13  * for which you can provide a custom implementation.  For example:
  14  * <pre><code>
  15 var trigger = new Ext.form.TriggerField();
  16 trigger.onTriggerClick = myTriggerFn;
  17 trigger.applyToMarkup('my-field');
  18 </code></pre>
  19  *
  20  * However, in general you will most likely want to use TriggerField as the base class for a reusable component.
  21  * {@link Ext.form.DateField} and {@link Ext.form.ComboBox} are perfect examples of this.
  22  *
  23  * @constructor
  24  * Create a new TriggerField.
  25  * @param {Object} config Configuration options (valid {@Ext.form.TextField} config options will also be applied
  26  * to the base TextField)
  27  * @xtype trigger
  28  */
  29 Ext.form.TriggerField = Ext.extend(Ext.form.TextField,  {
  30     /**
  31      * @cfg {String} triggerClass
  32      * An additional CSS class used to style the trigger button.  The trigger will always get the
  33      * class <tt>'x-form-trigger'</tt> by default and <tt>triggerClass</tt> will be <b>appended</b> if specified.
  34      */
  35     /**
  36      * @cfg {Mixed} triggerConfig
  37      * <p>A {@link Ext.DomHelper DomHelper} config object specifying the structure of the
  38      * trigger element for this Field. (Optional).</p>
  39      * <p>Specify this when you need a customized element to act as the trigger button for a TriggerField.</p>
  40      * <p>Note that when using this option, it is the developer's responsibility to ensure correct sizing, positioning
  41      * and appearance of the trigger.  Defaults to:</p>
  42      * <pre><code>{tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass}</code></pre>
  43      */
  44     /**
  45      * @cfg {String/Object} autoCreate <p>A {@link Ext.DomHelper DomHelper} element spec, or true for a default
  46      * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
  47      * See <tt>{@link Ext.Component#autoEl autoEl}</tt> for details.  Defaults to:</p>
  48      * <pre><code>{tag: "input", type: "text", size: "16", autocomplete: "off"}</code></pre>
  49      */
  50     defaultAutoCreate : {tag: "input", type: "text", size: "16", autocomplete: "off"},
  51     /**
  52      * @cfg {Boolean} hideTrigger <tt>true</tt> to hide the trigger element and display only the base
  53      * text field (defaults to <tt>false</tt>)
  54      */
  55     hideTrigger:false,
  56     /**
  57      * @cfg {Boolean} editable <tt>false</tt> to prevent the user from typing text directly into the field,
  58      * the field will only respond to a click on the trigger to set the value. (defaults to <tt>true</tt>).
  59      */
  60     editable: true,
  61     /**
  62      * @cfg {Boolean} readOnly <tt>true</tt> to prevent the user from changing the field, and
  63      * hides the trigger.  Superceeds the editable and hideTrigger options if the value is true.
  64      * (defaults to <tt>false</tt>)
  65      */
  66     readOnly: false,
  67     /**
  68      * @cfg {String} wrapFocusClass The class added to the to the wrap of the trigger element. Defaults to
  69      * <tt>x-trigger-wrap-focus</tt>.
  70      */
  71     wrapFocusClass: 'x-trigger-wrap-focus',
  72     /**
  73      * @hide
  74      * @method autoSize
  75      */
  76     autoSize: Ext.emptyFn,
  77     // private
  78     monitorTab : true,
  79     // private
  80     deferHeight : true,
  81     // private
  82     mimicing : false,
  83
  84     actionMode: 'wrap',
  85
  86     defaultTriggerWidth: 17,
  87
  88     // private
  89     onResize : function(w, h){
  90         Ext.form.TriggerField.superclass.onResize.call(this, w, h);
  91         var tw = this.getTriggerWidth();
  92         if(Ext.isNumber(w)){
  93             this.el.setWidth(w - tw);
  94         }
  95         this.wrap.setWidth(this.el.getWidth() + tw);
  96     },
  97
  98     getTriggerWidth: function(){
  99         var tw = this.trigger.getWidth();
 100         if(!this.hideTrigger && !this.readOnly && tw === 0){
 101             tw = this.defaultTriggerWidth;
 102         }
 103         return tw;
 104     },
 105
 106     // private
 107     alignErrorIcon : function(){
 108         if(this.wrap){
 109             this.errorIcon.alignTo(this.wrap, 'tl-tr', [2, 0]);
 110         }
 111     },
 112
 113     // private
 114     onRender : function(ct, position){
 115         this.doc = Ext.isIE ? Ext.getBody() : Ext.getDoc();
 116         Ext.form.TriggerField.superclass.onRender.call(this, ct, position);
 117
 118         this.wrap = this.el.wrap({cls: 'x-form-field-wrap x-form-field-trigger-wrap'});
 119         this.trigger = this.wrap.createChild(this.triggerConfig ||
 120                 {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass});
 121         this.initTrigger();
 122         if(!this.width){
 123             this.wrap.setWidth(this.el.getWidth()+this.trigger.getWidth());
 124         }
 125         this.resizeEl = this.positionEl = this.wrap;
 126     },
 127
 128     getWidth: function() {
 129         return(this.el.getWidth() + this.trigger.getWidth());
 130     },
 131
 132     updateEditState: function(){
 133         if(this.rendered){
 134             if (this.readOnly) {
 135                 this.el.dom.readOnly = true;
 136                 this.el.addClass('x-trigger-noedit');
 137                 this.mun(this.el, 'click', this.onTriggerClick, this);
 138                 this.trigger.setDisplayed(false);
 139             } else {
 140                 if (!this.editable) {
 141                     this.el.dom.readOnly = true;
 142                     this.el.addClass('x-trigger-noedit');
 143                     this.mon(this.el, 'click', this.onTriggerClick, this);
 144                 } else {
 145                     this.el.dom.readOnly = false;
 146                     this.el.removeClass('x-trigger-noedit');
 147                     this.mun(this.el, 'click', this.onTriggerClick, this);
 148                 }
 149                 this.trigger.setDisplayed(!this.hideTrigger);
 150             }
 151             this.onResize(this.width || this.wrap.getWidth());
 152         }
 153     },
 154
 155     setHideTrigger: function(hideTrigger){
 156         if(hideTrigger != this.hideTrigger){
 157             this.hideTrigger = hideTrigger;
 158             this.updateEditState();
 159         }
 160     },
 161
 162     /**
 163      * @param {Boolean} value True to allow the user to directly edit the field text
 164      * Allow or prevent the user from directly editing the field text.  If false is passed,
 165      * the user will only be able to modify the field using the trigger.  Will also add
 166      * a click event to the text field which will call the trigger. This method
 167      * is the runtime equivalent of setting the 'editable' config option at config time.
 168      */
 169     setEditable: function(editable){
 170         if(editable != this.editable){
 171             this.editable = editable;
 172             this.updateEditState();
 173         }
 174     },
 175
 176     /**
 177      * @param {Boolean} value True to prevent the user changing the field and explicitly
 178      * hide the trigger.
 179      * Setting this to true will superceed settings editable and hideTrigger.
 180      * Setting this to false will defer back to editable and hideTrigger. This method
 181      * is the runtime equivalent of setting the 'readOnly' config option at config time.
 182      */
 183     setReadOnly: function(readOnly){
 184         if(readOnly != this.readOnly){
 185             this.readOnly = readOnly;
 186             this.updateEditState();
 187         }
 188     },
 189
 190     afterRender : function(){
 191         Ext.form.TriggerField.superclass.afterRender.call(this);
 192         this.updateEditState();
 193     },
 194
 195     // private
 196     initTrigger : function(){
 197         this.mon(this.trigger, 'click', this.onTriggerClick, this, {preventDefault:true});
 198         this.trigger.addClassOnOver('x-form-trigger-over');
 199         this.trigger.addClassOnClick('x-form-trigger-click');
 200     },
 201
 202     // private
 203     onDestroy : function(){
 204         Ext.destroy(this.trigger, this.wrap);
 205         if (this.mimicing){
 206             this.doc.un('mousedown', this.mimicBlur, this);
 207         }
 208         delete this.doc;
 209         Ext.form.TriggerField.superclass.onDestroy.call(this);
 210     },
 211
 212     // private
 213     onFocus : function(){
 214         Ext.form.TriggerField.superclass.onFocus.call(this);
 215         if(!this.mimicing){
 216             this.wrap.addClass(this.wrapFocusClass);
 217             this.mimicing = true;
 218             this.doc.on('mousedown', this.mimicBlur, this, {delay: 10});
 219             if(this.monitorTab){
 220                 this.on('specialkey', this.checkTab, this);
 221             }
 222         }
 223     },
 224
 225     // private
 226     checkTab : function(me, e){
 227         if(e.getKey() == e.TAB){
 228             this.triggerBlur();
 229         }
 230     },
 231
 232     // private
 233     onBlur : Ext.emptyFn,
 234
 235     // private
 236     mimicBlur : function(e){
 237         if(!this.isDestroyed && !this.wrap.contains(e.target) && this.validateBlur(e)){
 238             this.triggerBlur();
 239         }
 240     },
 241
 242     // private
 243     triggerBlur : function(){
 244         this.mimicing = false;
 245         this.doc.un('mousedown', this.mimicBlur, this);
 246         if(this.monitorTab && this.el){
 247             this.un('specialkey', this.checkTab, this);
 248         }
 249         Ext.form.TriggerField.superclass.onBlur.call(this);
 250         if(this.wrap){
 251             this.wrap.removeClass(this.wrapFocusClass);
 252         }
 253     },
 254
 255     beforeBlur : Ext.emptyFn,
 256
 257     // private
 258     // This should be overriden by any subclass that needs to check whether or not the field can be blurred.
 259     validateBlur : function(e){
 260         return true;
 261     },
 262
 263     /**
 264      * The function that should handle the trigger's click event.  This method does nothing by default
 265      * until overridden by an implementing function.  See Ext.form.ComboBox and Ext.form.DateField for
 266      * sample implementations.
 267      * @method
 268      * @param {EventObject} e
 269      */
 270     onTriggerClick : Ext.emptyFn
 271
 272     /**
 273      * @cfg {Boolean} grow @hide
 274      */
 275     /**
 276      * @cfg {Number} growMin @hide
 277      */
 278     /**
 279      * @cfg {Number} growMax @hide
 280      */
 281 });
 282
 283 /**
 284  * @class Ext.form.TwinTriggerField
 285  * @extends Ext.form.TriggerField
 286  * TwinTriggerField is not a public class to be used directly.  It is meant as an abstract base class
 287  * to be extended by an implementing class.  For an example of implementing this class, see the custom
 288  * SearchField implementation here:
 289  * <a href="http://extjs.com/deploy/ext/examples/form/custom.html">http://extjs.com/deploy/ext/examples/form/custom.html</a>
 290  */
 291 Ext.form.TwinTriggerField = Ext.extend(Ext.form.TriggerField, {
 292     /**
 293      * @cfg {Mixed} triggerConfig
 294      * <p>A {@link Ext.DomHelper DomHelper} config object specifying the structure of the trigger elements
 295      * for this Field. (Optional).</p>
 296      * <p>Specify this when you need a customized element to contain the two trigger elements for this Field.
 297      * Each trigger element must be marked by the CSS class <tt>x-form-trigger</tt> (also see
 298      * <tt>{@link #trigger1Class}</tt> and <tt>{@link #trigger2Class}</tt>).</p>
 299      * <p>Note that when using this option, it is the developer's responsibility to ensure correct sizing,
 300      * positioning and appearance of the triggers.</p>
 301      */
 302     /**
 303      * @cfg {String} trigger1Class
 304      * An additional CSS class used to style the trigger button.  The trigger will always get the
 305      * class <tt>'x-form-trigger'</tt> by default and <tt>triggerClass</tt> will be <b>appended</b> if specified.
 306      */
 307     /**
 308      * @cfg {String} trigger2Class
 309      * An additional CSS class used to style the trigger button.  The trigger will always get the
 310      * class <tt>'x-form-trigger'</tt> by default and <tt>triggerClass</tt> will be <b>appended</b> if specified.
 311      */
 312
 313     initComponent : function(){
 314         Ext.form.TwinTriggerField.superclass.initComponent.call(this);
 315
 316         this.triggerConfig = {
 317             tag:'span', cls:'x-form-twin-triggers', cn:[
 318             {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger1Class},
 319             {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger2Class}
 320         ]};
 321     },
 322
 323     getTrigger : function(index){
 324         return this.triggers[index];
 325     },
 326
 327     afterRender: function(){
 328         Ext.form.TwinTriggerField.superclass.afterRender.call(this);
 329         var triggers = this.triggers,
 330             i = 0,
 331             len = triggers.length;
 332
 333         for(; i < len; ++i){
 334             if(this['hideTrigger' + (i + 1)]){
 335                     triggers[i].hide();
 336                 }
 337
 338         }
 339     },
 340
 341     initTrigger : function(){
 342         var ts = this.trigger.select('.x-form-trigger', true),
 343             triggerField = this;
 344
 345         ts.each(function(t, all, index){
 346             var triggerIndex = 'Trigger'+(index+1);
 347             t.hide = function(){
 348                 var w = triggerField.wrap.getWidth();
 349                 this.dom.style.display = 'none';
 350                 triggerField.el.setWidth(w-triggerField.trigger.getWidth());
 351                 this['hidden' + triggerIndex] = true;
 352             };
 353             t.show = function(){
 354                 var w = triggerField.wrap.getWidth();
 355                 this.dom.style.display = '';
 356                 triggerField.el.setWidth(w-triggerField.trigger.getWidth());
 357                 this['hidden' + triggerIndex] = false;
 358             };
 359             this.mon(t, 'click', this['on'+triggerIndex+'Click'], this, {preventDefault:true});
 360             t.addClassOnOver('x-form-trigger-over');
 361             t.addClassOnClick('x-form-trigger-click');
 362         }, this);
 363         this.triggers = ts.elements;
 364     },
 365
 366     getTriggerWidth: function(){
 367         var tw = 0;
 368         Ext.each(this.triggers, function(t, index){
 369             var triggerIndex = 'Trigger' + (index + 1),
 370                 w = t.getWidth();
 371             if(w === 0 && !this['hidden' + triggerIndex]){
 372                 tw += this.defaultTriggerWidth;
 373             }else{
 374                 tw += w;
 375             }
 376         }, this);
 377         return tw;
 378     },
 379
 380     // private
 381     onDestroy : function() {
 382         Ext.destroy(this.triggers);
 383         Ext.form.TwinTriggerField.superclass.onDestroy.call(this);
 384     },
 385
 386     /**
 387      * The function that should handle the trigger's click event.  This method does nothing by default
 388      * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
 389      * for additional information.
 390      * @method
 391      * @param {EventObject} e
 392      */
 393     onTrigger1Click : Ext.emptyFn,
 394     /**
 395      * The function that should handle the trigger's click event.  This method does nothing by default
 396      * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
 397      * for additional information.
 398      * @method
 399      * @param {EventObject} e
 400      */
 401     onTrigger2Click : Ext.emptyFn
 402 });
 403 Ext.reg('trigger', Ext.form.TriggerField);