Trigger2.html
17.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-form-field-Trigger'>/**
</span> * Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).
* The trigger has no default action, so you must assign a function to implement the trigger click handler by overriding
* {@link #onTriggerClick}. You can create a Trigger field directly, as it renders exactly like a combobox for which you
* can provide a custom implementation.
*
* For example:
*
* @example
* Ext.define('Ext.ux.CustomTrigger', {
* extend: 'Ext.form.field.Trigger',
* alias: 'widget.customtrigger',
*
* // override onTriggerClick
* onTriggerClick: function() {
* Ext.Msg.alert('Status', 'You clicked my trigger!');
* }
* });
*
* Ext.create('Ext.form.FormPanel', {
* title: 'Form with TriggerField',
* bodyPadding: 5,
* width: 350,
* renderTo: Ext.getBody(),
* items:[{
* xtype: 'customtrigger',
* fieldLabel: 'Sample Trigger',
* emptyText: 'click the trigger'
* }]
* });
*
* However, in general you will most likely want to use Trigger as the base class for a reusable component.
* {@link Ext.form.field.Date} and {@link Ext.form.field.ComboBox} are perfect examples of this.
*/
Ext.define('Ext.form.field.Trigger', {
extend:'Ext.form.field.Text',
alias: ['widget.triggerfield', 'widget.trigger'],
requires: ['Ext.DomHelper', 'Ext.util.ClickRepeater', 'Ext.layout.component.field.Trigger'],
alternateClassName: ['Ext.form.TriggerField', 'Ext.form.TwinTriggerField', 'Ext.form.Trigger'],
childEls: [
<span id='Ext-form-field-Trigger-property-triggerEl'> /**
</span> * @property {Ext.CompositeElement} triggerEl
* A composite of all the trigger button elements. Only set after the field has been rendered.
*/
{ name: 'triggerCell', select: '.' + Ext.baseCSSPrefix + 'trigger-cell' },
{ name: 'triggerEl', select: '.' + Ext.baseCSSPrefix + 'form-trigger' },
<span id='Ext-form-field-Trigger-property-triggerWrap'> /**
</span> * @property {Ext.Element} triggerWrap
* A reference to the `TABLE` element which encapsulates the input field and all trigger button(s). Only set after the field has been rendered.
*/
'triggerWrap',
<span id='Ext-form-field-Trigger-property-inputCell'> /**
</span> * @property {Ext.Element} inputCell
* A reference to the `TD` element wrapping the input element. Only set after the field has been rendered.
*/
'inputCell'
],
<span id='Ext-form-field-Trigger-cfg-triggerCls'> /**
</span> * @cfg {String} triggerCls
* An additional CSS class used to style the trigger button. The trigger will always get the {@link #triggerBaseCls}
* by default and triggerCls will be **appended** if specified.
*/
<span id='Ext-form-field-Trigger-cfg-triggerBaseCls'> /**
</span> * @cfg
* The base CSS class that is always added to the trigger button. The {@link #triggerCls} will be appended in
* addition to this class.
*/
triggerBaseCls: Ext.baseCSSPrefix + 'form-trigger',
<span id='Ext-form-field-Trigger-cfg-triggerWrapCls'> /**
</span> * @cfg
* The CSS class that is added to the div wrapping the trigger button(s).
*/
triggerWrapCls: Ext.baseCSSPrefix + 'form-trigger-wrap',
<span id='Ext-form-field-Trigger-cfg-triggerNoEditCls'> /**
</span> * @cfg
* The CSS class that is added to the text field when component is read-only or not editable.
*/
triggerNoEditCls: Ext.baseCSSPrefix + 'trigger-noedit',
<span id='Ext-form-field-Trigger-cfg-hideTrigger'> /**
</span> * @cfg {Boolean} hideTrigger
* true to hide the trigger element and display only the base text field
*/
hideTrigger: false,
<span id='Ext-form-field-Trigger-cfg-editable'> /**
</span> * @cfg {Boolean} editable
* false to prevent the user from typing text directly into the field; the field can only have its value set via an
* action invoked by the trigger.
*/
editable: true,
<span id='Ext-form-field-Trigger-cfg-readOnly'> /**
</span> * @cfg {Boolean} readOnly
* true to prevent the user from changing the field, and hides the trigger. Supercedes the editable and hideTrigger
* options if the value is true.
*/
readOnly: false,
<span id='Ext-form-field-Trigger-cfg-selectOnFocus'> /**
</span> * @cfg {Boolean} [selectOnFocus=false]
* true to select any existing text in the field immediately on focus. Only applies when
* {@link #editable editable} = true
*/
<span id='Ext-form-field-Trigger-cfg-repeatTriggerClick'> /**
</span> * @cfg {Boolean} repeatTriggerClick
* true to attach a {@link Ext.util.ClickRepeater click repeater} to the trigger.
*/
repeatTriggerClick: false,
<span id='Ext-form-field-Trigger-method-autoSize'> /**
</span> * @method autoSize
* @private
*/
autoSize: Ext.emptyFn,
// private
monitorTab: true,
// private
mimicing: false,
// private
triggerIndexRe: /trigger-index-(\d+)/,
componentLayout: 'triggerfield',
initComponent: function() {
this.wrapFocusCls = this.triggerWrapCls + '-focus';
this.callParent(arguments);
},
getSubTplMarkup: function() {
var me = this,
field = me.callParent(arguments);
return '<table id="' + me.id + '-triggerWrap" class="' + Ext.baseCSSPrefix + 'form-trigger-wrap" cellpadding="0" cellspacing="0"><tbody><tr>' +
'<td id="' + me.id + '-inputCell" class="' + Ext.baseCSSPrefix + 'form-trigger-input-cell">' + field + '</td>' +
me.getTriggerMarkup() +
'</tr></tbody></table>';
},
getSubTplData: function(){
var me = this,
data = me.callParent(),
readOnly = me.readOnly === true,
editable = me.editable !== false;
return Ext.apply(data, {
editableCls: (readOnly || !editable) ? ' ' + me.triggerNoEditCls : '',
readOnly: !editable || readOnly
});
},
getLabelableRenderData: function() {
var me = this,
triggerWrapCls = me.triggerWrapCls,
result = me.callParent(arguments);
return Ext.applyIf(result, {
triggerWrapCls: triggerWrapCls,
triggerMarkup: me.getTriggerMarkup()
});
},
getTriggerMarkup: function() {
var me = this,
i = 0,
hideTrigger = (me.readOnly || me.hideTrigger),
triggerCls,
triggerBaseCls = me.triggerBaseCls,
triggerConfigs = [];
// TODO this trigger<n>Cls API design doesn't feel clean, especially where it butts up against the
// single triggerCls config. Should rethink this, perhaps something more structured like a list of
// trigger config objects that hold cls, handler, etc.
// triggerCls is a synonym for trigger1Cls, so copy it.
if (!me.trigger1Cls) {
me.trigger1Cls = me.triggerCls;
}
// Create as many trigger elements as we have trigger<n>Cls configs, but always at least one
for (i = 0; (triggerCls = me['trigger' + (i + 1) + 'Cls']) || i < 1; i++) {
triggerConfigs.push({
tag: 'td',
valign: 'top',
cls: Ext.baseCSSPrefix + 'trigger-cell',
style: 'width:' + me.triggerWidth + (hideTrigger ? 'px;display:none' : 'px'),
cn: {
cls: [Ext.baseCSSPrefix + 'trigger-index-' + i, triggerBaseCls, triggerCls].join(' '),
role: 'button'
}
});
}
triggerConfigs[i - 1].cn.cls += ' ' + triggerBaseCls + '-last';
return Ext.DomHelper.markup(triggerConfigs);
},
disableCheck: function() {
return !this.disabled;
},
// private
beforeRender: function() {
var me = this,
triggerBaseCls = me.triggerBaseCls,
tempEl;
<span id='Ext-form-field-Trigger-property-triggerWidth'> /**
</span> * @property {Number} triggerWidth
* Width of the trigger element. Unless set explicitly, it will be
* automatically calculated through creating a temporary element
* on page. (That will be done just once per app run.)
* @private
*/
if (!me.triggerWidth) {
tempEl = Ext.resetElement.createChild({
style: 'position: absolute;',
cls: Ext.baseCSSPrefix + 'form-trigger'
});
Ext.form.field.Trigger.prototype.triggerWidth = tempEl.getWidth();
tempEl.remove();
}
me.callParent();
if (triggerBaseCls != Ext.baseCSSPrefix + 'form-trigger') {
// we may need to change the selectors by which we extract trigger elements if is triggerBaseCls isn't the value we
// stuck in childEls
me.addChildEls({ name: 'triggerEl', select: '.' + triggerBaseCls });
}
// these start correct in the fieldSubTpl:
me.lastTriggerStateFlags = me.getTriggerStateFlags();
},
onRender: function() {
var me = this;
me.callParent(arguments);
me.doc = Ext.getDoc();
me.initTrigger();
me.triggerEl.unselectable();
},
<span id='Ext-form-field-Trigger-method-getTriggerWidth'> /**
</span> * Get the total width of the trigger button area.
* @return {Number} The total trigger width
*/
getTriggerWidth: function() {
var me = this,
totalTriggerWidth = 0;
if (me.triggerWrap && !me.hideTrigger && !me.readOnly) {
totalTriggerWidth = me.triggerEl.getCount() * me.triggerWidth;
}
return totalTriggerWidth;
},
setHideTrigger: function(hideTrigger) {
if (hideTrigger != this.hideTrigger) {
this.hideTrigger = hideTrigger;
this.updateLayout();
}
},
<span id='Ext-form-field-Trigger-method-setEditable'> /**
</span> * Sets the editable state of this field. This method is the runtime equivalent of setting the 'editable' config
* option at config time.
* @param {Boolean} editable True to allow the user to directly edit the field text. If false is passed, the user
* will only be able to modify the field using the trigger. Will also add a click event to the text field which
* will call the trigger.
*/
setEditable: function(editable) {
if (editable != this.editable) {
this.editable = editable;
this.updateLayout();
}
},
<span id='Ext-form-field-Trigger-method-setReadOnly'> /**
</span> * Sets the read-only state of this field. This method is the runtime equivalent of setting the 'readOnly' config
* option at config time.
* @param {Boolean} readOnly True to prevent the user changing the field and explicitly hide the trigger. Setting
* this to true will supercede settings editable and hideTrigger. Setting this to false will defer back to editable
* and hideTrigger.
*/
setReadOnly: function(readOnly) {
if (readOnly != this.readOnly) {
this.readOnly = readOnly;
this.updateLayout();
}
},
// private
initTrigger: function() {
var me = this,
triggerWrap = me.triggerWrap,
triggerEl = me.triggerEl,
disableCheck = me.disableCheck,
els, eLen, el, e, idx;
if (me.repeatTriggerClick) {
me.triggerRepeater = new Ext.util.ClickRepeater(triggerWrap, {
preventDefault: true,
handler: me.onTriggerWrapClick,
listeners: {
mouseup: me.onTriggerWrapMouseup,
scope: me
},
scope: me
});
} else {
me.mon(triggerWrap, {
click: me.onTriggerWrapClick,
mouseup: me.onTriggerWrapMouseup,
scope: me
});
}
triggerEl.setVisibilityMode(Ext.Element.DISPLAY);
triggerEl.addClsOnOver(me.triggerBaseCls + '-over', disableCheck, me);
els = triggerEl.elements;
eLen = els.length;
for (e = 0; e < eLen; e++) {
el = els[e];
idx = e+1;
el.addClsOnOver(me['trigger' + (idx) + 'Cls'] + '-over', disableCheck, me);
el.addClsOnClick(me['trigger' + (idx) + 'Cls'] + '-click', disableCheck, me);
}
triggerEl.addClsOnClick(me.triggerBaseCls + '-click', disableCheck, me);
},
// private
onDestroy: function() {
var me = this;
Ext.destroyMembers(me, 'triggerRepeater', 'triggerWrap', 'triggerEl');
delete me.doc;
me.callParent();
},
// private
onFocus: function() {
var me = this;
me.callParent(arguments);
if (!me.mimicing) {
me.bodyEl.addCls(me.wrapFocusCls);
me.mimicing = true;
me.mon(me.doc, 'mousedown', me.mimicBlur, me, {
delay: 10
});
if (me.monitorTab) {
me.on('specialkey', me.checkTab, me);
}
}
},
// private
checkTab: function(me, e) {
if (!this.ignoreMonitorTab && e.getKey() == e.TAB) {
this.triggerBlur();
}
},
<span id='Ext-form-field-Trigger-method-getTriggerStateFlags'> /**
</span> * Returns a set of flags that describe the trigger state. These are just used to easily
* determine if the DOM is out-of-sync with the component's properties.
* @private
*/
getTriggerStateFlags: function () {
var me = this,
state = 0;
if (me.readOnly) {
state += 1;
}
if (me.editable) {
state += 2;
}
if (me.hideTrigger) {
state += 4;
}
return state;
},
<span id='Ext-form-field-Trigger-method-onBlur'> /**
</span> * @private
* The default blur handling must not occur for a TriggerField, implementing this template method as emptyFn disables that.
* Instead the tab key is monitored, and the superclass's onBlur is called when tab is detected
*/
onBlur: Ext.emptyFn,
// private
mimicBlur: function(e) {
if (!this.isDestroyed && !this.bodyEl.contains(e.target) && this.validateBlur(e)) {
this.triggerBlur(e);
}
},
// private
triggerBlur: function(e) {
var me = this;
me.mimicing = false;
me.mun(me.doc, 'mousedown', me.mimicBlur, me);
if (me.monitorTab && me.inputEl) {
me.un('specialkey', me.checkTab, me);
}
Ext.form.field.Trigger.superclass.onBlur.call(me, e);
if (me.bodyEl) {
me.bodyEl.removeCls(me.wrapFocusCls);
}
},
// private
// This should be overridden by any subclass that needs to check whether or not the field can be blurred.
validateBlur: function(e) {
return true;
},
// private
// process clicks upon triggers.
// determine which trigger index, and dispatch to the appropriate click handler
onTriggerWrapClick: function() {
var me = this,
targetEl, match,
triggerClickMethod,
event;
event = arguments[me.triggerRepeater ? 1 : 0];
if (event && !me.readOnly && !me.disabled) {
targetEl = event.getTarget('.' + me.triggerBaseCls, null);
match = targetEl && targetEl.className.match(me.triggerIndexRe);
if (match) {
triggerClickMethod = me['onTrigger' + (parseInt(match[1], 10) + 1) + 'Click'] || me.onTriggerClick;
if (triggerClickMethod) {
triggerClickMethod.call(me, event);
}
}
}
},
// private
// Handle trigger mouse up gesture. To be implemented in subclasses.
// Currently the Spinner subclass refocuses the input element upon end of spin.
onTriggerWrapMouseup: Ext.emptyFn,
<span id='Ext-form-field-Trigger-method-onTriggerClick'> /**
</span> * @method onTriggerClick
* @protected
* The function that should handle the trigger's click event. This method does nothing by default until overridden
* by an implementing function. See Ext.form.field.ComboBox and Ext.form.field.Date for sample implementations.
* @param {Ext.EventObject} e
*/
onTriggerClick: Ext.emptyFn
<span id='Ext-form-field-Trigger-cfg-grow'> /**
</span> * @cfg {Boolean} grow
* @private
*/
<span id='Ext-form-field-Trigger-cfg-growMin'> /**
</span> * @cfg {Number} growMin
* @private
*/
<span id='Ext-form-field-Trigger-cfg-growMax'> /**
</span> * @cfg {Number} growMax
* @private
*/
});
</pre>
</body>
</html>