Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.panel.Proxy.html
1 <!DOCTYPE html><html><head><title>Ext.panel.Proxy | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.panel.Proxy',
13         docClass: 'Ext.panel.Proxy',
14         docReq: 'Ext.panel.Proxy',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Proxy.html#Ext-panel.Proxy';
33     clsInfo = {"methods":["Proxy","getEl","getGhost","getProxy","hide","moveProxy","show"],"cfgs":["insertProxy"],"properties":["panel"],"events":[],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Proxy.html#Ext-panel.Proxy" target="_blank">Ext.panel.Proxy</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><p>A custom drag proxy implementation specific to <a href="Ext.panel.Panel.html" rel="Ext.panel.Panel" class="docClass">Ext.panel.Panel</a>s. This class
38 is primarily used internally for the Panel's drag drop implementation, and
39 should never need to be created directly.</p>
40 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-insertProxy" class="member f ni"><a href="Ext.panel.Proxy.html#config-insertProxy" rel="config-insertProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-cfg-insertProxy" class="viewSource">view source</a></div><a name="insertProxy"></a><a name="config-insertProxy"></a><a href="Ext.panel.Proxy.html#" rel="config-insertProxy" class="cls expand">insertProxy</a><span> : Boolean</span></div><div class="description"><div class="short">True to insert a placeholder proxy element
41 while dragging the panel, false to drag with no proxy (defaults to true).
42 ...</div><div class="long"><p>True to insert a placeholder proxy element
43 while dragging the panel, false to drag with no proxy (defaults to true).
44 Most Panels are not absolute positioned and therefore we need to reserve
45 this space.</p>
46 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-panel" class="member f ni"><a href="Ext.panel.Proxy.html#property-panel" rel="property-panel" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-property-panel" class="viewSource">view source</a></div><a name="panel"></a><a name="property-panel"></a><a href="Ext.panel.Proxy.html#" rel="property-panel" class="cls expand">panel</a><span> : Ext.panel.Panel</span></div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
47 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Proxy" class="member f ni"><a href="Ext.panel.Proxy.html#method-Proxy" rel="method-Proxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-method-constructor" class="viewSource">view source</a></div><a name="Proxy"></a><a name="method-Proxy"></a><a href="Ext.panel.Proxy.html#" rel="method-Proxy" class="cls expand">Proxy</a>(
48 <span class="pre">Object panel, Object config</span>)
49  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
50 <h3 class="pa">Parameters</h3><ul><li><span class="pre">panel</span> : Object<div class="sub-desc"><p>The <a href="Ext.panel.Panel.html" rel="Ext.panel.Panel" class="docClass">Ext.panel.Panel</a> to proxy for</p>
51 </div></li><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Configuration options</p>
52 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
53 </li></ul></div></div></div><div id="method-getEl" class="member ni"><a href="Ext.panel.Proxy.html#method-getEl" rel="method-getEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-method-getEl" class="viewSource">view source</a></div><a name="getEl"></a><a name="method-getEl"></a><a href="Ext.panel.Proxy.html#" rel="method-getEl" class="cls expand">getEl</a> : Element</div><div class="description"><div class="short"><p>Gets the proxy's element</p>
54 </div><div class="long"><p>Gets the proxy's element</p>
55 <h3 class="pa">Returns</h3><ul><li><span class="pre">Element</span>&nbsp; &nbsp;<p>The proxy's element</p>
56 </li></ul></div></div></div><div id="method-getGhost" class="member ni"><a href="Ext.panel.Proxy.html#method-getGhost" rel="method-getGhost" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-method-getGhost" class="viewSource">view source</a></div><a name="getGhost"></a><a name="method-getGhost"></a><a href="Ext.panel.Proxy.html#" rel="method-getGhost" class="cls expand">getGhost</a> : Panel</div><div class="description"><div class="short"><p>Gets the proxy's ghost Panel</p>
57 </div><div class="long"><p>Gets the proxy's ghost Panel</p>
58 <h3 class="pa">Returns</h3><ul><li><span class="pre">Panel</span>&nbsp; &nbsp;<p>The proxy's ghost Panel</p>
59 </li></ul></div></div></div><div id="method-getProxy" class="member ni"><a href="Ext.panel.Proxy.html#method-getProxy" rel="method-getProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-method-getProxy" class="viewSource">view source</a></div><a name="getProxy"></a><a name="method-getProxy"></a><a href="Ext.panel.Proxy.html#" rel="method-getProxy" class="cls expand">getProxy</a> : Element</div><div class="description"><div class="short"><p>Gets the proxy element. This is the element that represents where the
60 Panel was before we started the drag operation.</p>
61 </div><div class="long"><p>Gets the proxy element. This is the element that represents where the
62 Panel was before we started the drag operation.</p>
63 <h3 class="pa">Returns</h3><ul><li><span class="pre">Element</span>&nbsp; &nbsp;<p>The proxy's element</p>
64 </li></ul></div></div></div><div id="method-hide" class="member ni"><a href="Ext.panel.Proxy.html#method-hide" rel="method-hide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-method-hide" class="viewSource">view source</a></div><a name="hide"></a><a name="method-hide"></a><a href="Ext.panel.Proxy.html#" rel="method-hide" class="cls expand">hide</a> : void</div><div class="description"><div class="short"><p>Hides the proxy</p>
65 </div><div class="long"><p>Hides the proxy</p>
66 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
67 </li></ul></div></div></div><div id="method-moveProxy" class="member ni"><a href="Ext.panel.Proxy.html#method-moveProxy" rel="method-moveProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-method-moveProxy" class="viewSource">view source</a></div><a name="moveProxy"></a><a name="method-moveProxy"></a><a href="Ext.panel.Proxy.html#" rel="method-moveProxy" class="cls expand">moveProxy</a>(
68 <span class="pre">HTMLElement parentNode, [HTMLElement before]</span>)
69  : void</div><div class="description"><div class="short">Moves the proxy to a different position in the DOM.  This is typically
70 called while dragging the Panel to keep the pr...</div><div class="long"><p>Moves the proxy to a different position in the DOM.  This is typically
71 called while dragging the Panel to keep the proxy sync'd to the Panel's
72 location.</p>
73 <h3 class="pa">Parameters</h3><ul><li><span class="pre">parentNode</span> : HTMLElement<div class="sub-desc"><p>The proxy's parent DOM node</p>
74 </div></li><li><span class="pre">before</span> : HTMLElement<div class="sub-desc"><p>(optional) The sibling node before which the
75 proxy should be inserted (defaults to the parent's last child if not
76 specified)</p>
77 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
78 </li></ul></div></div></div><div id="method-show" class="member ni"><a href="Ext.panel.Proxy.html#method-show" rel="method-show" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.panel.Proxy.html" class="definedIn docClass">Ext.panel.Proxy</a><br/><a href="../source/Proxy.html#Ext-panel.Proxy-method-show" class="viewSource">view source</a></div><a name="show"></a><a name="method-show"></a><a href="Ext.panel.Proxy.html#" rel="method-show" class="cls expand">show</a> : void</div><div class="description"><div class="short"><p>Shows the proxy</p>
79 </div><div class="long"><p>Shows the proxy</p>
80 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
81 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>