/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
-/**
- * @class Ext.form.Field
- * @extends Ext.BoxComponent
- * Base class for form fields that provides default event handling, sizing, value handling and other functionality.
- * @constructor
- * Creates a new Field
- * @param {Object} config Configuration options
- * @xtype field
+Sencha Documentation Project /**
+ * @class Ext.form.field.Field
+
+This mixin provides a common interface for the logical behavior and state of form fields, including:
+
+- Getter and setter methods for field values
+- Events and methods for tracking value and validity changes
+- Methods for triggering validation
+
+**NOTE**: When implementing custom fields, it is most likely that you will want to extend the {@link Ext.form.field.Base}
+component class rather than using this mixin directly, as BaseField contains additional logic for generating an
+actual DOM complete with {@link Ext.form.Labelable label and error message} display and a form input field,
+plus methods that bind the Field value getters and setters to the input field's value.
+
+If you do want to implement this mixin directly and don't want to extend {@link Ext.form.field.Base}, then
+you will most likely want to override the following methods with custom implementations: {@link #getValue},
+{@link #setValue}, and {@link #getErrors}. Other methods may be overridden as needed but their base
+implementations should be sufficient for common cases. You will also need to make sure that {@link #initField}
+is called during the component's initialization.
+
+ * @markdown
+ * @docauthor Jason Johnston <jason@sencha.com>
*/
-Ext.form.Field = Ext.extend(Ext.BoxComponent, {
- /**
- * The label Element associated with this Field. Only available after this Field has been rendered by a
- * {@link form Ext.layout.FormLayout} layout manager.
- * @type Ext.Element
- * @property label
- */
- /**
- * @cfg {String} inputType The type attribute for input fields -- e.g. radio, text, password, file (defaults
- * to 'text'). The types 'file' and 'password' must be used to render those field types currently -- there are
- * no separate Ext components for those. Note that if you use inputType:'file', {@link #emptyText}
- * is not supported and should be avoided.
- */
- /**
- * @cfg {Number} tabIndex The tabIndex for this field. Note this only applies to fields that are rendered,
- * not those which are built via applyTo (defaults to undefined).
- */
- /**
- * @cfg {Mixed} value A value to initialize this field with (defaults to undefined).
- */
- /**
- * @cfg {String} name The field's HTML name attribute (defaults to '').
- * Note: this property must be set if this field is to be automatically included with
- * {@link Ext.form.BasicForm#submit form submit()}.
- */
- /**
- * @cfg {String} cls A custom CSS class to apply to the field's underlying element (defaults to '').
- */
+Ext.define('Ext.form.field.Field', {
- /**
- * @cfg {String} invalidClass The CSS class to use when marking a field invalid (defaults to 'x-form-invalid')
- */
- invalidClass : 'x-form-invalid',
- /**
- * @cfg {String} invalidText The error text to use when marking a field invalid and no message is provided
- * (defaults to 'The value in this field is invalid')
- */
- invalidText : 'The value in this field is invalid',
- /**
- * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to 'x-form-focus')
- */
- focusClass : 'x-form-focus',
- /**
- * @cfg {Boolean} preventMark
- * true to disable {@link #markInvalid marking the field invalid}.
- * Defaults to false.
- */
- /**
- * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable
- automatic validation (defaults to 'keyup').
- */
- validationEvent : 'keyup',
- /**
- * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true).
- */
- validateOnBlur : true,
- /**
- * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation
- * is initiated (defaults to 250)
- */
- validationDelay : 250,
- /**
- * @cfg {String/Object} autoCreate A {@link Ext.DomHelper DomHelper} element spec, or true for a default
- * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
- * See {@link Ext.Component#autoEl autoEl} for details. Defaults to:
- * {tag: 'input', type: 'text', size: '20', autocomplete: 'off'}
- */
- defaultAutoCreate : {tag: 'input', type: 'text', size: '20', autocomplete: 'off'},
- /**
- * @cfg {String} fieldClass The default CSS class for the field (defaults to 'x-form-field')
+ /**
+ * @property isFormField
+ * @type {Boolean}
+ * Flag denoting that this component is a Field. Always true.
*/
- fieldClass : 'x-form-field',
- /**
- * @cfg {String} msgTarget The location where the message text set through {@link #markInvalid} should display.
- * Must be one of the following values:
- *
- * qtip Display a quick tip containing the message when the user hovers over the field. This is the default.
- * {@link Ext.QuickTips#init Ext.QuickTips.init} must have been called for this setting to work.
- * title Display the message in a default browser title attribute popup.under Add a block div beneath the field containing the error message.side Add an error icon to the right of the field, displaying the message in a popup on hover.[element id] Add the error message directly to the innerHTML of the specified element.
Note: this only sets the element's readOnly DOM attribute.
- * Setting readOnly=true, for example, will not disable triggering a
- * ComboBox or DateField; it gives you the option of forcing the user to choose
- * via the trigger without typing in the text box. To hide the trigger use
- * {@link Ext.form.TriggerField#hideTrigger hideTrigger}.
+
+ /**
+ * @cfg {String} name The name of the field (defaults to undefined). By default this is used as the parameter
+ * name when including the {@link #getSubmitData field value} in a {@link Ext.form.Basic#submit form submit()}.
+ * To prevent the field from being included in the form submit, set {@link #submitValue} to <tt>false</tt>.
*/
- readOnly : false,
- /**
- * @cfg {Boolean} disabled True to disable the field (defaults to false).
- * Be aware that conformant with the HTML specification,
- * disabled Fields will not be {@link Ext.form.BasicForm#submit submitted}.
+
+ /**
+ * @cfg {Boolean} disabled True to disable the field (defaults to false). Disabled Fields will not be
+ * {@link Ext.form.Basic#submit submitted}.</p>
*/
disabled : false,
- /**
- * @cfg {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post.
- * Defaults to true.
+
+ /**
+ * @cfg {Boolean} submitValue Setting this to <tt>false</tt> will prevent the field from being
+ * {@link Ext.form.Basic#submit submitted} even when it is not disabled. Defaults to <tt>true</tt>.
*/
submitValue: true,
- // private
- isFormField : true,
-
- // private
- msgDisplay: '',
+ /**
+ * @cfg {Boolean} validateOnChange
+ * <p>Specifies whether this field should be validated immediately whenever a change in its value is detected.
+ * Defaults to <tt>true</tt>. If the validation results in a change in the field's validity, a
+ * {@link #validitychange} event will be fired. This allows the field to show feedback about the
+ * validity of its contents immediately as the user is typing.</p>
+ * <p>When set to <tt>false</tt>, feedback will not be immediate. However the form will still be validated
+ * before submitting if the <tt>clientValidation</tt> option to {@link Ext.form.Basic#doAction} is
+ * enabled, or if the field or form are validated manually.</p>
+ * <p>See also {@link Ext.form.field.Base#checkChangeEvents}for controlling how changes to the field's value are detected.</p>
+ */
+ validateOnChange: true,
- // private
- hasFocus : false,
+ /**
+ * @private
+ */
+ suspendCheckChange: 0,
- // private
- initComponent : function(){
- Ext.form.Field.superclass.initComponent.call(this);
+ /**
+ * Initializes this Field mixin on the current instance. Components using this mixin should call
+ * this method during their own initialization process.
+ */
+ initField: function() {
this.addEvents(
- /**
- * @event focus
- * Fires when this field receives input focus.
- * @param {Ext.form.Field} this
- */
- 'focus',
- /**
- * @event blur
- * Fires when this field loses input focus.
- * @param {Ext.form.Field} this
- */
- 'blur',
- /**
- * @event specialkey
- * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
- * To handle other keys see {@link Ext.Panel#keys} or {@link Ext.KeyMap}.
- * You can check {@link Ext.EventObject#getKey} to determine which key was pressed.
- * For example:
-var form = new Ext.form.FormPanel({
- ...
- items: [{
- fieldLabel: 'Field 1',
- name: 'field1',
- allowBlank: false
- },{
- fieldLabel: 'Field 2',
- name: 'field2',
- listeners: {
- specialkey: function(field, e){
- // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN,
- // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN
- if (e.{@link Ext.EventObject#getKey getKey()} == e.ENTER) {
- var form = field.ownerCt.getForm();
- form.submit();
- }
- }
- }
- }
- ],
- ...
-});
- *
- * @param {Ext.form.Field} this
- * @param {Ext.EventObject} e The event object
- */
- 'specialkey',
- /**
- * @event change
- * Fires just before the field blurs if the field value has changed.
- * @param {Ext.form.Field} this
+ /**
+ * @event change
+ * Fires when a user-initiated change is detected in the value of the field.
+ * @param {Ext.form.field.Field} this
* @param {Mixed} newValue The new value
* @param {Mixed} oldValue The original value
*/
'change',
- /**
- * @event invalid
- * Fires after the field has been marked as invalid.
- * @param {Ext.form.Field} this
- * @param {String} msg The validation message
+ /**
+ * @event validitychange
+ * Fires when a change in the field's validity is detected.
+ * @param {Ext.form.field.Field} this
+ * @param {Boolean} isValid Whether or not the field is now valid
*/
- 'invalid',
- /**
- * @event valid
- * Fires after the field has been validated with no errors.
- * @param {Ext.form.Field} this
+ 'validitychange',
+ /**
+ * @event dirtychange
+ * Fires when a change in the field's {@link #isDirty} state is detected.
+ * @param {Ext.form.field.Field} this
+ * @param {Boolean} isDirty Whether or not the field is now dirty
*/
- 'valid'
+ 'dirtychange'
);
- },
-
- /**
- * Returns the {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
- * attribute of the field if available.
- * @return {String} name The field {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
- */
- getName : function(){
- return this.rendered && this.el.dom.name ? this.el.dom.name : this.name || this.id || '';
- },
-
- // private
- onRender : function(ct, position){
- if(!this.el){
- var cfg = this.getAutoCreate();
-
- if(!cfg.name){
- cfg.name = this.name || this.id;
- }
- if(this.inputType){
- cfg.type = this.inputType;
- }
- this.autoEl = cfg;
- }
- Ext.form.Field.superclass.onRender.call(this, ct, position);
- if(this.submitValue === false){
- this.el.dom.removeAttribute('name');
- }
- var type = this.el.dom.type;
- if(type){
- if(type == 'password'){
- type = 'text';
- }
- this.el.addClass('x-form-'+type);
- }
- if(this.readOnly){
- this.setReadOnly(true);
- }
- if(this.tabIndex !== undefined){
- this.el.dom.setAttribute('tabIndex', this.tabIndex);
- }
- this.el.addClass([this.fieldClass, this.cls]);
+ this.initValue();
},
- // private
- getItemCt : function(){
- return this.itemCt;
- },
+ /**
+ * @protected
+ * Initializes the field's value based on the initial config.
+ */
+ initValue: function() {
+ var me = this;
- // private
- initValue : function(){
- if(this.value !== undefined){
- this.setValue(this.value);
- }else if(!Ext.isEmpty(this.el.dom.value) && this.el.dom.value != this.emptyText){
- this.setValue(this.el.dom.value);
- }
- /**
- * The original value of the field as configured in the {@link #value} configuration, or
- * as loaded by the last form load operation if the form's {@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
- * setting is true.
- * @type mixed
- * @property originalValue
+ /**
+ * @property originalValue
+ * @type Mixed
+ * The original value of the field as configured in the {@link #value} configuration, or as loaded by
+ * the last form load operation if the form's {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad}
+ * setting is <code>true</code>.
*/
- this.originalValue = this.getValue();
- },
+ me.originalValue = me.lastValue = me.value;
- /**
- * Returns true if the value of this Field has been changed from its original value.
- * Will return false if the field is disabled or has not been rendered yet.
- * Note that if the owning {@link Ext.form.BasicForm form} was configured with
- * {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
- * then the original value is updated when the values are loaded by
- * {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#setValues setValues}.
- * @return {Boolean} True if this field has been changed from its original value (and
- * is not disabled), false otherwise.
- */
- isDirty : function() {
- if(this.disabled || !this.rendered) {
- return false;
- }
- return String(this.getValue()) !== String(this.originalValue);
+ // Set the initial value - prevent validation on initial set
+ me.suspendCheckChange++;
+ me.setValue(me.value);
+ me.suspendCheckChange--;
},
- /**
- * Sets the read only state of this field.
- * @param {Boolean} readOnly Whether the field should be read only.
+ /**
+ * Returns the {@link Ext.form.field.Field#name name} attribute of the field. This is used as the parameter
+ * name when including the field value in a {@link Ext.form.Basic#submit form submit()}.
+ * @return {String} name The field {@link Ext.form.field.Field#name name}
*/
- setReadOnly : function(readOnly){
- if(this.rendered){
- this.el.dom.readOnly = readOnly;
- }
- this.readOnly = readOnly;
+ getName: function() {
+ return this.name;
},
- // private
- afterRender : function(){
- Ext.form.Field.superclass.afterRender.call(this);
- this.initEvents();
- this.initValue();
+ /**
+ * Returns the current data value of the field. The type of value returned is particular to the type of the
+ * particular field (e.g. a Date object for {@link Ext.form.field.Date}).
+ * @return {Mixed} value The field value
+ */
+ getValue: function() {
+ return this.value;
},
-
- // private
- fireKey : function(e){
- if(e.isSpecialKey()){
- this.fireEvent('specialkey', this, e);
+
+ /**
+ * Sets a data value into the field and runs the change detection and validation.
+ * @param {Mixed} value The value to set
+ * @return {Ext.form.field.Field} this
+ */
+ setValue: function(value) {
+ var me = this;
+ me.value = value;
+ me.checkChange();
+ return me;
+ },
+
+ /**
+ * Returns whether two field {@link #getValue values} are logically equal. Field implementations may override
+ * this to provide custom comparison logic appropriate for the particular field's data type.
+ * @param {Mixed} value1 The first value to compare
+ * @param {Mixed} value2 The second value to compare
+ * @return {Boolean} True if the values are equal, false if inequal.
+ */
+ isEqual: function(value1, value2) {
+ return String(value1) === String(value2);
+ },
+
+ /**
+ * <p>Returns the parameter(s) that would be included in a standard form submit for this field. Typically this
+ * will be an object with a single name-value pair, the name being this field's {@link #getName name} and the
+ * value being its current stringified value. More advanced field implementations may return more than one
+ * name-value pair.</p>
+ * <p>Note that the values returned from this method are not guaranteed to have been successfully
+ * {@link #validate validated}.</p>
+ * @return {Object} A mapping of submit parameter names to values; each value should be a string, or an array
+ * of strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no
+ * parameters to be submitted.
+ */
+ getSubmitData: function() {
+ var me = this,
+ data = null;
+ if (!me.disabled && me.submitValue && !me.isFileUpload()) {
+ data = {};
+ data[me.getName()] = '' + me.getValue();
}
+ return data;
+ },
+
+ /**
+ * <p>Returns the value(s) that should be saved to the {@link Ext.data.Model} instance for this field, when
+ * {@link Ext.form.Basic#updateRecord} is called. Typically this will be an object with a single name-value
+ * pair, the name being this field's {@link #getName name} and the value being its current data value. More
+ * advanced field implementations may return more than one name-value pair. The returned values will be
+ * saved to the corresponding field names in the Model.</p>
+ * <p>Note that the values returned from this method are not guaranteed to have been successfully
+ * {@link #validate validated}.</p>
+ * @return {Object} A mapping of submit parameter names to values; each value should be a string, or an array
+ * of strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no
+ * parameters to be submitted.
+ */
+ getModelData: function() {
+ var me = this,
+ data = null;
+ if (!me.disabled && !me.isFileUpload()) {
+ data = {};
+ data[me.getName()] = me.getValue();
+ }
+ return data;
},
- /**
- * Resets the current field value to the originally loaded value and clears any validation messages.
- * See {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
+ /**
+ * Resets the current field value to the originally loaded value and clears any validation messages.
+ * See {@link Ext.form.Basic}.{@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad}
*/
reset : function(){
- this.setValue(this.originalValue);
- this.clearInvalid();
- },
-
- // private
- initEvents : function(){
- this.mon(this.el, Ext.EventManager.getKeyEvent(), this.fireKey, this);
- this.mon(this.el, 'focus', this.onFocus, this);
-
- // standardise buffer across all browsers + OS-es for consistent event order.
- // (the 10ms buffer for Editors fixes a weird FF/Win editor issue when changing OS window focus)
- this.mon(this.el, 'blur', this.onBlur, this, this.inEditor ? {buffer:10} : null);
+ var me = this;
+
+ me.setValue(me.originalValue);
+ me.clearInvalid();
+ // delete here so we reset back to the original state
+ delete me.wasValid;
},
- // private
- preFocus: Ext.emptyFn,
-
- // private
- onFocus : function(){
- this.preFocus();
- if(this.focusClass){
- this.el.addClass(this.focusClass);
- }
- if(!this.hasFocus){
- this.hasFocus = true;
- /**
- * The value that the Field had at the time it was last focused. This is the value that is passed
- * to the {@link #change} event which is fired if the value has been changed when the Field is blurred.
- * This will be undefined until the Field has been visited. Compare {@link #originalValue}.
- * @type mixed
- * @property startValue
- */
- this.startValue = this.getValue();
- this.fireEvent('focus', this);
+ /**
+ * Resets the field's {@link #originalValue} property so it matches the current {@link #getValue value}.
+ * This is called by {@link Ext.form.Basic}.{@link Ext.form.Basic#setValues setValues} if the form's
+ * {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} property is set to true.
+ */
+ resetOriginalValue: function() {
+ this.originalValue = this.getValue();
+ this.checkDirty();
+ },
+
+ /**
+ * <p>Checks whether the value of the field has changed since the last time it was checked. If the value
+ * has changed, it:</p>
+ * <ol>
+ * <li>Fires the {@link #change change event},</li>
+ * <li>Performs validation if the {@link #validateOnChange} config is enabled, firing the
+ * {@link #validationchange validationchange event} if the validity has changed, and</li>
+ * <li>Checks the {@link #isDirty dirty state} of the field and fires the {@link #dirtychange dirtychange event}
+ * if it has changed.</li>
+ * </ol>
+ */
+ checkChange: function() {
+ if (!this.suspendCheckChange) {
+ var me = this,
+ newVal = me.getValue(),
+ oldVal = me.lastValue;
+ if (!me.isEqual(newVal, oldVal) && !me.isDestroyed) {
+ me.lastValue = newVal;
+ me.fireEvent('change', me, newVal, oldVal);
+ me.onChange(newVal, oldVal);
+ }
}
},
- // private
- beforeBlur : Ext.emptyFn,
-
- // private
- onBlur : function(){
- this.beforeBlur();
- if(this.focusClass){
- this.el.removeClass(this.focusClass);
- }
- this.hasFocus = false;
- if(this.validationEvent !== false && (this.validateOnBlur || this.validationEvent == 'blur')){
+ /**
+ * @private
+ * Called when the field's value changes. Performs validation if the {@link #validateOnChange}
+ * config is enabled, and invokes the dirty check.
+ */
+ onChange: function(newVal, oldVal) {
+ if (this.validateOnChange) {
this.validate();
}
- var v = this.getValue();
- if(String(v) !== String(this.startValue)){
- this.fireEvent('change', this, v, this.startValue);
- }
- this.fireEvent('blur', this);
- this.postBlur();
+ this.checkDirty();
},
- // private
- postBlur : Ext.emptyFn,
-
- /**
- * Returns whether or not the field value is currently valid by
- * {@link #validateValue validating} the {@link #processValue processed value}
- * of the field. Note: {@link #disabled} fields are ignored.
- * @param {Boolean} preventMark True to disable marking the field invalid
- * @return {Boolean} True if the value is valid, else false
+ /**
+ * <p>Returns true if the value of this Field has been changed from its {@link #originalValue}.
+ * Will always return false if the field is disabled.</p>
+ * <p>Note that if the owning {@link Ext.form.Basic form} was configured with
+ * {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad}
+ * then the {@link #originalValue} is updated when the values are loaded by
+ * {@link Ext.form.Basic}.{@link Ext.form.Basic#setValues setValues}.</p>
+ * @return {Boolean} True if this field has been changed from its original value (and
+ * is not disabled), false otherwise.
*/
- isValid : function(preventMark){
- if(this.disabled){
- return true;
- }
- var restore = this.preventMark;
- this.preventMark = preventMark === true;
- var v = this.validateValue(this.processValue(this.getRawValue()));
- this.preventMark = restore;
- return v;
+ isDirty : function() {
+ var me = this;
+ return !me.disabled && !me.isEqual(me.getValue(), me.originalValue);
},
- /**
- * Validates the field value
- * @return {Boolean} True if the value is valid, else false
+ /**
+ * Checks the {@link #isDirty} state of the field and if it has changed since the last time
+ * it was checked, fires the {@link #dirtychange} event.
*/
- validate : function(){
- if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
- this.clearInvalid();
- return true;
+ checkDirty: function() {
+ var me = this,
+ isDirty = me.isDirty();
+ if (isDirty !== me.wasDirty) {
+ me.fireEvent('dirtychange', me, isDirty);
+ me.onDirtyChange(isDirty);
+ me.wasDirty = isDirty;
}
- return false;
},
- /**
- * This method should only be overridden if necessary to prepare raw values
- * for validation (see {@link #validate} and {@link #isValid}). This method
- * is expected to return the processed value for the field which will
- * be used for validation (see validateValue method).
- * @param {Mixed} value
+ /**
+ * @private Called when the field's dirty state changes.
+ * @param {Boolean} isDirty
*/
- processValue : function(value){
- return value;
- },
+ onDirtyChange: Ext.emptyFn,
- /**
- * Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
- * with the first and false is returned, otherwise true is returned. Previously, subclasses were invited
- * to provide an implementation of this to process validations - from 3.2 onwards getErrors should be
- * overridden instead.
- * @param {Mixed} The current value of the field
- * @return {Boolean} True if all validations passed, false if one or more failed
+ /**
+ * <p>Runs this field's validators and returns an array of error messages for any validation failures.
+ * This is called internally during validation and would not usually need to be used manually.</p>
+ * <p>Each subclass should override or augment the return value to provide their own errors.</p>
+ * @param {Mixed} value The value to get errors for (defaults to the current field value)
+ * @return {Array} All error messages for this field; an empty Array if none.
*/
- validateValue : function(value) {
- //currently, we only show 1 error at a time for a field, so just use the first one
- var error = this.getErrors(value)[0];
-
- if (error == undefined) {
- return true;
- } else {
- this.markInvalid(error);
- return false;
- }
- },
-
- /**
- * Runs this field's validators and returns an array of error messages for any validation failures.
- * This is called internally during validation and would not usually need to be used manually.
- * Each subclass should override or augment the return value to provide their own errors
- * @return {Array} All error messages for this field
- */
- getErrors: function() {
+ getErrors: function(value) {
return [];
},
- /**
- * Gets the active error message for this field.
- * @return {String} Returns the active error message on the field, if there is no error, an empty string is returned.
+ /**
+ * <p>Returns whether or not the field value is currently valid by {@link #getErrors validating} the
+ * field's current value. The {@link #validitychange} event will not be fired; use {@link #validate}
+ * instead if you want the event to fire. <b>Note</b>: {@link #disabled} fields are always treated as valid.</p>
+ * <p>Implementations are encouraged to ensure that this method does not have side-effects such as
+ * triggering error message display.</p>
+ * @return {Boolean} True if the value is valid, else false
*/
- getActiveError : function(){
- return this.activeError || '';
+ isValid : function() {
+ var me = this;
+ return me.disabled || Ext.isEmpty(me.getErrors());
},
- /**
- * Display an error message associated with this field, using {@link #msgTarget} to determine how to
- * display the message and applying {@link #invalidClass} to the field's UI element.
- * Note: this method does not cause the Field's {@link #validate} method to return false
- * if the value does pass validation. So simply marking a Field as invalid will not prevent
- * submission of forms submitted with the {@link Ext.form.Action.Submit#clientValidation} option set.
- * {@link #isValid invalid}.
- * @param {String} msg (optional) The validation message (defaults to {@link #invalidText})
- */
- markInvalid : function(msg){
- //don't set the error icon if we're not rendered or marking is prevented
- if (this.rendered && !this.preventMark) {
- msg = msg || this.invalidText;
-
- var mt = this.getMessageHandler();
- if(mt){
- mt.mark(this, msg);
- }else if(this.msgTarget){
- this.el.addClass(this.invalidClass);
- var t = Ext.getDom(this.msgTarget);
- if(t){
- t.innerHTML = msg;
- t.style.display = this.msgDisplay;
- }
- }
- }
-
- this.setActiveError(msg);
- },
-
- /**
- * Clear any invalid styles/messages for this field
+ /**
+ * <p>Returns whether or not the field value is currently valid by {@link #getErrors validating} the
+ * field's current value, and fires the {@link #validitychange} event if the field's validity has
+ * changed since the last validation. <b>Note</b>: {@link #disabled} fields are always treated as valid.</p>
+ * <p>Custom implementations of this method are allowed to have side-effects such as triggering error
+ * message display. To validate without side-effects, use {@link #isValid}.</p>
+ * @return {Boolean} True if the value is valid, else false
*/
- clearInvalid : function(){
- //don't remove the error icon if we're not rendered or marking is prevented
- if (this.rendered && !this.preventMark) {
- this.el.removeClass(this.invalidClass);
- var mt = this.getMessageHandler();
- if(mt){
- mt.clear(this);
- }else if(this.msgTarget){
- this.el.removeClass(this.invalidClass);
- var t = Ext.getDom(this.msgTarget);
- if(t){
- t.innerHTML = '';
- t.style.display = 'none';
- }
- }
+ validate : function() {
+ var me = this,
+ isValid = me.isValid();
+ if (isValid !== me.wasValid) {
+ me.wasValid = isValid;
+ me.fireEvent('validitychange', me, isValid);
}
-
- this.unsetActiveError();
- },
-
- /**
- * Sets the current activeError to the given string. Fires the 'invalid' event.
- * This does not set up the error icon, only sets the message and fires the event. To show the error icon,
- * use markInvalid instead, which calls this method internally
- * @param {String} msg The error message
- * @param {Boolean} suppressEvent True to suppress the 'invalid' event from being fired
- */
- setActiveError: function(msg, suppressEvent) {
- this.activeError = msg;
- if (suppressEvent !== true) this.fireEvent('invalid', this, msg);
- },
-
- /**
- * Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
- * usually need to be called manually
- * @param {Boolean} suppressEvent True to suppress the 'invalid' event from being fired
- */
- unsetActiveError: function(suppressEvent) {
- delete this.activeError;
- if (suppressEvent !== true) this.fireEvent('valid', this);
- },
-
- // private
- getMessageHandler : function(){
- return Ext.form.MessageTargets[this.msgTarget];
- },
-
- // private
- getErrorCt : function(){
- return this.el.findParent('.x-form-element', 5, true) || // use form element wrap if available
- this.el.findParent('.x-form-field-wrap', 5, true); // else direct field wrap
- },
-
- // Alignment for 'under' target
- alignErrorEl : function(){
- this.errorEl.setWidth(this.getErrorCt().getWidth(true) - 20);
+ return isValid;
},
- // Alignment for 'side' target
- alignErrorIcon : function(){
- this.errorIcon.alignTo(this.el, 'tl-tr', [2, 0]);
- },
-
- /**
- * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.
- * @return {Mixed} value The field value
+ /**
+ * A utility for grouping a set of modifications which may trigger value changes into a single
+ * transaction, to prevent excessive firing of {@link #change} events. This is useful for instance
+ * if the field has sub-fields which are being updated as a group; you don't want the container
+ * field to check its own changed state for each subfield change.
+ * @param fn A function containing the transaction code
*/
- getRawValue : function(){
- var v = this.rendered ? this.el.getValue() : Ext.value(this.value, '');
- if(v === this.emptyText){
- v = '';
- }
- return v;
+ batchChanges: function(fn) {
+ this.suspendCheckChange++;
+ fn();
+ this.suspendCheckChange--;
+ this.checkChange();
},
- /**
- * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.
- * @return {Mixed} value The field value
+ /**
+ * Returns whether this Field is a file upload field; if it returns true, forms will use
+ * special techniques for {@link Ext.form.Basic#submit submitting the form} via AJAX. See
+ * {@link Ext.form.Basic#hasUpload} for details. If this returns true, the {@link #extractFileInput}
+ * method must also be implemented to return the corresponding file input element.
+ * @return {Boolean}
*/
- getValue : function(){
- if(!this.rendered) {
- return this.value;
- }
- var v = this.el.getValue();
- if(v === this.emptyText || v === undefined){
- v = '';
- }
- return v;
+ isFileUpload: function() {
+ return false;
},
- /**
- * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.
- * @param {Mixed} value The value to set
- * @return {Mixed} value The field value that is set
+ /**
+ * Only relevant if the instance's {@link #isFileUpload} method returns true. Returns a reference
+ * to the file input DOM element holding the user's selected file. The input will be appended into
+ * the submission form and will not be returned, so this method should also create a replacement.
+ * @return {HTMLInputElement}
*/
- setRawValue : function(v){
- return this.rendered ? (this.el.dom.value = (Ext.isEmpty(v) ? '' : v)) : '';
+ extractFileInput: function() {
+ return null;
},
- /**
- * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.
- * @param {Mixed} value The value to set
- * @return {Ext.form.Field} this
+ /**
+ * <p>Associate one or more error messages with this field. Components using this mixin should implement
+ * this method to update the component's rendering to display the messages.</p>
+ * <p><b>Note</b>: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to
+ * return <code>false</code> if the value does <i>pass</i> validation. So simply marking a Field as invalid
+ * will not prevent submission of forms submitted with the {@link Ext.form.action.Submit#clientValidation}
+ * option set.</p>
+ * @param {String/Array} errors The error message(s) for the field.
*/
- setValue : function(v){
- this.value = v;
- if(this.rendered){
- this.el.dom.value = (Ext.isEmpty(v) ? '' : v);
- this.validate();
- }
- return this;
- },
+ markInvalid: Ext.emptyFn,
- // private, does not work for all fields
- append : function(v){
- this.setValue([this.getValue(), v].join(''));
- }
-
- /**
- * @cfg {Boolean} autoWidth @hide
- */
- /**
- * @cfg {Boolean} autoHeight @hide
+ /**
+ * <p>Clear any invalid styles/messages for this field. Components using this mixin should implement
+ * this method to update the components rendering to clear any existing messages.</p>
+ * <p><b>Note</b>: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to
+ * return <code>true</code> if the value does not <i>pass</i> validation. So simply clearing a field's errors
+ * will not necessarily allow submission of forms submitted with the {@link Ext.form.action.Submit#clientValidation}
+ * option set.</p>
*/
+ clearInvalid: Ext.emptyFn
- /**
- * @cfg {String} autoEl @hide
- */
});
-
-
-Ext.form.MessageTargets = {
- 'qtip' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- field.el.dom.qtip = msg;
- field.el.dom.qclass = 'x-form-invalid-tip';
- if(Ext.QuickTips){ // fix for floating editors interacting with DND
- Ext.QuickTips.enable();
- }
- },
- clear: function(field){
- field.el.removeClass(field.invalidClass);
- field.el.dom.qtip = '';
- }
- },
- 'title' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- field.el.dom.title = msg;
- },
- clear: function(field){
- field.el.dom.title = '';
- }
- },
- 'under' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- if(!field.errorEl){
- var elp = field.getErrorCt();
- if(!elp){ // field has no container el
- field.el.dom.title = msg;
- return;
- }
- field.errorEl = elp.createChild({cls:'x-form-invalid-msg'});
- field.on('resize', field.alignErrorEl, field);
- field.on('destroy', function(){
- Ext.destroy(this.errorEl);
- }, field);
- }
- field.alignErrorEl();
- field.errorEl.update(msg);
- Ext.form.Field.msgFx[field.msgFx].show(field.errorEl, field);
- },
- clear: function(field){
- field.el.removeClass(field.invalidClass);
- if(field.errorEl){
- Ext.form.Field.msgFx[field.msgFx].hide(field.errorEl, field);
- }else{
- field.el.dom.title = '';
- }
- }
- },
- 'side' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- if(!field.errorIcon){
- var elp = field.getErrorCt();
- // field has no container el
- if(!elp){
- field.el.dom.title = msg;
- return;
- }
- field.errorIcon = elp.createChild({cls:'x-form-invalid-icon'});
- if (field.ownerCt) {
- field.ownerCt.on('afterlayout', field.alignErrorIcon, field);
- field.ownerCt.on('expand', field.alignErrorIcon, field);
- }
- field.on('resize', field.alignErrorIcon, field);
- field.on('destroy', function(){
- Ext.destroy(this.errorIcon);
- }, field);
- }
- field.alignErrorIcon();
- field.errorIcon.dom.qtip = msg;
- field.errorIcon.dom.qclass = 'x-form-invalid-tip';
- field.errorIcon.show();
- },
- clear: function(field){
- field.el.removeClass(field.invalidClass);
- if(field.errorIcon){
- field.errorIcon.dom.qtip = '';
- field.errorIcon.hide();
- }else{
- field.el.dom.title = '';
- }
- }
- }
-};
-
-// anything other than normal should be considered experimental
-Ext.form.Field.msgFx = {
- normal : {
- show: function(msgEl, f){
- msgEl.setDisplayed('block');
- },
-
- hide : function(msgEl, f){
- msgEl.setDisplayed(false).update('');
- }
- },
-
- slide : {
- show: function(msgEl, f){
- msgEl.slideIn('t', {stopFx:true});
- },
-
- hide : function(msgEl, f){
- msgEl.slideOut('t', {stopFx:true,useDisplay:true});
- }
- },
-
- slideRight : {
- show: function(msgEl, f){
- msgEl.fixDisplay();
- msgEl.alignTo(f.el, 'tl-tr');
- msgEl.slideIn('l', {stopFx:true});
- },
-
- hide : function(msgEl, f){
- msgEl.slideOut('l', {stopFx:true,useDisplay:true});
- }
- }
-};
-Ext.reg('field', Ext.form.Field);
-
-
-
\ No newline at end of file
+
\ No newline at end of file