Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Editor.html
index 6308584..6c2f4ae 100644 (file)
@@ -1,5 +1,22 @@
-<!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-Editor-method-constructor'><span id='Ext-Editor'>/**
-</span></span> * @class Ext.Editor
+<!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-Editor'>/**
+</span> * @class Ext.Editor
  * @extends Ext.Component
  *
  * &lt;p&gt;
@@ -33,10 +50,6 @@ editor.startEdit(el); // The value of the field will be taken as the innerHTML o
  * &lt;/code&gt;&lt;/pre&gt;
  * {@img Ext.Editor/Ext.Editor.png Ext.Editor component}
  *
- * @constructor
- * Create a new Editor
- * @param {Object} config The config object
- * @xtype editor
  */
 Ext.define('Ext.Editor', {
 
@@ -60,7 +73,7 @@ Ext.define('Ext.Editor', {
 <span id='Ext-Editor-cfg-allowBlur'>    /**
 </span>     * @cfg {Boolean} allowBlur
      * True to {@link #completeEdit complete the editing process} if in edit mode when the
-     * field is blurred. Defaults to &lt;tt&gt;true&lt;/tt&gt;.
+     * field is blurred.
      */
     allowBlur: true,
 
@@ -89,73 +102,79 @@ autoSize: {
 <span id='Ext-Editor-cfg-revertInvalid'>    /**
 </span>     * @cfg {Boolean} revertInvalid
      * True to automatically revert the field value and cancel the edit when the user completes an edit and the field
-     * validation fails (defaults to true)
+     * validation fails
      */
     revertInvalid: true,
 
 <span id='Ext-Editor-cfg-ignoreNoChange'>    /**
-</span>     * @cfg {Boolean} ignoreNoChange
+</span>     * @cfg {Boolean} [ignoreNoChange=false]
      * True to skip the edit completion process (no save, no events fired) if the user completes an edit and
-     * the value has not changed (defaults to false).  Applies only to string values - edits for other data types
+     * the value has not changed.  Applies only to string values - edits for other data types
      * will never be ignored.
      */
 
 <span id='Ext-Editor-cfg-hideEl'>    /**
-</span>     * @cfg {Boolean} hideEl
-     * False to keep the bound element visible while the editor is displayed (defaults to true)
+</span>     * @cfg {Boolean} [hideEl=true]
+     * False to keep the bound element visible while the editor is displayed
      */
 
 <span id='Ext-Editor-cfg-value'>    /**
-</span>     * @cfg {Mixed} value
-     * The data value of the underlying field (defaults to &quot;&quot;)
+</span>     * @cfg {Object} value
+     * The data value of the underlying field
      */
     value : '',
 
 <span id='Ext-Editor-cfg-alignment'>    /**
 </span>     * @cfg {String} alignment
-     * The position to align to (see {@link Ext.core.Element#alignTo} for more details, defaults to &quot;c-c?&quot;).
+     * The position to align to (see {@link Ext.Element#alignTo} for more details).
      */
     alignment: 'c-c?',
 
 <span id='Ext-Editor-cfg-offsets'>    /**
-</span>     * @cfg {Array} offsets
-     * The offsets to use when aligning (see {@link Ext.core.Element#alignTo} for more details. Defaults to &lt;tt&gt;[0, 0]&lt;/tt&gt;.
+</span>     * @cfg {Number[]} offsets
+     * The offsets to use when aligning (see {@link Ext.Element#alignTo} for more details.
      */
     offsets: [0, 0],
 
 <span id='Ext-Editor-cfg-shadow'>    /**
-</span>     * @cfg {Boolean/String} shadow &quot;sides&quot; for sides/bottom only, &quot;frame&quot; for 4-way shadow, and &quot;drop&quot;
-     * for bottom-right shadow (defaults to &quot;frame&quot;)
+</span>     * @cfg {Boolean/String} shadow
+     * &quot;sides&quot; for sides/bottom only, &quot;frame&quot; for 4-way shadow, and &quot;drop&quot; for bottom-right shadow.
      */
     shadow : 'frame',
 
 <span id='Ext-Editor-cfg-constrain'>    /**
-</span>     * @cfg {Boolean} constrain True to constrain the editor to the viewport
+</span>     * @cfg {Boolean} constrain
+     * True to constrain the editor to the viewport
      */
     constrain : false,
 
 <span id='Ext-Editor-cfg-swallowKeys'>    /**
-</span>     * @cfg {Boolean} swallowKeys Handle the keydown/keypress events so they don't propagate (defaults to true)
+</span>     * @cfg {Boolean} swallowKeys
+     * Handle the keydown/keypress events so they don't propagate
      */
     swallowKeys : true,
 
 <span id='Ext-Editor-cfg-completeOnEnter'>    /**
-</span>     * @cfg {Boolean} completeOnEnter True to complete the edit when the enter key is pressed. Defaults to &lt;tt&gt;true&lt;/tt&gt;.
+</span>     * @cfg {Boolean} completeOnEnter
+     * True to complete the edit when the enter key is pressed.
      */
     completeOnEnter : true,
 
 <span id='Ext-Editor-cfg-cancelOnEsc'>    /**
-</span>     * @cfg {Boolean} cancelOnEsc True to cancel the edit when the escape key is pressed. Defaults to &lt;tt&gt;true&lt;/tt&gt;.
+</span>     * @cfg {Boolean} cancelOnEsc
+     * True to cancel the edit when the escape key is pressed.
      */
     cancelOnEsc : true,
 
 <span id='Ext-Editor-cfg-updateEl'>    /**
-</span>     * @cfg {Boolean} updateEl True to update the innerHTML of the bound element when the update completes (defaults to false)
+</span>     * @cfg {Boolean} updateEl
+     * True to update the innerHTML of the bound element when the update completes
      */
     updateEl : false,
 
 <span id='Ext-Editor-cfg-parentEl'>    /**
-</span>     * @cfg {Mixed} parentEl An element to render to. Defaults to the &lt;tt&gt;document.body&lt;/tt&gt;.
+</span>     * @cfg {String/HTMLElement/Ext.Element} parentEl
+     * An element to render to. Defaults to the &lt;tt&gt;document.body&lt;/tt&gt;.
      */
 
     // private overrides
@@ -195,43 +214,45 @@ autoSize: {
              * Fires when editing is initiated, but before the value changes.  Editing can be canceled by returning
              * false from the handler of this event.
              * @param {Ext.Editor} this
-             * @param {Ext.core.Element} boundEl The underlying element bound to this editor
-             * @param {Mixed} value The field value being set
+             * @param {Ext.Element} boundEl The underlying element bound to this editor
+             * @param {Object} value The field value being set
              */
             'beforestartedit',
+
 <span id='Ext-Editor-event-startedit'>            /**
 </span>             * @event startedit
              * Fires when this editor is displayed
              * @param {Ext.Editor} this
-             * @param {Ext.core.Element} boundEl The underlying element bound to this editor
-             * @param {Mixed} value The starting field value
+             * @param {Ext.Element} boundEl The underlying element bound to this editor
+             * @param {Object} value The starting field value
              */
             'startedit',
+
 <span id='Ext-Editor-event-beforecomplete'>            /**
 </span>             * @event beforecomplete
              * Fires after a change has been made to the field, but before the change is reflected in the underlying
              * field.  Saving the change to the field can be canceled by returning false from the handler of this event.
              * Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this
              * event will not fire since no edit actually occurred.
-             * @param {Editor} this
-             * @param {Mixed} value The current field value
-             * @param {Mixed} startValue The original field value
+             * @param {Ext.Editor} this
+             * @param {Object} value The current field value
+             * @param {Object} startValue The original field value
              */
             'beforecomplete',
 <span id='Ext-Editor-event-complete'>            /**
 </span>             * @event complete
              * Fires after editing is complete and any changed value has been written to the underlying field.
              * @param {Ext.Editor} this
-             * @param {Mixed} value The current field value
-             * @param {Mixed} startValue The original field value
+             * @param {Object} value The current field value
+             * @param {Object} startValue The original field value
              */
             'complete',
 <span id='Ext-Editor-event-canceledit'>            /**
 </span>             * @event canceledit
              * Fires after editing has been canceled and the editor's value has been reset.
              * @param {Ext.Editor} this
-             * @param {Mixed} value The user-entered field value that was discarded
-             * @param {Mixed} startValue The original field value that was set back into the editor after cancel
+             * @param {Object} value The user-entered field value that was discarded
+             * @param {Object} startValue The original field value that was set back into the editor after cancel
              */
             'canceledit',
 <span id='Ext-Editor-event-specialkey'>            /**
@@ -254,19 +275,22 @@ autoSize: {
     // private
     onRender : function(ct, position) {
         var me = this,
-            field = me.field;
+            field = me.field,
+            inputEl = field.inputEl;
 
         me.callParent(arguments);
 
         field.render(me.el);
         //field.hide();
         // Ensure the field doesn't get submitted as part of any form
-        field.inputEl.dom.name = '';
-        if (me.swallowKeys) {
-            field.inputEl.swallowEvent([
-                'keypress', // *** Opera
-                'keydown'   // *** all other browsers
-            ]);
+        if (inputEl) {
+            inputEl.dom.name = '';
+            if (me.swallowKeys) {
+                inputEl.swallowEvent([
+                    'keypress', // *** Opera
+                    'keydown'   // *** all other browsers
+                ]);
+            }
         }
     },
 
@@ -298,7 +322,7 @@ autoSize: {
 
 <span id='Ext-Editor-method-startEdit'>    /**
 </span>     * Starts the editing process and shows the editor.
-     * @param {Mixed} el The element to edit
+     * @param {String/HTMLElement/Ext.Element} el The element to edit
      * @param {String} value (optional) A value to initialize the editor with. If a value is not provided, it defaults
       * to the innerHTML of el.
      */
@@ -342,7 +366,7 @@ autoSize: {
 
 <span id='Ext-Editor-method-completeEdit'>    /**
 </span>     * Ends the editing process, persists the changed value to the underlying field, and hides the editor.
-     * @param {Boolean} remainVisible Override the default behavior and keep the editor visible after edit (defaults to false)
+     * @param {Boolean} [remainVisible=false] Override the default behavior and keep the editor visible after edit
      */
     completeEdit : function(remainVisible) {
         var me = this,
@@ -396,8 +420,7 @@ autoSize: {
 <span id='Ext-Editor-method-cancelEdit'>    /**
 </span>     * Cancels the editing process and hides the editor without persisting any changes.  The field value will be
      * reverted to the original starting value.
-     * @param {Boolean} remainVisible Override the default behavior and keep the editor visible after
-     * cancel (defaults to false)
+     * @param {Boolean} [remainVisible=false] Override the default behavior and keep the editor visible after cancel
      */
     cancelEdit : function(remainVisible) {
         var me = this,
@@ -453,7 +476,7 @@ autoSize: {
 
 <span id='Ext-Editor-method-setValue'>    /**
 </span>     * Sets the data value of the editor
-     * @param {Mixed} value Any valid value supported by the underlying field
+     * @param {Object} value Any valid value supported by the underlying field
      */
     setValue : function(value) {
         this.field.setValue(value);
@@ -461,7 +484,7 @@ autoSize: {
 
 <span id='Ext-Editor-method-getValue'>    /**
 </span>     * Gets the data value of the editor
-     * @return {Mixed} The data value
+     * @return {Object} The data value
      */
     getValue : function() {
         return this.field.getValue();
@@ -477,4 +500,6 @@ autoSize: {
 
         me.callParent(arguments);
     }
-});</pre></pre></body></html>
\ No newline at end of file
+});</pre>
+</body>
+</html>