3 * Copyright(c) 2006-2010 Ext JS, Inc.
5 * http://www.extjs.com/license
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:
15 var trigger = new Ext.form.TriggerField();
16 trigger.onTriggerClick = myTriggerFn;
17 trigger.applyToMarkup('my-field');
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.
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)
29 Ext.form.TriggerField = Ext.extend(Ext.form.TextField, {
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.
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>
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>
50 defaultAutoCreate : {tag: "input", type: "text", size: "16", autocomplete: "off"},
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>)
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>).
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>)
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>.
71 wrapFocusClass: 'x-trigger-wrap-focus',
76 autoSize: Ext.emptyFn,
86 defaultTriggerWidth: 17,
89 onResize : function(w, h){
90 Ext.form.TriggerField.superclass.onResize.call(this, w, h);
91 var tw = this.getTriggerWidth();
93 this.el.setWidth(w - tw);
95 this.wrap.setWidth(this.el.getWidth() + tw);
98 getTriggerWidth: function(){
99 var tw = this.trigger.getWidth();
100 if(!this.hideTrigger && !this.readOnly && tw === 0){
101 tw = this.defaultTriggerWidth;
107 alignErrorIcon : function(){
109 this.errorIcon.alignTo(this.wrap, 'tl-tr', [2, 0]);
114 onRender : function(ct, position){
115 this.doc = Ext.isIE ? Ext.getBody() : Ext.getDoc();
116 Ext.form.TriggerField.superclass.onRender.call(this, ct, position);
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});
123 this.wrap.setWidth(this.el.getWidth()+this.trigger.getWidth());
125 this.resizeEl = this.positionEl = this.wrap;
128 getWidth: function() {
129 return(this.el.getWidth() + this.trigger.getWidth());
132 updateEditState: function(){
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);
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);
145 this.el.dom.readOnly = false;
146 this.el.removeClass('x-trigger-noedit');
147 this.mun(this.el, 'click', this.onTriggerClick, this);
149 this.trigger.setDisplayed(!this.hideTrigger);
151 this.onResize(this.width || this.wrap.getWidth());
155 setHideTrigger: function(hideTrigger){
156 if(hideTrigger != this.hideTrigger){
157 this.hideTrigger = hideTrigger;
158 this.updateEditState();
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.
169 setEditable: function(editable){
170 if(editable != this.editable){
171 this.editable = editable;
172 this.updateEditState();
177 * @param {Boolean} value True to prevent the user changing the field and explicitly
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.
183 setReadOnly: function(readOnly){
184 if(readOnly != this.readOnly){
185 this.readOnly = readOnly;
186 this.updateEditState();
190 afterRender : function(){
191 Ext.form.TriggerField.superclass.afterRender.call(this);
192 this.updateEditState();
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');
203 onDestroy : function(){
204 Ext.destroy(this.trigger, this.wrap);
206 this.doc.un('mousedown', this.mimicBlur, this);
209 Ext.form.TriggerField.superclass.onDestroy.call(this);
213 onFocus : function(){
214 Ext.form.TriggerField.superclass.onFocus.call(this);
216 this.wrap.addClass(this.wrapFocusClass);
217 this.mimicing = true;
218 this.doc.on('mousedown', this.mimicBlur, this, {delay: 10});
220 this.on('specialkey', this.checkTab, this);
226 checkTab : function(me, e){
227 if(e.getKey() == e.TAB){
233 onBlur : Ext.emptyFn,
236 mimicBlur : function(e){
237 if(!this.isDestroyed && !this.wrap.contains(e.target) && this.validateBlur(e)){
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);
249 Ext.form.TriggerField.superclass.onBlur.call(this);
251 this.wrap.removeClass(this.wrapFocusClass);
255 beforeBlur : Ext.emptyFn,
258 // This should be overriden by any subclass that needs to check whether or not the field can be blurred.
259 validateBlur : function(e){
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.
268 * @param {EventObject} e
270 onTriggerClick : Ext.emptyFn
273 * @cfg {Boolean} grow @hide
276 * @cfg {Number} growMin @hide
279 * @cfg {Number} growMax @hide
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>
291 Ext.form.TwinTriggerField = Ext.extend(Ext.form.TriggerField, {
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>
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.
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.
313 initComponent : function(){
314 Ext.form.TwinTriggerField.superclass.initComponent.call(this);
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}
323 getTrigger : function(index){
324 return this.triggers[index];
327 initTrigger : function(){
328 var ts = this.trigger.select('.x-form-trigger', true);
329 var triggerField = this;
330 ts.each(function(t, all, index){
331 var triggerIndex = 'Trigger'+(index+1);
333 var w = triggerField.wrap.getWidth();
334 this.dom.style.display = 'none';
335 triggerField.el.setWidth(w-triggerField.trigger.getWidth());
336 this['hidden' + triggerIndex] = true;
339 var w = triggerField.wrap.getWidth();
340 this.dom.style.display = '';
341 triggerField.el.setWidth(w-triggerField.trigger.getWidth());
342 this['hidden' + triggerIndex] = false;
345 if(this['hide'+triggerIndex]){
346 t.dom.style.display = 'none';
347 this['hidden' + triggerIndex] = true;
349 this.mon(t, 'click', this['on'+triggerIndex+'Click'], this, {preventDefault:true});
350 t.addClassOnOver('x-form-trigger-over');
351 t.addClassOnClick('x-form-trigger-click');
353 this.triggers = ts.elements;
356 getTriggerWidth: function(){
358 Ext.each(this.triggers, function(t, index){
359 var triggerIndex = 'Trigger' + (index + 1),
361 if(w === 0 && !this['hidden' + triggerIndex]){
362 tw += this.defaultTriggerWidth;
371 onDestroy : function() {
372 Ext.destroy(this.triggers);
373 Ext.form.TwinTriggerField.superclass.onDestroy.call(this);
377 * The function that should handle the trigger's click event. This method does nothing by default
378 * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
379 * for additional information.
381 * @param {EventObject} e
383 onTrigger1Click : Ext.emptyFn,
385 * The function that should handle the trigger's click event. This method does nothing by default
386 * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
387 * for additional information.
389 * @param {EventObject} e
391 onTrigger2Click : Ext.emptyFn
393 Ext.reg('trigger', Ext.form.TriggerField);