Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Hidden.html
index 78a8013..a2c79ed 100644 (file)
@@ -1,46 +1,62 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-form.field.Hidden-method-constructor'><span id='Ext-form.field.Hidden'>/**
-</span></span> * @class Ext.form.field.Hidden
- * @extends Ext.form.field.Base
- * &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;
- * &lt;p&gt;This creates an actual input element with type=&quot;submit&quot; 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.&lt;/p&gt;
- * &lt;p&gt;Because of this, in most cases it is more convenient and less problematic to simply
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-form-field-Hidden'>/**
+</span> * 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=&quot;submit&quot; 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}.&lt;/p&gt;
- * &lt;p&gt;Example:&lt;/p&gt;
- * &lt;pre&gt;&lt;code&gt;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'
-                }
-            });
-        }
-    }]
-});&lt;/code&gt;&lt;/pre&gt;
- * &lt;p&gt;Submitting the above form will result in three values sent to the server:
- * &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;
+ * {@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&amp;hidden;_field_1=value+from+hidden+field&amp;hidden_field_2=value+from+submit+call
  *
- * @constructor
- * Create a new Hidden field.
- * @param {Object} config Configuration options
- * 
- * @xtype hiddenfield
  */
 Ext.define('Ext.form.field.Hidden', {
     extend:'Ext.form.field.Base',
@@ -55,6 +71,14 @@ Ext.define('Ext.form.field.Hidden', {
         this.formItemCls += '-hidden';
         this.callParent();    
     },
+    
+<span id='Ext-form-field-Hidden-method-isEqual'>    /**
+</span>     * @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,
@@ -66,4 +90,6 @@ Ext.define('Ext.form.field.Hidden', {
     markInvalid : Ext.emptyFn,
     clearInvalid : Ext.emptyFn
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>