git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.DDProxy.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.dd.DDProxy</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.dd.DDProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.dd.DDProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.dd.DDProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.dd.DDProxy-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DDProxy
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.dd.DDProxy
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_dd_DDProxy.js.html">Roo/dd/DDProxy.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DDProxy</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A DragDrop implementation that inserts an empty, bordered div into<br/>the document that follows the cursor during drag operations.  At the time of<br/>the click, the frame div is resized to the dimensions of the linked html<br/>element, and moved to the exact location of the linked element.<br/><br/>References to the "frame" element refer to the single proxy element that<br/>was created to be dragged in place of all DDProxy elements on the<br/>page.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DDProxy';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.dd" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.dd.DDProxy.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.dd.DDProxy-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.dd.DDProxy-props"></a>
 131
 132
 133
 134
 135
 136
 137
 138       <table cellspacing="0" class="member-table">
 139       <caption>Public Properties </caption>
 140         <tr>
 141             <th class="sig-header" colspan="2">Property</th>
 142             <th class="sig-header">Description</th>
 143             <th class="msource-header">Defined By</th>
 144         </tr>
 145
 146
 147
 148
 149
 150
 151
 152
 153           <tr class="property-row config-row-alt0 notInherited">
 154             <td class="micon">
 155                 <a class="exi" href="#expand">&nbsp;</a>
 156             </td>
 157             <td class="sig">
 158                <a id="Roo.dd.DDProxy-prop-dragElId" name=".dragElId"></a>
 159                <div class="fixedFont">
 160                     <span class="attributes">Roo.dd.DDProxy.</span><b  class="itemname">dragElId</b> :
 161                      <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
 162                      </div>
 163             </td>
 164             <td class="sig">
 165                 <div class="mdesc">
 166
 167
 168                    <div class="short">
 169                         The default drag frame div id
 170
 171
 172
 173                    </div>
 174
 175                     <div class="long">
 176
 177                         The default drag frame div id
 178
 179                 </div>
 180                 </div>
 181             </td>
 182
 183             <td class="msource">
 184             Roo.dd.DDProxy
 185             </td>
 186
 187           </tr>
 188
 189
 190
 191
 192
 193         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 194         <tr class="property-row alt">
 195
 196         -->
 197
 198     </table>
 199
 200
 201   <!-- ============================== methods summary / details ======================== -->
 202
 203
 204   <a id="Roo.dd.DDProxy-methods"></a>
 205         <!-- constructor?? -->
 206
 207         <!-- static's first
 208
 209
 210         -->
 211
 212         <!-- then dynamics first -->
 213
 214
 215
 216
 217
 218
 219       <table cellspacing="0" class="member-table">
 220       <caption>Public Methods</caption>
 221         <tr>
 222             <th class="sig-header" colspan="2">Method</th>
 223             <th class="msource-header">Defined By</th>
 224
 225         </tr>
 226
 227
 228
 229
 230
 231
 232
 233           <tr class="method-row config-row-alt0 expandable notInherited">
 234             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 235
 236
 237             <td class="sig">
 238                 <a id="Roo.dd-method-DDProxy"   name=".DDProxy"></a>
 239                 <div class="fixedFont">
 240                         <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DDProxy</b>
 241
 242                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
 243
 244
 245
 246                 </div>
 247                 <div class="mdesc">
 248
 249
 250                         <div class="short">Create a new Roo.dd.DDProxy</div>
 251
 252
 253                     <div class="long">
 254
 255
 256
 257                                 Create a new Roo.dd.DDProxy
 258
 259
 260                                 <dl class="detailList">
 261                                 <dt class="heading">Parameters:</dt>
 262
 263                                         <dt>
 264                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 265
 266                                         </dt>
 267                                         <dd>the id of the linked html element</dd>
 268
 269                                         <dt>
 270                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>sGroup</b>
 271
 272                                         </dt>
 273                                         <dd>the group of related DragDrop objects</dd>
 274
 275                                         <dt>
 276                                                 <span class="fixedFont">object</span>  <b>config</b>
 277
 278                                         </dt>
 279                                         <dd>an object containing configurable attributes<br/>               Valid properties for DDProxy in addition to those in DragDrop:<br/>                  resizeFrame, centerFrame, dragElId</dd>
 280
 281                                 </dl>
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293                     </div>
 294                 </div>
 295
 296             </td>
 297             <td class="msource">
 298                 &nbsp;
 299             </td>
 300         </tr>
 301
 302
 303           <tr class="method-row config-row-alt1 expandable notInherited">
 304             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 305
 306
 307             <td class="sig">
 308                 <a id="Roo.dd.DDProxy-method-createFrame"   name=".createFrame"></a>
 309                 <div class="fixedFont">
 310                         <span class="attributes"></span><b class="itemname">createFrame</b>
 311
 312                                  ()
 313
 314
 315
 316                 </div>
 317                 <div class="mdesc">
 318
 319                    <div class="short">Creates the proxy element if it does not yet exist</div>
 320
 321
 322
 323                     <div class="long">
 324
 325                                 Creates the proxy element if it does not yet exist
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342                     </div>
 343                 </div>
 344
 345             </td>
 346             <td class="msource">
 347
 348                         Roo.dd.DDProxy
 349                 &nbsp;
 350             </td>
 351         </tr>
 352
 353
 354           <tr class="method-row config-row-alt0 expandable notInherited">
 355             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 356
 357
 358             <td class="sig">
 359                 <a id="Roo.dd.DDProxy-method-initFrame"   name=".initFrame"></a>
 360                 <div class="fixedFont">
 361                         <span class="attributes"></span><b class="itemname">initFrame</b>
 362
 363                                  ()
 364
 365
 366
 367                 </div>
 368                 <div class="mdesc">
 369
 370                    <div class="short">Initialization for the drag frame element.</div>
 371
 372
 373
 374                     <div class="long">
 375
 376                                 Initialization for the drag frame element.  Must be called in the<br/>constructor of all subclasses
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393                     </div>
 394                 </div>
 395
 396             </td>
 397             <td class="msource">
 398
 399                         Roo.dd.DDProxy
 400                 &nbsp;
 401             </td>
 402         </tr>
 403
 404
 405     </table>
 406
 407
 408   <!-- ============================== events summary / details ======================== -->
 409
 410
 411   <a id="Roo.dd.DDProxy-events"></a>
 412
 413
 414
 415
 416
 417      <table cellspacing="0" class="member-table">
 418       <caption class="Empty">Events - Has None</caption>
 419      </table>
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429 <!-- ============================== footer ================================= -->
 430                 <div class="fineprint" style="clear:both">
 431
 432                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:51 GMT+0800 (HKT)
 433                         Based on
 434                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 435                 </div>
 436         </body>
 437 </html>