docs/source/Hidden.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-form-field-Hidden-method-constructor'><span id='Ext-form-field-Hidden'>/**
  19 </span></span> * @class Ext.form.field.Hidden
  20  * @extends Ext.form.field.Base
  21  * &lt;p&gt;A basic hidden field for storing hidden values in forms that need to be passed in the form submit.&lt;/p&gt;
  22  * &lt;p&gt;This creates an actual input element with type=&quot;submit&quot; in the DOM. While its label is
  23  * {@link #hideLabel not rendered} by default, it is still a real component and may be sized according to
  24  * its owner container's layout.&lt;/p&gt;
  25  * &lt;p&gt;Because of this, in most cases it is more convenient and less problematic to simply
  26  * {@link Ext.form.action.Action#params pass hidden parameters} directly when
  27  * {@link Ext.form.Basic#submit submitting the form}.&lt;/p&gt;
  28  * &lt;p&gt;Example:&lt;/p&gt;
  29  * &lt;pre&gt;&lt;code&gt;new Ext.form.Panel({
  30     title: 'My Form',
  31     items: [{
  32         xtype: 'textfield',
  33         fieldLabel: 'Text Field',
  34         name: 'text_field',
  35         value: 'value from text field'
  36     }, {
  37         xtype: 'hiddenfield',
  38         name: 'hidden_field_1',
  39         value: 'value from hidden field'
  40     }],
  41
  42     buttons: [{
  43         text: 'Submit',
  44         handler: function() {
  45             this.up('form').getForm().submit({
  46                 params: {
  47                     hidden_field_2: 'value from submit call'
  48                 }
  49             });
  50         }
  51     }]
  52 });&lt;/code&gt;&lt;/pre&gt;
  53  * &lt;p&gt;Submitting the above form will result in three values sent to the server:
  54  * &lt;code&gt;text_field=value+from+text+field&amp;hidden_field_1=value+from+hidden+field&amp;&lt;br&gt;hidden_field_2=value+from+submit+call&lt;/code&gt;&lt;/p&gt;
  55  *
  56  * @constructor
  57  * Create a new Hidden field.
  58  * @param {Object} config Configuration options
  59  *
  60  * @xtype hiddenfield
  61  */
  62 Ext.define('Ext.form.field.Hidden', {
  63     extend:'Ext.form.field.Base',
  64     alias: ['widget.hiddenfield', 'widget.hidden'],
  65     alternateClassName: 'Ext.form.Hidden',
  66
  67     // private
  68     inputType : 'hidden',
  69     hideLabel: true,
  70
  71     initComponent: function(){
  72         this.formItemCls += '-hidden';
  73         this.callParent();
  74     },
  75
  76     // These are all private overrides
  77     initEvents: Ext.emptyFn,
  78     setSize : Ext.emptyFn,
  79     setWidth : Ext.emptyFn,
  80     setHeight : Ext.emptyFn,
  81     setPosition : Ext.emptyFn,
  82     setPagePosition : Ext.emptyFn,
  83     markInvalid : Ext.emptyFn,
  84     clearInvalid : Ext.emptyFn
  85 });
  86 </pre>
  87 </body>
  88 </html>