Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Proxy.html
index db12f1d..84a6a62 100644 (file)
@@ -1,19 +1,37 @@
-<!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-panel.Proxy-method-constructor'><span id='Ext-panel.Proxy'>/**
-</span></span> * @class Ext.panel.Proxy
- * @extends Object
- * A custom drag proxy implementation specific to {@link Ext.panel.Panel}s. This class
+<!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-panel-Proxy'>/**
+</span> * A custom drag proxy implementation specific to {@link Ext.panel.Panel}s. This class
  * is primarily used internally for the Panel's drag drop implementation, and
  * should never need to be created directly.
- * @constructor
- * @param panel The {@link Ext.panel.Panel} to proxy for
- * @param config Configuration options
+ * @private
  */
 Ext.define('Ext.panel.Proxy', {
-    
+
     alternateClassName: 'Ext.dd.PanelProxy',
-    
+
+<span id='Ext-panel-Proxy-method-constructor'>    /**
+</span>     * Creates new panel proxy.
+     * @param {Ext.panel.Panel} panel The {@link Ext.panel.Panel} to proxy for
+     * @param {Object} [config] Config object
+     */
     constructor: function(panel, config){
-<span id='Ext-panel.Proxy-property-panel'>        /**
+<span id='Ext-panel-Proxy-property-panel'>        /**
 </span>         * @property panel
          * @type Ext.panel.Panel
          */
@@ -22,11 +40,10 @@ Ext.define('Ext.panel.Proxy', {
         Ext.apply(this, config);
     },
 
-<span id='Ext-panel.Proxy-cfg-insertProxy'>    /**
-</span>     * @cfg {Boolean} insertProxy True to insert a placeholder proxy element
-     * while dragging the panel, false to drag with no proxy (defaults to true).
-     * Most Panels are not absolute positioned and therefore we need to reserve
-     * this space.
+<span id='Ext-panel-Proxy-cfg-insertProxy'>    /**
+</span>     * @cfg {Boolean} insertProxy
+     * True to insert a placeholder proxy element while dragging the panel, false to drag with no proxy.
+     * Most Panels are not absolute positioned and therefore we need to reserve this space.
      */
     insertProxy: true,
 
@@ -37,32 +54,32 @@ Ext.define('Ext.panel.Proxy', {
     stop: Ext.emptyFn,
     sync: Ext.emptyFn,
 
-<span id='Ext-panel.Proxy-method-getEl'>    /**
+<span id='Ext-panel-Proxy-method-getEl'>    /**
 </span>     * Gets the proxy's element
-     * @return {Element} The proxy's element
+     * @return {Ext.Element} The proxy's element
      */
     getEl: function(){
         return this.ghost.el;
     },
 
-<span id='Ext-panel.Proxy-method-getGhost'>    /**
+<span id='Ext-panel-Proxy-method-getGhost'>    /**
 </span>     * Gets the proxy's ghost Panel
-     * @return {Panel} The proxy's ghost Panel
+     * @return {Ext.panel.Panel} The proxy's ghost Panel
      */
     getGhost: function(){
         return this.ghost;
     },
 
-<span id='Ext-panel.Proxy-method-getProxy'>    /**
+<span id='Ext-panel-Proxy-method-getProxy'>    /**
 </span>     * Gets the proxy element. This is the element that represents where the
      * Panel was before we started the drag operation.
-     * @return {Element} The proxy's element
+     * @return {Ext.Element} The proxy's element
      */
     getProxy: function(){
         return this.proxy;
     },
 
-<span id='Ext-panel.Proxy-method-hide'>    /**
+<span id='Ext-panel-Proxy-method-hide'>    /**
 </span>     * Hides the proxy
      */
     hide : function(){
@@ -78,13 +95,13 @@ Ext.define('Ext.panel.Proxy', {
         }
     },
 
-<span id='Ext-panel.Proxy-method-show'>    /**
+<span id='Ext-panel-Proxy-method-show'>    /**
 </span>     * Shows the proxy
      */
     show: function(){
         if (!this.ghost) {
             var panelSize = this.panel.getSize();
-            this.panel.el.setVisibilityMode(Ext.core.Element.DISPLAY);
+            this.panel.el.setVisibilityMode(Ext.Element.DISPLAY);
             this.ghost = this.panel.ghost();
             if (this.insertProxy) {
                 // bc Panels aren't absolute positioned we need to take up the space
@@ -103,12 +120,12 @@ Ext.define('Ext.panel.Proxy', {
         }
     },
 
-<span id='Ext-panel.Proxy-method-moveProxy'>    /**
+<span id='Ext-panel-Proxy-method-moveProxy'>    /**
 </span>     * Moves the proxy to a different position in the DOM.  This is typically
      * called while dragging the Panel to keep the proxy sync'd to the Panel's
      * location.
      * @param {HTMLElement} parentNode The proxy's parent DOM node
-     * @param {HTMLElement} before (optional) The sibling node before which the
+     * @param {HTMLElement} [before] The sibling node before which the
      * proxy should be inserted (defaults to the parent's last child if not
      * specified)
      */
@@ -117,4 +134,6 @@ Ext.define('Ext.panel.Proxy', {
             parentNode.insertBefore(this.proxy.dom, before);
         }
     }
-});</pre></pre></body></html>
\ No newline at end of file
+});</pre>
+</body>
+</html>