3 * Copyright(c) 2006-2010 Ext JS, Inc.
5 * http://www.extjs.com/license
8 * @class Ext.form.Field
9 * @extends Ext.BoxComponent
10 * Base class for form fields that provides default event handling, sizing, value handling and other functionality.
13 * @param {Object} config Configuration options
16 Ext.form.Field = Ext.extend(Ext.BoxComponent, {
18 * <p>The label Element associated with this Field. <b>Only available after this Field has been rendered by a
19 * {@link form Ext.layout.FormLayout} layout manager.</b></p>
24 * @cfg {String} inputType The type attribute for input fields -- e.g. radio, text, password, file (defaults
25 * to 'text'). The types 'file' and 'password' must be used to render those field types currently -- there are
26 * no separate Ext components for those. Note that if you use <tt>inputType:'file'</tt>, {@link #emptyText}
27 * is not supported and should be avoided.
30 * @cfg {Number} tabIndex The tabIndex for this field. Note this only applies to fields that are rendered,
31 * not those which are built via applyTo (defaults to undefined).
34 * @cfg {Mixed} value A value to initialize this field with (defaults to undefined).
37 * @cfg {String} name The field's HTML name attribute (defaults to '').
38 * <b>Note</b>: this property must be set if this field is to be automatically included with
39 * {@link Ext.form.BasicForm#submit form submit()}.
42 * @cfg {String} cls A custom CSS class to apply to the field's underlying element (defaults to '').
46 * @cfg {String} invalidClass The CSS class to use when marking a field invalid (defaults to 'x-form-invalid')
48 invalidClass : 'x-form-invalid',
50 * @cfg {String} invalidText The error text to use when marking a field invalid and no message is provided
51 * (defaults to 'The value in this field is invalid')
53 invalidText : 'The value in this field is invalid',
55 * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to 'x-form-focus')
57 focusClass : 'x-form-focus',
59 * @cfg {Boolean} preventMark
60 * <tt>true</tt> to disable {@link #markInvalid marking the field invalid}.
61 * Defaults to <tt>false</tt>.
64 * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable
65 automatic validation (defaults to 'keyup').
67 validationEvent : 'keyup',
69 * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true).
71 validateOnBlur : true,
73 * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation
74 * is initiated (defaults to 250)
76 validationDelay : 250,
78 * @cfg {String/Object} autoCreate <p>A {@link Ext.DomHelper DomHelper} element spec, or true for a default
79 * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
80 * See <tt>{@link Ext.Component#autoEl autoEl}</tt> for details. Defaults to:</p>
81 * <pre><code>{tag: 'input', type: 'text', size: '20', autocomplete: 'off'}</code></pre>
83 defaultAutoCreate : {tag: 'input', type: 'text', size: '20', autocomplete: 'off'},
85 * @cfg {String} fieldClass The default CSS class for the field (defaults to 'x-form-field')
87 fieldClass : 'x-form-field',
89 * @cfg {String} msgTarget <p>The location where the message text set through {@link #markInvalid} should display.
90 * Must be one of the following values:</p>
91 * <div class="mdetail-params"><ul>
92 * <li><code>qtip</code> Display a quick tip containing the message when the user hovers over the field. This is the default.
93 * <div class="subdesc"><b>{@link Ext.QuickTips#init Ext.QuickTips.init} must have been called for this setting to work.</b></div</li>
94 * <li><code>title</code> Display the message in a default browser title attribute popup.</li>
95 * <li><code>under</code> Add a block div beneath the field containing the error message.</li>
96 * <li><code>side</code> Add an error icon to the right of the field, displaying the message in a popup on hover.</li>
97 * <li><code>[element id]</code> Add the error message directly to the innerHTML of the specified element.</li>
102 * @cfg {String} msgFx <b>Experimental</b> The effect used when displaying a validation message under the field
103 * (defaults to 'normal').
107 * @cfg {Boolean} readOnly <tt>true</tt> to mark the field as readOnly in HTML
108 * (defaults to <tt>false</tt>).
109 * <br><p><b>Note</b>: this only sets the element's readOnly DOM attribute.
110 * Setting <code>readOnly=true</code>, for example, will not disable triggering a
111 * ComboBox or DateField; it gives you the option of forcing the user to choose
112 * via the trigger without typing in the text box. To hide the trigger use
113 * <code>{@link Ext.form.TriggerField#hideTrigger hideTrigger}</code>.</p>
117 * @cfg {Boolean} disabled True to disable the field (defaults to false).
118 * <p>Be aware that conformant with the <a href="http://www.w3.org/TR/html401/interact/forms.html#h-17.12.1">HTML specification</a>,
119 * disabled Fields will not be {@link Ext.form.BasicForm#submit submitted}.</p>
123 * @cfg {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post.
124 * Defaults to <tt>true</tt>.
138 initComponent : function(){
139 Ext.form.Field.superclass.initComponent.call(this);
143 * Fires when this field receives input focus.
144 * @param {Ext.form.Field} this
149 * Fires when this field loses input focus.
150 * @param {Ext.form.Field} this
155 * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
156 * To handle other keys see {@link Ext.Panel#keys} or {@link Ext.KeyMap}.
157 * You can check {@link Ext.EventObject#getKey} to determine which key was pressed.
158 * For example: <pre><code>
159 var form = new Ext.form.FormPanel({
162 fieldLabel: 'Field 1',
166 fieldLabel: 'Field 2',
169 specialkey: function(field, e){
170 // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN,
171 // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN
172 if (e.{@link Ext.EventObject#getKey getKey()} == e.ENTER) {
173 var form = field.ownerCt.getForm();
183 * @param {Ext.form.Field} this
184 * @param {Ext.EventObject} e The event object
189 * Fires just before the field blurs if the field value has changed.
190 * @param {Ext.form.Field} this
191 * @param {Mixed} newValue The new value
192 * @param {Mixed} oldValue The original value
197 * Fires after the field has been marked as invalid.
198 * @param {Ext.form.Field} this
199 * @param {String} msg The validation message
204 * Fires after the field has been validated with no errors.
205 * @param {Ext.form.Field} this
212 * Returns the {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
213 * attribute of the field if available.
214 * @return {String} name The field {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
216 getName : function(){
217 return this.rendered && this.el.dom.name ? this.el.dom.name : this.name || this.id || '';
221 onRender : function(ct, position){
223 var cfg = this.getAutoCreate();
226 cfg.name = this.name || this.id;
229 cfg.type = this.inputType;
233 Ext.form.Field.superclass.onRender.call(this, ct, position);
234 if(this.submitValue === false){
235 this.el.dom.removeAttribute('name');
237 var type = this.el.dom.type;
239 if(type == 'password'){
242 this.el.addClass('x-form-'+type);
245 this.setReadOnly(true);
247 if(this.tabIndex !== undefined){
248 this.el.dom.setAttribute('tabIndex', this.tabIndex);
251 this.el.addClass([this.fieldClass, this.cls]);
255 getItemCt : function(){
260 initValue : function(){
261 if(this.value !== undefined){
262 this.setValue(this.value);
263 }else if(!Ext.isEmpty(this.el.dom.value) && this.el.dom.value != this.emptyText){
264 this.setValue(this.el.dom.value);
267 * The original value of the field as configured in the {@link #value} configuration, or
268 * as loaded by the last form load operation if the form's {@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
269 * setting is <code>true</code>.
271 * @property originalValue
273 this.originalValue = this.getValue();
277 * <p>Returns true if the value of this Field has been changed from its original value.
278 * Will return false if the field is disabled or has not been rendered yet.</p>
279 * <p>Note that if the owning {@link Ext.form.BasicForm form} was configured with
280 * {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
281 * then the <i>original value</i> is updated when the values are loaded by
282 * {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#setValues setValues}.</p>
283 * @return {Boolean} True if this field has been changed from its original value (and
284 * is not disabled), false otherwise.
286 isDirty : function() {
287 if(this.disabled || !this.rendered) {
290 return String(this.getValue()) !== String(this.originalValue);
294 * Sets the read only state of this field.
295 * @param {Boolean} readOnly Whether the field should be read only.
297 setReadOnly : function(readOnly){
299 this.el.dom.readOnly = readOnly;
301 this.readOnly = readOnly;
305 afterRender : function(){
306 Ext.form.Field.superclass.afterRender.call(this);
312 fireKey : function(e){
313 if(e.isSpecialKey()){
314 this.fireEvent('specialkey', this, e);
319 * Resets the current field value to the originally loaded value and clears any validation messages.
320 * See {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
323 this.setValue(this.originalValue);
328 initEvents : function(){
329 this.mon(this.el, Ext.EventManager.useKeydown ? 'keydown' : 'keypress', this.fireKey, this);
330 this.mon(this.el, 'focus', this.onFocus, this);
332 // standardise buffer across all browsers + OS-es for consistent event order.
333 // (the 10ms buffer for Editors fixes a weird FF/Win editor issue when changing OS window focus)
334 this.mon(this.el, 'blur', this.onBlur, this, this.inEditor ? {buffer:10} : null);
338 preFocus: Ext.emptyFn,
341 onFocus : function(){
344 this.el.addClass(this.focusClass);
347 this.hasFocus = true;
349 * <p>The value that the Field had at the time it was last focused. This is the value that is passed
350 * to the {@link #change} event which is fired if the value has been changed when the Field is blurred.</p>
351 * <p><b>This will be undefined until the Field has been visited.</b> Compare {@link #originalValue}.</p>
353 * @property startValue
355 this.startValue = this.getValue();
356 this.fireEvent('focus', this);
361 beforeBlur : Ext.emptyFn,
367 this.el.removeClass(this.focusClass);
369 this.hasFocus = false;
370 if(this.validationEvent !== false && (this.validateOnBlur || this.validationEvent == 'blur')){
373 var v = this.getValue();
374 if(String(v) !== String(this.startValue)){
375 this.fireEvent('change', this, v, this.startValue);
377 this.fireEvent('blur', this);
382 postBlur : Ext.emptyFn,
385 * Returns whether or not the field value is currently valid by
386 * {@link #validateValue validating} the {@link #processValue processed value}
387 * of the field. <b>Note</b>: {@link #disabled} fields are ignored.
388 * @param {Boolean} preventMark True to disable marking the field invalid
389 * @return {Boolean} True if the value is valid, else false
391 isValid : function(preventMark){
395 var restore = this.preventMark;
396 this.preventMark = preventMark === true;
397 var v = this.validateValue(this.processValue(this.getRawValue()));
398 this.preventMark = restore;
403 * Validates the field value
404 * @return {Boolean} True if the value is valid, else false
406 validate : function(){
407 if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
415 * This method should only be overridden if necessary to prepare raw values
416 * for validation (see {@link #validate} and {@link #isValid}). This method
417 * is expected to return the processed value for the field which will
418 * be used for validation (see validateValue method).
419 * @param {Mixed} value
421 processValue : function(value){
426 * Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
427 * with the first and false is returned, otherwise true is returned. Previously, subclasses were invited
428 * to provide an implementation of this to process validations - from 3.2 onwards getErrors should be
429 * overridden instead.
430 * @param {Mixed} The current value of the field
431 * @return {Boolean} True if all validations passed, false if one or more failed
433 validateValue : function(value) {
434 //currently, we only show 1 error at a time for a field, so just use the first one
435 var error = this.getErrors(value)[0];
437 if (error == undefined) {
440 this.markInvalid(error);
446 * Runs this field's validators and returns an array of error messages for any validation failures.
447 * This is called internally during validation and would not usually need to be used manually.
448 * Each subclass should override or augment the return value to provide their own errors
449 * @return {Array} All error messages for this field
451 getErrors: function() {
456 * Gets the active error message for this field.
457 * @return {String} Returns the active error message on the field, if there is no error, an empty string is returned.
459 getActiveError : function(){
460 return this.activeError || '';
464 * <p>Display an error message associated with this field, using {@link #msgTarget} to determine how to
465 * display the message and applying {@link #invalidClass} to the field's UI element.</p>
466 * <p><b>Note</b>: this method does not cause the Field's {@link #validate} method to return <code>false</code>
467 * if the value does <i>pass</i> validation. So simply marking a Field as invalid will not prevent
468 * submission of forms submitted with the {@link Ext.form.Action.Submit#clientValidation} option set.</p>
469 * {@link #isValid invalid}.
470 * @param {String} msg (optional) The validation message (defaults to {@link #invalidText})
472 markInvalid : function(msg){
473 //don't set the error icon if we're not rendered or marking is prevented
474 if (this.rendered && !this.preventMark) {
475 msg = msg || this.invalidText;
477 var mt = this.getMessageHandler();
480 }else if(this.msgTarget){
481 this.el.addClass(this.invalidClass);
482 var t = Ext.getDom(this.msgTarget);
485 t.style.display = this.msgDisplay;
490 this.setActiveError(msg);
494 * Clear any invalid styles/messages for this field
496 clearInvalid : function(){
497 //don't remove the error icon if we're not rendered or marking is prevented
498 if (this.rendered && !this.preventMark) {
499 this.el.removeClass(this.invalidClass);
500 var mt = this.getMessageHandler();
503 }else if(this.msgTarget){
504 this.el.removeClass(this.invalidClass);
505 var t = Ext.getDom(this.msgTarget);
508 t.style.display = 'none';
513 this.unsetActiveError();
517 * Sets the current activeError to the given string. Fires the 'invalid' event.
518 * This does not set up the error icon, only sets the message and fires the event. To show the error icon,
519 * use markInvalid instead, which calls this method internally
520 * @param {String} msg The error message
521 * @param {Boolean} suppressEvent True to suppress the 'invalid' event from being fired
523 setActiveError: function(msg, suppressEvent) {
524 this.activeError = msg;
525 if (suppressEvent !== true) this.fireEvent('invalid', this, msg);
529 * Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
530 * usually need to be called manually
531 * @param {Boolean} suppressEvent True to suppress the 'invalid' event from being fired
533 unsetActiveError: function(suppressEvent) {
534 delete this.activeError;
535 if (suppressEvent !== true) this.fireEvent('valid', this);
539 getMessageHandler : function(){
540 return Ext.form.MessageTargets[this.msgTarget];
544 getErrorCt : function(){
545 return this.el.findParent('.x-form-element', 5, true) || // use form element wrap if available
546 this.el.findParent('.x-form-field-wrap', 5, true); // else direct field wrap
549 // Alignment for 'under' target
550 alignErrorEl : function(){
551 this.errorEl.setWidth(this.getErrorCt().getWidth(true) - 20);
554 // Alignment for 'side' target
555 alignErrorIcon : function(){
556 this.errorIcon.alignTo(this.el, 'tl-tr', [2, 0]);
560 * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.
561 * @return {Mixed} value The field value
563 getRawValue : function(){
564 var v = this.rendered ? this.el.getValue() : Ext.value(this.value, '');
565 if(v === this.emptyText){
572 * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.
573 * @return {Mixed} value The field value
575 getValue : function(){
579 var v = this.el.getValue();
580 if(v === this.emptyText || v === undefined){
587 * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.
588 * @param {Mixed} value The value to set
589 * @return {Mixed} value The field value that is set
591 setRawValue : function(v){
592 return this.rendered ? (this.el.dom.value = (Ext.isEmpty(v) ? '' : v)) : '';
596 * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.
597 * @param {Mixed} value The value to set
598 * @return {Ext.form.Field} this
600 setValue : function(v){
603 this.el.dom.value = (Ext.isEmpty(v) ? '' : v);
609 // private, does not work for all fields
610 append : function(v){
611 this.setValue([this.getValue(), v].join(''));
615 * @cfg {Boolean} autoWidth @hide
618 * @cfg {Boolean} autoHeight @hide
622 * @cfg {String} autoEl @hide
627 Ext.form.MessageTargets = {
629 mark: function(field, msg){
630 field.el.addClass(field.invalidClass);
631 field.el.dom.qtip = msg;
632 field.el.dom.qclass = 'x-form-invalid-tip';
633 if(Ext.QuickTips){ // fix for floating editors interacting with DND
634 Ext.QuickTips.enable();
637 clear: function(field){
638 field.el.removeClass(field.invalidClass);
639 field.el.dom.qtip = '';
643 mark: function(field, msg){
644 field.el.addClass(field.invalidClass);
645 field.el.dom.title = msg;
647 clear: function(field){
648 field.el.dom.title = '';
652 mark: function(field, msg){
653 field.el.addClass(field.invalidClass);
655 var elp = field.getErrorCt();
656 if(!elp){ // field has no container el
657 field.el.dom.title = msg;
660 field.errorEl = elp.createChild({cls:'x-form-invalid-msg'});
661 field.on('resize', field.alignErrorEl, field);
662 field.on('destroy', function(){
663 Ext.destroy(this.errorEl);
666 field.alignErrorEl();
667 field.errorEl.update(msg);
668 Ext.form.Field.msgFx[field.msgFx].show(field.errorEl, field);
670 clear: function(field){
671 field.el.removeClass(field.invalidClass);
673 Ext.form.Field.msgFx[field.msgFx].hide(field.errorEl, field);
675 field.el.dom.title = '';
680 mark: function(field, msg){
681 field.el.addClass(field.invalidClass);
682 if(!field.errorIcon){
683 var elp = field.getErrorCt();
684 // field has no container el
686 field.el.dom.title = msg;
689 field.errorIcon = elp.createChild({cls:'x-form-invalid-icon'});
691 field.ownerCt.on('afterlayout', field.alignErrorIcon, field);
692 field.ownerCt.on('expand', field.alignErrorIcon, field);
694 field.on('resize', field.alignErrorIcon, field);
695 field.on('destroy', function(){
696 Ext.destroy(this.errorIcon);
699 field.alignErrorIcon();
700 field.errorIcon.dom.qtip = msg;
701 field.errorIcon.dom.qclass = 'x-form-invalid-tip';
702 field.errorIcon.show();
704 clear: function(field){
705 field.el.removeClass(field.invalidClass);
707 field.errorIcon.dom.qtip = '';
708 field.errorIcon.hide();
710 field.el.dom.title = '';
716 // anything other than normal should be considered experimental
717 Ext.form.Field.msgFx = {
719 show: function(msgEl, f){
720 msgEl.setDisplayed('block');
723 hide : function(msgEl, f){
724 msgEl.setDisplayed(false).update('');
729 show: function(msgEl, f){
730 msgEl.slideIn('t', {stopFx:true});
733 hide : function(msgEl, f){
734 msgEl.slideOut('t', {stopFx:true,useDisplay:true});
739 show: function(msgEl, f){
741 msgEl.alignTo(f.el, 'tl-tr');
742 msgEl.slideIn('l', {stopFx:true});
745 hide : function(msgEl, f){
746 msgEl.slideOut('l', {stopFx:true,useDisplay:true});
750 Ext.reg('field', Ext.form.Field);
752 * @class Ext.form.TextField
753 * @extends Ext.form.Field
754 * <p>Basic text field. Can be used as a direct replacement for traditional text inputs,
755 * or as the base class for more sophisticated input controls (like {@link Ext.form.TextArea}
756 * and {@link Ext.form.ComboBox}).</p>
757 * <p><b><u>Validation</u></b></p>
758 * <p>The validation procedure is described in the documentation for {@link #validateValue}.</p>
759 * <p><b><u>Alter Validation Behavior</u></b></p>
760 * <p>Validation behavior for each field can be configured:</p>
761 * <div class="mdetail-params"><ul>
762 * <li><code>{@link Ext.form.TextField#invalidText invalidText}</code> : the default validation message to
763 * show if any validation step above does not provide a message when invalid</li>
764 * <li><code>{@link Ext.form.TextField#maskRe maskRe}</code> : filter out keystrokes before any validation occurs</li>
765 * <li><code>{@link Ext.form.TextField#stripCharsRe stripCharsRe}</code> : filter characters after being typed in,
766 * but before being validated</li>
767 * <li><code>{@link Ext.form.Field#invalidClass invalidClass}</code> : alternate style when invalid</li>
768 * <li><code>{@link Ext.form.Field#validateOnBlur validateOnBlur}</code>,
769 * <code>{@link Ext.form.Field#validationDelay validationDelay}</code>, and
770 * <code>{@link Ext.form.Field#validationEvent validationEvent}</code> : modify how/when validation is triggered</li>
773 * @constructor Creates a new TextField
774 * @param {Object} config Configuration options
778 Ext.form.TextField = Ext.extend(Ext.form.Field, {
780 * @cfg {String} vtypeText A custom error message to display in place of the default message provided
781 * for the <b><code>{@link #vtype}</code></b> currently set for this field (defaults to <tt>''</tt>). <b>Note</b>:
782 * only applies if <b><code>{@link #vtype}</code></b> is set, else ignored.
785 * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value
786 * before validation (defaults to <tt>null</tt>).
789 * @cfg {Boolean} grow <tt>true</tt> if this field should automatically grow and shrink to its content
790 * (defaults to <tt>false</tt>)
794 * @cfg {Number} growMin The minimum width to allow when <code><b>{@link #grow}</b> = true</code> (defaults
799 * @cfg {Number} growMax The maximum width to allow when <code><b>{@link #grow}</b> = true</code> (defaults
804 * @cfg {String} vtype A validation type name as defined in {@link Ext.form.VTypes} (defaults to <tt>null</tt>)
808 * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do
809 * not match (defaults to <tt>null</tt>)
813 * @cfg {Boolean} disableKeyFilter Specify <tt>true</tt> to disable input keystroke filtering (defaults
816 disableKeyFilter : false,
818 * @cfg {Boolean} allowBlank Specify <tt>false</tt> to validate that the value's length is > 0 (defaults to
823 * @cfg {Number} minLength Minimum input field length required (defaults to <tt>0</tt>)
827 * @cfg {Number} maxLength Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
828 * This behavior is intended to provide instant feedback to the user by improving usability to allow pasting
829 * and editing or overtyping and back tracking. To restrict the maximum number of characters that can be
830 * entered into the field use <tt><b>{@link Ext.form.Field#autoCreate autoCreate}</b></tt> to add
831 * any attributes you want to a field, for example:<pre><code>
832 var myField = new Ext.form.NumberField({
835 fieldLabel: 'Mobile',
836 maxLength: 16, // for validation
837 autoCreate: {tag: 'input', type: 'text', size: '20', autocomplete: 'off', maxlength: '10'}
841 maxLength : Number.MAX_VALUE,
843 * @cfg {String} minLengthText Error text to display if the <b><tt>{@link #minLength minimum length}</tt></b>
844 * validation fails (defaults to <tt>'The minimum length for this field is {minLength}'</tt>)
846 minLengthText : 'The minimum length for this field is {0}',
848 * @cfg {String} maxLengthText Error text to display if the <b><tt>{@link #maxLength maximum length}</tt></b>
849 * validation fails (defaults to <tt>'The maximum length for this field is {maxLength}'</tt>)
851 maxLengthText : 'The maximum length for this field is {0}',
853 * @cfg {Boolean} selectOnFocus <tt>true</tt> to automatically select any existing field text when the field
854 * receives input focus (defaults to <tt>false</tt>)
856 selectOnFocus : false,
858 * @cfg {String} blankText The error text to display if the <b><tt>{@link #allowBlank}</tt></b> validation
859 * fails (defaults to <tt>'This field is required'</tt>)
861 blankText : 'This field is required',
863 * @cfg {Function} validator
864 * <p>A custom validation function to be called during field validation ({@link #validateValue})
865 * (defaults to <tt>null</tt>). If specified, this function will be called first, allowing the
866 * developer to override the default validation process.</p>
867 * <br><p>This function will be passed the following Parameters:</p>
868 * <div class="mdetail-params"><ul>
869 * <li><code>value</code>: <i>Mixed</i>
870 * <div class="sub-desc">The current field value</div></li>
872 * <br><p>This function is to Return:</p>
873 * <div class="mdetail-params"><ul>
874 * <li><code>true</code>: <i>Boolean</i>
875 * <div class="sub-desc"><code>true</code> if the value is valid</div></li>
876 * <li><code>msg</code>: <i>String</i>
877 * <div class="sub-desc">An error message if the value is invalid</div></li>
882 * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation
883 * (defaults to <tt>null</tt>). If the test fails, the field will be marked invalid using
884 * <b><tt>{@link #regexText}</tt></b>.
888 * @cfg {String} regexText The error text to display if <b><tt>{@link #regex}</tt></b> is used and the
889 * test fails during validation (defaults to <tt>''</tt>)
893 * @cfg {String} emptyText The default text to place into an empty field (defaults to <tt>null</tt>).
894 * <b>Note</b>: that this value will be submitted to the server if this field is enabled and configured
895 * with a {@link #name}.
899 * @cfg {String} emptyClass The CSS class to apply to an empty field to style the <b><tt>{@link #emptyText}</tt></b>
900 * (defaults to <tt>'x-form-empty-field'</tt>). This class is automatically added and removed as needed
901 * depending on the current field value.
903 emptyClass : 'x-form-empty-field',
906 * @cfg {Boolean} enableKeyEvents <tt>true</tt> to enable the proxying of key events for the HTML input
907 * field (defaults to <tt>false</tt>)
910 initComponent : function(){
911 Ext.form.TextField.superclass.initComponent.call(this);
915 * Fires when the <tt><b>{@link #autoSize}</b></tt> function is triggered. The field may or
916 * may not have actually changed size according to the default logic, but this event provides
917 * a hook for the developer to apply additional logic at runtime to resize the field if needed.
918 * @param {Ext.form.Field} this This text field
919 * @param {Number} width The new field width
925 * Keydown input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
927 * @param {Ext.form.TextField} this This text field
928 * @param {Ext.EventObject} e
933 * Keyup input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
935 * @param {Ext.form.TextField} this This text field
936 * @param {Ext.EventObject} e
941 * Keypress input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
943 * @param {Ext.form.TextField} this This text field
944 * @param {Ext.EventObject} e
951 initEvents : function(){
952 Ext.form.TextField.superclass.initEvents.call(this);
953 if(this.validationEvent == 'keyup'){
954 this.validationTask = new Ext.util.DelayedTask(this.validate, this);
955 this.mon(this.el, 'keyup', this.filterValidation, this);
957 else if(this.validationEvent !== false && this.validationEvent != 'blur'){
958 this.mon(this.el, this.validationEvent, this.validate, this, {buffer: this.validationDelay});
960 if(this.selectOnFocus || this.emptyText){
961 this.mon(this.el, 'mousedown', this.onMouseDown, this);
964 this.applyEmptyText();
967 if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Ext.form.VTypes[this.vtype+'Mask']))){
968 this.mon(this.el, 'keypress', this.filterKeys, this);
971 this.mon(this.el, 'keyup', this.onKeyUpBuffered, this, {buffer: 50});
972 this.mon(this.el, 'click', this.autoSize, this);
974 if(this.enableKeyEvents){
978 keydown: this.onKeyDown,
979 keypress: this.onKeyPress
984 onMouseDown: function(e){
986 this.mon(this.el, 'mouseup', Ext.emptyFn, this, { single: true, preventDefault: true });
990 processValue : function(value){
991 if(this.stripCharsRe){
992 var newValue = value.replace(this.stripCharsRe, '');
993 if(newValue !== value){
994 this.setRawValue(newValue);
1001 filterValidation : function(e){
1002 if(!e.isNavKeyPress()){
1003 this.validationTask.delay(this.validationDelay);
1008 onDisable: function(){
1009 Ext.form.TextField.superclass.onDisable.call(this);
1011 this.el.dom.unselectable = 'on';
1016 onEnable: function(){
1017 Ext.form.TextField.superclass.onEnable.call(this);
1019 this.el.dom.unselectable = '';
1024 onKeyUpBuffered : function(e){
1025 if(this.doAutoSize(e)){
1031 doAutoSize : function(e){
1032 return !e.isNavKeyPress();
1036 onKeyUp : function(e){
1037 this.fireEvent('keyup', this, e);
1041 onKeyDown : function(e){
1042 this.fireEvent('keydown', this, e);
1046 onKeyPress : function(e){
1047 this.fireEvent('keypress', this, e);
1051 * Resets the current field value to the originally-loaded value and clears any validation messages.
1052 * Also adds <tt><b>{@link #emptyText}</b></tt> and <tt><b>{@link #emptyClass}</b></tt> if the
1053 * original value was blank.
1056 Ext.form.TextField.superclass.reset.call(this);
1057 this.applyEmptyText();
1060 applyEmptyText : function(){
1061 if(this.rendered && this.emptyText && this.getRawValue().length < 1 && !this.hasFocus){
1062 this.setRawValue(this.emptyText);
1063 this.el.addClass(this.emptyClass);
1068 preFocus : function(){
1071 if(el.dom.value == this.emptyText){
1072 this.setRawValue('');
1074 el.removeClass(this.emptyClass);
1076 if(this.selectOnFocus){
1082 postBlur : function(){
1083 this.applyEmptyText();
1087 filterKeys : function(e){
1092 if(Ext.isGecko && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
1095 var cc = String.fromCharCode(e.getCharCode());
1096 if(!Ext.isGecko && e.isSpecialKey() && !cc){
1099 if(!this.maskRe.test(cc)){
1104 setValue : function(v){
1105 if(this.emptyText && this.el && !Ext.isEmpty(v)){
1106 this.el.removeClass(this.emptyClass);
1108 Ext.form.TextField.superclass.setValue.apply(this, arguments);
1109 this.applyEmptyText();
1115 * <p>Validates a value according to the field's validation rules and returns an array of errors
1116 * for any failing validations. Validation rules are processed in the following order:</p>
1117 * <div class="mdetail-params"><ul>
1119 * <li><b>1. Field specific validator</b>
1120 * <div class="sub-desc">
1121 * <p>A validator offers a way to customize and reuse a validation specification.
1122 * If a field is configured with a <code>{@link #validator}</code>
1123 * function, it will be passed the current field value. The <code>{@link #validator}</code>
1124 * function is expected to return either:
1125 * <div class="mdetail-params"><ul>
1126 * <li>Boolean <tt>true</tt> if the value is valid (validation continues).</li>
1127 * <li>a String to represent the invalid message if invalid (validation halts).</li>
1131 * <li><b>2. Basic Validation</b>
1132 * <div class="sub-desc">
1133 * <p>If the <code>{@link #validator}</code> has not halted validation,
1134 * basic validation proceeds as follows:</p>
1136 * <div class="mdetail-params"><ul>
1138 * <li><code>{@link #allowBlank}</code> : (Invalid message =
1139 * <code>{@link #emptyText}</code>)<div class="sub-desc">
1140 * Depending on the configuration of <code>{@link #allowBlank}</code>, a
1141 * blank field will cause validation to halt at this step and return
1142 * Boolean true or false accordingly.
1145 * <li><code>{@link #minLength}</code> : (Invalid message =
1146 * <code>{@link #minLengthText}</code>)<div class="sub-desc">
1147 * If the passed value does not satisfy the <code>{@link #minLength}</code>
1148 * specified, validation halts.
1151 * <li><code>{@link #maxLength}</code> : (Invalid message =
1152 * <code>{@link #maxLengthText}</code>)<div class="sub-desc">
1153 * If the passed value does not satisfy the <code>{@link #maxLength}</code>
1154 * specified, validation halts.
1160 * <li><b>3. Preconfigured Validation Types (VTypes)</b>
1161 * <div class="sub-desc">
1162 * <p>If none of the prior validation steps halts validation, a field
1163 * configured with a <code>{@link #vtype}</code> will utilize the
1164 * corresponding {@link Ext.form.VTypes VTypes} validation function.
1165 * If invalid, either the field's <code>{@link #vtypeText}</code> or
1166 * the VTypes vtype Text property will be used for the invalid message.
1167 * Keystrokes on the field will be filtered according to the VTypes
1168 * vtype Mask property.</p>
1171 * <li><b>4. Field specific regex test</b>
1172 * <div class="sub-desc">
1173 * <p>If none of the prior validation steps halts validation, a field's
1174 * configured <code>{@link #regex}</code> test will be processed.
1175 * The invalid message for this test is configured with
1176 * <code>{@link #regexText}</code>.</p>
1179 * @param {Mixed} value The value to validate. The processed raw value will be used if nothing is passed
1180 * @return {Array} Array of any validation errors
1182 getErrors: function(value) {
1183 var errors = Ext.form.TextField.superclass.getErrors.apply(this, arguments);
1185 value = value || this.processValue(this.getRawValue());
1187 if (Ext.isFunction(this.validator)) {
1188 var msg = this.validator(value);
1194 if (value.length < 1 || value === this.emptyText) {
1195 if (this.allowBlank) {
1196 //if value is blank and allowBlank is true, there cannot be any additional errors
1199 errors.push(this.blankText);
1203 if (!this.allowBlank && (value.length < 1 || value === this.emptyText)) { // if it's blank
1204 errors.push(this.blankText);
1207 if (value.length < this.minLength) {
1208 errors.push(String.format(this.minLengthText, this.minLength));
1211 if (value.length > this.maxLength) {
1212 errors.push(String.format(this.maxLengthText, this.maxLength));
1216 var vt = Ext.form.VTypes;
1217 if(!vt[this.vtype](value, this)){
1218 errors.push(this.vtypeText || vt[this.vtype +'Text']);
1222 if (this.regex && !this.regex.test(value)) {
1223 errors.push(this.regexText);
1230 * Selects text in this field
1231 * @param {Number} start (optional) The index where the selection should start (defaults to 0)
1232 * @param {Number} end (optional) The index where the selection should end (defaults to the text length)
1234 selectText : function(start, end){
1235 var v = this.getRawValue();
1236 var doFocus = false;
1238 start = start === undefined ? 0 : start;
1239 end = end === undefined ? v.length : end;
1240 var d = this.el.dom;
1241 if(d.setSelectionRange){
1242 d.setSelectionRange(start, end);
1243 }else if(d.createTextRange){
1244 var range = d.createTextRange();
1245 range.moveStart('character', start);
1246 range.moveEnd('character', end-v.length);
1249 doFocus = Ext.isGecko || Ext.isOpera;
1259 * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
1260 * This only takes effect if <tt><b>{@link #grow}</b> = true</tt>, and fires the {@link #autosize} event.
1262 autoSize : function(){
1263 if(!this.grow || !this.rendered){
1267 this.metrics = Ext.util.TextMetrics.createInstance(this.el);
1270 var v = el.dom.value;
1271 var d = document.createElement('div');
1272 d.appendChild(document.createTextNode(v));
1277 var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin));
1278 this.el.setWidth(w);
1279 this.fireEvent('autosize', this, w);
1282 onDestroy: function(){
1283 if(this.validationTask){
1284 this.validationTask.cancel();
1285 this.validationTask = null;
1287 Ext.form.TextField.superclass.onDestroy.call(this);
1290 Ext.reg('textfield', Ext.form.TextField);
1292 * @class Ext.form.TriggerField
1293 * @extends Ext.form.TextField
1294 * Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).
1295 * The trigger has no default action, so you must assign a function to implement the trigger click handler by
1296 * overriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox
1297 * for which you can provide a custom implementation. For example:
1299 var trigger = new Ext.form.TriggerField();
1300 trigger.onTriggerClick = myTriggerFn;
1301 trigger.applyToMarkup('my-field');
1304 * However, in general you will most likely want to use TriggerField as the base class for a reusable component.
1305 * {@link Ext.form.DateField} and {@link Ext.form.ComboBox} are perfect examples of this.
1308 * Create a new TriggerField.
1309 * @param {Object} config Configuration options (valid {@Ext.form.TextField} config options will also be applied
1310 * to the base TextField)
1313 Ext.form.TriggerField = Ext.extend(Ext.form.TextField, {
1315 * @cfg {String} triggerClass
1316 * An additional CSS class used to style the trigger button. The trigger will always get the
1317 * class <tt>'x-form-trigger'</tt> by default and <tt>triggerClass</tt> will be <b>appended</b> if specified.
1320 * @cfg {Mixed} triggerConfig
1321 * <p>A {@link Ext.DomHelper DomHelper} config object specifying the structure of the
1322 * trigger element for this Field. (Optional).</p>
1323 * <p>Specify this when you need a customized element to act as the trigger button for a TriggerField.</p>
1324 * <p>Note that when using this option, it is the developer's responsibility to ensure correct sizing, positioning
1325 * and appearance of the trigger. Defaults to:</p>
1326 * <pre><code>{tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass}</code></pre>
1329 * @cfg {String/Object} autoCreate <p>A {@link Ext.DomHelper DomHelper} element spec, or true for a default
1330 * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
1331 * See <tt>{@link Ext.Component#autoEl autoEl}</tt> for details. Defaults to:</p>
1332 * <pre><code>{tag: "input", type: "text", size: "16", autocomplete: "off"}</code></pre>
1334 defaultAutoCreate : {tag: "input", type: "text", size: "16", autocomplete: "off"},
1336 * @cfg {Boolean} hideTrigger <tt>true</tt> to hide the trigger element and display only the base
1337 * text field (defaults to <tt>false</tt>)
1341 * @cfg {Boolean} editable <tt>false</tt> to prevent the user from typing text directly into the field,
1342 * the field will only respond to a click on the trigger to set the value. (defaults to <tt>true</tt>).
1346 * @cfg {Boolean} readOnly <tt>true</tt> to prevent the user from changing the field, and
1347 * hides the trigger. Superceeds the editable and hideTrigger options if the value is true.
1348 * (defaults to <tt>false</tt>)
1352 * @cfg {String} wrapFocusClass The class added to the to the wrap of the trigger element. Defaults to
1353 * <tt>x-trigger-wrap-focus</tt>.
1355 wrapFocusClass: 'x-trigger-wrap-focus',
1360 autoSize: Ext.emptyFn,
1370 defaultTriggerWidth: 17,
1373 onResize : function(w, h){
1374 Ext.form.TriggerField.superclass.onResize.call(this, w, h);
1375 var tw = this.getTriggerWidth();
1376 if(Ext.isNumber(w)){
1377 this.el.setWidth(w - tw);
1379 this.wrap.setWidth(this.el.getWidth() + tw);
1382 getTriggerWidth: function(){
1383 var tw = this.trigger.getWidth();
1384 if(!this.hideTrigger && !this.readOnly && tw === 0){
1385 tw = this.defaultTriggerWidth;
1391 alignErrorIcon : function(){
1393 this.errorIcon.alignTo(this.wrap, 'tl-tr', [2, 0]);
1398 onRender : function(ct, position){
1399 this.doc = Ext.isIE ? Ext.getBody() : Ext.getDoc();
1400 Ext.form.TriggerField.superclass.onRender.call(this, ct, position);
1402 this.wrap = this.el.wrap({cls: 'x-form-field-wrap x-form-field-trigger-wrap'});
1403 this.trigger = this.wrap.createChild(this.triggerConfig ||
1404 {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass});
1407 this.wrap.setWidth(this.el.getWidth()+this.trigger.getWidth());
1409 this.resizeEl = this.positionEl = this.wrap;
1412 getWidth: function() {
1413 return(this.el.getWidth() + this.trigger.getWidth());
1416 updateEditState: function(){
1418 if (this.readOnly) {
1419 this.el.dom.readOnly = true;
1420 this.el.addClass('x-trigger-noedit');
1421 this.mun(this.el, 'click', this.onTriggerClick, this);
1422 this.trigger.setDisplayed(false);
1424 if (!this.editable) {
1425 this.el.dom.readOnly = true;
1426 this.el.addClass('x-trigger-noedit');
1427 this.mon(this.el, 'click', this.onTriggerClick, this);
1429 this.el.dom.readOnly = false;
1430 this.el.removeClass('x-trigger-noedit');
1431 this.mun(this.el, 'click', this.onTriggerClick, this);
1433 this.trigger.setDisplayed(!this.hideTrigger);
1435 this.onResize(this.width || this.wrap.getWidth());
1439 setHideTrigger: function(hideTrigger){
1440 if(hideTrigger != this.hideTrigger){
1441 this.hideTrigger = hideTrigger;
1442 this.updateEditState();
1447 * @param {Boolean} value True to allow the user to directly edit the field text
1448 * Allow or prevent the user from directly editing the field text. If false is passed,
1449 * the user will only be able to modify the field using the trigger. Will also add
1450 * a click event to the text field which will call the trigger. This method
1451 * is the runtime equivalent of setting the 'editable' config option at config time.
1453 setEditable: function(editable){
1454 if(editable != this.editable){
1455 this.editable = editable;
1456 this.updateEditState();
1461 * @param {Boolean} value True to prevent the user changing the field and explicitly
1463 * Setting this to true will superceed settings editable and hideTrigger.
1464 * Setting this to false will defer back to editable and hideTrigger. This method
1465 * is the runtime equivalent of setting the 'readOnly' config option at config time.
1467 setReadOnly: function(readOnly){
1468 if(readOnly != this.readOnly){
1469 this.readOnly = readOnly;
1470 this.updateEditState();
1474 afterRender : function(){
1475 Ext.form.TriggerField.superclass.afterRender.call(this);
1476 this.updateEditState();
1480 initTrigger : function(){
1481 this.mon(this.trigger, 'click', this.onTriggerClick, this, {preventDefault:true});
1482 this.trigger.addClassOnOver('x-form-trigger-over');
1483 this.trigger.addClassOnClick('x-form-trigger-click');
1487 onDestroy : function(){
1488 Ext.destroy(this.trigger, this.wrap);
1490 this.doc.un('mousedown', this.mimicBlur, this);
1493 Ext.form.TriggerField.superclass.onDestroy.call(this);
1497 onFocus : function(){
1498 Ext.form.TriggerField.superclass.onFocus.call(this);
1500 this.wrap.addClass(this.wrapFocusClass);
1501 this.mimicing = true;
1502 this.doc.on('mousedown', this.mimicBlur, this, {delay: 10});
1503 if(this.monitorTab){
1504 this.on('specialkey', this.checkTab, this);
1510 checkTab : function(me, e){
1511 if(e.getKey() == e.TAB){
1517 onBlur : Ext.emptyFn,
1520 mimicBlur : function(e){
1521 if(!this.isDestroyed && !this.wrap.contains(e.target) && this.validateBlur(e)){
1527 triggerBlur : function(){
1528 this.mimicing = false;
1529 this.doc.un('mousedown', this.mimicBlur, this);
1530 if(this.monitorTab && this.el){
1531 this.un('specialkey', this.checkTab, this);
1533 Ext.form.TriggerField.superclass.onBlur.call(this);
1535 this.wrap.removeClass(this.wrapFocusClass);
1539 beforeBlur : Ext.emptyFn,
1542 // This should be overriden by any subclass that needs to check whether or not the field can be blurred.
1543 validateBlur : function(e){
1548 * The function that should handle the trigger's click event. This method does nothing by default
1549 * until overridden by an implementing function. See Ext.form.ComboBox and Ext.form.DateField for
1550 * sample implementations.
1552 * @param {EventObject} e
1554 onTriggerClick : Ext.emptyFn
1557 * @cfg {Boolean} grow @hide
1560 * @cfg {Number} growMin @hide
1563 * @cfg {Number} growMax @hide
1568 * @class Ext.form.TwinTriggerField
1569 * @extends Ext.form.TriggerField
1570 * TwinTriggerField is not a public class to be used directly. It is meant as an abstract base class
1571 * to be extended by an implementing class. For an example of implementing this class, see the custom
1572 * SearchField implementation here:
1573 * <a href="http://extjs.com/deploy/ext/examples/form/custom.html">http://extjs.com/deploy/ext/examples/form/custom.html</a>
1575 Ext.form.TwinTriggerField = Ext.extend(Ext.form.TriggerField, {
1577 * @cfg {Mixed} triggerConfig
1578 * <p>A {@link Ext.DomHelper DomHelper} config object specifying the structure of the trigger elements
1579 * for this Field. (Optional).</p>
1580 * <p>Specify this when you need a customized element to contain the two trigger elements for this Field.
1581 * Each trigger element must be marked by the CSS class <tt>x-form-trigger</tt> (also see
1582 * <tt>{@link #trigger1Class}</tt> and <tt>{@link #trigger2Class}</tt>).</p>
1583 * <p>Note that when using this option, it is the developer's responsibility to ensure correct sizing,
1584 * positioning and appearance of the triggers.</p>
1587 * @cfg {String} trigger1Class
1588 * An additional CSS class used to style the trigger button. The trigger will always get the
1589 * class <tt>'x-form-trigger'</tt> by default and <tt>triggerClass</tt> will be <b>appended</b> if specified.
1592 * @cfg {String} trigger2Class
1593 * An additional CSS class used to style the trigger button. The trigger will always get the
1594 * class <tt>'x-form-trigger'</tt> by default and <tt>triggerClass</tt> will be <b>appended</b> if specified.
1597 initComponent : function(){
1598 Ext.form.TwinTriggerField.superclass.initComponent.call(this);
1600 this.triggerConfig = {
1601 tag:'span', cls:'x-form-twin-triggers', cn:[
1602 {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger1Class},
1603 {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger2Class}
1607 getTrigger : function(index){
1608 return this.triggers[index];
1611 initTrigger : function(){
1612 var ts = this.trigger.select('.x-form-trigger', true);
1613 var triggerField = this;
1614 ts.each(function(t, all, index){
1615 var triggerIndex = 'Trigger'+(index+1);
1616 t.hide = function(){
1617 var w = triggerField.wrap.getWidth();
1618 this.dom.style.display = 'none';
1619 triggerField.el.setWidth(w-triggerField.trigger.getWidth());
1620 this['hidden' + triggerIndex] = true;
1622 t.show = function(){
1623 var w = triggerField.wrap.getWidth();
1624 this.dom.style.display = '';
1625 triggerField.el.setWidth(w-triggerField.trigger.getWidth());
1626 this['hidden' + triggerIndex] = false;
1629 if(this['hide'+triggerIndex]){
1630 t.dom.style.display = 'none';
1631 this['hidden' + triggerIndex] = true;
1633 this.mon(t, 'click', this['on'+triggerIndex+'Click'], this, {preventDefault:true});
1634 t.addClassOnOver('x-form-trigger-over');
1635 t.addClassOnClick('x-form-trigger-click');
1637 this.triggers = ts.elements;
1640 getTriggerWidth: function(){
1642 Ext.each(this.triggers, function(t, index){
1643 var triggerIndex = 'Trigger' + (index + 1),
1645 if(w === 0 && !this['hidden' + triggerIndex]){
1646 tw += this.defaultTriggerWidth;
1655 onDestroy : function() {
1656 Ext.destroy(this.triggers);
1657 Ext.form.TwinTriggerField.superclass.onDestroy.call(this);
1661 * The function that should handle the trigger's click event. This method does nothing by default
1662 * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
1663 * for additional information.
1665 * @param {EventObject} e
1667 onTrigger1Click : Ext.emptyFn,
1669 * The function that should handle the trigger's click event. This method does nothing by default
1670 * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
1671 * for additional information.
1673 * @param {EventObject} e
1675 onTrigger2Click : Ext.emptyFn
1677 Ext.reg('trigger', Ext.form.TriggerField);
1679 * @class Ext.form.TextArea
1680 * @extends Ext.form.TextField
1681 * Multiline text field. Can be used as a direct replacement for traditional textarea fields, plus adds
1682 * support for auto-sizing.
1684 * Creates a new TextArea
1685 * @param {Object} config Configuration options
1688 Ext.form.TextArea = Ext.extend(Ext.form.TextField, {
1690 * @cfg {Number} growMin The minimum height to allow when <tt>{@link Ext.form.TextField#grow grow}=true</tt>
1691 * (defaults to <tt>60</tt>)
1695 * @cfg {Number} growMax The maximum height to allow when <tt>{@link Ext.form.TextField#grow grow}=true</tt>
1696 * (defaults to <tt>1000</tt>)
1699 growAppend : ' \n ',
1701 enterIsSpecial : false,
1704 * @cfg {Boolean} preventScrollbars <tt>true</tt> to prevent scrollbars from appearing regardless of how much text is
1705 * in the field. This option is only relevant when {@link #grow} is <tt>true</tt>. Equivalent to setting overflow: hidden, defaults to
1708 preventScrollbars: false,
1710 * @cfg {String/Object} autoCreate <p>A {@link Ext.DomHelper DomHelper} element spec, or true for a default
1711 * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
1712 * See <tt>{@link Ext.Component#autoEl autoEl}</tt> for details. Defaults to:</p>
1713 * <pre><code>{tag: "textarea", style: "width:100px;height:60px;", autocomplete: "off"}</code></pre>
1717 onRender : function(ct, position){
1719 this.defaultAutoCreate = {
1721 style:"width:100px;height:60px;",
1725 Ext.form.TextArea.superclass.onRender.call(this, ct, position);
1727 this.textSizeEl = Ext.DomHelper.append(document.body, {
1728 tag: "pre", cls: "x-form-grow-sizer"
1730 if(this.preventScrollbars){
1731 this.el.setStyle("overflow", "hidden");
1733 this.el.setHeight(this.growMin);
1737 onDestroy : function(){
1738 Ext.removeNode(this.textSizeEl);
1739 Ext.form.TextArea.superclass.onDestroy.call(this);
1742 fireKey : function(e){
1743 if(e.isSpecialKey() && (this.enterIsSpecial || (e.getKey() != e.ENTER || e.hasModifier()))){
1744 this.fireEvent("specialkey", this, e);
1749 doAutoSize : function(e){
1750 return !e.isNavKeyPress() || e.getKey() == e.ENTER;
1754 * Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.
1755 * This only takes effect if grow = true, and fires the {@link #autosize} event if the height changes.
1757 autoSize: function(){
1758 if(!this.grow || !this.textSizeEl){
1762 v = Ext.util.Format.htmlEncode(el.dom.value),
1763 ts = this.textSizeEl,
1766 Ext.fly(ts).setWidth(this.el.getWidth());
1770 v += this.growAppend;
1772 v = v.replace(/\n/g, ' <br />');
1776 h = Math.min(this.growMax, Math.max(ts.offsetHeight, this.growMin));
1777 if(h != this.lastHeight){
1778 this.lastHeight = h;
1779 this.el.setHeight(h);
1780 this.fireEvent("autosize", this, h);
1784 Ext.reg('textarea', Ext.form.TextArea);/**
1785 * @class Ext.form.NumberField
1786 * @extends Ext.form.TextField
1787 * Numeric text field that provides automatic keystroke filtering and numeric validation.
1789 * Creates a new NumberField
1790 * @param {Object} config Configuration options
1791 * @xtype numberfield
1793 Ext.form.NumberField = Ext.extend(Ext.form.TextField, {
1795 * @cfg {RegExp} stripCharsRe @hide
1798 * @cfg {RegExp} maskRe @hide
1801 * @cfg {String} fieldClass The default CSS class for the field (defaults to "x-form-field x-form-num-field")
1803 fieldClass: "x-form-field x-form-num-field",
1805 * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true)
1807 allowDecimals : true,
1809 * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.')
1811 decimalSeparator : ".",
1813 * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2)
1815 decimalPrecision : 2,
1817 * @cfg {Boolean} allowNegative False to prevent entering a negative sign (defaults to true)
1819 allowNegative : true,
1821 * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)
1823 minValue : Number.NEGATIVE_INFINITY,
1825 * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE)
1827 maxValue : Number.MAX_VALUE,
1829 * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")
1831 minText : "The minimum value for this field is {0}",
1833 * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")
1835 maxText : "The maximum value for this field is {0}",
1837 * @cfg {String} nanText Error text to display if the value is not a valid number. For example, this can happen
1838 * if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number")
1840 nanText : "{0} is not a valid number",
1842 * @cfg {String} baseChars The base set of characters to evaluate as valid numbers (defaults to '0123456789').
1844 baseChars : "0123456789",
1847 initEvents : function(){
1848 var allowed = this.baseChars + '';
1849 if (this.allowDecimals) {
1850 allowed += this.decimalSeparator;
1852 if (this.allowNegative) {
1855 this.maskRe = new RegExp('[' + Ext.escapeRe(allowed) + ']');
1856 Ext.form.NumberField.superclass.initEvents.call(this);
1860 * Runs all of NumberFields validations and returns an array of any errors. Note that this first
1861 * runs TextField's validations, so the returned array is an amalgamation of all field errors.
1862 * The additional validations run test that the value is a number, and that it is within the
1863 * configured min and max values.
1864 * @param {Mixed} value The value to get errors for (defaults to the current field value)
1865 * @return {Array} All validation errors for this field
1867 getErrors: function(value) {
1868 var errors = Ext.form.NumberField.superclass.getErrors.apply(this, arguments);
1870 value = value || this.processValue(this.getRawValue());
1872 if (value.length < 1) { // if it's blank and textfield didn't flag it then it's valid
1876 value = String(value).replace(this.decimalSeparator, ".");
1879 errors.push(String.format(this.nanText, value));
1882 var num = this.parseValue(value);
1884 if(num < this.minValue){
1885 errors.push(String.format(this.minText, this.minValue));
1888 if(num > this.maxValue){
1889 errors.push(String.format(this.maxText, this.maxValue));
1895 getValue : function(){
1896 return this.fixPrecision(this.parseValue(Ext.form.NumberField.superclass.getValue.call(this)));
1899 setValue : function(v){
1900 v = Ext.isNumber(v) ? v : parseFloat(String(v).replace(this.decimalSeparator, "."));
1901 v = isNaN(v) ? '' : String(v).replace(".", this.decimalSeparator);
1902 return Ext.form.NumberField.superclass.setValue.call(this, v);
1906 * Replaces any existing {@link #minValue} with the new value.
1907 * @param {Number} value The minimum value
1909 setMinValue : function(value){
1910 this.minValue = Ext.num(value, Number.NEGATIVE_INFINITY);
1914 * Replaces any existing {@link #maxValue} with the new value.
1915 * @param {Number} value The maximum value
1917 setMaxValue : function(value){
1918 this.maxValue = Ext.num(value, Number.MAX_VALUE);
1922 parseValue : function(value){
1923 value = parseFloat(String(value).replace(this.decimalSeparator, "."));
1924 return isNaN(value) ? '' : value;
1928 fixPrecision : function(value){
1929 var nan = isNaN(value);
1930 if(!this.allowDecimals || this.decimalPrecision == -1 || nan || !value){
1931 return nan ? '' : value;
1933 return parseFloat(parseFloat(value).toFixed(this.decimalPrecision));
1936 beforeBlur : function(){
1937 var v = this.parseValue(this.getRawValue());
1938 if(!Ext.isEmpty(v)){
1939 this.setValue(this.fixPrecision(v));
1943 Ext.reg('numberfield', Ext.form.NumberField);/**
1944 * @class Ext.form.DateField
1945 * @extends Ext.form.TriggerField
1946 * Provides a date input field with a {@link Ext.DatePicker} dropdown and automatic date validation.
1948 * Create a new DateField
1949 * @param {Object} config
1952 Ext.form.DateField = Ext.extend(Ext.form.TriggerField, {
1954 * @cfg {String} format
1955 * The default date format string which can be overriden for localization support. The format must be
1956 * valid according to {@link Date#parseDate} (defaults to <tt>'m/d/Y'</tt>).
1960 * @cfg {String} altFormats
1961 * Multiple date formats separated by "<tt>|</tt>" to try when parsing a user input value and it
1962 * does not match the defined format (defaults to
1963 * <tt>'m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d'</tt>).
1965 altFormats : "m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d",
1967 * @cfg {String} disabledDaysText
1968 * The tooltip to display when the date falls on a disabled day (defaults to <tt>'Disabled'</tt>)
1970 disabledDaysText : "Disabled",
1972 * @cfg {String} disabledDatesText
1973 * The tooltip text to display when the date falls on a disabled date (defaults to <tt>'Disabled'</tt>)
1975 disabledDatesText : "Disabled",
1977 * @cfg {String} minText
1978 * The error text to display when the date in the cell is before <tt>{@link #minValue}</tt> (defaults to
1979 * <tt>'The date in this field must be after {minValue}'</tt>).
1981 minText : "The date in this field must be equal to or after {0}",
1983 * @cfg {String} maxText
1984 * The error text to display when the date in the cell is after <tt>{@link #maxValue}</tt> (defaults to
1985 * <tt>'The date in this field must be before {maxValue}'</tt>).
1987 maxText : "The date in this field must be equal to or before {0}",
1989 * @cfg {String} invalidText
1990 * The error text to display when the date in the field is invalid (defaults to
1991 * <tt>'{value} is not a valid date - it must be in the format {format}'</tt>).
1993 invalidText : "{0} is not a valid date - it must be in the format {1}",
1995 * @cfg {String} triggerClass
1996 * An additional CSS class used to style the trigger button. The trigger will always get the
1997 * class <tt>'x-form-trigger'</tt> and <tt>triggerClass</tt> will be <b>appended</b> if specified
1998 * (defaults to <tt>'x-form-date-trigger'</tt> which displays a calendar icon).
2000 triggerClass : 'x-form-date-trigger',
2002 * @cfg {Boolean} showToday
2003 * <tt>false</tt> to hide the footer area of the DatePicker containing the Today button and disable
2004 * the keyboard handler for spacebar that selects the current date (defaults to <tt>true</tt>).
2008 * @cfg {Date/String} minValue
2009 * The minimum allowed date. Can be either a Javascript date object or a string date in a
2010 * valid format (defaults to null).
2013 * @cfg {Date/String} maxValue
2014 * The maximum allowed date. Can be either a Javascript date object or a string date in a
2015 * valid format (defaults to null).
2018 * @cfg {Array} disabledDays
2019 * An array of days to disable, 0 based (defaults to null). Some examples:<pre><code>
2020 // disable Sunday and Saturday:
2021 disabledDays: [0, 6]
2022 // disable weekdays:
2023 disabledDays: [1,2,3,4,5]
2027 * @cfg {Array} disabledDates
2028 * An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
2029 * expression so they are very powerful. Some examples:<pre><code>
2030 // disable these exact dates:
2031 disabledDates: ["03/08/2003", "09/16/2003"]
2032 // disable these days for every year:
2033 disabledDates: ["03/08", "09/16"]
2034 // only match the beginning (useful if you are using short years):
2035 disabledDates: ["^03/08"]
2036 // disable every day in March 2006:
2037 disabledDates: ["03/../2006"]
2038 // disable every day in every March:
2039 disabledDates: ["^03"]
2041 * Note that the format of the dates included in the array should exactly match the {@link #format} config.
2042 * In order to support regular expressions, if you are using a {@link #format date format} that has "." in
2043 * it, you will have to escape the dot when restricting dates. For example: <tt>["03\\.08\\.03"]</tt>.
2046 * @cfg {String/Object} autoCreate
2047 * A {@link Ext.DomHelper DomHelper element specification object}, or <tt>true</tt> for the default element
2048 * specification object:<pre><code>
2049 * autoCreate: {tag: "input", type: "text", size: "10", autocomplete: "off"}
2054 defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "off"},
2056 // in the absence of a time value, a default value of 12 noon will be used
2057 // (note: 12 noon was chosen because it steers well clear of all DST timezone changes)
2058 initTime: '12', // 24 hour format
2060 initTimeFormat: 'H',
2062 // PUBLIC -- to be documented
2063 safeParse : function(value, format) {
2064 if (/[gGhH]/.test(format.replace(/(\\.)/g, ''))) {
2065 // if parse format contains hour information, no DST adjustment is necessary
2066 return Date.parseDate(value, format);
2068 // set time to 12 noon, then clear the time
2069 var parsedDate = Date.parseDate(value + ' ' + this.initTime, format + ' ' + this.initTimeFormat);
2071 if (parsedDate) return parsedDate.clearTime();
2075 initComponent : function(){
2076 Ext.form.DateField.superclass.initComponent.call(this);
2081 * Fires when a date is selected via the date picker.
2082 * @param {Ext.form.DateField} this
2083 * @param {Date} date The date that was selected
2088 if(Ext.isString(this.minValue)){
2089 this.minValue = this.parseDate(this.minValue);
2091 if(Ext.isString(this.maxValue)){
2092 this.maxValue = this.parseDate(this.maxValue);
2094 this.disabledDatesRE = null;
2095 this.initDisabledDays();
2098 initEvents: function() {
2099 Ext.form.DateField.superclass.initEvents.call(this);
2100 this.keyNav = new Ext.KeyNav(this.el, {
2101 "down": function(e) {
2102 this.onTriggerClick();
2111 initDisabledDays : function(){
2112 if(this.disabledDates){
2113 var dd = this.disabledDates,
2114 len = dd.length - 1,
2117 Ext.each(dd, function(d, i){
2118 re += Ext.isDate(d) ? '^' + Ext.escapeRe(d.dateFormat(this.format)) + '$' : dd[i];
2123 this.disabledDatesRE = new RegExp(re + ')');
2128 * Replaces any existing disabled dates with new values and refreshes the DatePicker.
2129 * @param {Array} disabledDates An array of date strings (see the <tt>{@link #disabledDates}</tt> config
2130 * for details on supported values) used to disable a pattern of dates.
2132 setDisabledDates : function(dd){
2133 this.disabledDates = dd;
2134 this.initDisabledDays();
2136 this.menu.picker.setDisabledDates(this.disabledDatesRE);
2141 * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the DatePicker.
2142 * @param {Array} disabledDays An array of disabled day indexes. See the <tt>{@link #disabledDays}</tt>
2143 * config for details on supported values.
2145 setDisabledDays : function(dd){
2146 this.disabledDays = dd;
2148 this.menu.picker.setDisabledDays(dd);
2153 * Replaces any existing <tt>{@link #minValue}</tt> with the new value and refreshes the DatePicker.
2154 * @param {Date} value The minimum date that can be selected
2156 setMinValue : function(dt){
2157 this.minValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
2159 this.menu.picker.setMinDate(this.minValue);
2164 * Replaces any existing <tt>{@link #maxValue}</tt> with the new value and refreshes the DatePicker.
2165 * @param {Date} value The maximum date that can be selected
2167 setMaxValue : function(dt){
2168 this.maxValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
2170 this.menu.picker.setMaxDate(this.maxValue);
2175 * Runs all of NumberFields validations and returns an array of any errors. Note that this first
2176 * runs TextField's validations, so the returned array is an amalgamation of all field errors.
2177 * The additional validation checks are testing that the date format is valid, that the chosen
2178 * date is within the min and max date constraints set, that the date chosen is not in the disabledDates
2179 * regex and that the day chosed is not one of the disabledDays.
2180 * @param {Mixed} value The value to get errors for (defaults to the current field value)
2181 * @return {Array} All validation errors for this field
2183 getErrors: function(value) {
2184 var errors = Ext.form.DateField.superclass.getErrors.apply(this, arguments);
2186 value = this.formatDate(value || this.processValue(this.getRawValue()));
2188 if (value.length < 1) { // if it's blank and textfield didn't flag it then it's valid
2193 value = this.parseDate(value);
2195 errors.push(String.format(this.invalidText, svalue, this.format));
2199 var time = value.getTime();
2200 if (this.minValue && time < this.minValue.getTime()) {
2201 errors.push(String.format(this.minText, this.formatDate(this.minValue)));
2204 if (this.maxValue && time > this.maxValue.getTime()) {
2205 errors.push(String.format(this.maxText, this.formatDate(this.maxValue)));
2208 if (this.disabledDays) {
2209 var day = value.getDay();
2211 for(var i = 0; i < this.disabledDays.length; i++) {
2212 if (day === this.disabledDays[i]) {
2213 errors.push(this.disabledDaysText);
2219 var fvalue = this.formatDate(value);
2220 if (this.disabledDatesRE && this.disabledDatesRE.test(fvalue)) {
2221 errors.push(String.format(this.disabledDatesText, fvalue));
2228 // Provides logic to override the default TriggerField.validateBlur which just returns true
2229 validateBlur : function(){
2230 return !this.menu || !this.menu.isVisible();
2234 * Returns the current date value of the date field.
2235 * @return {Date} The date value
2237 getValue : function(){
2238 return this.parseDate(Ext.form.DateField.superclass.getValue.call(this)) || "";
2242 * Sets the value of the date field. You can pass a date object or any string that can be
2243 * parsed into a valid date, using <tt>{@link #format}</tt> as the date format, according
2244 * to the same rules as {@link Date#parseDate} (the default format used is <tt>"m/d/Y"</tt>).
2247 //All of these calls set the same date value (May 4, 2006)
2249 //Pass a date object:
2250 var dt = new Date('5/4/2006');
2251 dateField.setValue(dt);
2253 //Pass a date string (default format):
2254 dateField.setValue('05/04/2006');
2256 //Pass a date string (custom format):
2257 dateField.format = 'Y-m-d';
2258 dateField.setValue('2006-05-04');
2260 * @param {String/Date} date The date or valid date string
2261 * @return {Ext.form.Field} this
2263 setValue : function(date){
2264 return Ext.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date)));
2268 parseDate : function(value) {
2269 if(!value || Ext.isDate(value)){
2273 var v = this.safeParse(value, this.format),
2274 af = this.altFormats,
2275 afa = this.altFormatsArray;
2278 afa = afa || af.split("|");
2280 for (var i = 0, len = afa.length; i < len && !v; i++) {
2281 v = this.safeParse(value, afa[i]);
2288 onDestroy : function(){
2289 Ext.destroy(this.menu, this.keyNav);
2290 Ext.form.DateField.superclass.onDestroy.call(this);
2294 formatDate : function(date){
2295 return Ext.isDate(date) ? date.dateFormat(this.format) : date;
2299 * @method onTriggerClick
2303 // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker
2304 onTriggerClick : function(){
2308 if(this.menu == null){
2309 this.menu = new Ext.menu.DateMenu({
2311 focusOnSelect: false
2315 Ext.apply(this.menu.picker, {
2316 minDate : this.minValue,
2317 maxDate : this.maxValue,
2318 disabledDatesRE : this.disabledDatesRE,
2319 disabledDatesText : this.disabledDatesText,
2320 disabledDays : this.disabledDays,
2321 disabledDaysText : this.disabledDaysText,
2322 format : this.format,
2323 showToday : this.showToday,
2324 minText : String.format(this.minText, this.formatDate(this.minValue)),
2325 maxText : String.format(this.maxText, this.formatDate(this.maxValue))
2327 this.menu.picker.setValue(this.getValue() || new Date());
2328 this.menu.show(this.el, "tl-bl?");
2329 this.menuEvents('on');
2333 menuEvents: function(method){
2334 this.menu[method]('select', this.onSelect, this);
2335 this.menu[method]('hide', this.onMenuHide, this);
2336 this.menu[method]('show', this.onFocus, this);
2339 onSelect: function(m, d){
2341 this.fireEvent('select', this, d);
2345 onMenuHide: function(){
2346 this.focus(false, 60);
2347 this.menuEvents('un');
2351 beforeBlur : function(){
2352 var v = this.parseDate(this.getRawValue());
2359 * @cfg {Boolean} grow @hide
2362 * @cfg {Number} growMin @hide
2365 * @cfg {Number} growMax @hide
2372 Ext.reg('datefield', Ext.form.DateField);/**
2373 * @class Ext.form.DisplayField
2374 * @extends Ext.form.Field
2375 * A display-only text field which is not validated and not submitted.
2377 * Creates a new DisplayField.
2378 * @param {Object} config Configuration options
2379 * @xtype displayfield
2381 Ext.form.DisplayField = Ext.extend(Ext.form.Field, {
2382 validationEvent : false,
2383 validateOnBlur : false,
2384 defaultAutoCreate : {tag: "div"},
2386 * @cfg {String} fieldClass The default CSS class for the field (defaults to <tt>"x-form-display-field"</tt>)
2388 fieldClass : "x-form-display-field",
2390 * @cfg {Boolean} htmlEncode <tt>false</tt> to skip HTML-encoding the text when rendering it (defaults to
2391 * <tt>false</tt>). This might be useful if you want to include tags in the field's innerHTML rather than
2392 * rendering them as string literals per the default logic.
2397 initEvents : Ext.emptyFn,
2399 isValid : function(){
2403 validate : function(){
2407 getRawValue : function(){
2408 var v = this.rendered ? this.el.dom.innerHTML : Ext.value(this.value, '');
2409 if(v === this.emptyText){
2412 if(this.htmlEncode){
2413 v = Ext.util.Format.htmlDecode(v);
2418 getValue : function(){
2419 return this.getRawValue();
2422 getName: function() {
2426 setRawValue : function(v){
2427 if(this.htmlEncode){
2428 v = Ext.util.Format.htmlEncode(v);
2430 return this.rendered ? (this.el.dom.innerHTML = (Ext.isEmpty(v) ? '' : v)) : (this.value = v);
2433 setValue : function(v){
2434 this.setRawValue(v);
2438 * @cfg {String} inputType
2442 * @cfg {Boolean} disabled
2446 * @cfg {Boolean} readOnly
2450 * @cfg {Boolean} validateOnBlur
2454 * @cfg {Number} validationDelay
2458 * @cfg {String/Boolean} validationEvent
2463 Ext.reg('displayfield', Ext.form.DisplayField);
2465 * @class Ext.form.ComboBox
2466 * @extends Ext.form.TriggerField
2467 * <p>A combobox control with support for autocomplete, remote-loading, paging and many other features.</p>
2468 * <p>A ComboBox works in a similar manner to a traditional HTML <select> field. The difference is
2469 * that to submit the {@link #valueField}, you must specify a {@link #hiddenName} to create a hidden input
2470 * field to hold the value of the valueField. The <i>{@link #displayField}</i> is shown in the text field
2471 * which is named according to the {@link #name}.</p>
2472 * <p><b><u>Events</u></b></p>
2473 * <p>To do something when something in ComboBox is selected, configure the select event:<pre><code>
2474 var cb = new Ext.form.ComboBox({
2475 // all of your config options
2478 'select': yourFunction
2482 // Alternatively, you can assign events after the object is created:
2483 var cb = new Ext.form.ComboBox(yourOptions);
2484 cb.on('select', yourFunction, yourScope);
2487 * <p><b><u>ComboBox in Grid</u></b></p>
2488 * <p>If using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a {@link Ext.grid.Column#renderer renderer}
2489 * will be needed to show the displayField when the editor is not active. Set up the renderer manually, or implement
2490 * a reusable render, for example:<pre><code>
2491 // create reusable renderer
2492 Ext.util.Format.comboRenderer = function(combo){
2493 return function(value){
2494 var record = combo.findRecord(combo.{@link #valueField}, value);
2495 return record ? record.get(combo.{@link #displayField}) : combo.{@link #valueNotFoundText};
2499 // create the combo instance
2500 var combo = new Ext.form.ComboBox({
2501 {@link #typeAhead}: true,
2502 {@link #triggerAction}: 'all',
2503 {@link #lazyRender}:true,
2504 {@link #mode}: 'local',
2505 {@link #store}: new Ext.data.ArrayStore({
2511 data: [[1, 'item1'], [2, 'item2']]
2513 {@link #valueField}: 'myId',
2514 {@link #displayField}: 'displayText'
2517 // snippet of column model used within grid
2518 var cm = new Ext.grid.ColumnModel([{
2521 header: "Some Header",
2522 dataIndex: 'whatever',
2524 editor: combo, // specify reference to combo instance
2525 renderer: Ext.util.Format.comboRenderer(combo) // pass combo instance to reusable renderer
2531 * <p><b><u>Filtering</u></b></p>
2532 * <p>A ComboBox {@link #doQuery uses filtering itself}, for information about filtering the ComboBox
2533 * store manually see <tt>{@link #lastQuery}</tt>.</p>
2535 * Create a new ComboBox.
2536 * @param {Object} config Configuration options
2539 Ext.form.ComboBox = Ext.extend(Ext.form.TriggerField, {
2541 * @cfg {Mixed} transform The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
2542 * Note that if you specify this and the combo is going to be in an {@link Ext.form.BasicForm} or
2543 * {@link Ext.form.FormPanel}, you must also set <tt>{@link #lazyRender} = true</tt>.
2546 * @cfg {Boolean} lazyRender <tt>true</tt> to prevent the ComboBox from rendering until requested
2547 * (should always be used when rendering into an {@link Ext.Editor} (e.g. {@link Ext.grid.EditorGridPanel Grids}),
2548 * defaults to <tt>false</tt>).
2551 * @cfg {String/Object} autoCreate <p>A {@link Ext.DomHelper DomHelper} element spec, or <tt>true</tt> for a default
2552 * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
2553 * See <tt>{@link Ext.Component#autoEl autoEl}</tt> for details. Defaults to:</p>
2554 * <pre><code>{tag: "input", type: "text", size: "24", autocomplete: "off"}</code></pre>
2557 * @cfg {Ext.data.Store/Array} store The data source to which this combo is bound (defaults to <tt>undefined</tt>).
2558 * Acceptable values for this property are:
2559 * <div class="mdetail-params"><ul>
2560 * <li><b>any {@link Ext.data.Store Store} subclass</b></li>
2561 * <li><b>an Array</b> : Arrays will be converted to a {@link Ext.data.ArrayStore} internally,
2562 * automatically generating {@link Ext.data.Field#name field names} to work with all data components.
2563 * <div class="mdetail-params"><ul>
2564 * <li><b>1-dimensional array</b> : (e.g., <tt>['Foo','Bar']</tt>)<div class="sub-desc">
2565 * A 1-dimensional array will automatically be expanded (each array item will be used for both the combo
2566 * {@link #valueField} and {@link #displayField})</div></li>
2567 * <li><b>2-dimensional array</b> : (e.g., <tt>[['f','Foo'],['b','Bar']]</tt>)<div class="sub-desc">
2568 * For a multi-dimensional array, the value in index 0 of each item will be assumed to be the combo
2569 * {@link #valueField}, while the value at index 1 is assumed to be the combo {@link #displayField}.
2570 * </div></li></ul></div></li></ul></div>
2571 * <p>See also <tt>{@link #mode}</tt>.</p>
2574 * @cfg {String} title If supplied, a header element is created containing this text and added into the top of
2575 * the dropdown list (defaults to undefined, with no header element)
2579 defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"},
2581 * @cfg {Number} listWidth The width (used as a parameter to {@link Ext.Element#setWidth}) of the dropdown
2582 * list (defaults to the width of the ComboBox field). See also <tt>{@link #minListWidth}
2585 * @cfg {String} displayField The underlying {@link Ext.data.Field#name data field name} to bind to this
2586 * ComboBox (defaults to undefined if <tt>{@link #mode} = 'remote'</tt> or <tt>'field1'</tt> if
2587 * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
2588 * the store configuration}).
2589 * <p>See also <tt>{@link #valueField}</tt>.</p>
2590 * <p><b>Note</b>: if using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a
2591 * {@link Ext.grid.Column#renderer renderer} will be needed to show the displayField when the editor is not
2595 * @cfg {String} valueField The underlying {@link Ext.data.Field#name data value name} to bind to this
2596 * ComboBox (defaults to undefined if <tt>{@link #mode} = 'remote'</tt> or <tt>'field2'</tt> if
2597 * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
2598 * the store configuration}).
2599 * <p><b>Note</b>: use of a <tt>valueField</tt> requires the user to make a selection in order for a value to be
2600 * mapped. See also <tt>{@link #hiddenName}</tt>, <tt>{@link #hiddenValue}</tt>, and <tt>{@link #displayField}</tt>.</p>
2603 * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the
2604 * field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically
2605 * post during a form submission. See also {@link #valueField}.
2606 * <p><b>Note</b>: the hidden field's id will also default to this name if {@link #hiddenId} is not specified.
2607 * The ComboBox {@link Ext.Component#id id} and the <tt>{@link #hiddenId}</tt> <b>should be different</b>, since
2608 * no two DOM nodes should share the same id. So, if the ComboBox <tt>{@link Ext.form.Field#name name}</tt> and
2609 * <tt>hiddenName</tt> are the same, you should specify a unique <tt>{@link #hiddenId}</tt>.</p>
2612 * @cfg {String} hiddenId If <tt>{@link #hiddenName}</tt> is specified, <tt>hiddenId</tt> can also be provided
2613 * to give the hidden field a unique id (defaults to the <tt>{@link #hiddenName}</tt>). The <tt>hiddenId</tt>
2614 * and combo {@link Ext.Component#id id} should be different, since no two DOM
2615 * nodes should share the same id.
2618 * @cfg {String} hiddenValue Sets the initial value of the hidden field if {@link #hiddenName} is
2619 * specified to contain the selected {@link #valueField}, from the Store. Defaults to the configured
2620 * <tt>{@link Ext.form.Field#value value}</tt>.
2623 * @cfg {String} listClass The CSS class to add to the predefined <tt>'x-combo-list'</tt> class
2624 * applied the dropdown list element (defaults to '').
2628 * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list
2629 * (defaults to <tt>'x-combo-selected'</tt>)
2631 selectedClass : 'x-combo-selected',
2633 * @cfg {String} listEmptyText The empty text to display in the data view if no items are found.
2638 * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always
2639 * get the class <tt>'x-form-trigger'</tt> and <tt>triggerClass</tt> will be <b>appended</b> if specified
2640 * (defaults to <tt>'x-form-arrow-trigger'</tt> which displays a downward arrow icon).
2642 triggerClass : 'x-form-arrow-trigger',
2644 * @cfg {Boolean/String} shadow <tt>true</tt> or <tt>"sides"</tt> for the default effect, <tt>"frame"</tt> for
2645 * 4-way shadow, and <tt>"drop"</tt> for bottom-right
2649 * @cfg {String/Array} listAlign A valid anchor position value. See <tt>{@link Ext.Element#alignTo}</tt> for details
2650 * on supported anchor positions and offsets. To specify x/y offsets as well, this value
2651 * may be specified as an Array of <tt>{@link Ext.Element#alignTo}</tt> method arguments.</p>
2652 * <pre><code>[ 'tl-bl?', [6,0] ]</code></pre>(defaults to <tt>'tl-bl?'</tt>)
2654 listAlign : 'tl-bl?',
2656 * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown
2657 * (defaults to <tt>300</tt>)
2661 * @cfg {Number} minHeight The minimum height in pixels of the dropdown list when the list is constrained by its
2662 * distance to the viewport edges (defaults to <tt>90</tt>)
2666 * @cfg {String} triggerAction The action to execute when the trigger is clicked.
2667 * <div class="mdetail-params"><ul>
2668 * <li><b><tt>'query'</tt></b> : <b>Default</b>
2669 * <p class="sub-desc">{@link #doQuery run the query} using the {@link Ext.form.Field#getRawValue raw value}.</p></li>
2670 * <li><b><tt>'all'</tt></b> :
2671 * <p class="sub-desc">{@link #doQuery run the query} specified by the <tt>{@link #allQuery}</tt> config option</p></li>
2673 * <p>See also <code>{@link #queryParam}</code>.</p>
2675 triggerAction : 'query',
2677 * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and
2678 * {@link #typeAhead} activate (defaults to <tt>4</tt> if <tt>{@link #mode} = 'remote'</tt> or <tt>0</tt> if
2679 * <tt>{@link #mode} = 'local'</tt>, does not apply if
2680 * <tt>{@link Ext.form.TriggerField#editable editable} = false</tt>).
2684 * @cfg {Boolean} autoSelect <tt>true</tt> to select the first result gathered by the data store (defaults
2685 * to <tt>true</tt>). A false value would require a manual selection from the dropdown list to set the components value
2686 * unless the value of ({@link #typeAheadDelay}) were true.
2690 * @cfg {Boolean} typeAhead <tt>true</tt> to populate and autoselect the remainder of the text being
2691 * typed after a configurable delay ({@link #typeAheadDelay}) if it matches a known value (defaults
2692 * to <tt>false</tt>)
2696 * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and
2697 * sending the query to filter the dropdown list (defaults to <tt>500</tt> if <tt>{@link #mode} = 'remote'</tt>
2698 * or <tt>10</tt> if <tt>{@link #mode} = 'local'</tt>)
2702 * @cfg {Number} pageSize If greater than <tt>0</tt>, a {@link Ext.PagingToolbar} is displayed in the
2703 * footer of the dropdown list and the {@link #doQuery filter queries} will execute with page start and
2704 * {@link Ext.PagingToolbar#pageSize limit} parameters. Only applies when <tt>{@link #mode} = 'remote'</tt>
2705 * (defaults to <tt>0</tt>).
2709 * @cfg {Boolean} selectOnFocus <tt>true</tt> to select any existing text in the field immediately on focus.
2710 * Only applies when <tt>{@link Ext.form.TriggerField#editable editable} = true</tt> (defaults to
2713 selectOnFocus : false,
2715 * @cfg {String} queryParam Name of the query ({@link Ext.data.Store#baseParam baseParam} name for the store)
2716 * as it will be passed on the querystring (defaults to <tt>'query'</tt>)
2718 queryParam : 'query',
2720 * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies
2721 * when <tt>{@link #mode} = 'remote'</tt> (defaults to <tt>'Loading...'</tt>)
2723 loadingText : 'Loading...',
2725 * @cfg {Boolean} resizable <tt>true</tt> to add a resize handle to the bottom of the dropdown list
2726 * (creates an {@link Ext.Resizable} with 'se' {@link Ext.Resizable#pinned pinned} handles).
2727 * Defaults to <tt>false</tt>.
2731 * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if
2732 * <tt>{@link #resizable} = true</tt> (defaults to <tt>8</tt>)
2736 * @cfg {String} allQuery The text query to send to the server to return all records for the list
2737 * with no filtering (defaults to '')
2741 * @cfg {String} mode Acceptable values are:
2742 * <div class="mdetail-params"><ul>
2743 * <li><b><tt>'remote'</tt></b> : <b>Default</b>
2744 * <p class="sub-desc">Automatically loads the <tt>{@link #store}</tt> the <b>first</b> time the trigger
2745 * is clicked. If you do not want the store to be automatically loaded the first time the trigger is
2746 * clicked, set to <tt>'local'</tt> and manually load the store. To force a requery of the store
2747 * <b>every</b> time the trigger is clicked see <tt>{@link #lastQuery}</tt>.</p></li>
2748 * <li><b><tt>'local'</tt></b> :
2749 * <p class="sub-desc">ComboBox loads local data</p>
2751 var combo = new Ext.form.ComboBox({
2752 renderTo: document.body,
2754 store: new Ext.data.ArrayStore({
2757 'myId', // numeric value is the key
2760 data: [[1, 'item1'], [2, 'item2']] // data is local
2763 displayField: 'displayText',
2764 triggerAction: 'all'
2766 * </code></pre></li>
2771 * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to <tt>70</tt>, will
2772 * be ignored if <tt>{@link #listWidth}</tt> has a higher value)
2776 * @cfg {Boolean} forceSelection <tt>true</tt> to restrict the selected value to one of the values in the list,
2777 * <tt>false</tt> to allow the user to set arbitrary text into the field (defaults to <tt>false</tt>)
2779 forceSelection : false,
2781 * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
2782 * if <tt>{@link #typeAhead} = true</tt> (defaults to <tt>250</tt>)
2784 typeAheadDelay : 250,
2786 * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
2787 * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this
2788 * default text is used, it means there is no value set and no validation will occur on this field.
2792 * @cfg {Boolean} lazyInit <tt>true</tt> to not initialize the list for this combo until the field is focused
2793 * (defaults to <tt>true</tt>)
2798 * @cfg {Boolean} clearFilterOnReset <tt>true</tt> to clear any filters on the store (when in local mode) when reset is called
2799 * (defaults to <tt>true</tt>)
2801 clearFilterOnReset : true,
2804 * @cfg {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post.
2805 * If a hiddenName is specified, setting this to true will cause both the hidden field and the element to be submitted.
2806 * Defaults to <tt>undefined</tt>.
2808 submitValue: undefined,
2811 * The value of the match string used to filter the store. Delete this property to force a requery.
2814 var combo = new Ext.form.ComboBox({
2819 // delete the previous query in the beforequery event or set
2820 // combo.lastQuery = null (this will reload the store the next time it expands)
2821 beforequery: function(qe){
2822 delete qe.combo.lastQuery;
2827 * To make sure the filter in the store is not cleared the first time the ComboBox trigger is used
2828 * configure the combo with <tt>lastQuery=''</tt>. Example use:
2830 var combo = new Ext.form.ComboBox({
2833 triggerAction: 'all',
2837 * @property lastQuery
2842 initComponent : function(){
2843 Ext.form.ComboBox.superclass.initComponent.call(this);
2847 * Fires when the dropdown list is expanded
2848 * @param {Ext.form.ComboBox} combo This combo box
2853 * Fires when the dropdown list is collapsed
2854 * @param {Ext.form.ComboBox} combo This combo box
2859 * @event beforeselect
2860 * Fires before a list item is selected. Return false to cancel the selection.
2861 * @param {Ext.form.ComboBox} combo This combo box
2862 * @param {Ext.data.Record} record The data record returned from the underlying store
2863 * @param {Number} index The index of the selected item in the dropdown list
2868 * Fires when a list item is selected
2869 * @param {Ext.form.ComboBox} combo This combo box
2870 * @param {Ext.data.Record} record The data record returned from the underlying store
2871 * @param {Number} index The index of the selected item in the dropdown list
2875 * @event beforequery
2876 * Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
2877 * cancel property to true.
2878 * @param {Object} queryEvent An object that has these properties:<ul>
2879 * <li><code>combo</code> : Ext.form.ComboBox <div class="sub-desc">This combo box</div></li>
2880 * <li><code>query</code> : String <div class="sub-desc">The query</div></li>
2881 * <li><code>forceAll</code> : Boolean <div class="sub-desc">True to force "all" query</div></li>
2882 * <li><code>cancel</code> : Boolean <div class="sub-desc">Set to true to cancel the query</div></li>
2888 var s = Ext.getDom(this.transform);
2889 if(!this.hiddenName){
2890 this.hiddenName = s.name;
2893 this.mode = 'local';
2894 var d = [], opts = s.options;
2895 for(var i = 0, len = opts.length;i < len; i++){
2897 value = (o.hasAttribute ? o.hasAttribute('value') : o.getAttributeNode('value').specified) ? o.value : o.text;
2898 if(o.selected && Ext.isEmpty(this.value, true)) {
2901 d.push([value, o.text]);
2903 this.store = new Ext.data.ArrayStore({
2905 fields: ['value', 'text'],
2909 this.valueField = 'value';
2910 this.displayField = 'text';
2912 s.name = Ext.id(); // wipe out the name in case somewhere else they have a reference
2913 if(!this.lazyRender){
2915 this.el = Ext.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate);
2916 this.render(this.el.parentNode, s);
2920 //auto-configure store from local array data
2921 else if(this.store){
2922 this.store = Ext.StoreMgr.lookup(this.store);
2923 if(this.store.autoCreated){
2924 this.displayField = this.valueField = 'field1';
2925 if(!this.store.expandData){
2926 this.displayField = 'field2';
2928 this.mode = 'local';
2932 this.selectedIndex = -1;
2933 if(this.mode == 'local'){
2934 if(!Ext.isDefined(this.initialConfig.queryDelay)){
2935 this.queryDelay = 10;
2937 if(!Ext.isDefined(this.initialConfig.minChars)){
2944 onRender : function(ct, position){
2945 if(this.hiddenName && !Ext.isDefined(this.submitValue)){
2946 this.submitValue = false;
2948 Ext.form.ComboBox.superclass.onRender.call(this, ct, position);
2949 if(this.hiddenName){
2950 this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName,
2951 id: (this.hiddenId||this.hiddenName)}, 'before', true);
2955 this.el.dom.setAttribute('autocomplete', 'off');
2961 this.on('focus', this.initList, this, {single: true});
2966 initValue : function(){
2967 Ext.form.ComboBox.superclass.initValue.call(this);
2968 if(this.hiddenField){
2969 this.hiddenField.value =
2970 Ext.value(Ext.isDefined(this.hiddenValue) ? this.hiddenValue : this.value, '');
2974 getParentZIndex : function(){
2977 this.findParentBy(function(ct){
2978 zindex = parseInt(ct.getPositionEl().getStyle('z-index'), 10);
2986 initList : function(){
2988 var cls = 'x-combo-list',
2989 listParent = Ext.getDom(this.getListParent() || Ext.getBody()),
2990 zindex = parseInt(Ext.fly(listParent).getStyle('z-index'), 10);
2993 zindex = this.getParentZIndex();
2996 this.list = new Ext.Layer({
2997 parentEl: listParent,
2998 shadow: this.shadow,
2999 cls: [cls, this.listClass].join(' '),
3001 zindex: (zindex || 12000) + 5
3004 var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth);
3005 this.list.setSize(lw, 0);
3006 this.list.swallowEvent('mousewheel');
3007 this.assetHeight = 0;
3008 if(this.syncFont !== false){
3009 this.list.setStyle('font-size', this.el.getStyle('font-size'));
3012 this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
3013 this.assetHeight += this.header.getHeight();
3016 this.innerList = this.list.createChild({cls:cls+'-inner'});
3017 this.mon(this.innerList, 'mouseover', this.onViewOver, this);
3018 this.mon(this.innerList, 'mousemove', this.onViewMove, this);
3019 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
3022 this.footer = this.list.createChild({cls:cls+'-ft'});
3023 this.pageTb = new Ext.PagingToolbar({
3025 pageSize: this.pageSize,
3026 renderTo:this.footer
3028 this.assetHeight += this.footer.getHeight();
3033 * @cfg {String/Ext.XTemplate} tpl <p>The template string, or {@link Ext.XTemplate} instance to
3034 * use to display each item in the dropdown list. The dropdown list is displayed in a
3035 * DataView. See {@link #view}.</p>
3036 * <p>The default template string is:</p><pre><code>
3037 '<tpl for="."><div class="x-combo-list-item">{' + this.displayField + '}</div></tpl>'
3039 * <p>Override the default value to create custom UI layouts for items in the list.
3040 * For example:</p><pre><code>
3041 '<tpl for="."><div ext:qtip="{state}. {nick}" class="x-combo-list-item">{state}</div></tpl>'
3043 * <p>The template <b>must</b> contain one or more substitution parameters using field
3044 * names from the Combo's</b> {@link #store Store}. In the example above an
3045 * <pre>ext:qtip</pre> attribute is added to display other fields from the Store.</p>
3046 * <p>To preserve the default visual look of list items, add the CSS class name
3047 * <pre>x-combo-list-item</pre> to the template's container element.</p>
3048 * <p>Also see {@link #itemSelector} for additional details.</p>
3050 this.tpl = '<tpl for="."><div class="'+cls+'-item">{' + this.displayField + '}</div></tpl>';
3052 * @cfg {String} itemSelector
3053 * <p>A simple CSS selector (e.g. div.some-class or span:first-child) that will be
3054 * used to determine what nodes the {@link #view Ext.DataView} which handles the dropdown
3055 * display will be working with.</p>
3056 * <p><b>Note</b>: this setting is <b>required</b> if a custom XTemplate has been
3057 * specified in {@link #tpl} which assigns a class other than <pre>'x-combo-list-item'</pre>
3058 * to dropdown list items</b>
3063 * The {@link Ext.DataView DataView} used to display the ComboBox's options.
3064 * @type Ext.DataView
3066 this.view = new Ext.DataView({
3067 applyTo: this.innerList,
3070 selectedClass: this.selectedClass,
3071 itemSelector: this.itemSelector || '.' + cls + '-item',
3072 emptyText: this.listEmptyText,
3073 deferEmptyText: false
3076 this.mon(this.view, {
3077 containerclick : this.onViewClick,
3078 click : this.onViewClick,
3082 this.bindStore(this.store, true);
3085 this.resizer = new Ext.Resizable(this.list, {
3086 pinned:true, handles:'se'
3088 this.mon(this.resizer, 'resize', function(r, w, h){
3089 this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
3091 this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
3092 this.restrictHeight();
3095 this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
3101 * <p>Returns the element used to house this ComboBox's pop-up list. Defaults to the document body.</p>
3102 * A custom implementation may be provided as a configuration option if the floating list needs to be rendered
3103 * to a different Element. An example might be rendering the list inside a Menu so that clicking
3104 * the list does not hide the Menu:<pre><code>
3105 var store = new Ext.data.ArrayStore({
3107 fields: ['initials', 'fullname'],
3109 ['FF', 'Fred Flintstone'],
3110 ['BR', 'Barney Rubble']
3114 var combo = new Ext.form.ComboBox({
3116 displayField: 'fullname',
3117 emptyText: 'Select a name...',
3118 forceSelection: true,
3119 getListParent: function() {
3120 return this.el.up('.x-menu');
3122 iconCls: 'no-icon', //use iconCls if placing within menu to shift to right side of menu
3124 selectOnFocus: true,
3125 triggerAction: 'all',
3130 var menu = new Ext.menu.Menu({
3133 combo // A Field in a Menu
3138 getListParent : function() {
3139 return document.body;
3143 * Returns the store associated with this combo.
3144 * @return {Ext.data.Store} The store
3146 getStore : function(){
3151 bindStore : function(store, initial){
3152 if(this.store && !initial){
3153 if(this.store !== store && this.store.autoDestroy){
3154 this.store.destroy();
3156 this.store.un('beforeload', this.onBeforeLoad, this);
3157 this.store.un('load', this.onLoad, this);
3158 this.store.un('exception', this.collapse, this);
3163 this.view.bindStore(null);
3166 this.pageTb.bindStore(null);
3172 this.lastQuery = null;
3174 this.pageTb.bindStore(store);
3178 this.store = Ext.StoreMgr.lookup(store);
3181 beforeload: this.onBeforeLoad,
3183 exception: this.collapse
3187 this.view.bindStore(store);
3193 Ext.form.ComboBox.superclass.reset.call(this);
3194 if(this.clearFilterOnReset && this.mode == 'local'){
3195 this.store.clearFilter();
3200 initEvents : function(){
3201 Ext.form.ComboBox.superclass.initEvents.call(this);
3206 * <p>A {@link Ext.KeyNav KeyNav} object which handles navigation keys for this ComboBox. This performs actions
3207 * based on keystrokes typed when the input field is focused.</p>
3208 * <p><b>After the ComboBox has been rendered</b>, you may override existing navigation key functionality,
3209 * or add your own based upon key names as specified in the {@link Ext.KeyNav KeyNav} class.</p>
3210 * <p>The function is executed in the scope (<code>this</code> reference of the ComboBox. Example:</p><pre><code>
3211 myCombo.keyNav.esc = function(e) { // Override ESC handling function
3212 this.collapse(); // Standard behaviour of Ext's ComboBox.
3213 this.setValue(this.startValue); // We reset to starting value on ESC
3215 myCombo.keyNav.tab = function() { // Override TAB handling function
3216 this.onViewClick(false); // Select the currently highlighted row
3220 this.keyNav = new Ext.KeyNav(this.el, {
3222 this.inKeyMode = true;
3226 "down" : function(e){
3227 if(!this.isExpanded()){
3228 this.onTriggerClick();
3230 this.inKeyMode = true;
3235 "enter" : function(e){
3239 "esc" : function(e){
3243 "tab" : function(e){
3244 if (this.forceSelection === true) {
3247 this.onViewClick(false);
3254 doRelay : function(e, h, hname){
3255 if(hname == 'down' || this.scope.isExpanded()){
3256 // this MUST be called before ComboBox#fireKey()
3257 var relay = Ext.KeyNav.prototype.doRelay.apply(this, arguments);
3258 if(!Ext.isIE && Ext.EventManager.useKeydown){
3259 // call Combo#fireKey() for browsers which use keydown event (except IE)
3260 this.scope.fireKey(e);
3267 forceKeyDown : true,
3268 defaultEventAction: 'stopEvent'
3270 this.queryDelay = Math.max(this.queryDelay || 10,
3271 this.mode == 'local' ? 10 : 250);
3272 this.dqTask = new Ext.util.DelayedTask(this.initQuery, this);
3274 this.taTask = new Ext.util.DelayedTask(this.onTypeAhead, this);
3276 if(!this.enableKeyEvents){
3277 this.mon(this.el, 'keyup', this.onKeyUp, this);
3283 onDestroy : function(){
3285 this.dqTask.cancel();
3288 this.bindStore(null);
3295 Ext.destroyMembers(this, 'hiddenField');
3296 Ext.form.ComboBox.superclass.onDestroy.call(this);
3300 fireKey : function(e){
3301 if (!this.isExpanded()) {
3302 Ext.form.ComboBox.superclass.fireKey.call(this, e);
3307 onResize : function(w, h){
3308 Ext.form.ComboBox.superclass.onResize.apply(this, arguments);
3309 if(!isNaN(w) && this.isVisible() && this.list){
3312 this.bufferSize = w;
3316 doResize: function(w){
3317 if(!Ext.isDefined(this.listWidth)){
3318 var lw = Math.max(w, this.minListWidth);
3319 this.list.setWidth(lw);
3320 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
3325 onEnable : function(){
3326 Ext.form.ComboBox.superclass.onEnable.apply(this, arguments);
3327 if(this.hiddenField){
3328 this.hiddenField.disabled = false;
3333 onDisable : function(){
3334 Ext.form.ComboBox.superclass.onDisable.apply(this, arguments);
3335 if(this.hiddenField){
3336 this.hiddenField.disabled = true;
3341 onBeforeLoad : function(){
3345 this.innerList.update(this.loadingText ?
3346 '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
3347 this.restrictHeight();
3348 this.selectedIndex = -1;
3352 onLoad : function(){
3356 if(this.store.getCount() > 0 || this.listEmptyText){
3358 this.restrictHeight();
3359 if(this.lastQuery == this.allQuery){
3361 this.el.dom.select();
3364 if(this.autoSelect !== false && !this.selectByValue(this.value, true)){
3365 this.select(0, true);
3368 if(this.autoSelect !== false){
3371 if(this.typeAhead && this.lastKey != Ext.EventObject.BACKSPACE && this.lastKey != Ext.EventObject.DELETE){
3372 this.taTask.delay(this.typeAheadDelay);
3382 onTypeAhead : function(){
3383 if(this.store.getCount() > 0){
3384 var r = this.store.getAt(0);
3385 var newValue = r.data[this.displayField];
3386 var len = newValue.length;
3387 var selStart = this.getRawValue().length;
3388 if(selStart != len){
3389 this.setRawValue(newValue);
3390 this.selectText(selStart, newValue.length);
3396 assertValue : function(){
3397 var val = this.getRawValue(),
3398 rec = this.findRecord(this.displayField, val);
3400 if(!rec && this.forceSelection){
3401 if(val.length > 0 && val != this.emptyText){
3402 this.el.dom.value = Ext.value(this.lastSelectionText, '');
3403 this.applyEmptyText();
3409 // onSelect may have already set the value and by doing so
3410 // set the display field properly. Let's not wipe out the
3411 // valueField here by just sending the displayField.
3412 if (val == rec.get(this.displayField) && this.value == rec.get(this.valueField)){
3415 val = rec.get(this.valueField || this.displayField);
3422 onSelect : function(record, index){
3423 if(this.fireEvent('beforeselect', this, record, index) !== false){
3424 this.setValue(record.data[this.valueField || this.displayField]);
3426 this.fireEvent('select', this, record, index);
3431 getName: function(){
3432 var hf = this.hiddenField;
3433 return hf && hf.name ? hf.name : this.hiddenName || Ext.form.ComboBox.superclass.getName.call(this);
3437 * Returns the currently selected field value or empty string if no value is set.
3438 * @return {String} value The selected value
3440 getValue : function(){
3441 if(this.valueField){
3442 return Ext.isDefined(this.value) ? this.value : '';
3444 return Ext.form.ComboBox.superclass.getValue.call(this);
3449 * Clears any text/value currently set in the field
3451 clearValue : function(){
3452 if(this.hiddenField){
3453 this.hiddenField.value = '';
3455 this.setRawValue('');
3456 this.lastSelectionText = '';
3457 this.applyEmptyText();
3462 * Sets the specified value into the field. If the value finds a match, the corresponding record text
3463 * will be displayed in the field. If the value does not match the data value of an existing item,
3464 * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
3465 * Otherwise the field will be blank (although the value will still be set).
3466 * @param {String} value The value to match
3467 * @return {Ext.form.Field} this
3469 setValue : function(v){
3471 if(this.valueField){
3472 var r = this.findRecord(this.valueField, v);
3474 text = r.data[this.displayField];
3475 }else if(Ext.isDefined(this.valueNotFoundText)){
3476 text = this.valueNotFoundText;
3479 this.lastSelectionText = text;
3480 if(this.hiddenField){
3481 this.hiddenField.value = Ext.value(v, '');
3483 Ext.form.ComboBox.superclass.setValue.call(this, text);
3489 findRecord : function(prop, value){
3491 if(this.store.getCount() > 0){
3492 this.store.each(function(r){
3493 if(r.data[prop] == value){
3503 onViewMove : function(e, t){
3504 this.inKeyMode = false;
3508 onViewOver : function(e, t){
3509 if(this.inKeyMode){ // prevent key nav and mouse over conflicts
3512 var item = this.view.findItemFromChild(t);
3514 var index = this.view.indexOf(item);
3515 this.select(index, false);
3520 onViewClick : function(doFocus){
3521 var index = this.view.getSelectedIndexes()[0],
3525 this.onSelect(r, index);
3529 if(doFocus !== false){
3536 restrictHeight : function(){
3537 this.innerList.dom.style.height = '';
3538 var inner = this.innerList.dom,
3539 pad = this.list.getFrameWidth('tb') + (this.resizable ? this.handleHeight : 0) + this.assetHeight,
3540 h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight),
3541 ha = this.getPosition()[1]-Ext.getBody().getScroll().top,
3542 hb = Ext.lib.Dom.getViewHeight()-ha-this.getSize().height,
3543 space = Math.max(ha, hb, this.minHeight || 0)-this.list.shadowOffset-pad-5;
3545 h = Math.min(h, space, this.maxHeight);
3547 this.innerList.setHeight(h);
3548 this.list.beginUpdate();
3549 this.list.setHeight(h+pad);
3550 this.list.alignTo.apply(this.list, [this.el].concat(this.listAlign));
3551 this.list.endUpdate();
3555 * Returns true if the dropdown list is expanded, else false.
3557 isExpanded : function(){
3558 return this.list && this.list.isVisible();
3562 * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
3563 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
3564 * @param {String} value The data value of the item to select
3565 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
3566 * selected item if it is not currently in view (defaults to true)
3567 * @return {Boolean} True if the value matched an item in the list, else false
3569 selectByValue : function(v, scrollIntoView){
3570 if(!Ext.isEmpty(v, true)){
3571 var r = this.findRecord(this.valueField || this.displayField, v);
3573 this.select(this.store.indexOf(r), scrollIntoView);
3581 * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
3582 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
3583 * @param {Number} index The zero-based index of the list item to select
3584 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
3585 * selected item if it is not currently in view (defaults to true)
3587 select : function(index, scrollIntoView){
3588 this.selectedIndex = index;
3589 this.view.select(index);
3590 if(scrollIntoView !== false){
3591 var el = this.view.getNode(index);
3593 this.innerList.scrollChildIntoView(el, false);
3600 selectNext : function(){
3601 var ct = this.store.getCount();
3603 if(this.selectedIndex == -1){
3605 }else if(this.selectedIndex < ct-1){
3606 this.select(this.selectedIndex+1);
3612 selectPrev : function(){
3613 var ct = this.store.getCount();
3615 if(this.selectedIndex == -1){
3617 }else if(this.selectedIndex !== 0){
3618 this.select(this.selectedIndex-1);
3624 onKeyUp : function(e){
3626 if(this.editable !== false && this.readOnly !== true && (k == e.BACKSPACE || !e.isSpecialKey())){
3629 this.dqTask.delay(this.queryDelay);
3631 Ext.form.ComboBox.superclass.onKeyUp.call(this, e);
3635 validateBlur : function(){
3636 return !this.list || !this.list.isVisible();
3640 initQuery : function(){
3641 this.doQuery(this.getRawValue());
3645 beforeBlur : function(){
3650 postBlur : function(){
3651 Ext.form.ComboBox.superclass.postBlur.call(this);
3653 this.inKeyMode = false;
3657 * Execute a query to filter the dropdown list. Fires the {@link #beforequery} event prior to performing the
3658 * query allowing the query action to be canceled if needed.
3659 * @param {String} query The SQL query to execute
3660 * @param {Boolean} forceAll <tt>true</tt> to force the query to execute even if there are currently fewer
3661 * characters in the field than the minimum specified by the <tt>{@link #minChars}</tt> config option. It
3662 * also clears any filter previously saved in the current store (defaults to <tt>false</tt>)
3664 doQuery : function(q, forceAll){
3665 q = Ext.isEmpty(q) ? '' : q;
3672 if(this.fireEvent('beforequery', qe)===false || qe.cancel){
3676 forceAll = qe.forceAll;
3677 if(forceAll === true || (q.length >= this.minChars)){
3678 if(this.lastQuery !== q){
3680 if(this.mode == 'local'){
3681 this.selectedIndex = -1;
3683 this.store.clearFilter();
3685 this.store.filter(this.displayField, q);
3689 this.store.baseParams[this.queryParam] = q;
3691 params: this.getParams(q)
3696 this.selectedIndex = -1;
3703 getParams : function(q){
3705 //p[this.queryParam] = q;
3708 p.limit = this.pageSize;
3714 * Hides the dropdown list if it is currently expanded. Fires the {@link #collapse} event on completion.
3716 collapse : function(){
3717 if(!this.isExpanded()){
3721 Ext.getDoc().un('mousewheel', this.collapseIf, this);
3722 Ext.getDoc().un('mousedown', this.collapseIf, this);
3723 this.fireEvent('collapse', this);
3727 collapseIf : function(e){
3728 if(!this.isDestroyed && !e.within(this.wrap) && !e.within(this.list)){
3734 * Expands the dropdown list if it is currently hidden. Fires the {@link #expand} event on completion.
3736 expand : function(){
3737 if(this.isExpanded() || !this.hasFocus){
3741 if(this.title || this.pageSize){
3742 this.assetHeight = 0;
3744 this.assetHeight += this.header.getHeight();
3747 this.assetHeight += this.footer.getHeight();
3751 if(this.bufferSize){
3752 this.doResize(this.bufferSize);
3753 delete this.bufferSize;
3755 this.list.alignTo.apply(this.list, [this.el].concat(this.listAlign));
3757 // zindex can change, re-check it and set it if necessary
3758 var listParent = Ext.getDom(this.getListParent() || Ext.getBody()),
3759 zindex = parseInt(Ext.fly(listParent).getStyle('z-index') ,10);
3761 zindex = this.getParentZIndex();
3764 this.list.setZIndex(zindex + 5);
3768 this.innerList.setOverflow('auto'); // necessary for FF 2.0/Mac
3770 this.mon(Ext.getDoc(), {
3772 mousewheel: this.collapseIf,
3773 mousedown: this.collapseIf
3775 this.fireEvent('expand', this);
3779 * @method onTriggerClick
3783 // Implements the default empty TriggerField.onTriggerClick function
3784 onTriggerClick : function(){
3785 if(this.readOnly || this.disabled){
3788 if(this.isExpanded()){
3793 if(this.triggerAction == 'all') {
3794 this.doQuery(this.allQuery, true);
3796 this.doQuery(this.getRawValue());
3807 * @cfg {Boolean} grow @hide
3810 * @cfg {Number} growMin @hide
3813 * @cfg {Number} growMax @hide
3817 Ext.reg('combo', Ext.form.ComboBox);
3819 * @class Ext.form.Checkbox
3820 * @extends Ext.form.Field
3821 * Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.
3823 * Creates a new Checkbox
3824 * @param {Object} config Configuration options
3827 Ext.form.Checkbox = Ext.extend(Ext.form.Field, {
3829 * @cfg {String} focusClass The CSS class to use when the checkbox receives focus (defaults to undefined)
3831 focusClass : undefined,
3833 * @cfg {String} fieldClass The default CSS class for the checkbox (defaults to 'x-form-field')
3835 fieldClass : 'x-form-field',
3837 * @cfg {Boolean} checked <tt>true</tt> if the checkbox should render initially checked (defaults to <tt>false</tt>)
3841 * @cfg {String} boxLabel The text that appears beside the checkbox
3845 * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to
3846 * {tag: 'input', type: 'checkbox', autocomplete: 'off'})
3848 defaultAutoCreate : { tag: 'input', type: 'checkbox', autocomplete: 'off'},
3850 * @cfg {String} boxLabel The text that appears beside the checkbox
3853 * @cfg {String} inputValue The value that should go into the generated input element's value attribute
3856 * @cfg {Function} handler A function called when the {@link #checked} value changes (can be used instead of
3857 * handling the check event). The handler is passed the following parameters:
3858 * <div class="mdetail-params"><ul>
3859 * <li><b>checkbox</b> : Ext.form.Checkbox<div class="sub-desc">The Checkbox being toggled.</div></li>
3860 * <li><b>checked</b> : Boolean<div class="sub-desc">The new checked state of the checkbox.</div></li>
3864 * @cfg {Object} scope An object to use as the scope ('this' reference) of the {@link #handler} function
3865 * (defaults to this Checkbox).
3869 actionMode : 'wrap',
3872 initComponent : function(){
3873 Ext.form.Checkbox.superclass.initComponent.call(this);
3877 * Fires when the checkbox is checked or unchecked.
3878 * @param {Ext.form.Checkbox} this This checkbox
3879 * @param {Boolean} checked The new checked value
3886 onResize : function(){
3887 Ext.form.Checkbox.superclass.onResize.apply(this, arguments);
3888 if(!this.boxLabel && !this.fieldLabel){
3889 this.el.alignTo(this.wrap, 'c-c');
3894 initEvents : function(){
3895 Ext.form.Checkbox.superclass.initEvents.call(this);
3898 click: this.onClick,
3899 change: this.onClick
3905 * Overridden and disabled. The editor element does not support standard valid/invalid marking.
3908 markInvalid : Ext.emptyFn,
3911 * Overridden and disabled. The editor element does not support standard valid/invalid marking.
3914 clearInvalid : Ext.emptyFn,
3917 onRender : function(ct, position){
3918 Ext.form.Checkbox.superclass.onRender.call(this, ct, position);
3919 if(this.inputValue !== undefined){
3920 this.el.dom.value = this.inputValue;
3922 this.wrap = this.el.wrap({cls: 'x-form-check-wrap'});
3924 this.wrap.createChild({tag: 'label', htmlFor: this.el.id, cls: 'x-form-cb-label', html: this.boxLabel});
3927 this.setValue(true);
3929 this.checked = this.el.dom.checked;
3931 // Need to repaint for IE, otherwise positioning is broken
3933 this.wrap.repaint();
3935 this.resizeEl = this.positionEl = this.wrap;
3939 onDestroy : function(){
3940 Ext.destroy(this.wrap);
3941 Ext.form.Checkbox.superclass.onDestroy.call(this);
3945 initValue : function() {
3946 this.originalValue = this.getValue();
3950 * Returns the checked state of the checkbox.
3951 * @return {Boolean} True if checked, else false
3953 getValue : function(){
3955 return this.el.dom.checked;
3957 return this.checked;
3961 onClick : function(){
3962 if(this.el.dom.checked != this.checked){
3963 this.setValue(this.el.dom.checked);
3968 * Sets the checked state of the checkbox, fires the 'check' event, and calls a
3969 * <code>{@link #handler}</code> (if configured).
3970 * @param {Boolean/String} checked The following values will check the checkbox:
3971 * <code>true, 'true', '1', or 'on'</code>. Any other value will uncheck the checkbox.
3972 * @return {Ext.form.Field} this
3974 setValue : function(v){
3975 var checked = this.checked ;
3976 this.checked = (v === true || v === 'true' || v == '1' || String(v).toLowerCase() == 'on');
3978 this.el.dom.checked = this.checked;
3979 this.el.dom.defaultChecked = this.checked;
3981 if(checked != this.checked){
3982 this.fireEvent('check', this, this.checked);
3984 this.handler.call(this.scope || this, this, this.checked);
3990 Ext.reg('checkbox', Ext.form.Checkbox);
3992 * @class Ext.form.CheckboxGroup
3993 * @extends Ext.form.Field
3994 * <p>A grouping container for {@link Ext.form.Checkbox} controls.</p>
3995 * <p>Sample usage:</p>
3997 var myCheckboxGroup = new Ext.form.CheckboxGroup({
3999 xtype: 'checkboxgroup',
4000 fieldLabel: 'Single Column',
4001 itemCls: 'x-check-group-alt',
4002 // Put all controls in a single column with width 100%
4005 {boxLabel: 'Item 1', name: 'cb-col-1'},
4006 {boxLabel: 'Item 2', name: 'cb-col-2', checked: true},
4007 {boxLabel: 'Item 3', name: 'cb-col-3'}
4012 * Creates a new CheckboxGroup
4013 * @param {Object} config Configuration options
4014 * @xtype checkboxgroup
4016 Ext.form.CheckboxGroup = Ext.extend(Ext.form.Field, {
4018 * @cfg {Array} items An Array of {@link Ext.form.Checkbox Checkbox}es or Checkbox config objects
4019 * to arrange in the group.
4022 * @cfg {String/Number/Array} columns Specifies the number of columns to use when displaying grouped
4023 * checkbox/radio controls using automatic layout. This config can take several types of values:
4024 * <ul><li><b>'auto'</b> : <p class="sub-desc">The controls will be rendered one per column on one row and the width
4025 * of each column will be evenly distributed based on the width of the overall field container. This is the default.</p></li>
4026 * <li><b>Number</b> : <p class="sub-desc">If you specific a number (e.g., 3) that number of columns will be
4027 * created and the contained controls will be automatically distributed based on the value of {@link #vertical}.</p></li>
4028 * <li><b>Array</b> : Object<p class="sub-desc">You can also specify an array of column widths, mixing integer
4029 * (fixed width) and float (percentage width) values as needed (e.g., [100, .25, .75]). Any integer values will
4030 * be rendered first, then any float values will be calculated as a percentage of the remaining space. Float
4031 * values do not have to add up to 1 (100%) although if you want the controls to take up the entire field
4032 * container you should do so.</p></li></ul>
4036 * @cfg {Boolean} vertical True to distribute contained controls across columns, completely filling each column
4037 * top to bottom before starting on the next column. The number of controls in each column will be automatically
4038 * calculated to keep columns as even as possible. The default value is false, so that controls will be added
4039 * to columns one at a time, completely filling each row left to right before starting on the next row.
4043 * @cfg {Boolean} allowBlank False to validate that at least one item in the group is checked (defaults to true).
4044 * If no items are selected at validation time, {@link @blankText} will be used as the error text.
4048 * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails (defaults to "You must
4049 * select at least one item in this group")
4051 blankText : "You must select at least one item in this group",
4054 defaultType : 'checkbox',
4057 groupCls : 'x-form-check-group',
4060 initComponent: function(){
4064 * Fires when the state of a child checkbox changes.
4065 * @param {Ext.form.CheckboxGroup} this
4066 * @param {Array} checked An array containing the checked boxes.
4070 this.on('change', this.validate, this);
4071 Ext.form.CheckboxGroup.superclass.initComponent.call(this);
4075 onRender : function(ct, position){
4084 bufferResize: false // Default this to false, since it doesn't really have a proper ownerCt.
4088 defaultType: this.defaultType,
4096 if(this.items[0].items){
4098 // The container has standard ColumnLayout configs, so pass them in directly
4100 Ext.apply(panelCfg, {
4101 layoutConfig: {columns: this.items.length},
4102 defaults: this.defaults,
4105 for(var i=0, len=this.items.length; i<len; i++){
4106 Ext.applyIf(this.items[i], colCfg);
4111 // The container has field item configs, so we have to generate the column
4112 // panels first then move the items into the columns as needed.
4114 var numCols, cols = [];
4116 if(typeof this.columns == 'string'){ // 'auto' so create a col per item
4117 this.columns = this.items.length;
4119 if(!Ext.isArray(this.columns)){
4121 for(var i=0; i<this.columns; i++){
4122 cs.push((100/this.columns)*.01); // distribute by even %
4127 numCols = this.columns.length;
4129 // Generate the column configs with the correct width setting
4130 for(var i=0; i<numCols; i++){
4131 var cc = Ext.apply({items:[]}, colCfg);
4132 cc[this.columns[i] <= 1 ? 'columnWidth' : 'width'] = this.columns[i];
4134 cc.defaults = Ext.apply(cc.defaults || {}, this.defaults);
4139 // Distribute the original items into the columns
4141 var rows = Math.ceil(this.items.length / numCols), ri = 0;
4142 for(var i=0, len=this.items.length; i<len; i++){
4143 if(i>0 && i%rows==0){
4146 if(this.items[i].fieldLabel){
4147 this.items[i].hideLabel = false;
4149 cols[ri].items.push(this.items[i]);
4152 for(var i=0, len=this.items.length; i<len; i++){
4153 var ci = i % numCols;
4154 if(this.items[i].fieldLabel){
4155 this.items[i].hideLabel = false;
4157 cols[ci].items.push(this.items[i]);
4161 Ext.apply(panelCfg, {
4162 layoutConfig: {columns: numCols},
4167 this.panel = new Ext.Container(panelCfg);
4168 this.panel.ownerCt = this;
4169 this.el = this.panel.getEl();
4171 if(this.forId && this.itemCls){
4172 var l = this.el.up(this.itemCls).child('label', true);
4174 l.setAttribute('htmlFor', this.forId);
4178 var fields = this.panel.findBy(function(c){
4179 return c.isFormField;
4182 this.items = new Ext.util.MixedCollection();
4183 this.items.addAll(fields);
4185 Ext.form.CheckboxGroup.superclass.onRender.call(this, ct, position);
4188 initValue : function(){
4190 this.setValue.apply(this, this.buffered ? this.value : [this.value]);
4191 delete this.buffered;
4196 afterRender : function(){
4197 Ext.form.CheckboxGroup.superclass.afterRender.call(this);
4198 this.eachItem(function(item){
4199 item.on('check', this.fireChecked, this);
4200 item.inGroup = true;
4205 doLayout: function(){
4206 //ugly method required to layout hidden items
4208 this.panel.forceLayout = this.ownerCt.forceLayout;
4209 this.panel.doLayout();
4214 fireChecked: function(){
4216 this.eachItem(function(item){
4221 this.fireEvent('change', this, arr);
4225 * Runs CheckboxGroup's validations and returns an array of any errors. The only error by default
4226 * is if allowBlank is set to true and no items are checked.
4227 * @return {Array} Array of all validation errors
4229 getErrors: function() {
4230 var errors = Ext.form.CheckboxGroup.superclass.getErrors.apply(this, arguments);
4232 if (!this.allowBlank) {
4235 this.eachItem(function(f){
4237 return (blank = false);
4241 if (blank) errors.push(this.blankText);
4248 isDirty: function(){
4249 //override the behaviour to check sub items.
4250 if (this.disabled || !this.rendered) {
4256 this.eachItem(function(item){
4267 setReadOnly : function(readOnly){
4269 this.eachItem(function(item){
4270 item.setReadOnly(readOnly);
4273 this.readOnly = readOnly;
4277 onDisable : function(){
4278 this.eachItem(function(item){
4284 onEnable : function(){
4285 this.eachItem(function(item){
4291 onResize : function(w, h){
4292 this.panel.setSize(w, h);
4293 this.panel.doLayout();
4296 // inherit docs from Field
4298 if (this.originalValue) {
4300 this.eachItem(function(c){
4303 c.originalValue = c.getValue();
4306 // Set items stored in originalValue, ugly - set a flag to reset the originalValue
4307 // during the horrible onSetValue. This will allow trackResetOnLoad to function.
4308 this.resetOriginal = true;
4309 this.setValue(this.originalValue);
4310 delete this.resetOriginal;
4312 this.eachItem(function(c){
4318 // Defer the clearInvalid so if BaseForm's collection is being iterated it will be called AFTER it is complete.
4319 // Important because reset is being called on both the group and the individual items.
4321 this.clearInvalid();
4326 * {@link Ext.form.Checkbox#setValue Set the value(s)} of an item or items
4327 * in the group. Examples illustrating how this method may be called:
4329 // call with name and value
4330 myCheckboxGroup.setValue('cb-col-1', true);
4331 // call with an array of boolean values
4332 myCheckboxGroup.setValue([true, false, false]);
4333 // call with an object literal specifying item:value pairs
4334 myCheckboxGroup.setValue({
4338 // use comma separated string to set items with name to true (checked)
4339 myCheckboxGroup.setValue('cb-col-1,cb-col-3');
4341 * See {@link Ext.form.Checkbox#setValue} for additional information.
4342 * @param {Mixed} id The checkbox to check, or as described by example shown.
4343 * @param {Boolean} value (optional) The value to set the item.
4344 * @return {Ext.form.CheckboxGroup} this
4346 setValue: function(){
4348 this.onSetValue.apply(this, arguments);
4350 this.buffered = true;
4351 this.value = arguments;
4358 * Sets the values of one or more of the items within the CheckboxGroup
4359 * @param {String|Array|Object} id Can take multiple forms. Can be optionally:
4361 * <li>An ID string to be used with a second argument</li>
4362 * <li>An array of the form ['some', 'list', 'of', 'ids', 'to', 'mark', 'checked']</li>
4363 * <li>An array in the form [true, true, false, true, false] etc, where each item relates to the check status of
4364 * the checkbox at the same index</li>
4365 * <li>An object containing ids of the checkboxes as keys and check values as properties</li>
4367 * @param {String} value The value to set the field to if the first argument was a string
4369 onSetValue: function(id, value){
4370 if(arguments.length == 1){
4371 if(Ext.isArray(id)){
4372 Ext.each(id, function(val, idx){
4373 if (Ext.isObject(val) && val.setValue){ // array of checkbox components to be checked
4375 if (this.resetOriginal === true) {
4376 val.originalValue = val.getValue();
4378 } else { // an array of boolean values
4379 var item = this.items.itemAt(idx);
4385 }else if(Ext.isObject(id)){
4386 // set of name/value pairs
4388 var f = this.getBox(i);
4394 this.setValueForItem(id);
4397 var f = this.getBox(id);
4405 beforeDestroy: function(){
4406 Ext.destroy(this.panel);
4407 Ext.form.CheckboxGroup.superclass.beforeDestroy.call(this);
4411 setValueForItem : function(val){
4412 val = String(val).split(',');
4413 this.eachItem(function(item){
4414 if(val.indexOf(item.inputValue)> -1){
4415 item.setValue(true);
4421 getBox : function(id){
4423 this.eachItem(function(f){
4424 if(id == f || f.dataIndex == id || f.id == id || f.getName() == id){
4433 * Gets an array of the selected {@link Ext.form.Checkbox} in the group.
4434 * @return {Array} An array of the selected checkboxes.
4436 getValue : function(){
4438 this.eachItem(function(item){
4448 * Convenience function which passes the given function to every item in the composite
4449 * @param {Function} fn The function to call
4450 * @param {Object} scope Optional scope object
4452 eachItem: function(fn, scope) {
4453 if(this.items && this.items.each){
4454 this.items.each(fn, scope || this);
4459 * @cfg {String} name
4464 * @method getRawValue
4467 getRawValue : Ext.emptyFn,
4470 * @method setRawValue
4473 setRawValue : Ext.emptyFn
4477 Ext.reg('checkboxgroup', Ext.form.CheckboxGroup);
4479 * @class Ext.form.CompositeField
4480 * @extends Ext.form.Field
4481 * Composite field allowing a number of form Fields to be rendered on the same row. The fields are rendered
4482 * using an hbox layout internally, so all of the normal HBox layout config items are available. Example usage:
4485 xtype: 'compositefield',
4489 xtype : 'textfield',
4490 fieldLabel: 'Title',
4494 xtype : 'textfield',
4495 fieldLabel: 'First',
4499 xtype : 'textfield',
4506 * In the example above the composite's fieldLabel will be set to 'Title, First, Last' as it groups the fieldLabels
4507 * of each of its children. This can be overridden by setting a fieldLabel on the compositefield itself:
4510 xtype: 'compositefield',
4511 fieldLabel: 'Custom label',
4515 * Any Ext.form.* component can be placed inside a composite field.
4517 Ext.form.CompositeField = Ext.extend(Ext.form.Field, {
4520 * @property defaultMargins
4522 * The margins to apply by default to each field in the composite
4524 defaultMargins: '0 5 0 0',
4527 * @property skipLastItemMargin
4529 * If true, the defaultMargins are not applied to the last item in the composite field set (defaults to true)
4531 skipLastItemMargin: true,
4534 * @property isComposite
4536 * Signifies that this is a Composite field
4541 * @property combineErrors
4543 * True to combine errors from the individual fields into a single error message at the CompositeField level (defaults to true)
4545 combineErrors: true,
4548 //Builds the composite field label
4549 initComponent: function() {
4554 for (var i=0, j = items.length; i < j; i++) {
4557 labels.push(item.fieldLabel);
4559 //apply any defaults
4560 Ext.apply(item, this.defaults);
4562 //apply default margins to each item except the last
4563 if (!(i == j - 1 && this.skipLastItemMargin)) {
4564 Ext.applyIf(item, {margins: this.defaultMargins});
4568 this.fieldLabel = this.fieldLabel || this.buildLabel(labels);
4571 * @property fieldErrors
4572 * @type Ext.util.MixedCollection
4573 * MixedCollection of current errors on the Composite's subfields. This is used internally to track when
4574 * to show and hide error messages at the Composite level. Listeners are attached to the MixedCollection's
4575 * add, remove and replace events to update the error icon in the UI as errors are added or removed.
4577 this.fieldErrors = new Ext.util.MixedCollection(true, function(item) {
4581 this.fieldErrors.on({
4583 add : this.updateInvalidMark,
4584 remove : this.updateInvalidMark,
4585 replace: this.updateInvalidMark
4588 Ext.form.CompositeField.superclass.initComponent.apply(this, arguments);
4593 * Creates an internal container using hbox and renders the fields to it
4595 onRender: function(ct, position) {
4599 * @type Ext.Container
4600 * A container configured with hbox layout which is responsible for laying out the subfields
4602 var innerCt = this.innerCt = new Ext.Container({
4606 cls : 'x-form-composite',
4607 defaultMargins: '0 3 0 0'
4610 this.el = innerCt.getEl();
4612 var fields = innerCt.findBy(function(c) {
4613 return c.isFormField;
4618 * @type Ext.util.MixedCollection
4619 * Internal collection of all of the subfields in this Composite
4621 this.items = new Ext.util.MixedCollection();
4622 this.items.addAll(fields);
4624 //if we're combining subfield errors into a single message, override the markInvalid and clearInvalid
4625 //methods of each subfield and show them at the Composite level instead
4626 if (this.combineErrors) {
4627 this.eachItem(function(field) {
4629 markInvalid : this.onFieldMarkInvalid.createDelegate(this, [field], 0),
4630 clearInvalid: this.onFieldClearInvalid.createDelegate(this, [field], 0)
4635 //set the label 'for' to the first item
4636 var l = this.el.parent().parent().child('label', true);
4638 l.setAttribute('for', this.items.items[0].id);
4642 Ext.form.CompositeField.superclass.onRender.apply(this, arguments);
4646 * Called if combineErrors is true and a subfield's markInvalid method is called.
4647 * By default this just adds the subfield's error to the internal fieldErrors MixedCollection
4648 * @param {Ext.form.Field} field The field that was marked invalid
4649 * @param {String} message The error message
4651 onFieldMarkInvalid: function(field, message) {
4652 var name = field.getName(),
4653 error = {field: name, error: message};
4655 this.fieldErrors.replace(name, error);
4657 field.el.addClass(field.invalidClass);
4661 * Called if combineErrors is true and a subfield's clearInvalid method is called.
4662 * By default this just updates the internal fieldErrors MixedCollection.
4663 * @param {Ext.form.Field} field The field that was marked invalid
4665 onFieldClearInvalid: function(field) {
4666 this.fieldErrors.removeKey(field.getName());
4668 field.el.removeClass(field.invalidClass);
4673 * Called after a subfield is marked valid or invalid, this checks to see if any of the subfields are
4674 * currently invalid. If any subfields are invalid it builds a combined error message marks the composite
4675 * invalid, otherwise clearInvalid is called
4677 updateInvalidMark: function() {
4678 var ieStrict = Ext.isIE6 && Ext.isStrict;
4680 if (this.fieldErrors.length == 0) {
4681 this.clearInvalid();
4683 //IE6 in strict mode has a layout bug when using 'under' as the error message target. This fixes it
4685 this.clearInvalid.defer(50, this);
4688 var message = this.buildCombinedErrorMessage(this.fieldErrors.items);
4691 this.markInvalid(message);
4693 //IE6 in strict mode has a layout bug when using 'under' as the error message target. This fixes it
4695 this.markInvalid(message);
4701 * Performs validation checks on each subfield and returns false if any of them fail validation.
4702 * @return {Boolean} False if any subfield failed validation
4704 validateValue: function() {
4707 this.eachItem(function(field) {
4708 if (!field.isValid()) valid = false;
4715 * Takes an object containing error messages for contained fields, returning a combined error
4716 * string (defaults to just placing each item on a new line). This can be overridden to provide
4717 * custom combined error message handling.
4718 * @param {Array} errors Array of errors in format: [{field: 'title', error: 'some error'}]
4719 * @return {String} The combined error message
4721 buildCombinedErrorMessage: function(errors) {
4725 for (var i = 0, j = errors.length; i < j; i++) {
4728 combined.push(String.format("{0}: {1}", error.field, error.error));
4731 return combined.join("<br />");
4735 * Sorts the internal fieldErrors MixedCollection by the order in which the fields are defined.
4736 * This is called before displaying errors to ensure that the errors are presented in the expected order.
4737 * This function can be overridden to provide a custom sorting order if needed.
4739 sortErrors: function() {
4740 var fields = this.items;
4742 this.fieldErrors.sort("ASC", function(a, b) {
4743 var findByName = function(key) {
4744 return function(field) {
4745 return field.getName() == key;
4749 var aIndex = fields.findIndexBy(findByName(a.field)),
4750 bIndex = fields.findIndexBy(findByName(b.field));
4752 return aIndex < bIndex ? -1 : 1;
4757 * Resets each field in the composite to their previous value
4760 this.eachItem(function(item) {
4764 // Defer the clearInvalid so if BaseForm's collection is being iterated it will be called AFTER it is complete.
4765 // Important because reset is being called on both the group and the individual items.
4767 this.clearInvalid();
4772 * Calls clearInvalid on all child fields. This is a convenience function and should not often need to be called
4773 * as fields usually take care of clearing themselves
4775 clearInvalidChildren: function() {
4776 this.eachItem(function(item) {
4777 item.clearInvalid();
4782 * Builds a label string from an array of subfield labels.
4783 * By default this just joins the labels together with a comma
4784 * @param {Array} segments Array of each of the labels in the composite field's subfields
4785 * @return {String} The built label
4787 buildLabel: function(segments) {
4788 return segments.join(", ");
4792 * Checks each field in the composite and returns true if any is dirty
4793 * @return {Boolean} True if any field is dirty
4795 isDirty: function(){
4796 //override the behaviour to check sub items.
4797 if (this.disabled || !this.rendered) {
4802 this.eachItem(function(item){
4813 * Convenience function which passes the given function to every item in the composite
4814 * @param {Function} fn The function to call
4815 * @param {Object} scope Optional scope object
4817 eachItem: function(fn, scope) {
4818 if(this.items && this.items.each){
4819 this.items.each(fn, scope || this);
4825 * Passes the resize call through to the inner panel
4827 onResize: function(adjWidth, adjHeight, rawWidth, rawHeight) {
4828 var innerCt = this.innerCt;
4830 if (this.rendered && innerCt.rendered) {
4831 innerCt.setSize(adjWidth, adjHeight);
4834 Ext.form.CompositeField.superclass.onResize.apply(this, arguments);
4839 * Forces the internal container to be laid out again
4841 doLayout: function(shallow, force) {
4842 if (this.rendered) {
4843 var innerCt = this.innerCt;
4845 innerCt.forceLayout = this.ownerCt.forceLayout;
4846 innerCt.doLayout(shallow, force);
4853 beforeDestroy: function(){
4854 Ext.destroy(this.innerCt);
4856 Ext.form.CompositeField.superclass.beforeDestroy.call(this);
4859 //override the behaviour to check sub items.
4860 setReadOnly : function(readOnly) {
4861 readOnly = readOnly || true;
4864 this.eachItem(function(item){
4865 item.setReadOnly(readOnly);
4868 this.readOnly = readOnly;
4871 onShow : function() {
4872 Ext.form.CompositeField.superclass.onShow.call(this);
4876 //override the behaviour to check sub items.
4877 onDisable : function(){
4878 this.eachItem(function(item){
4883 //override the behaviour to check sub items.
4884 onEnable : function(){
4885 this.eachItem(function(item){
4891 Ext.reg('compositefield', Ext.form.CompositeField);
4893 * @class Ext.form.Radio
4894 * @extends Ext.form.Checkbox
4895 * Single radio field. Same as Checkbox, but provided as a convenience for automatically setting the input type.
4896 * Radio grouping is handled automatically by the browser if you give each radio in a group the same name.
4898 * Creates a new Radio
4899 * @param {Object} config Configuration options
4902 Ext.form.Radio = Ext.extend(Ext.form.Checkbox, {
4906 * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
4909 markInvalid : Ext.emptyFn,
4911 * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
4914 clearInvalid : Ext.emptyFn,
4917 * If this radio is part of a group, it will return the selected value
4920 getGroupValue : function(){
4921 var p = this.el.up('form') || Ext.getBody();
4922 var c = p.child('input[name='+this.el.dom.name+']:checked', true);
4923 return c ? c.value : null;
4927 onClick : function(){
4928 if(this.el.dom.checked != this.checked){
4929 var els = this.getCheckEl().select('input[name=' + this.el.dom.name + ']');
4930 els.each(function(el){
4931 if(el.dom.id == this.id){
4932 this.setValue(true);
4934 Ext.getCmp(el.dom.id).setValue(false);
4941 * Sets either the checked/unchecked status of this Radio, or, if a string value
4942 * is passed, checks a sibling Radio of the same name whose value is the value specified.
4943 * @param value {String/Boolean} Checked value, or the value of the sibling radio button to check.
4944 * @return {Ext.form.Field} this
4946 setValue : function(v){
4947 if (typeof v == 'boolean') {
4948 Ext.form.Radio.superclass.setValue.call(this, v);
4949 } else if (this.rendered) {
4950 var r = this.getCheckEl().child('input[name=' + this.el.dom.name + '][value=' + v + ']', true);
4952 Ext.getCmp(r.id).setValue(true);
4959 getCheckEl: function(){
4961 return this.el.up('.x-form-radio-group')
4963 return this.el.up('form') || Ext.getBody();
4966 Ext.reg('radio', Ext.form.Radio);
4968 * @class Ext.form.RadioGroup
4969 * @extends Ext.form.CheckboxGroup
4970 * A grouping container for {@link Ext.form.Radio} controls.
4972 * Creates a new RadioGroup
4973 * @param {Object} config Configuration options
4976 Ext.form.RadioGroup = Ext.extend(Ext.form.CheckboxGroup, {
4978 * @cfg {Array} items An Array of {@link Ext.form.Radio Radio}s or Radio config objects
4979 * to arrange in the group.
4982 * @cfg {Boolean} allowBlank True to allow every item in the group to be blank (defaults to true).
4983 * If allowBlank = false and no items are selected at validation time, {@link @blankText} will
4984 * be used as the error text.
4988 * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails
4989 * (defaults to 'You must select one item in this group')
4991 blankText : 'You must select one item in this group',
4994 defaultType : 'radio',
4997 groupCls : 'x-form-radio-group',
5001 * Fires when the state of a child radio changes.
5002 * @param {Ext.form.RadioGroup} this
5003 * @param {Ext.form.Radio} checked The checked radio
5007 * Gets the selected {@link Ext.form.Radio} in the group, if it exists.
5008 * @return {Ext.form.Radio} The selected radio.
5010 getValue : function(){
5012 this.eachItem(function(item){
5022 * Sets the checked radio in the group.
5023 * @param {String/Ext.form.Radio} id The radio to check.
5024 * @param {Boolean} value The value to set the radio.
5025 * @return {Ext.form.RadioGroup} this
5027 onSetValue : function(id, value){
5028 if(arguments.length > 1){
5029 var f = this.getBox(id);
5033 this.eachItem(function(item){
5035 item.setValue(false);
5041 this.setValueForItem(id);
5045 setValueForItem : function(val){
5046 val = String(val).split(',')[0];
5047 this.eachItem(function(item){
5048 item.setValue(val == item.inputValue);
5053 fireChecked : function(){
5054 if(!this.checkTask){
5055 this.checkTask = new Ext.util.DelayedTask(this.bufferChecked, this);
5057 this.checkTask.delay(10);
5061 bufferChecked : function(){
5063 this.eachItem(function(item){
5069 this.fireEvent('change', this, out);
5072 onDestroy : function(){
5074 this.checkTask.cancel();
5075 this.checkTask = null;
5077 Ext.form.RadioGroup.superclass.onDestroy.call(this);
5082 Ext.reg('radiogroup', Ext.form.RadioGroup);
5084 * @class Ext.form.Hidden
5085 * @extends Ext.form.Field
5086 * A basic hidden field for storing hidden values in forms that need to be passed in the form submit.
5088 * Create a new Hidden field.
5089 * @param {Object} config Configuration options
5092 Ext.form.Hidden = Ext.extend(Ext.form.Field, {
5094 inputType : 'hidden',
5097 onRender : function(){
5098 Ext.form.Hidden.superclass.onRender.apply(this, arguments);
5102 initEvents : function(){
5103 this.originalValue = this.getValue();
5106 // These are all private overrides
5107 setSize : Ext.emptyFn,
5108 setWidth : Ext.emptyFn,
5109 setHeight : Ext.emptyFn,
5110 setPosition : Ext.emptyFn,
5111 setPagePosition : Ext.emptyFn,
5112 markInvalid : Ext.emptyFn,
5113 clearInvalid : Ext.emptyFn
5115 Ext.reg('hidden', Ext.form.Hidden);/**
5116 * @class Ext.form.BasicForm
5117 * @extends Ext.util.Observable
5118 * <p>Encapsulates the DOM <form> element at the heart of the {@link Ext.form.FormPanel FormPanel} class, and provides
5119 * input field management, validation, submission, and form loading services.</p>
5120 * <p>By default, Ext Forms are submitted through Ajax, using an instance of {@link Ext.form.Action.Submit}.
5121 * To enable normal browser submission of an Ext Form, use the {@link #standardSubmit} config option.</p>
5122 * <p><b><u>File Uploads</u></b></p>
5123 * <p>{@link #fileUpload File uploads} are not performed using Ajax submission, that
5124 * is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard
5125 * manner with the DOM <tt><form></tt> element temporarily modified to have its
5126 * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
5127 * to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document
5128 * but removed after the return data has been gathered.</p>
5129 * <p>The server response is parsed by the browser to create the document for the IFRAME. If the
5130 * server is using JSON to send the return object, then the
5131 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
5132 * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
5133 * <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
5134 * "<" as "&lt;", "&" as "&amp;" etc.</p>
5135 * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object
5136 * is created containing a <tt>responseText</tt> property in order to conform to the
5137 * requirements of event handlers and callbacks.</p>
5138 * <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>
5139 * and some server technologies (notably JEE) may require some custom processing in order to
5140 * retrieve parameter names and parameter values from the packet content.</p>
5142 * @param {Mixed} el The form element or its id
5143 * @param {Object} config Configuration options
5145 Ext.form.BasicForm = Ext.extend(Ext.util.Observable, {
5147 constructor: function(el, config){
5148 Ext.apply(this, config);
5149 if(Ext.isString(this.paramOrder)){
5150 this.paramOrder = this.paramOrder.split(/[\s,|]/);
5153 * A {@link Ext.util.MixedCollection MixedCollection} containing all the Ext.form.Fields in this form.
5154 * @type MixedCollection
5157 this.items = new Ext.util.MixedCollection(false, function(o){
5158 return o.getItemId();
5162 * @event beforeaction
5163 * Fires before any action is performed. Return false to cancel the action.
5164 * @param {Form} this
5165 * @param {Action} action The {@link Ext.form.Action} to be performed
5169 * @event actionfailed
5170 * Fires when an action fails.
5171 * @param {Form} this
5172 * @param {Action} action The {@link Ext.form.Action} that failed
5176 * @event actioncomplete
5177 * Fires when an action is completed.
5178 * @param {Form} this
5179 * @param {Action} action The {@link Ext.form.Action} that completed
5187 Ext.form.BasicForm.superclass.constructor.call(this);
5191 * @cfg {String} method
5192 * The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
5195 * @cfg {DataReader} reader
5196 * An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to read
5197 * data when executing 'load' actions. This is optional as there is built-in
5198 * support for processing JSON. For additional information on using an XMLReader
5199 * see the example provided in examples/form/xml-form.html.
5202 * @cfg {DataReader} errorReader
5203 * <p>An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to
5204 * read field error messages returned from 'submit' actions. This is optional
5205 * as there is built-in support for processing JSON.</p>
5206 * <p>The Records which provide messages for the invalid Fields must use the
5207 * Field name (or id) as the Record ID, and must contain a field called 'msg'
5208 * which contains the error message.</p>
5209 * <p>The errorReader does not have to be a full-blown implementation of a
5210 * DataReader. It simply needs to implement a <tt>read(xhr)</tt> function
5211 * which returns an Array of Records in an object with the following
5212 * structure:</p><pre><code>
5214 records: recordArray
5220 * The URL to use for form actions if one isn't supplied in the
5221 * <code>{@link #doAction doAction} options</code>.
5224 * @cfg {Boolean} fileUpload
5225 * Set to true if this form is a file upload.
5226 * <p>File uploads are not performed using normal 'Ajax' techniques, that is they are <b>not</b>
5227 * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
5228 * DOM <tt><form></tt> element temporarily modified to have its
5229 * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
5230 * to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document
5231 * but removed after the return data has been gathered.</p>
5232 * <p>The server response is parsed by the browser to create the document for the IFRAME. If the
5233 * server is using JSON to send the return object, then the
5234 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
5235 * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
5236 * <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
5237 * "<" as "&lt;", "&" as "&amp;" etc.</p>
5238 * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object
5239 * is created containing a <tt>responseText</tt> property in order to conform to the
5240 * requirements of event handlers and callbacks.</p>
5241 * <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>
5242 * and some server technologies (notably JEE) may require some custom processing in order to
5243 * retrieve parameter names and parameter values from the packet content.</p>
5246 * @cfg {Object} baseParams
5247 * <p>Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</p>
5248 * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
5251 * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds).
5256 * @cfg {Object} api (Optional) If specified load and submit actions will be handled
5257 * with {@link Ext.form.Action.DirectLoad} and {@link Ext.form.Action.DirectSubmit}.
5258 * Methods which have been imported by Ext.Direct can be specified here to load and submit
5260 * Such as the following:<pre><code>
5262 load: App.ss.MyProfile.load,
5263 submit: App.ss.MyProfile.submit
5266 * <p>Load actions can use <code>{@link #paramOrder}</code> or <code>{@link #paramsAsHash}</code>
5267 * to customize how the load method is invoked.
5268 * Submit actions will always use a standard form submit. The formHandler configuration must
5269 * be set on the associated server-side method which has been imported by Ext.Direct</p>
5273 * @cfg {Array/String} paramOrder <p>A list of params to be executed server side.
5274 * Defaults to <tt>undefined</tt>. Only used for the <code>{@link #api}</code>
5275 * <code>load</code> configuration.</p>
5276 * <br><p>Specify the params in the order in which they must be executed on the
5277 * server-side as either (1) an Array of String values, or (2) a String of params
5278 * delimited by either whitespace, comma, or pipe. For example,
5279 * any of the following would be acceptable:</p><pre><code>
5280 paramOrder: ['param1','param2','param3']
5281 paramOrder: 'param1 param2 param3'
5282 paramOrder: 'param1,param2,param3'
5283 paramOrder: 'param1|param2|param'
5286 paramOrder: undefined,
5289 * @cfg {Boolean} paramsAsHash Only used for the <code>{@link #api}</code>
5290 * <code>load</code> configuration. Send parameters as a collection of named
5291 * arguments (defaults to <tt>false</tt>). Providing a
5292 * <tt>{@link #paramOrder}</tt> nullifies this configuration.
5294 paramsAsHash: false,
5297 * @cfg {String} waitTitle
5298 * The default title to show for the waiting message box (defaults to <tt>'Please Wait...'</tt>)
5300 waitTitle: 'Please Wait...',
5303 activeAction : null,
5306 * @cfg {Boolean} trackResetOnLoad If set to <tt>true</tt>, {@link #reset}() resets to the last loaded
5307 * or {@link #setValues}() data instead of when the form was first created. Defaults to <tt>false</tt>.
5309 trackResetOnLoad : false,
5312 * @cfg {Boolean} standardSubmit
5313 * <p>If set to <tt>true</tt>, standard HTML form submits are used instead
5314 * of XHR (Ajax) style form submissions. Defaults to <tt>false</tt>.</p>
5315 * <br><p><b>Note:</b> When using <code>standardSubmit</code>, the
5316 * <code>options</code> to <code>{@link #submit}</code> are ignored because
5317 * Ext's Ajax infrastracture is bypassed. To pass extra parameters (e.g.
5318 * <code>baseParams</code> and <code>params</code>), utilize hidden fields
5319 * to submit extra data, for example:</p>
5322 standardSubmit: true,
5326 {@link url}: 'myProcess.php',
5333 handler: function(){
5334 var fp = this.ownerCt.ownerCt,
5335 form = fp.getForm();
5336 if (form.isValid()) {
5337 // check if there are baseParams and if
5338 // hiddent items have been added already
5339 if (fp.baseParams && !fp.paramsAdded) {
5340 // add hidden items for all baseParams
5341 for (i in fp.baseParams) {
5345 value: fp.baseParams[i]
5349 // set a custom flag to prevent re-adding
5350 fp.paramsAdded = true;
5352 form.{@link #submit}();
5360 * By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
5361 * element by passing it or its id or mask the form itself by passing in true.
5363 * @property waitMsgTarget
5367 initEl : function(el){
5368 this.el = Ext.get(el);
5369 this.id = this.el.id || Ext.id();
5370 if(!this.standardSubmit){
5371 this.el.on('submit', this.onSubmit, this);
5373 this.el.addClass('x-form');
5377 * Get the HTML form Element
5378 * @return Ext.Element
5385 onSubmit : function(e){
5390 * Destroys this object.
5392 * @param {Boolean} bound true if the object is bound to a form panel. If this is the case
5393 * the FormPanel will take care of destroying certain things, so we're just doubling up.
5395 destroy: function(bound){
5397 this.items.each(function(f){
5400 Ext.destroy(this.el);
5403 this.purgeListeners();
5407 * Returns true if client-side validation on the form is successful.
5410 isValid : function(){
5412 this.items.each(function(f){
5421 * <p>Returns true if any fields in this form have changed from their original values.</p>
5422 * <p>Note that if this BasicForm was configured with {@link #trackResetOnLoad} then the
5423 * Fields' <i>original values</i> are updated when the values are loaded by {@link #setValues}
5424 * or {@link #loadRecord}.</p>
5427 isDirty : function(){
5429 this.items.each(function(f){
5439 * Performs a predefined action ({@link Ext.form.Action.Submit} or
5440 * {@link Ext.form.Action.Load}) or a custom extension of {@link Ext.form.Action}
5441 * to perform application-specific processing.
5442 * @param {String/Object} actionName The name of the predefined action type,
5443 * or instance of {@link Ext.form.Action} to perform.
5444 * @param {Object} options (optional) The options to pass to the {@link Ext.form.Action}.
5445 * All of the config options listed below are supported by both the
5446 * {@link Ext.form.Action.Submit submit} and {@link Ext.form.Action.Load load}
5447 * actions unless otherwise noted (custom actions could also accept
5448 * other config options):<ul>
5450 * <li><b>url</b> : String<div class="sub-desc">The url for the action (defaults
5451 * to the form's {@link #url}.)</div></li>
5453 * <li><b>method</b> : String<div class="sub-desc">The form method to use (defaults
5454 * to the form's method, or POST if not defined)</div></li>
5456 * <li><b>params</b> : String/Object<div class="sub-desc"><p>The params to pass
5457 * (defaults to the form's baseParams, or none if not defined)</p>
5458 * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p></div></li>
5460 * <li><b>headers</b> : Object<div class="sub-desc">Request headers to set for the action
5461 * (defaults to the form's default headers)</div></li>
5463 * <li><b>success</b> : Function<div class="sub-desc">The callback that will
5464 * be invoked after a successful response (see top of
5465 * {@link Ext.form.Action.Submit submit} and {@link Ext.form.Action.Load load}
5466 * for a description of what constitutes a successful response).
5467 * The function is passed the following parameters:<ul>
5468 * <li><tt>form</tt> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
5469 * <li><tt>action</tt> : The {@link Ext.form.Action Action} object which performed the operation.
5470 * <div class="sub-desc">The action object contains these properties of interest:<ul>
5471 * <li><tt>{@link Ext.form.Action#response response}</tt></li>
5472 * <li><tt>{@link Ext.form.Action#result result}</tt> : interrogate for custom postprocessing</li>
5473 * <li><tt>{@link Ext.form.Action#type type}</tt></li>
5474 * </ul></div></li></ul></div></li>
5476 * <li><b>failure</b> : Function<div class="sub-desc">The callback that will be invoked after a
5477 * failed transaction attempt. The function is passed the following parameters:<ul>
5478 * <li><tt>form</tt> : The {@link Ext.form.BasicForm} that requested the action.</li>
5479 * <li><tt>action</tt> : The {@link Ext.form.Action Action} object which performed the operation.
5480 * <div class="sub-desc">The action object contains these properties of interest:<ul>
5481 * <li><tt>{@link Ext.form.Action#failureType failureType}</tt></li>
5482 * <li><tt>{@link Ext.form.Action#response response}</tt></li>
5483 * <li><tt>{@link Ext.form.Action#result result}</tt> : interrogate for custom postprocessing</li>
5484 * <li><tt>{@link Ext.form.Action#type type}</tt></li>
5485 * </ul></div></li></ul></div></li>
5487 * <li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the
5488 * callback functions (The <tt>this</tt> reference for the callback functions).</div></li>
5490 * <li><b>clientValidation</b> : Boolean<div class="sub-desc">Submit Action only.
5491 * Determines whether a Form's fields are validated in a final call to
5492 * {@link Ext.form.BasicForm#isValid isValid} prior to submission. Set to <tt>false</tt>
5493 * to prevent this. If undefined, pre-submission field validation is performed.</div></li></ul>
5495 * @return {BasicForm} this
5497 doAction : function(action, options){
5498 if(Ext.isString(action)){
5499 action = new Ext.form.Action.ACTION_TYPES[action](this, options);
5501 if(this.fireEvent('beforeaction', this, action) !== false){
5502 this.beforeAction(action);
5503 action.run.defer(100, action);
5509 * Shortcut to {@link #doAction do} a {@link Ext.form.Action.Submit submit action}.
5510 * @param {Object} options The options to pass to the action (see {@link #doAction} for details).<br>
5511 * <p><b>Note:</b> this is ignored when using the {@link #standardSubmit} option.</p>
5512 * <p>The following code:</p><pre><code>
5513 myFormPanel.getForm().submit({
5514 clientValidation: true,
5515 url: 'updateConsignment.php',
5517 newStatus: 'delivered'
5519 success: function(form, action) {
5520 Ext.Msg.alert('Success', action.result.msg);
5522 failure: function(form, action) {
5523 switch (action.failureType) {
5524 case Ext.form.Action.CLIENT_INVALID:
5525 Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');
5527 case Ext.form.Action.CONNECT_FAILURE:
5528 Ext.Msg.alert('Failure', 'Ajax communication failed');
5530 case Ext.form.Action.SERVER_INVALID:
5531 Ext.Msg.alert('Failure', action.result.msg);
5536 * would process the following server response for a successful submission:<pre><code>
5538 "success":true, // note this is Boolean, not string
5539 "msg":"Consignment updated"
5542 * and the following server response for a failed submission:<pre><code>
5544 "success":false, // note this is Boolean, not string
5545 "msg":"You do not have permission to perform this operation"
5548 * @return {BasicForm} this
5550 submit : function(options){
5551 options = options || {};
5552 if(this.standardSubmit){
5553 var v = options.clientValidation === false || this.isValid();
5555 var el = this.el.dom;
5556 if(this.url && Ext.isEmpty(el.action)){
5557 el.action = this.url;
5563 var submitAction = String.format('{0}submit', this.api ? 'direct' : '');
5564 this.doAction(submitAction, options);
5569 * Shortcut to {@link #doAction do} a {@link Ext.form.Action.Load load action}.
5570 * @param {Object} options The options to pass to the action (see {@link #doAction} for details)
5571 * @return {BasicForm} this
5573 load : function(options){
5574 var loadAction = String.format('{0}load', this.api ? 'direct' : '');
5575 this.doAction(loadAction, options);
5580 * Persists the values in this form into the passed {@link Ext.data.Record} object in a beginEdit/endEdit block.
5581 * @param {Record} record The record to edit
5582 * @return {BasicForm} this
5584 updateRecord : function(record){
5586 var fs = record.fields;
5587 fs.each(function(f){
5588 var field = this.findField(f.name);
5590 record.set(f.name, field.getValue());
5598 * Loads an {@link Ext.data.Record} into this form by calling {@link #setValues} with the
5599 * {@link Ext.data.Record#data record data}.
5600 * See also {@link #trackResetOnLoad}.
5601 * @param {Record} record The record to load
5602 * @return {BasicForm} this
5604 loadRecord : function(record){
5605 this.setValues(record.data);
5610 beforeAction : function(action){
5611 // Call HtmlEditor's syncValue before actions
5612 this.items.each(function(f){
5613 if(f.isFormField && f.syncValue){
5617 var o = action.options;
5619 if(this.waitMsgTarget === true){
5620 this.el.mask(o.waitMsg, 'x-mask-loading');
5621 }else if(this.waitMsgTarget){
5622 this.waitMsgTarget = Ext.get(this.waitMsgTarget);
5623 this.waitMsgTarget.mask(o.waitMsg, 'x-mask-loading');
5625 Ext.MessageBox.wait(o.waitMsg, o.waitTitle || this.waitTitle);
5631 afterAction : function(action, success){
5632 this.activeAction = null;
5633 var o = action.options;
5635 if(this.waitMsgTarget === true){
5637 }else if(this.waitMsgTarget){
5638 this.waitMsgTarget.unmask();
5640 Ext.MessageBox.updateProgress(1);
5641 Ext.MessageBox.hide();
5648 Ext.callback(o.success, o.scope, [this, action]);
5649 this.fireEvent('actioncomplete', this, action);
5651 Ext.callback(o.failure, o.scope, [this, action]);
5652 this.fireEvent('actionfailed', this, action);
5657 * Find a {@link Ext.form.Field} in this form.
5658 * @param {String} id The value to search for (specify either a {@link Ext.Component#id id},
5659 * {@link Ext.grid.Column#dataIndex dataIndex}, {@link Ext.form.Field#getName name or hiddenName}).
5662 findField : function(id) {
5663 var field = this.items.get(id);
5665 if (!Ext.isObject(field)) {
5666 //searches for the field corresponding to the given id. Used recursively for composite fields
5667 var findMatchingField = function(f) {
5668 if (f.isFormField) {
5669 if (f.dataIndex == id || f.id == id || f.getName() == id) {
5672 } else if (f.isComposite && f.rendered) {
5673 return f.items.each(findMatchingField);
5678 this.items.each(findMatchingField);
5680 return field || null;
5685 * Mark fields in this form invalid in bulk.
5686 * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
5687 * @return {BasicForm} this
5689 markInvalid : function(errors){
5690 if (Ext.isArray(errors)) {
5691 for(var i = 0, len = errors.length; i < len; i++){
5692 var fieldError = errors[i];
5693 var f = this.findField(fieldError.id);
5695 f.markInvalid(fieldError.msg);
5701 if(!Ext.isFunction(errors[id]) && (field = this.findField(id))){
5702 field.markInvalid(errors[id]);
5711 * Set values for fields in this form in bulk.
5712 * @param {Array/Object} values Either an array in the form:<pre><code>
5713 [{id:'clientName', value:'Fred. Olsen Lines'},
5714 {id:'portOfLoading', value:'FXT'},
5715 {id:'portOfDischarge', value:'OSL'} ]</code></pre>
5716 * or an object hash of the form:<pre><code>
5718 clientName: 'Fred. Olsen Lines',
5719 portOfLoading: 'FXT',
5720 portOfDischarge: 'OSL'
5722 * @return {BasicForm} this
5724 setValues : function(values){
5725 if(Ext.isArray(values)){ // array of objects
5726 for(var i = 0, len = values.length; i < len; i++){
5728 var f = this.findField(v.id);
5730 f.setValue(v.value);
5731 if(this.trackResetOnLoad){
5732 f.originalValue = f.getValue();
5736 }else{ // object hash
5739 if(!Ext.isFunction(values[id]) && (field = this.findField(id))){
5740 field.setValue(values[id]);
5741 if(this.trackResetOnLoad){
5742 field.originalValue = field.getValue();
5751 * <p>Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit.
5752 * If multiple fields exist with the same name they are returned as an array.</p>
5753 * <p><b>Note:</b> The values are collected from all enabled HTML input elements within the form, <u>not</u> from
5754 * the Ext Field objects. This means that all returned values are Strings (or Arrays of Strings) and that the
5755 * value can potentially be the emptyText of a field.</p>
5756 * @param {Boolean} asString (optional) Pass true to return the values as a string. (defaults to false, returning an Object)
5757 * @return {String/Object}
5759 getValues : function(asString){
5760 var fs = Ext.lib.Ajax.serializeForm(this.el.dom);
5761 if(asString === true){
5764 return Ext.urlDecode(fs);
5768 * Retrieves the fields in the form as a set of key/value pairs, using the {@link Ext.form.Field#getValue getValue()} method.
5769 * If multiple fields exist with the same name they are returned as an array.
5770 * @param {Boolean} dirtyOnly (optional) True to return only fields that are dirty.
5771 * @return {Object} The values in the form
5773 getFieldValues : function(dirtyOnly){
5778 this.items.each(function(f) {
5779 if (dirtyOnly !== true || f.isDirty()) {
5784 if(Ext.isDefined(key)){
5785 if(Ext.isArray(key)){
5799 * Clears all invalid messages in this form.
5800 * @return {BasicForm} this
5802 clearInvalid : function(){
5803 this.items.each(function(f){
5811 * @return {BasicForm} this
5814 this.items.each(function(f){
5821 * Add Ext.form Components to this form's Collection. This does not result in rendering of
5822 * the passed Component, it just enables the form to validate Fields, and distribute values to
5824 * <p><b>You will not usually call this function. In order to be rendered, a Field must be added
5825 * to a {@link Ext.Container Container}, usually an {@link Ext.form.FormPanel FormPanel}.
5826 * The FormPanel to which the field is added takes care of adding the Field to the BasicForm's
5827 * collection.</b></p>
5828 * @param {Field} field1
5829 * @param {Field} field2 (optional)
5830 * @param {Field} etc (optional)
5831 * @return {BasicForm} this
5834 this.items.addAll(Array.prototype.slice.call(arguments, 0));
5839 * Removes a field from the items collection (does NOT remove its markup).
5840 * @param {Field} field
5841 * @return {BasicForm} this
5843 remove : function(field){
5844 this.items.remove(field);
5849 * Removes all fields from the collection that have been destroyed.
5851 cleanDestroyed : function() {
5852 this.items.filterBy(function(o) { return !!o.isDestroyed; }).each(this.remove, this);
5856 * Iterates through the {@link Ext.form.Field Field}s which have been {@link #add add}ed to this BasicForm,
5857 * checks them for an id attribute, and calls {@link Ext.form.Field#applyToMarkup} on the existing dom element with that id.
5858 * @return {BasicForm} this
5860 render : function(){
5861 this.items.each(function(f){
5862 if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists
5863 f.applyToMarkup(f.id);
5870 * Calls {@link Ext#apply} for all fields in this form with the passed object.
5871 * @param {Object} values
5872 * @return {BasicForm} this
5874 applyToFields : function(o){
5875 this.items.each(function(f){
5882 * Calls {@link Ext#applyIf} for all field in this form with the passed object.
5883 * @param {Object} values
5884 * @return {BasicForm} this
5886 applyIfToFields : function(o){
5887 this.items.each(function(f){
5893 callFieldMethod : function(fnName, args){
5895 this.items.each(function(f){
5896 if(Ext.isFunction(f[fnName])){
5897 f[fnName].apply(f, args);
5905 Ext.BasicForm = Ext.form.BasicForm;
5907 * @class Ext.form.FormPanel
5908 * @extends Ext.Panel
5909 * <p>Standard form container.</p>
5911 * <p><b><u>Layout</u></b></p>
5912 * <p>By default, FormPanel is configured with <tt>layout:'form'</tt> to use an {@link Ext.layout.FormLayout}
5913 * layout manager, which styles and renders fields and labels correctly. When nesting additional Containers
5914 * within a FormPanel, you should ensure that any descendant Containers which host input Fields use the
5915 * {@link Ext.layout.FormLayout} layout manager.</p>
5917 * <p><b><u>BasicForm</u></b></p>
5918 * <p>Although <b>not listed</b> as configuration options of FormPanel, the FormPanel class accepts all
5919 * of the config options required to configure its internal {@link Ext.form.BasicForm} for:
5920 * <div class="mdetail-params"><ul>
5921 * <li>{@link Ext.form.BasicForm#fileUpload file uploads}</li>
5922 * <li>functionality for {@link Ext.form.BasicForm#doAction loading, validating and submitting} the form</li>
5925 * <p><b>Note</b>: If subclassing FormPanel, any configuration options for the BasicForm must be applied to
5926 * the <tt><b>initialConfig</b></tt> property of the FormPanel. Applying {@link Ext.form.BasicForm BasicForm}
5927 * configuration settings to <b><tt>this</tt></b> will <b>not</b> affect the BasicForm's configuration.</p>
5929 * <p><b><u>Form Validation</u></b></p>
5930 * <p>For information on form validation see the following:</p>
5931 * <div class="mdetail-params"><ul>
5932 * <li>{@link Ext.form.TextField}</li>
5933 * <li>{@link Ext.form.VTypes}</li>
5934 * <li>{@link Ext.form.BasicForm#doAction BasicForm.doAction <b>clientValidation</b> notes}</li>
5935 * <li><tt>{@link Ext.form.FormPanel#monitorValid monitorValid}</tt></li>
5938 * <p><b><u>Form Submission</u></b></p>
5939 * <p>By default, Ext Forms are submitted through Ajax, using {@link Ext.form.Action}. To enable normal browser
5940 * submission of the {@link Ext.form.BasicForm BasicForm} contained in this FormPanel, see the
5941 * <tt><b>{@link Ext.form.BasicForm#standardSubmit standardSubmit}</b></tt> option.</p>
5944 * @param {Object} config Configuration options
5947 Ext.FormPanel = Ext.extend(Ext.Panel, {
5949 * @cfg {String} formId (optional) The id of the FORM tag (defaults to an auto-generated id).
5952 * @cfg {Boolean} hideLabels
5953 * <p><tt>true</tt> to hide field labels by default (sets <tt>display:none</tt>). Defaults to
5954 * <tt>false</tt>.</p>
5955 * <p>Also see {@link Ext.Component}.<tt>{@link Ext.Component#hideLabel hideLabel}</tt>.
5958 * @cfg {Number} labelPad
5959 * The default padding in pixels for field labels (defaults to <tt>5</tt>). <tt>labelPad</tt> only
5960 * applies if <tt>{@link #labelWidth}</tt> is also specified, otherwise it will be ignored.
5963 * @cfg {String} labelSeparator
5964 * See {@link Ext.Component}.<tt>{@link Ext.Component#labelSeparator labelSeparator}</tt>
5967 * @cfg {Number} labelWidth The width of labels in pixels. This property cascades to child containers
5968 * and can be overridden on any child container (e.g., a fieldset can specify a different <tt>labelWidth</tt>
5969 * for its fields) (defaults to <tt>100</tt>).
5972 * @cfg {String} itemCls A css class to apply to the x-form-item of fields. This property cascades to child containers.
5975 * @cfg {Array} buttons
5976 * An array of {@link Ext.Button}s or {@link Ext.Button} configs used to add buttons to the footer of this FormPanel.<br>
5977 * <p>Buttons in the footer of a FormPanel may be configured with the option <tt>formBind: true</tt>. This causes
5978 * the form's {@link #monitorValid valid state monitor task} to enable/disable those Buttons depending on
5979 * the form's valid/invalid state.</p>
5984 * @cfg {Number} minButtonWidth Minimum width of all buttons in pixels (defaults to <tt>75</tt>).
5986 minButtonWidth : 75,
5989 * @cfg {String} labelAlign The label alignment value used for the <tt>text-align</tt> specification
5990 * for the <b>container</b>. Valid values are <tt>"left</tt>", <tt>"top"</tt> or <tt>"right"</tt>
5991 * (defaults to <tt>"left"</tt>). This property cascades to child <b>containers</b> and can be
5992 * overridden on any child <b>container</b> (e.g., a fieldset can specify a different <tt>labelAlign</tt>
5995 labelAlign : 'left',
5998 * @cfg {Boolean} monitorValid If <tt>true</tt>, the form monitors its valid state <b>client-side</b> and
5999 * regularly fires the {@link #clientvalidation} event passing that state.<br>
6000 * <p>When monitoring valid state, the FormPanel enables/disables any of its configured
6001 * {@link #buttons} which have been configured with <code>formBind: true</code> depending
6002 * on whether the {@link Ext.form.BasicForm#isValid form is valid} or not. Defaults to <tt>false</tt></p>
6004 monitorValid : false,
6007 * @cfg {Number} monitorPoll The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
6012 * @cfg {String} layout Defaults to <tt>'form'</tt>. Normally this configuration property should not be altered.
6013 * For additional details see {@link Ext.layout.FormLayout} and {@link Ext.Container#layout Ext.Container.layout}.
6018 initComponent : function(){
6019 this.form = this.createForm();
6020 Ext.FormPanel.superclass.initComponent.call(this);
6024 cls: this.baseCls + '-body',
6025 method : this.method || 'POST',
6026 id : this.formId || Ext.id()
6028 if(this.fileUpload) {
6029 this.bodyCfg.enctype = 'multipart/form-data';
6035 * @event clientvalidation
6036 * If the monitorValid config option is true, this event fires repetitively to notify of valid state
6037 * @param {Ext.form.FormPanel} this
6038 * @param {Boolean} valid true if the form has passed client-side validation
6043 this.relayEvents(this.form, ['beforeaction', 'actionfailed', 'actioncomplete']);
6047 createForm : function(){
6048 var config = Ext.applyIf({listeners: {}}, this.initialConfig);
6049 return new Ext.form.BasicForm(null, config);
6053 initFields : function(){
6055 var formPanel = this;
6056 var fn = function(c){
6057 if(formPanel.isField(c)){
6059 }else if(c.findBy && c != formPanel){
6060 formPanel.applySettings(c);
6061 //each check required for check/radio groups.
6062 if(c.items && c.items.each){
6063 c.items.each(fn, this);
6067 this.items.each(fn, this);
6071 applySettings: function(c){
6074 labelAlign: ct.labelAlign,
6075 labelWidth: ct.labelWidth,
6081 getLayoutTarget : function(){
6082 return this.form.el;
6086 * Provides access to the {@link Ext.form.BasicForm Form} which this Panel contains.
6087 * @return {Ext.form.BasicForm} The {@link Ext.form.BasicForm Form} which this Panel contains.
6089 getForm : function(){
6094 onRender : function(ct, position){
6096 Ext.FormPanel.superclass.onRender.call(this, ct, position);
6097 this.form.initEl(this.body);
6101 beforeDestroy : function(){
6102 this.stopMonitoring();
6103 this.form.destroy(true);
6104 Ext.FormPanel.superclass.beforeDestroy.call(this);
6107 // Determine if a Component is usable as a form Field.
6108 isField : function(c) {
6109 return !!c.setValue && !!c.getValue && !!c.markInvalid && !!c.clearInvalid;
6113 initEvents : function(){
6114 Ext.FormPanel.superclass.initEvents.call(this);
6115 // Listeners are required here to catch bubbling events from children.
6118 add: this.onAddEvent,
6119 remove: this.onRemoveEvent
6121 if(this.monitorValid){ // initialize after render
6122 this.startMonitoring();
6128 Ext.FormPanel.superclass.onAdd.call(this, c);
6133 onAddEvent: function(ct, c){
6140 processAdd : function(c){
6141 // If a single form Field, add it
6142 if(this.isField(c)){
6144 // If a Container, add any Fields it might contain
6146 this.applySettings(c);
6147 this.form.add.apply(this.form, c.findBy(this.isField));
6152 onRemove: function(c){
6153 Ext.FormPanel.superclass.onRemove.call(this, c);
6154 this.processRemove(c);
6157 onRemoveEvent: function(ct, c){
6159 this.processRemove(c);
6164 processRemove: function(c){
6165 if(!this.destroying){
6166 // If a single form Field, remove it
6167 if(this.isField(c)){
6168 this.form.remove(c);
6169 // If a Container, its already destroyed by the time it gets here. Remove any references to destroyed fields.
6170 }else if (c.findBy){
6171 Ext.each(c.findBy(this.isField), this.form.remove, this.form);
6172 if (c.isDestroyed) {
6173 this.form.cleanDestroyed();
6180 * Starts monitoring of the valid state of this form. Usually this is done by passing the config
6181 * option "monitorValid"
6183 startMonitoring : function(){
6184 if(!this.validTask){
6185 this.validTask = new Ext.util.TaskRunner();
6186 this.validTask.start({
6187 run : this.bindHandler,
6188 interval : this.monitorPoll || 200,
6195 * Stops monitoring of the valid state of this form
6197 stopMonitoring : function(){
6199 this.validTask.stopAll();
6200 this.validTask = null;
6205 * This is a proxy for the underlying BasicForm's {@link Ext.form.BasicForm#load} call.
6206 * @param {Object} options The options to pass to the action (see {@link Ext.form.BasicForm#doAction} for details)
6209 this.form.load.apply(this.form, arguments);
6213 onDisable : function(){
6214 Ext.FormPanel.superclass.onDisable.call(this);
6216 this.form.items.each(function(){
6223 onEnable : function(){
6224 Ext.FormPanel.superclass.onEnable.call(this);
6226 this.form.items.each(function(){
6233 bindHandler : function(){
6235 this.form.items.each(function(f){
6236 if(!f.isValid(true)){
6242 var fitems = this.fbar.items.items;
6243 for(var i = 0, len = fitems.length; i < len; i++){
6244 var btn = fitems[i];
6245 if(btn.formBind === true && btn.disabled === valid){
6246 btn.setDisabled(!valid);
6250 this.fireEvent('clientvalidation', this, valid);
6253 Ext.reg('form', Ext.FormPanel);
6255 Ext.form.FormPanel = Ext.FormPanel;
6257 * @class Ext.form.FieldSet
6258 * @extends Ext.Panel
6259 * Standard container used for grouping items within a {@link Ext.form.FormPanel form}.
6261 var form = new Ext.FormPanel({
6262 title: 'Simple Form with FieldSets',
6263 labelWidth: 75, // label settings here cascade unless overridden
6264 url: 'save-form.php',
6266 bodyStyle:'padding:5px 5px 0',
6268 renderTo: document.body,
6269 layout:'column', // arrange items in columns
6270 defaults: { // defaults applied to items
6273 bodyStyle: 'padding:4px'
6276 // Fieldset in Column 1
6279 title: 'Fieldset 1',
6283 anchor: '-20' // leave room for error icon
6285 defaultType: 'textfield',
6287 fieldLabel: 'Field 1'
6289 fieldLabel: 'Field 2'
6291 fieldLabel: 'Field 3'
6295 // Fieldset in Column 2 - Panel inside
6297 title: 'Show Panel', // title, header, or checkboxToggle creates fieldset header
6300 checkboxToggle: true,
6301 collapsed: true, // fieldset initially collapsed
6306 title: 'Panel inside a fieldset',
6314 * @param {Object} config Configuration options
6317 Ext.form.FieldSet = Ext.extend(Ext.Panel, {
6319 * @cfg {Mixed} checkboxToggle <tt>true</tt> to render a checkbox into the fieldset frame just
6320 * in front of the legend to expand/collapse the fieldset when the checkbox is toggled. (defaults
6321 * to <tt>false</tt>).
6322 * <p>A {@link Ext.DomHelper DomHelper} element spec may also be specified to create the checkbox.
6323 * If <tt>true</tt> is specified, the default DomHelper config object used to create the element
6324 * is:</p><pre><code>
6325 * {tag: 'input', type: 'checkbox', name: this.checkboxName || this.id+'-checkbox'}
6329 * @cfg {String} checkboxName The name to assign to the fieldset's checkbox if <tt>{@link #checkboxToggle} = true</tt>
6330 * (defaults to <tt>'[checkbox id]-checkbox'</tt>).
6333 * @cfg {Boolean} collapsible
6334 * <tt>true</tt> to make the fieldset collapsible and have the expand/collapse toggle button automatically
6335 * rendered into the legend element, <tt>false</tt> to keep the fieldset statically sized with no collapse
6336 * button (defaults to <tt>false</tt>). Another option is to configure <tt>{@link #checkboxToggle}</tt>.
6339 * @cfg {Number} labelWidth The width of labels. This property cascades to child containers.
6342 * @cfg {String} itemCls A css class to apply to the <tt>x-form-item</tt> of fields (see
6343 * {@link Ext.layout.FormLayout}.{@link Ext.layout.FormLayout#fieldTpl fieldTpl} for details).
6344 * This property cascades to child containers.
6347 * @cfg {String} baseCls The base CSS class applied to the fieldset (defaults to <tt>'x-fieldset'</tt>).
6349 baseCls : 'x-fieldset',
6351 * @cfg {String} layout The {@link Ext.Container#layout} to use inside the fieldset (defaults to <tt>'form'</tt>).
6355 * @cfg {Boolean} animCollapse
6356 * <tt>true</tt> to animate the transition when the panel is collapsed, <tt>false</tt> to skip the
6357 * animation (defaults to <tt>false</tt>).
6359 animCollapse : false,
6362 onRender : function(ct, position){
6364 this.el = document.createElement('fieldset');
6365 this.el.id = this.id;
6366 if (this.title || this.header || this.checkboxToggle) {
6367 this.el.appendChild(document.createElement('legend')).className = this.baseCls + '-header';
6371 Ext.form.FieldSet.superclass.onRender.call(this, ct, position);
6373 if(this.checkboxToggle){
6374 var o = typeof this.checkboxToggle == 'object' ?
6375 this.checkboxToggle :
6376 {tag: 'input', type: 'checkbox', name: this.checkboxName || this.id+'-checkbox'};
6377 this.checkbox = this.header.insertFirst(o);
6378 this.checkbox.dom.checked = !this.collapsed;
6379 this.mon(this.checkbox, 'click', this.onCheckClick, this);
6384 onCollapse : function(doAnim, animArg){
6386 this.checkbox.dom.checked = false;
6388 Ext.form.FieldSet.superclass.onCollapse.call(this, doAnim, animArg);
6393 onExpand : function(doAnim, animArg){
6395 this.checkbox.dom.checked = true;
6397 Ext.form.FieldSet.superclass.onExpand.call(this, doAnim, animArg);
6401 * This function is called by the fieldset's checkbox when it is toggled (only applies when
6402 * checkboxToggle = true). This method should never be called externally, but can be
6403 * overridden to provide custom behavior when the checkbox is toggled if needed.
6405 onCheckClick : function(){
6406 this[this.checkbox.dom.checked ? 'expand' : 'collapse']();
6410 * @cfg {String/Number} activeItem
6414 * @cfg {Mixed} applyTo
6418 * @cfg {Boolean} bodyBorder
6422 * @cfg {Boolean} border
6426 * @cfg {Boolean/Number} bufferResize
6430 * @cfg {Boolean} collapseFirst
6434 * @cfg {String} defaultType
6438 * @cfg {String} disabledClass
6442 * @cfg {String} elements
6446 * @cfg {Boolean} floating
6450 * @cfg {Boolean} footer
6454 * @cfg {Boolean} frame
6458 * @cfg {Boolean} header
6462 * @cfg {Boolean} headerAsText
6466 * @cfg {Boolean} hideCollapseTool
6470 * @cfg {String} iconCls
6474 * @cfg {Boolean/String} shadow
6478 * @cfg {Number} shadowOffset
6482 * @cfg {Boolean} shim
6486 * @cfg {Object/Array} tbar
6490 * @cfg {Array} tools
6494 * @cfg {Ext.Template/Ext.XTemplate} toolTemplate
6498 * @cfg {String} xtype
6514 * @method getBottomToolbar
6518 * @method getTopToolbar
6522 * @method setIconClass
6530 * @event beforeclose
6546 Ext.reg('fieldset', Ext.form.FieldSet);/**
6547 * @class Ext.form.HtmlEditor
6548 * @extends Ext.form.Field
6549 * Provides a lightweight HTML Editor component. Some toolbar features are not supported by Safari and will be
6550 * automatically hidden when needed. These are noted in the config options where appropriate.
6551 * <br><br>The editor's toolbar buttons have tooltips defined in the {@link #buttonTips} property, but they are not
6552 * enabled by default unless the global {@link Ext.QuickTips} singleton is {@link Ext.QuickTips#init initialized}.
6553 * <br><br><b>Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT
6554 * supported by this editor.</b>
6555 * <br><br>An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within
6556 * any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.
6557 * <br><br>Example usage:
6559 // Simple example rendered with default options:
6560 Ext.QuickTips.init(); // enable tooltips
6561 new Ext.form.HtmlEditor({
6562 renderTo: Ext.getBody(),
6567 // Passed via xtype into a container and with custom options:
6568 Ext.QuickTips.init(); // enable tooltips
6570 title: 'HTML Editor',
6571 renderTo: Ext.getBody(),
6577 xtype: 'htmleditor',
6578 enableColors: false,
6579 enableAlignments: false
6584 * Create a new HtmlEditor
6585 * @param {Object} config
6589 Ext.form.HtmlEditor = Ext.extend(Ext.form.Field, {
6591 * @cfg {Boolean} enableFormat Enable the bold, italic and underline buttons (defaults to true)
6593 enableFormat : true,
6595 * @cfg {Boolean} enableFontSize Enable the increase/decrease font size buttons (defaults to true)
6597 enableFontSize : true,
6599 * @cfg {Boolean} enableColors Enable the fore/highlight color buttons (defaults to true)
6601 enableColors : true,
6603 * @cfg {Boolean} enableAlignments Enable the left, center, right alignment buttons (defaults to true)
6605 enableAlignments : true,
6607 * @cfg {Boolean} enableLists Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
6611 * @cfg {Boolean} enableSourceEdit Enable the switch to source edit button. Not available in Safari. (defaults to true)
6613 enableSourceEdit : true,
6615 * @cfg {Boolean} enableLinks Enable the create link button. Not available in Safari. (defaults to true)
6619 * @cfg {Boolean} enableFont Enable font selection. Not available in Safari. (defaults to true)
6623 * @cfg {String} createLinkText The default text for the create link prompt
6625 createLinkText : 'Please enter the URL for the link:',
6627 * @cfg {String} defaultLinkValue The default value for the create link prompt (defaults to http:/ /)
6629 defaultLinkValue : 'http:/'+'/',
6631 * @cfg {Array} fontFamilies An array of available font families
6640 defaultFont: 'tahoma',
6642 * @cfg {String} defaultValue A default value to be put into the editor to resolve focus issues (defaults to   (Non-breaking space) in Opera and IE6, ​ (Zero-width space) in all other browsers).
6644 defaultValue: (Ext.isOpera || Ext.isIE6) ? ' ' : '​',
6646 // private properties
6648 validationEvent : false,
6650 initialized : false,
6652 sourceEditMode : false,
6653 onFocus : Ext.emptyFn,
6656 defaultAutoCreate : {
6658 style:"width:500px;height:300px;",
6663 initComponent : function(){
6667 * Fires when the editor is fully initialized (including the iframe)
6668 * @param {HtmlEditor} this
6673 * Fires when the editor is first receives the focus. Any insertion must wait
6674 * until after this event.
6675 * @param {HtmlEditor} this
6680 * Fires before the textarea is updated with content from the editor iframe. Return false
6681 * to cancel the sync.
6682 * @param {HtmlEditor} this
6683 * @param {String} html
6688 * Fires before the iframe editor is updated with content from the textarea. Return false
6689 * to cancel the push.
6690 * @param {HtmlEditor} this
6691 * @param {String} html
6696 * Fires when the textarea is updated with content from the editor iframe.
6697 * @param {HtmlEditor} this
6698 * @param {String} html
6703 * Fires when the iframe editor is updated with content from the textarea.
6704 * @param {HtmlEditor} this
6705 * @param {String} html
6709 * @event editmodechange
6710 * Fires when the editor switches edit modes
6711 * @param {HtmlEditor} this
6712 * @param {Boolean} sourceEdit True if source edit, false if standard editing.
6719 createFontOptions : function(){
6720 var buf = [], fs = this.fontFamilies, ff, lc;
6721 for(var i = 0, len = fs.length; i< len; i++){
6723 lc = ff.toLowerCase();
6725 '<option value="',lc,'" style="font-family:',ff,';"',
6726 (this.defaultFont == lc ? ' selected="true">' : '>'),
6731 return buf.join('');
6735 * Protected method that will not generally be called directly. It
6736 * is called when the editor creates its toolbar. Override this method if you need to
6737 * add custom toolbar buttons.
6738 * @param {HtmlEditor} editor
6740 createToolbar : function(editor){
6742 var tipsEnabled = Ext.QuickTips && Ext.QuickTips.isEnabled();
6745 function btn(id, toggle, handler){
6749 iconCls: 'x-edit-'+id,
6750 enableToggle:toggle !== false,
6752 handler:handler||editor.relayBtnCmd,
6753 clickEvent:'mousedown',
6754 tooltip: tipsEnabled ? editor.buttonTips[id] || undefined : undefined,
6755 overflowText: editor.buttonTips[id].title || undefined,
6761 if(this.enableFont && !Ext.isSafari2){
6762 var fontSelectItem = new Ext.Toolbar.Item({
6765 cls:'x-font-select',
6766 html: this.createFontOptions()
6776 if(this.enableFormat){
6784 if(this.enableFontSize){
6787 btn('increasefontsize', false, this.adjustFont),
6788 btn('decreasefontsize', false, this.adjustFont)
6792 if(this.enableColors){
6797 iconCls: 'x-edit-forecolor',
6798 clickEvent:'mousedown',
6799 tooltip: tipsEnabled ? editor.buttonTips.forecolor || undefined : undefined,
6801 menu : new Ext.menu.ColorMenu({
6802 allowReselect: true,
6808 select: function(cp, color){
6809 this.execCmd('forecolor', Ext.isWebKit || Ext.isIE ? '#'+color : color);
6813 clickEvent:'mousedown'
6818 iconCls: 'x-edit-backcolor',
6819 clickEvent:'mousedown',
6820 tooltip: tipsEnabled ? editor.buttonTips.backcolor || undefined : undefined,
6822 menu : new Ext.menu.ColorMenu({
6826 allowReselect: true,
6829 select: function(cp, color){
6831 this.execCmd('useCSS', false);
6832 this.execCmd('hilitecolor', color);
6833 this.execCmd('useCSS', true);
6836 this.execCmd(Ext.isOpera ? 'hilitecolor' : 'backcolor', Ext.isWebKit || Ext.isIE ? '#'+color : color);
6841 clickEvent:'mousedown'
6847 if(this.enableAlignments){
6851 btn('justifycenter'),
6857 if(this.enableLinks){
6860 btn('createlink', false, this.createLink)
6864 if(this.enableLists){
6867 btn('insertorderedlist'),
6868 btn('insertunorderedlist')
6871 if(this.enableSourceEdit){
6874 btn('sourceedit', true, function(btn){
6875 this.toggleSourceEdit(!this.sourceEditMode);
6881 // build the toolbar
6882 var tb = new Ext.Toolbar({
6883 renderTo: this.wrap.dom.firstChild,
6887 if (fontSelectItem) {
6888 this.fontSelect = fontSelectItem.el;
6890 this.mon(this.fontSelect, 'change', function(){
6891 var font = this.fontSelect.dom.value;
6892 this.relayCmd('fontname', font);
6897 // stop form submits
6898 this.mon(tb.el, 'click', function(e){
6906 onDisable: function(){
6908 Ext.form.HtmlEditor.superclass.onDisable.call(this);
6911 onEnable: function(){
6913 Ext.form.HtmlEditor.superclass.onEnable.call(this);
6916 setReadOnly: function(readOnly){
6918 Ext.form.HtmlEditor.superclass.setReadOnly.call(this, readOnly);
6919 if(this.initialized){
6921 this.getEditorBody().contentEditable = !readOnly;
6923 this.setDesignMode(!readOnly);
6925 var bd = this.getEditorBody();
6927 bd.style.cursor = this.readOnly ? 'default' : 'text';
6929 this.disableItems(readOnly);
6934 * Protected method that will not generally be called directly. It
6935 * is called when the editor initializes the iframe with HTML contents. Override this method if you
6936 * want to change the initialization markup of the iframe (e.g. to add stylesheets).
6938 * Note: IE8-Standards has unwanted scroller behavior, so the default meta tag forces IE7 compatibility
6940 getDocMarkup : function(){
6941 var h = Ext.fly(this.iframe).getHeight() - this.iframePad * 2;
6942 return String.format('<html><head><style type="text/css">body{border: 0; margin: 0; padding: {0}px; height: {1}px; cursor: text}</style></head><body></body></html>', this.iframePad, h);
6946 getEditorBody : function(){
6947 var doc = this.getDoc();
6948 return doc.body || doc.documentElement;
6952 getDoc : function(){
6953 return Ext.isIE ? this.getWin().document : (this.iframe.contentDocument || this.getWin().document);
6957 getWin : function(){
6958 return Ext.isIE ? this.iframe.contentWindow : window.frames[this.iframe.name];
6962 onRender : function(ct, position){
6963 Ext.form.HtmlEditor.superclass.onRender.call(this, ct, position);
6964 this.el.dom.style.border = '0 none';
6965 this.el.dom.setAttribute('tabIndex', -1);
6966 this.el.addClass('x-hidden');
6967 if(Ext.isIE){ // fix IE 1px bogus margin
6968 this.el.applyStyles('margin-top:-1px;margin-bottom:-1px;');
6970 this.wrap = this.el.wrap({
6971 cls:'x-html-editor-wrap', cn:{cls:'x-html-editor-tb'}
6974 this.createToolbar(this);
6976 this.disableItems(true);
6980 this.createIFrame();
6983 var sz = this.el.getSize();
6984 this.setSize(sz.width, this.height || sz.height);
6986 this.resizeEl = this.positionEl = this.wrap;
6989 createIFrame: function(){
6990 var iframe = document.createElement('iframe');
6991 iframe.name = Ext.id();
6992 iframe.frameBorder = '0';
6993 iframe.style.overflow = 'auto';
6995 this.wrap.dom.appendChild(iframe);
6996 this.iframe = iframe;
6998 this.monitorTask = Ext.TaskMgr.start({
6999 run: this.checkDesignMode,
7005 initFrame : function(){
7006 Ext.TaskMgr.stop(this.monitorTask);
7007 var doc = this.getDoc();
7008 this.win = this.getWin();
7011 doc.write(this.getDocMarkup());
7014 var task = { // must defer to wait for browser to be ready
7016 var doc = this.getDoc();
7017 if(doc.body || doc.readyState == 'complete'){
7018 Ext.TaskMgr.stop(task);
7019 this.setDesignMode(true);
7020 this.initEditor.defer(10, this);
7027 Ext.TaskMgr.start(task);
7031 checkDesignMode : function(){
7032 if(this.wrap && this.wrap.dom.offsetWidth){
7033 var doc = this.getDoc();
7037 if(!doc.editorInitialized || this.getDesignMode() != 'on'){
7044 * set current design mode. To enable, mode can be true or 'on', off otherwise
7046 setDesignMode : function(mode){
7048 if(doc = this.getDoc()){
7052 doc.designMode = (/on|true/i).test(String(mode).toLowerCase()) ?'on':'off';
7058 getDesignMode : function(){
7059 var doc = this.getDoc();
7060 if(!doc){ return ''; }
7061 return String(doc.designMode).toLowerCase();
7065 disableItems: function(disabled){
7066 if(this.fontSelect){
7067 this.fontSelect.dom.disabled = disabled;
7069 this.tb.items.each(function(item){
7070 if(item.getItemId() != 'sourceedit'){
7071 item.setDisabled(disabled);
7077 onResize : function(w, h){
7078 Ext.form.HtmlEditor.superclass.onResize.apply(this, arguments);
7079 if(this.el && this.iframe){
7080 if(Ext.isNumber(w)){
7081 var aw = w - this.wrap.getFrameWidth('lr');
7082 this.el.setWidth(aw);
7083 this.tb.setWidth(aw);
7084 this.iframe.style.width = Math.max(aw, 0) + 'px';
7086 if(Ext.isNumber(h)){
7087 var ah = h - this.wrap.getFrameWidth('tb') - this.tb.el.getHeight();
7088 this.el.setHeight(ah);
7089 this.iframe.style.height = Math.max(ah, 0) + 'px';
7090 var bd = this.getEditorBody();
7092 bd.style.height = Math.max((ah - (this.iframePad*2)), 0) + 'px';
7099 * Toggles the editor between standard and source edit mode.
7100 * @param {Boolean} sourceEdit (optional) True for source edit, false for standard
7102 toggleSourceEdit : function(sourceEditMode){
7107 if (sourceEditMode === undefined) {
7108 sourceEditMode = !this.sourceEditMode;
7110 this.sourceEditMode = sourceEditMode === true;
7111 var btn = this.tb.getComponent('sourceedit');
7113 if (btn.pressed !== this.sourceEditMode) {
7114 btn.toggle(this.sourceEditMode);
7115 if (!btn.xtbHidden) {
7119 if (this.sourceEditMode) {
7120 // grab the height of the containing panel before we hide the iframe
7121 ls = this.getSize();
7123 iframeHeight = Ext.get(this.iframe).getHeight();
7125 this.disableItems(true);
7127 this.iframe.className = 'x-hidden';
7128 this.el.removeClass('x-hidden');
7129 this.el.dom.removeAttribute('tabIndex');
7131 this.el.dom.style.height = iframeHeight + 'px';
7134 elHeight = parseInt(this.el.dom.style.height, 10);
7135 if (this.initialized) {
7136 this.disableItems(this.readOnly);
7139 this.iframe.className = '';
7140 this.el.addClass('x-hidden');
7141 this.el.dom.setAttribute('tabIndex', -1);
7145 this.iframe.style.height = elHeight + 'px';
7147 this.fireEvent('editmodechange', this, this.sourceEditMode);
7150 // private used internally
7151 createLink : function() {
7152 var url = prompt(this.createLinkText, this.defaultLinkValue);
7153 if(url && url != 'http:/'+'/'){
7154 this.relayCmd('createlink', url);
7159 initEvents : function(){
7160 this.originalValue = this.getValue();
7164 * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
7167 markInvalid : Ext.emptyFn,
7170 * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
7173 clearInvalid : Ext.emptyFn,
7175 // docs inherit from Field
7176 setValue : function(v){
7177 Ext.form.HtmlEditor.superclass.setValue.call(this, v);
7183 * Protected method that will not generally be called directly. If you need/want
7184 * custom HTML cleanup, this is the method you should override.
7185 * @param {String} html The HTML to be cleaned
7186 * @return {String} The cleaned HTML
7188 cleanHtml: function(html) {
7189 html = String(html);
7190 if(Ext.isWebKit){ // strip safari nonsense
7191 html = html.replace(/\sclass="(?:Apple-style-span|khtml-block-placeholder)"/gi, '');
7195 * Neat little hack. Strips out all the non-digit characters from the default
7196 * value and compares it to the character code of the first character in the string
7197 * because it can cause encoding issues when posted to the server.
7199 if(html.charCodeAt(0) == this.defaultValue.replace(/\D/g, '')){
7200 html = html.substring(1);
7206 * Protected method that will not generally be called directly. Syncs the contents
7207 * of the editor iframe with the textarea.
7209 syncValue : function(){
7210 if(this.initialized){
7211 var bd = this.getEditorBody();
7212 var html = bd.innerHTML;
7214 var bs = bd.getAttribute('style'); // Safari puts text-align styles on the body element!
7215 var m = bs.match(/text-align:(.*?);/i);
7217 html = '<div style="'+m[0]+'">' + html + '</div>';
7220 html = this.cleanHtml(html);
7221 if(this.fireEvent('beforesync', this, html) !== false){
7222 this.el.dom.value = html;
7223 this.fireEvent('sync', this, html);
7228 //docs inherit from Field
7229 getValue : function() {
7230 this[this.sourceEditMode ? 'pushValue' : 'syncValue']();
7231 return Ext.form.HtmlEditor.superclass.getValue.call(this);
7235 * Protected method that will not generally be called directly. Pushes the value of the textarea
7236 * into the iframe editor.
7238 pushValue : function(){
7239 if(this.initialized){
7240 var v = this.el.dom.value;
7241 if(!this.activated && v.length < 1){
7242 v = this.defaultValue;
7244 if(this.fireEvent('beforepush', this, v) !== false){
7245 this.getEditorBody().innerHTML = v;
7247 // Gecko hack, see: https://bugzilla.mozilla.org/show_bug.cgi?id=232791#c8
7248 this.setDesignMode(false); //toggle off first
7249 this.setDesignMode(true);
7251 this.fireEvent('push', this, v);
7258 deferFocus : function(){
7259 this.focus.defer(10, this);
7262 // docs inherit from Field
7264 if(this.win && !this.sourceEditMode){
7272 initEditor : function(){
7273 //Destroying the component during/before initEditor can cause issues.
7275 var dbody = this.getEditorBody(),
7276 ss = this.el.getStyles('font-size', 'font-family', 'background-image', 'background-repeat', 'background-color', 'color'),
7280 ss['background-attachment'] = 'fixed'; // w3c
7281 dbody.bgProperties = 'fixed'; // ie
7283 Ext.DomHelper.applyStyles(dbody, ss);
7285 doc = this.getDoc();
7289 Ext.EventManager.removeAll(doc);
7294 * We need to use createDelegate here, because when using buffer, the delayed task is added
7295 * as a property to the function. When the listener is removed, the task is deleted from the function.
7296 * Since onEditorEvent is shared on the prototype, if we have multiple html editors, the first time one of the editors
7297 * is destroyed, it causes the fn to be deleted from the prototype, which causes errors. Essentially, we're just anonymizing the function.
7299 fn = this.onEditorEvent.createDelegate(this);
7300 Ext.EventManager.on(doc, {
7309 Ext.EventManager.on(doc, 'keypress', this.applyCommand, this);
7311 if(Ext.isIE || Ext.isWebKit || Ext.isOpera){
7312 Ext.EventManager.on(doc, 'keydown', this.fixKeys, this);
7314 doc.editorInitialized = true;
7315 this.initialized = true;
7317 this.setReadOnly(this.readOnly);
7318 this.fireEvent('initialize', this);
7323 onDestroy : function(){
7324 if(this.monitorTask){
7325 Ext.TaskMgr.stop(this.monitorTask);
7328 Ext.destroy(this.tb);
7329 var doc = this.getDoc();
7332 Ext.EventManager.removeAll(doc);
7333 for (var prop in doc){
7339 this.wrap.dom.innerHTML = '';
7345 this.el.removeAllListeners();
7348 this.purgeListeners();
7352 onFirstFocus : function(){
7353 this.activated = true;
7354 this.disableItems(this.readOnly);
7355 if(Ext.isGecko){ // prevent silly gecko errors
7357 var s = this.win.getSelection();
7358 if(!s.focusNode || s.focusNode.nodeType != 3){
7359 var r = s.getRangeAt(0);
7360 r.selectNodeContents(this.getEditorBody());
7365 this.execCmd('useCSS', true);
7366 this.execCmd('styleWithCSS', false);
7369 this.fireEvent('activate', this);
7373 adjustFont: function(btn){
7374 var adjust = btn.getItemId() == 'increasefontsize' ? 1 : -1,
7375 doc = this.getDoc(),
7376 v = parseInt(doc.queryCommandValue('FontSize') || 2, 10);
7377 if((Ext.isSafari && !Ext.isSafari2) || Ext.isChrome || Ext.isAir){
7379 // 1 = 10px, 2 = 13px, 3 = 16px, 4 = 18px, 5 = 24px, 6 = 32px
7393 v = v.constrain(1, 6);
7395 if(Ext.isSafari){ // safari
7398 v = Math.max(1, v+adjust) + (Ext.isSafari ? 'px' : 0);
7400 this.execCmd('FontSize', v);
7404 onEditorEvent : function(e){
7405 this.updateToolbar();
7410 * Protected method that will not generally be called directly. It triggers
7411 * a toolbar update by reading the markup state of the current selection in the editor.
7413 updateToolbar: function(){
7419 if(!this.activated){
7420 this.onFirstFocus();
7424 var btns = this.tb.items.map,
7425 doc = this.getDoc();
7427 if(this.enableFont && !Ext.isSafari2){
7428 var name = (doc.queryCommandValue('FontName')||this.defaultFont).toLowerCase();
7429 if(name != this.fontSelect.dom.value){
7430 this.fontSelect.dom.value = name;
7433 if(this.enableFormat){
7434 btns.bold.toggle(doc.queryCommandState('bold'));
7435 btns.italic.toggle(doc.queryCommandState('italic'));
7436 btns.underline.toggle(doc.queryCommandState('underline'));
7438 if(this.enableAlignments){
7439 btns.justifyleft.toggle(doc.queryCommandState('justifyleft'));
7440 btns.justifycenter.toggle(doc.queryCommandState('justifycenter'));
7441 btns.justifyright.toggle(doc.queryCommandState('justifyright'));
7443 if(!Ext.isSafari2 && this.enableLists){
7444 btns.insertorderedlist.toggle(doc.queryCommandState('insertorderedlist'));
7445 btns.insertunorderedlist.toggle(doc.queryCommandState('insertunorderedlist'));
7448 Ext.menu.MenuMgr.hideAll();
7454 relayBtnCmd : function(btn){
7455 this.relayCmd(btn.getItemId());
7459 * Executes a Midas editor command on the editor document and performs necessary focus and
7460 * toolbar updates. <b>This should only be called after the editor is initialized.</b>
7461 * @param {String} cmd The Midas command
7462 * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null)
7464 relayCmd : function(cmd, value){
7467 this.execCmd(cmd, value);
7468 this.updateToolbar();
7473 * Executes a Midas editor command directly on the editor document.
7474 * For visual commands, you should use {@link #relayCmd} instead.
7475 * <b>This should only be called after the editor is initialized.</b>
7476 * @param {String} cmd The Midas command
7477 * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null)
7479 execCmd : function(cmd, value){
7480 var doc = this.getDoc();
7481 doc.execCommand(cmd, false, value === undefined ? null : value);
7486 applyCommand : function(e){
7488 var c = e.getCharCode(), cmd;
7490 c = String.fromCharCode(c);
7513 * Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated
7515 * @param {String} text
7517 insertAtCursor : function(text){
7518 if(!this.activated){
7523 var doc = this.getDoc(),
7524 r = doc.selection.createRange();
7532 this.execCmd('InsertHTML', text);
7538 fixKeys : function(){ // load time branching for fastest keydown performance
7542 doc = this.getDoc(),
7546 r = doc.selection.createRange();
7549 r.pasteHTML(' ');
7552 }else if(k == e.ENTER){
7553 r = doc.selection.createRange();
7555 var target = r.parentElement();
7556 if(!target || target.tagName.toLowerCase() != 'li'){
7558 r.pasteHTML('<br />');
7565 }else if(Ext.isOpera){
7571 this.execCmd('InsertHTML',' ');
7575 }else if(Ext.isWebKit){
7580 this.execCmd('InsertText','\t');
7582 }else if(k == e.ENTER){
7584 this.execCmd('InsertHtml','<br /><br />');
7592 * Returns the editor's toolbar. <b>This is only available after the editor has been rendered.</b>
7593 * @return {Ext.Toolbar}
7595 getToolbar : function(){
7600 * Object collection of toolbar tooltips for the buttons in the editor. The key
7601 * is the command id associated with that button and the value is a valid QuickTips object.
7606 title: 'Bold (Ctrl+B)',
7607 text: 'Make the selected text bold.',
7608 cls: 'x-html-editor-tip'
7611 title: 'Italic (Ctrl+I)',
7612 text: 'Make the selected text italic.',
7613 cls: 'x-html-editor-tip'
7621 title: 'Bold (Ctrl+B)',
7622 text: 'Make the selected text bold.',
7623 cls: 'x-html-editor-tip'
7626 title: 'Italic (Ctrl+I)',
7627 text: 'Make the selected text italic.',
7628 cls: 'x-html-editor-tip'
7631 title: 'Underline (Ctrl+U)',
7632 text: 'Underline the selected text.',
7633 cls: 'x-html-editor-tip'
7635 increasefontsize : {
7637 text: 'Increase the font size.',
7638 cls: 'x-html-editor-tip'
7640 decreasefontsize : {
7641 title: 'Shrink Text',
7642 text: 'Decrease the font size.',
7643 cls: 'x-html-editor-tip'
7646 title: 'Text Highlight Color',
7647 text: 'Change the background color of the selected text.',
7648 cls: 'x-html-editor-tip'
7651 title: 'Font Color',
7652 text: 'Change the color of the selected text.',
7653 cls: 'x-html-editor-tip'
7656 title: 'Align Text Left',
7657 text: 'Align text to the left.',
7658 cls: 'x-html-editor-tip'
7661 title: 'Center Text',
7662 text: 'Center text in the editor.',
7663 cls: 'x-html-editor-tip'
7666 title: 'Align Text Right',
7667 text: 'Align text to the right.',
7668 cls: 'x-html-editor-tip'
7670 insertunorderedlist : {
7671 title: 'Bullet List',
7672 text: 'Start a bulleted list.',
7673 cls: 'x-html-editor-tip'
7675 insertorderedlist : {
7676 title: 'Numbered List',
7677 text: 'Start a numbered list.',
7678 cls: 'x-html-editor-tip'
7682 text: 'Make the selected text a hyperlink.',
7683 cls: 'x-html-editor-tip'
7686 title: 'Source Edit',
7687 text: 'Switch to source editing mode.',
7688 cls: 'x-html-editor-tip'
7692 // hide stuff that is not compatible
7710 * @cfg {String} fieldClass @hide
7713 * @cfg {String} focusClass @hide
7716 * @cfg {String} autoCreate @hide
7719 * @cfg {String} inputType @hide
7722 * @cfg {String} invalidClass @hide
7725 * @cfg {String} invalidText @hide
7728 * @cfg {String} msgFx @hide
7731 * @cfg {String} validateOnBlur @hide
7734 * @cfg {Boolean} allowDomMove @hide
7737 * @cfg {String} applyTo @hide
7740 * @cfg {String} autoHeight @hide
7743 * @cfg {String} autoWidth @hide
7746 * @cfg {String} cls @hide
7749 * @cfg {String} disabled @hide
7752 * @cfg {String} disabledClass @hide
7755 * @cfg {String} msgTarget @hide
7758 * @cfg {String} readOnly @hide
7761 * @cfg {String} style @hide
7764 * @cfg {String} validationDelay @hide
7767 * @cfg {String} validationEvent @hide
7770 * @cfg {String} tabIndex @hide
7773 * @property disabled
7777 * @method applyToMarkup
7797 * @method setDisabled
7805 Ext.reg('htmleditor', Ext.form.HtmlEditor);
7807 * @class Ext.form.TimeField
7808 * @extends Ext.form.ComboBox
7809 * Provides a time input field with a time dropdown and automatic time validation. Example usage:
7811 new Ext.form.TimeField({
7812 minValue: '9:00 AM',
7813 maxValue: '6:00 PM',
7818 * Create a new TimeField
7819 * @param {Object} config
7822 Ext.form.TimeField = Ext.extend(Ext.form.ComboBox, {
7824 * @cfg {Date/String} minValue
7825 * The minimum allowed time. Can be either a Javascript date object with a valid time value or a string
7826 * time in a valid format -- see {@link #format} and {@link #altFormats} (defaults to undefined).
7828 minValue : undefined,
7830 * @cfg {Date/String} maxValue
7831 * The maximum allowed time. Can be either a Javascript date object with a valid time value or a string
7832 * time in a valid format -- see {@link #format} and {@link #altFormats} (defaults to undefined).
7834 maxValue : undefined,
7836 * @cfg {String} minText
7837 * The error text to display when the date in the cell is before minValue (defaults to
7838 * 'The time in this field must be equal to or after {0}').
7840 minText : "The time in this field must be equal to or after {0}",
7842 * @cfg {String} maxText
7843 * The error text to display when the time is after maxValue (defaults to
7844 * 'The time in this field must be equal to or before {0}').
7846 maxText : "The time in this field must be equal to or before {0}",
7848 * @cfg {String} invalidText
7849 * The error text to display when the time in the field is invalid (defaults to
7850 * '{value} is not a valid time').
7852 invalidText : "{0} is not a valid time",
7854 * @cfg {String} format
7855 * The default time format string which can be overriden for localization support. The format must be
7856 * valid according to {@link Date#parseDate} (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
7857 * format try 'H:i' instead.
7861 * @cfg {String} altFormats
7862 * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
7863 * format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A').
7865 altFormats : "g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A",
7867 * @cfg {Number} increment
7868 * The number of minutes between each time value in the list (defaults to 15).
7875 triggerAction: 'all',
7879 // private - This is the date to use when generating time values in the absence of either minValue
7880 // or maxValue. Using the current date causes DST issues on DST boundary dates, so this is an
7881 // arbitrary "safe" date that can be any date aside from DST boundary dates.
7882 initDate: '1/1/2008',
7884 initDateFormat: 'j/n/Y',
7887 initComponent : function(){
7888 if(Ext.isDefined(this.minValue)){
7889 this.setMinValue(this.minValue, true);
7891 if(Ext.isDefined(this.maxValue)){
7892 this.setMaxValue(this.maxValue, true);
7895 this.generateStore(true);
7897 Ext.form.TimeField.superclass.initComponent.call(this);
7901 * Replaces any existing {@link #minValue} with the new time and refreshes the store.
7902 * @param {Date/String} value The minimum time that can be selected
7904 setMinValue: function(value, /* private */ initial){
7905 this.setLimit(value, true, initial);
7910 * Replaces any existing {@link #maxValue} with the new time and refreshes the store.
7911 * @param {Date/String} value The maximum time that can be selected
7913 setMaxValue: function(value, /* private */ initial){
7914 this.setLimit(value, false, initial);
7919 generateStore: function(initial){
7920 var min = this.minValue || new Date(this.initDate).clearTime(),
7921 max = this.maxValue || new Date(this.initDate).clearTime().add('mi', (24 * 60) - 1),
7925 times.push(min.dateFormat(this.format));
7926 min = min.add('mi', this.increment);
7928 this.bindStore(times, initial);
7932 setLimit: function(value, isMin, initial){
7934 if(Ext.isString(value)){
7935 d = this.parseDate(value);
7936 }else if(Ext.isDate(value)){
7940 var val = new Date(this.initDate).clearTime();
7941 val.setHours(d.getHours(), d.getMinutes(), d.getSeconds(), d.getMilliseconds());
7942 this[isMin ? 'minValue' : 'maxValue'] = val;
7944 this.generateStore();
7950 getValue : function(){
7951 var v = Ext.form.TimeField.superclass.getValue.call(this);
7952 return this.formatDate(this.parseDate(v)) || '';
7956 setValue : function(value){
7957 return Ext.form.TimeField.superclass.setValue.call(this, this.formatDate(this.parseDate(value)));
7960 // private overrides
7961 validateValue : Ext.form.DateField.prototype.validateValue,
7963 formatDate : Ext.form.DateField.prototype.formatDate,
7965 parseDate: function(value) {
7966 if (!value || Ext.isDate(value)) {
7970 var id = this.initDate + ' ',
7971 idf = this.initDateFormat + ' ',
7972 v = Date.parseDate(id + value, idf + this.format), // *** handle DST. note: this.format is a TIME-only format
7973 af = this.altFormats;
7976 if (!this.altFormatsArray) {
7977 this.altFormatsArray = af.split("|");
7979 for (var i = 0, afa = this.altFormatsArray, len = afa.length; i < len && !v; i++) {
7980 v = Date.parseDate(id + value, idf + afa[i]);
7987 Ext.reg('timefield', Ext.form.TimeField);/**
7988 * @class Ext.form.SliderField
7989 * @extends Ext.form.Field
7990 * Wraps a {@link Ext.Slider Slider} so it can be used as a form field.
7992 * Creates a new SliderField
7993 * @param {Object} config Configuration options. Note that you can pass in any slider configuration options, as well as
7994 * as any field configuration options.
7995 * @xtype sliderfield
7997 Ext.form.SliderField = Ext.extend(Ext.form.Field, {
8000 * @cfg {Boolean} useTips
8001 * True to use an Ext.slider.Tip to display tips for the value. Defaults to <tt>true</tt>.
8006 * @cfg {Function} tipText
8007 * A function used to display custom text for the slider tip. Defaults to <tt>null</tt>, which will
8008 * use the default on the plugin.
8016 * Initialize the component.
8019 initComponent : function() {
8020 var cfg = Ext.copyTo({
8021 id: this.id + '-slider'
8022 }, this.initialConfig, ['vertical', 'minValue', 'maxValue', 'decimalPrecision', 'keyIncrement', 'increment', 'clickToChange', 'animate']);
8024 // only can use it if it exists.
8026 var plug = this.tipText ? {getText: this.tipText} : {};
8027 cfg.plugins = [new Ext.slider.Tip(plug)];
8029 this.slider = new Ext.Slider(cfg);
8030 Ext.form.SliderField.superclass.initComponent.call(this);
8034 * Set up the hidden field
8035 * @param {Object} ct The container to render to.
8036 * @param {Object} position The position in the container to render to.
8039 onRender : function(ct, position){
8046 Ext.form.SliderField.superclass.onRender.call(this, ct, position);
8047 this.wrap = this.el.wrap({cls: 'x-form-field-wrap'});
8048 this.resizeEl = this.positionEl = this.wrap;
8049 this.slider.render(this.wrap);
8053 * Ensure that the slider size is set automatically when the field resizes.
8054 * @param {Object} w The width
8055 * @param {Object} h The height
8056 * @param {Object} aw The adjusted width
8057 * @param {Object} ah The adjusted height
8060 onResize : function(w, h, aw, ah){
8061 Ext.form.SliderField.superclass.onResize.call(this, w, h, aw, ah);
8062 this.slider.setSize(w, h);
8066 * Initialize any events for this class.
8069 initEvents : function(){
8070 Ext.form.SliderField.superclass.initEvents.call(this);
8071 this.slider.on('change', this.onChange, this);
8075 * Utility method to set the value of the field when the slider changes.
8076 * @param {Object} slider The slider object.
8077 * @param {Object} v The new value.
8080 onChange : function(slider, v){
8081 this.setValue(v, undefined, true);
8085 * Enable the slider when the field is enabled.
8088 onEnable : function(){
8089 Ext.form.SliderField.superclass.onEnable.call(this);
8090 this.slider.enable();
8094 * Disable the slider when the field is disabled.
8097 onDisable : function(){
8098 Ext.form.SliderField.superclass.onDisable.call(this);
8099 this.slider.disable();
8103 * Ensure the slider is destroyed when the field is destroyed.
8106 beforeDestroy : function(){
8107 Ext.destroy(this.slider);
8108 Ext.form.SliderField.superclass.beforeDestroy.call(this);
8112 * If a side icon is shown, do alignment to the slider
8115 alignErrorIcon : function(){
8116 this.errorIcon.alignTo(this.slider.el, 'tl-tr', [2, 0]);
8120 * Sets the minimum field value.
8121 * @param {Number} v The new minimum value.
8122 * @return {Ext.form.SliderField} this
8124 setMinValue : function(v){
8125 this.slider.setMinValue(v);
8130 * Sets the maximum field value.
8131 * @param {Number} v The new maximum value.
8132 * @return {Ext.form.SliderField} this
8134 setMaxValue : function(v){
8135 this.slider.setMaxValue(v);
8140 * Sets the value for this field.
8141 * @param {Number} v The new value.
8142 * @param {Boolean} animate (optional) Whether to animate the transition. If not specified, it will default to the animate config.
8143 * @return {Ext.form.SliderField} this
8145 setValue : function(v, animate, /* private */ silent){
8146 // silent is used if the setValue method is invoked by the slider
8147 // which means we don't need to set the value on the slider.
8149 this.slider.setValue(v, animate);
8151 return Ext.form.SliderField.superclass.setValue.call(this, this.slider.getValue());
8155 * Gets the current value for this field.
8156 * @return {Number} The current value.
8158 getValue : function(){
8159 return this.slider.getValue();
8163 Ext.reg('sliderfield', Ext.form.SliderField);/**
8164 * @class Ext.form.Label
8165 * @extends Ext.BoxComponent
8166 * Basic Label field.
8168 * Creates a new Label
8169 * @param {Ext.Element/String/Object} config The configuration options. If an element is passed, it is set as the internal
8170 * element and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element
8171 * and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.
8174 Ext.form.Label = Ext.extend(Ext.BoxComponent, {
8176 * @cfg {String} text The plain text to display within the label (defaults to ''). If you need to include HTML
8177 * tags within the label's innerHTML, use the {@link #html} config instead.
8180 * @cfg {String} forId The id of the input element to which this label will be bound via the standard HTML 'for'
8181 * attribute. If not specified, the attribute will not be added to the label.
8184 * @cfg {String} html An HTML fragment that will be used as the label's innerHTML (defaults to '').
8185 * Note that if {@link #text} is specified it will take precedence and this value will be ignored.
8189 onRender : function(ct, position){
8191 this.el = document.createElement('label');
8192 this.el.id = this.getId();
8193 this.el.innerHTML = this.text ? Ext.util.Format.htmlEncode(this.text) : (this.html || '');
8195 this.el.setAttribute('for', this.forId);
8198 Ext.form.Label.superclass.onRender.call(this, ct, position);
8202 * Updates the label's innerHTML with the specified string.
8203 * @param {String} text The new label text
8204 * @param {Boolean} encode (optional) False to skip HTML-encoding the text when rendering it
8205 * to the label (defaults to true which encodes the value). This might be useful if you want to include
8206 * tags in the label's innerHTML rather than rendering them as string literals per the default logic.
8207 * @return {Label} this
8209 setText : function(t, encode){
8210 var e = encode === false;
8211 this[!e ? 'text' : 'html'] = t;
8212 delete this[e ? 'text' : 'html'];
8214 this.el.dom.innerHTML = encode !== false ? Ext.util.Format.htmlEncode(t) : t;
8220 Ext.reg('label', Ext.form.Label);/**
8221 * @class Ext.form.Action
8222 * <p>The subclasses of this class provide actions to perform upon {@link Ext.form.BasicForm Form}s.</p>
8223 * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
8224 * the Form needs to perform an action such as submit or load. The Configuration options
8225 * listed for this class are set through the Form's action methods: {@link Ext.form.BasicForm#submit submit},
8226 * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#doAction doAction}</p>
8227 * <p>The instance of Action which performed the action is passed to the success
8228 * and failure callbacks of the Form's action methods ({@link Ext.form.BasicForm#submit submit},
8229 * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#doAction doAction}),
8230 * and to the {@link Ext.form.BasicForm#actioncomplete actioncomplete} and
8231 * {@link Ext.form.BasicForm#actionfailed actionfailed} event handlers.</p>
8233 Ext.form.Action = function(form, options){
8235 this.options = options || {};
8239 * Failure type returned when client side validation of the Form fails
8240 * thus aborting a submit action. Client side validation is performed unless
8241 * {@link #clientValidation} is explicitly set to <tt>false</tt>.
8245 Ext.form.Action.CLIENT_INVALID = 'client';
8247 * <p>Failure type returned when server side processing fails and the {@link #result}'s
8248 * <tt style="font-weight:bold">success</tt> property is set to <tt>false</tt>.</p>
8249 * <p>In the case of a form submission, field-specific error messages may be returned in the
8250 * {@link #result}'s <tt style="font-weight:bold">errors</tt> property.</p>
8254 Ext.form.Action.SERVER_INVALID = 'server';
8256 * Failure type returned when a communication error happens when attempting
8257 * to send a request to the remote server. The {@link #response} may be examined to
8258 * provide further information.
8262 Ext.form.Action.CONNECT_FAILURE = 'connect';
8264 * Failure type returned when the response's <tt style="font-weight:bold">success</tt>
8265 * property is set to <tt>false</tt>, or no field values are returned in the response's
8266 * <tt style="font-weight:bold">data</tt> property.
8270 Ext.form.Action.LOAD_FAILURE = 'load';
8272 Ext.form.Action.prototype = {
8274 * @cfg {String} url The URL that the Action is to invoke.
8277 * @cfg {Boolean} reset When set to <tt><b>true</b></tt>, causes the Form to be
8278 * {@link Ext.form.BasicForm.reset reset} on Action success. If specified, this happens
8279 * <b>before</b> the {@link #success} callback is called and before the Form's
8280 * {@link Ext.form.BasicForm.actioncomplete actioncomplete} event fires.
8283 * @cfg {String} method The HTTP method to use to access the requested URL. Defaults to the
8284 * {@link Ext.form.BasicForm}'s method, or if that is not specified, the underlying DOM form's method.
8287 * @cfg {Mixed} params <p>Extra parameter values to pass. These are added to the Form's
8288 * {@link Ext.form.BasicForm#baseParams} and passed to the specified URL along with the Form's
8290 * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
8293 * @cfg {Number} timeout The number of seconds to wait for a server response before
8294 * failing with the {@link #failureType} as {@link #Action.CONNECT_FAILURE}. If not specified,
8295 * defaults to the configured <tt>{@link Ext.form.BasicForm#timeout timeout}</tt> of the
8296 * {@link Ext.form.BasicForm form}.
8299 * @cfg {Function} success The function to call when a valid success return packet is recieved.
8300 * The function is passed the following parameters:<ul class="mdetail-params">
8301 * <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
8302 * <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. The {@link #result}
8303 * property of this object may be examined to perform custom postprocessing.</div></li>
8307 * @cfg {Function} failure The function to call when a failure packet was recieved, or when an
8308 * error ocurred in the Ajax communication.
8309 * The function is passed the following parameters:<ul class="mdetail-params">
8310 * <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
8311 * <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. If an Ajax
8312 * error ocurred, the failure type will be in {@link #failureType}. The {@link #result}
8313 * property of this object may be examined to perform custom postprocessing.</div></li>
8317 * @cfg {Object} scope The scope in which to call the callback functions (The <tt>this</tt> reference
8318 * for the callback functions).
8321 * @cfg {String} waitMsg The message to be displayed by a call to {@link Ext.MessageBox#wait}
8322 * during the time the action is being processed.
8325 * @cfg {String} waitTitle The title to be displayed by a call to {@link Ext.MessageBox#wait}
8326 * during the time the action is being processed.
8330 * @cfg {Boolean} submitEmptyText If set to <tt>true</tt>, the emptyText value will be sent with the form
8331 * when it is submitted. Defaults to <tt>true</tt>.
8335 * The type of action this Action instance performs.
8336 * Currently only "submit" and "load" are supported.
8341 * The type of failure detected will be one of these: {@link #CLIENT_INVALID},
8342 * {@link #SERVER_INVALID}, {@link #CONNECT_FAILURE}, or {@link #LOAD_FAILURE}. Usage:
8344 var fp = new Ext.form.FormPanel({
8349 handler: function(){
8350 if(fp.getForm().isValid()){
8351 fp.getForm().submit({
8352 url: 'form-submit.php',
8353 waitMsg: 'Submitting your data...',
8354 success: function(form, action){
8355 // server responded with success = true
8356 var result = action.{@link #result};
8358 failure: function(form, action){
8359 if (action.{@link #failureType} === Ext.form.Action.{@link #CONNECT_FAILURE}) {
8360 Ext.Msg.alert('Error',
8361 'Status:'+action.{@link #response}.status+': '+
8362 action.{@link #response}.statusText);
8364 if (action.failureType === Ext.form.Action.{@link #SERVER_INVALID}){
8365 // server responded with success = false
8366 Ext.Msg.alert('Invalid', action.{@link #result}.errormsg);
8374 handler: function(){
8375 fp.getForm().reset();
8379 * @property failureType
8383 * The XMLHttpRequest object used to perform the action.
8384 * @property response
8388 * The decoded response object containing a boolean <tt style="font-weight:bold">success</tt> property and
8389 * other, action-specific properties.
8395 run : function(options){
8400 success : function(response){
8405 handleResponse : function(response){
8409 // default connection failure
8410 failure : function(response){
8411 this.response = response;
8412 this.failureType = Ext.form.Action.CONNECT_FAILURE;
8413 this.form.afterAction(this, false);
8417 // shared code among all Actions to validate that there was a response
8418 // with either responseText or responseXml
8419 processResponse : function(response){
8420 this.response = response;
8421 if(!response.responseText && !response.responseXML){
8424 this.result = this.handleResponse(response);
8428 // utility functions used internally
8429 getUrl : function(appendParams){
8430 var url = this.options.url || this.form.url || this.form.el.dom.action;
8432 var p = this.getParams();
8434 url = Ext.urlAppend(url, p);
8441 getMethod : function(){
8442 return (this.options.method || this.form.method || this.form.el.dom.method || 'POST').toUpperCase();
8446 getParams : function(){
8447 var bp = this.form.baseParams;
8448 var p = this.options.params;
8450 if(typeof p == "object"){
8451 p = Ext.urlEncode(Ext.applyIf(p, bp));
8452 }else if(typeof p == 'string' && bp){
8453 p += '&' + Ext.urlEncode(bp);
8456 p = Ext.urlEncode(bp);
8462 createCallback : function(opts){
8463 var opts = opts || {};
8465 success: this.success,
8466 failure: this.failure,
8468 timeout: (opts.timeout*1000) || (this.form.timeout*1000),
8469 upload: this.form.fileUpload ? this.success : undefined
8475 * @class Ext.form.Action.Submit
8476 * @extends Ext.form.Action
8477 * <p>A class which handles submission of data from {@link Ext.form.BasicForm Form}s
8478 * and processes the returned response.</p>
8479 * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
8480 * {@link Ext.form.BasicForm#submit submit}ting.</p>
8481 * <p><u><b>Response Packet Criteria</b></u></p>
8482 * <p>A response packet may contain:
8483 * <div class="mdetail-params"><ul>
8484 * <li><b><code>success</code></b> property : Boolean
8485 * <div class="sub-desc">The <code>success</code> property is required.</div></li>
8486 * <li><b><code>errors</code></b> property : Object
8487 * <div class="sub-desc"><div class="sub-desc">The <code>errors</code> property,
8488 * which is optional, contains error messages for invalid fields.</div></li>
8490 * <p><u><b>JSON Packets</b></u></p>
8491 * <p>By default, response packets are assumed to be JSON, so a typical response
8492 * packet may look like this:</p><pre><code>
8496 clientCode: "Client not found",
8497 portOfLoading: "This field must not be null"
8500 * <p>Other data may be placed into the response for processing by the {@link Ext.form.BasicForm}'s callback
8501 * or event handler methods. The object decoded from this JSON is available in the
8502 * {@link Ext.form.Action#result result} property.</p>
8503 * <p>Alternatively, if an {@link #errorReader} is specified as an {@link Ext.data.XmlReader XmlReader}:</p><pre><code>
8504 errorReader: new Ext.data.XmlReader({
8512 * <p>then the results may be sent back in XML format:</p><pre><code>
8513 <?xml version="1.0" encoding="UTF-8"?>
8514 <message success="false">
8517 <id>clientCode</id>
8518 <msg><![CDATA[Code not found. <br /><i>This is a test validation message from the server </i>]]></msg>
8521 <id>portOfLoading</id>
8522 <msg><![CDATA[Port not found. <br /><i>This is a test validation message from the server </i>]]></msg>
8527 * <p>Other elements may be placed into the response XML for processing by the {@link Ext.form.BasicForm}'s callback
8528 * or event handler methods. The XML document is available in the {@link #errorReader}'s {@link Ext.data.XmlReader#xmlData xmlData} property.</p>
8530 Ext.form.Action.Submit = function(form, options){
8531 Ext.form.Action.Submit.superclass.constructor.call(this, form, options);
8534 Ext.extend(Ext.form.Action.Submit, Ext.form.Action, {
8536 * @cfg {Ext.data.DataReader} errorReader <p><b>Optional. JSON is interpreted with
8537 * no need for an errorReader.</b></p>
8538 * <p>A Reader which reads a single record from the returned data. The DataReader's
8539 * <b>success</b> property specifies how submission success is determined. The Record's
8540 * data provides the error messages to apply to any invalid form Fields.</p>
8543 * @cfg {boolean} clientValidation Determines whether a Form's fields are validated
8544 * in a final call to {@link Ext.form.BasicForm#isValid isValid} prior to submission.
8545 * Pass <tt>false</tt> in the Form's submit options to prevent this. If not defined, pre-submission field validation
8552 var o = this.options,
8553 method = this.getMethod(),
8554 isGet = method == 'GET';
8555 if(o.clientValidation === false || this.form.isValid()){
8556 if (o.submitEmptyText === false) {
8557 var fields = this.form.items,
8559 fields.each(function(f) {
8560 if (f.el.getValue() == f.emptyText) {
8561 emptyFields.push(f);
8562 f.el.dom.value = "";
8566 Ext.Ajax.request(Ext.apply(this.createCallback(o), {
8567 form:this.form.el.dom,
8568 url:this.getUrl(isGet),
8571 params:!isGet ? this.getParams() : null,
8572 isUpload: this.form.fileUpload
8574 if (o.submitEmptyText === false) {
8575 Ext.each(emptyFields, function(f) {
8576 if (f.applyEmptyText) {
8581 }else if (o.clientValidation !== false){ // client validation failed
8582 this.failureType = Ext.form.Action.CLIENT_INVALID;
8583 this.form.afterAction(this, false);
8588 success : function(response){
8589 var result = this.processResponse(response);
8590 if(result === true || result.success){
8591 this.form.afterAction(this, true);
8595 this.form.markInvalid(result.errors);
8597 this.failureType = Ext.form.Action.SERVER_INVALID;
8598 this.form.afterAction(this, false);
8602 handleResponse : function(response){
8603 if(this.form.errorReader){
8604 var rs = this.form.errorReader.read(response);
8607 for(var i = 0, len = rs.records.length; i < len; i++) {
8608 var r = rs.records[i];
8612 if(errors.length < 1){
8616 success : rs.success,
8620 return Ext.decode(response.responseText);
8626 * @class Ext.form.Action.Load
8627 * @extends Ext.form.Action
8628 * <p>A class which handles loading of data from a server into the Fields of an {@link Ext.form.BasicForm}.</p>
8629 * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
8630 * {@link Ext.form.BasicForm#load load}ing.</p>
8631 * <p><u><b>Response Packet Criteria</b></u></p>
8632 * <p>A response packet <b>must</b> contain:
8633 * <div class="mdetail-params"><ul>
8634 * <li><b><code>success</code></b> property : Boolean</li>
8635 * <li><b><code>data</code></b> property : Object</li>
8636 * <div class="sub-desc">The <code>data</code> property contains the values of Fields to load.
8637 * The individual value object for each Field is passed to the Field's
8638 * {@link Ext.form.Field#setValue setValue} method.</div></li>
8640 * <p><u><b>JSON Packets</b></u></p>
8641 * <p>By default, response packets are assumed to be JSON, so for the following form load call:<pre><code>
8642 var myFormPanel = new Ext.form.FormPanel({
8643 title: 'Client and routing info',
8645 fieldLabel: 'Client',
8648 fieldLabel: 'Port of loading',
8649 name: 'portOfLoading'
8651 fieldLabel: 'Port of discharge',
8652 name: 'portOfDischarge'
8655 myFormPanel.{@link Ext.form.FormPanel#getForm getForm}().{@link Ext.form.BasicForm#load load}({
8656 url: '/getRoutingInfo.php',
8658 consignmentRef: myConsignmentRef
8660 failure: function(form, action) {
8661 Ext.Msg.alert("Load failed", action.result.errorMessage);
8665 * a <b>success response</b> packet may look like this:</p><pre><code>
8669 clientName: "Fred. Olsen Lines",
8670 portOfLoading: "FXT",
8671 portOfDischarge: "OSL"
8674 * while a <b>failure response</b> packet may look like this:</p><pre><code>
8677 errorMessage: "Consignment reference not found"
8679 * <p>Other data may be placed into the response for processing the {@link Ext.form.BasicForm Form}'s
8680 * callback or event handler methods. The object decoded from this JSON is available in the
8681 * {@link Ext.form.Action#result result} property.</p>
8683 Ext.form.Action.Load = function(form, options){
8684 Ext.form.Action.Load.superclass.constructor.call(this, form, options);
8685 this.reader = this.form.reader;
8688 Ext.extend(Ext.form.Action.Load, Ext.form.Action, {
8694 Ext.Ajax.request(Ext.apply(
8695 this.createCallback(this.options), {
8696 method:this.getMethod(),
8697 url:this.getUrl(false),
8698 headers: this.options.headers,
8699 params:this.getParams()
8704 success : function(response){
8705 var result = this.processResponse(response);
8706 if(result === true || !result.success || !result.data){
8707 this.failureType = Ext.form.Action.LOAD_FAILURE;
8708 this.form.afterAction(this, false);
8711 this.form.clearInvalid();
8712 this.form.setValues(result.data);
8713 this.form.afterAction(this, true);
8717 handleResponse : function(response){
8718 if(this.form.reader){
8719 var rs = this.form.reader.read(response);
8720 var data = rs.records && rs.records[0] ? rs.records[0].data : null;
8722 success : rs.success,
8726 return Ext.decode(response.responseText);
8733 * @class Ext.form.Action.DirectLoad
8734 * @extends Ext.form.Action.Load
8735 * <p>Provides Ext.direct support for loading form data.</p>
8736 * <p>This example illustrates usage of Ext.Direct to <b>load</b> a form through Ext.Direct.</p>
8738 var myFormPanel = new Ext.form.FormPanel({
8739 // configs for FormPanel
8740 title: 'Basic Information',
8741 renderTo: document.body,
8742 width: 300, height: 160,
8745 // configs apply to child items
8746 defaults: {anchor: '100%'},
8747 defaultType: 'textfield',
8752 fieldLabel: 'Email',
8755 fieldLabel: 'Company',
8759 // configs for BasicForm
8761 // The server-side method to call for load() requests
8762 load: Profile.getBasicInfo,
8763 // The server-side must mark the submit handler as a 'formHandler'
8764 submit: Profile.updateBasicInfo
8766 // specify the order for the passed params
8767 paramOrder: ['uid', 'foo']
8771 myFormPanel.getForm().load({
8772 // pass 2 arguments to server side getBasicInfo method (len=2)
8779 * The data packet sent to the server will resemble something like:
8783 "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
8784 "data":[34,"bar"] // note the order of the params
8788 * The form will process a data packet returned by the server that is similar
8789 * to the following format:
8793 "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
8797 "name":"Fred Flintstone",
8798 "company":"Slate Rock and Gravel",
8799 "email":"fred.flintstone@slaterg.com"
8806 Ext.form.Action.DirectLoad = Ext.extend(Ext.form.Action.Load, {
8807 constructor: function(form, opts) {
8808 Ext.form.Action.DirectLoad.superclass.constructor.call(this, form, opts);
8810 type : 'directload',
8813 var args = this.getParams();
8814 args.push(this.success, this);
8815 this.form.api.load.apply(window, args);
8818 getParams : function() {
8819 var buf = [], o = {};
8820 var bp = this.form.baseParams;
8821 var p = this.options.params;
8822 Ext.apply(o, p, bp);
8823 var paramOrder = this.form.paramOrder;
8825 for(var i = 0, len = paramOrder.length; i < len; i++){
8826 buf.push(o[paramOrder[i]]);
8828 }else if(this.form.paramsAsHash){
8833 // Direct actions have already been processed and therefore
8834 // we can directly set the result; Direct Actions do not have
8835 // a this.response property.
8836 processResponse : function(result) {
8837 this.result = result;
8841 success : function(response, trans){
8842 if(trans.type == Ext.Direct.exceptions.SERVER){
8845 Ext.form.Action.DirectLoad.superclass.success.call(this, response);
8850 * @class Ext.form.Action.DirectSubmit
8851 * @extends Ext.form.Action.Submit
8852 * <p>Provides Ext.direct support for submitting form data.</p>
8853 * <p>This example illustrates usage of Ext.Direct to <b>submit</b> a form through Ext.Direct.</p>
8855 var myFormPanel = new Ext.form.FormPanel({
8856 // configs for FormPanel
8857 title: 'Basic Information',
8858 renderTo: document.body,
8859 width: 300, height: 160,
8863 handler: function(){
8864 myFormPanel.getForm().submit({
8873 // configs apply to child items
8874 defaults: {anchor: '100%'},
8875 defaultType: 'textfield',
8880 fieldLabel: 'Email',
8883 fieldLabel: 'Company',
8887 // configs for BasicForm
8889 // The server-side method to call for load() requests
8890 load: Profile.getBasicInfo,
8891 // The server-side must mark the submit handler as a 'formHandler'
8892 submit: Profile.updateBasicInfo
8894 // specify the order for the passed params
8895 paramOrder: ['uid', 'foo']
8898 * The data packet sent to the server will resemble something like:
8901 "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6",
8905 "extAction":"Profile","extMethod":"updateBasicInfo",
8906 "extType":"rpc","extTID":"6","extUpload":"false",
8907 "name":"Aaron Conran","email":"aaron@extjs.com","company":"Ext JS, LLC"
8912 * The form will process a data packet returned by the server that is similar
8915 // sample success packet (batched requests)
8918 "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":3,
8925 // sample failure packet (one request)
8927 "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6",
8930 "email":"already taken"
8937 * Also see the discussion in {@link Ext.form.Action.DirectLoad}.
8939 Ext.form.Action.DirectSubmit = Ext.extend(Ext.form.Action.Submit, {
8940 constructor : function(form, opts) {
8941 Ext.form.Action.DirectSubmit.superclass.constructor.call(this, form, opts);
8943 type : 'directsubmit',
8944 // override of Submit
8946 var o = this.options;
8947 if(o.clientValidation === false || this.form.isValid()){
8948 // tag on any additional params to be posted in the
8950 this.success.params = this.getParams();
8951 this.form.api.submit(this.form.el.dom, this.success, this);
8952 }else if (o.clientValidation !== false){ // client validation failed
8953 this.failureType = Ext.form.Action.CLIENT_INVALID;
8954 this.form.afterAction(this, false);
8958 getParams : function() {
8960 var bp = this.form.baseParams;
8961 var p = this.options.params;
8962 Ext.apply(o, p, bp);
8965 // Direct actions have already been processed and therefore
8966 // we can directly set the result; Direct Actions do not have
8967 // a this.response property.
8968 processResponse : function(result) {
8969 this.result = result;
8973 success : function(response, trans){
8974 if(trans.type == Ext.Direct.exceptions.SERVER){
8977 Ext.form.Action.DirectSubmit.superclass.success.call(this, response);
8981 Ext.form.Action.ACTION_TYPES = {
8982 'load' : Ext.form.Action.Load,
8983 'submit' : Ext.form.Action.Submit,
8984 'directload' : Ext.form.Action.DirectLoad,
8985 'directsubmit' : Ext.form.Action.DirectSubmit
8988 * @class Ext.form.VTypes
8989 * <p>This is a singleton object which contains a set of commonly used field validation functions.
8990 * The validations provided are basic and intended to be easily customizable and extended.</p>
8991 * <p>To add custom VTypes specify the <code>{@link Ext.form.TextField#vtype vtype}</code> validation
8992 * test function, and optionally specify any corresponding error text to display and any keystroke
8993 * filtering mask to apply. For example:</p>
8995 // custom Vtype for vtype:'time'
8996 var timeTest = /^([1-9]|1[0-9]):([0-5][0-9])(\s[a|p]m)$/i;
8997 Ext.apply(Ext.form.VTypes, {
8998 // vtype validation function
8999 time: function(val, field) {
9000 return timeTest.test(val);
9002 // vtype Text property: The error text to display when the validation function returns false
9003 timeText: 'Not a valid time. Must be in the format "12:34 PM".',
9004 // vtype Mask property: The keystroke filter mask
9005 timeMask: /[\d\s:amp]/i
9010 // custom Vtype for vtype:'IPAddress'
9011 Ext.apply(Ext.form.VTypes, {
9012 IPAddress: function(v) {
9013 return /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(v);
9015 IPAddressText: 'Must be a numeric IP address',
9016 IPAddressMask: /[\d\.]/i
9021 Ext.form.VTypes = function(){
9022 // closure these in so they are only created once.
9023 var alpha = /^[a-zA-Z_]+$/,
9024 alphanum = /^[a-zA-Z0-9_]+$/,
9025 email = /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$/,
9026 url = /(((^https?)|(^ftp)):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@&#;`~=%!]*)(\.\w{2,})?)*\/?)/i;
9028 // All these messages and functions are configurable
9031 * The function used to validate email addresses. Note that this is a very basic validation -- complete
9032 * validation per the email RFC specifications is very complex and beyond the scope of this class, although
9033 * this function can be overridden if a more comprehensive validation scheme is desired. See the validation
9034 * section of the <a href="http://en.wikipedia.org/wiki/E-mail_address">Wikipedia article on email addresses</a>
9035 * for additional information. This implementation is intended to validate the following emails:<tt>
9036 * 'barney@example.de', 'barney.rubble@example.com', 'barney-rubble@example.coop', 'barney+rubble@example.com'
9038 * @param {String} value The email address
9039 * @return {Boolean} true if the RegExp test passed, and false if not.
9041 'email' : function(v){
9042 return email.test(v);
9045 * The error text to display when the email validation function returns false. Defaults to:
9046 * <tt>'This field should be an e-mail address in the format "user@example.com"'</tt>
9049 'emailText' : 'This field should be an e-mail address in the format "user@example.com"',
9051 * The keystroke filter mask to be applied on email input. See the {@link #email} method for
9052 * information about more complex email validation. Defaults to:
9053 * <tt>/[a-z0-9_\.\-@]/i</tt>
9056 'emailMask' : /[a-z0-9_\.\-@\+]/i,
9059 * The function used to validate URLs
9060 * @param {String} value The URL
9061 * @return {Boolean} true if the RegExp test passed, and false if not.
9063 'url' : function(v){
9067 * The error text to display when the url validation function returns false. Defaults to:
9068 * <tt>'This field should be a URL in the format "http:/'+'/www.example.com"'</tt>
9071 'urlText' : 'This field should be a URL in the format "http:/'+'/www.example.com"',
9074 * The function used to validate alpha values
9075 * @param {String} value The value
9076 * @return {Boolean} true if the RegExp test passed, and false if not.
9078 'alpha' : function(v){
9079 return alpha.test(v);
9082 * The error text to display when the alpha validation function returns false. Defaults to:
9083 * <tt>'This field should only contain letters and _'</tt>
9086 'alphaText' : 'This field should only contain letters and _',
9088 * The keystroke filter mask to be applied on alpha input. Defaults to:
9089 * <tt>/[a-z_]/i</tt>
9092 'alphaMask' : /[a-z_]/i,
9095 * The function used to validate alphanumeric values
9096 * @param {String} value The value
9097 * @return {Boolean} true if the RegExp test passed, and false if not.
9099 'alphanum' : function(v){
9100 return alphanum.test(v);
9103 * The error text to display when the alphanumeric validation function returns false. Defaults to:
9104 * <tt>'This field should only contain letters, numbers and _'</tt>
9107 'alphanumText' : 'This field should only contain letters, numbers and _',
9109 * The keystroke filter mask to be applied on alphanumeric input. Defaults to:
9110 * <tt>/[a-z0-9_]/i</tt>
9113 'alphanumMask' : /[a-z0-9_]/i