X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6e39d509471fe9b4e2660e0d1631b350d0c66f40..HEAD:/docs/source/Hidden.html diff --git a/docs/source/Hidden.html b/docs/source/Hidden.html index e1b3667f..a2c79ed6 100644 --- a/docs/source/Hidden.html +++ b/docs/source/Hidden.html @@ -1,43 +1,95 @@ - -
- -/** - * @class Ext.form.Hidden - * @extends Ext.form.Field - * A basic hidden field for storing hidden values in forms that need to be passed in the form submit. - * @constructor - * Create a new Hidden field. - * @param {Object} config Configuration options - * @xtype hidden - */ -Ext.form.Hidden = Ext.extend(Ext.form.Field, { - // private - inputType : 'hidden', - - // private - onRender : function(){ - Ext.form.Hidden.superclass.onRender.apply(this, arguments); - }, - - // private - initEvents : function(){ - this.originalValue = this.getValue(); - }, - - // These are all private overrides - setSize : Ext.emptyFn, - setWidth : Ext.emptyFn, - setHeight : Ext.emptyFn, - setPosition : Ext.emptyFn, - setPagePosition : Ext.emptyFn, - markInvalid : Ext.emptyFn, - clearInvalid : Ext.emptyFn -}); -Ext.reg('hidden', Ext.form.Hidden);- - \ No newline at end of file + + + + +
/** + * A basic hidden field for storing hidden values in forms that need to be passed in the form submit. + * + * This creates an actual input element with type="submit" in the DOM. While its label is + * {@link #hideLabel not rendered} by default, it is still a real component and may be sized according + * to its owner container's layout. + * + * Because of this, in most cases it is more convenient and less problematic to simply + * {@link Ext.form.action.Action#params pass hidden parameters} directly when + * {@link Ext.form.Basic#submit submitting the form}. + * + * Example: + * + * new Ext.form.Panel({ + * title: 'My Form', + * items: [{ + * xtype: 'textfield', + * fieldLabel: 'Text Field', + * name: 'text_field', + * value: 'value from text field' + * }, { + * xtype: 'hiddenfield', + * name: 'hidden_field_1', + * value: 'value from hidden field' + * }], + * + * buttons: [{ + * text: 'Submit', + * handler: function() { + * this.up('form').getForm().submit({ + * params: { + * hidden_field_2: 'value from submit call' + * } + * }); + * } + * }] + * }); + * + * Submitting the above form will result in three values sent to the server: + * + * text_field=value+from+text+field&hidden;_field_1=value+from+hidden+field&hidden_field_2=value+from+submit+call + * + */ +Ext.define('Ext.form.field.Hidden', { + extend:'Ext.form.field.Base', + alias: ['widget.hiddenfield', 'widget.hidden'], + alternateClassName: 'Ext.form.Hidden', + + // private + inputType : 'hidden', + hideLabel: true, + + initComponent: function(){ + this.formItemCls += '-hidden'; + this.callParent(); + }, + + /** + * @private + * Override. Treat undefined and null values as equal to an empty string value. + */ + isEqual: function(value1, value2) { + return this.isEqualAsString(value1, value2); + }, + + // These are all private overrides + initEvents: Ext.emptyFn, + setSize : Ext.emptyFn, + setWidth : Ext.emptyFn, + setHeight : Ext.emptyFn, + setPosition : Ext.emptyFn, + setPagePosition : Ext.emptyFn, + markInvalid : Ext.emptyFn, + clearInvalid : Ext.emptyFn +}); ++ +