git.roojs.org Git - roojs1/blob - docs.old/symbols/Roo.QuickTips.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.QuickTips</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.QuickTips-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.QuickTips-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.QuickTips-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.QuickTips-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 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.QuickTips
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_QuickTips.js.html">Roo/QuickTips.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">QuickTips</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Provides attractive and customizable tooltips for any element.
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  78 <div class="comments">
  79         <b>Class Comments / Notes</B> =>
  80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.QuickTips';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.QuickTips.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.QuickTips-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.QuickTips-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.QuickTips-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo.QuickTips-method-disable"   name=".disable"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">Roo.QuickTips.</span><b class="itemname">disable</b>
 170
 171                                  ()
 172
 173
 174
 175                 </div>
 176                 <div class="mdesc">
 177
 178                    <div class="short">Disable this quick tip.</div>
 179
 180
 181
 182                     <div class="long">
 183
 184                                 Disable this quick tip.
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201                     </div>
 202                 </div>
 203
 204             </td>
 205             <td class="msource">
 206
 207                         Roo.QuickTips
 208                 &nbsp;
 209             </td>
 210         </tr>
 211
 212
 213           <tr class="method-row config-row-alt1 expandable notInherited">
 214             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 215
 216
 217             <td class="sig">
 218                 <a id="Roo.QuickTips-method-enable"   name=".enable"></a>
 219                 <div class="fixedFont">
 220                         <span class="attributes">Roo.QuickTips.</span><b class="itemname">enable</b>
 221
 222                                  ()
 223
 224
 225
 226                 </div>
 227                 <div class="mdesc">
 228
 229                    <div class="short">Enable this quick tip.</div>
 230
 231
 232
 233                     <div class="long">
 234
 235                                 Enable this quick tip.
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252                     </div>
 253                 </div>
 254
 255             </td>
 256             <td class="msource">
 257
 258                         Roo.QuickTips
 259                 &nbsp;
 260             </td>
 261         </tr>
 262
 263
 264           <tr class="method-row config-row-alt0 expandable notInherited">
 265             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 266
 267
 268             <td class="sig">
 269                 <a id="Roo.QuickTips-method-init"   name=".init"></a>
 270                 <div class="fixedFont">
 271                         <span class="attributes">Roo.QuickTips.</span><b class="itemname">init</b>
 272
 273                                  ()
 274
 275
 276
 277                 </div>
 278                 <div class="mdesc">
 279
 280                    <div class="short">Initialize and enable QuickTips for first use.</div>
 281
 282
 283
 284                     <div class="long">
 285
 286                                 Initialize and enable QuickTips for first use.  This should be called once before the first attempt to access<br/>or display QuickTips in a page.
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303                     </div>
 304                 </div>
 305
 306             </td>
 307             <td class="msource">
 308
 309                         Roo.QuickTips
 310                 &nbsp;
 311             </td>
 312         </tr>
 313
 314
 315           <tr class="method-row config-row-alt1 expandable notInherited">
 316             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 317
 318
 319             <td class="sig">
 320                 <a id="Roo.QuickTips-method-isEnabled"   name=".isEnabled"></a>
 321                 <div class="fixedFont">
 322                         <span class="attributes">Roo.QuickTips.</span><b class="itemname">isEnabled</b>
 323
 324                                  ()
 325
 326
 327
 328                 </div>
 329                 <div class="mdesc">
 330
 331                    <div class="short">Returns true if the quick tip is enabled, else false.</div>
 332
 333
 334
 335                     <div class="long">
 336
 337                                 Returns true if the quick tip is enabled, else false.
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354                     </div>
 355                 </div>
 356
 357             </td>
 358             <td class="msource">
 359
 360                         Roo.QuickTips
 361                 &nbsp;
 362             </td>
 363         </tr>
 364
 365
 366           <tr class="method-row config-row-alt0 expandable notInherited">
 367             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 368
 369
 370             <td class="sig">
 371                 <a id="Roo.QuickTips-method-register"   name=".register"></a>
 372                 <div class="fixedFont">
 373                         <span class="attributes">Roo.QuickTips.</span><b class="itemname">register</b>
 374
 375                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 376
 377
 378
 379                 </div>
 380                 <div class="mdesc">
 381
 382                    <div class="short">Configures a new quick tip instance and assigns it to a target element.</div>
 383
 384
 385
 386                     <div class="long">
 387
 388                                 Configures a new quick tip instance and assigns it to a target element.  The following config options<br/>are supported:<br/><pre><br/>Property    Type                   Description<br/>----------  ---------------------  ------------------------------------------------------------------------<br/>target      Element/String/Array   An Element, id or array of ids that this quick tip should be tied to<br/></ul>
 389
 390
 391
 392
 393
 394
 395                                 <dl class="detailList">
 396                                 <dt class="heading">Parameters:</dt>
 397
 398                                         <dt>
 399                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 400
 401                                         </dt>
 402                                         <dd>The config object</dd>
 403
 404                                 </dl>
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416                     </div>
 417                 </div>
 418
 419             </td>
 420             <td class="msource">
 421
 422                         Roo.QuickTips
 423                 &nbsp;
 424             </td>
 425         </tr>
 426
 427
 428           <tr class="method-row config-row-alt1 expandable notInherited">
 429             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 430
 431
 432             <td class="sig">
 433                 <a id="Roo.QuickTips-method-unregister"   name=".unregister"></a>
 434                 <div class="fixedFont">
 435                         <span class="attributes">Roo.QuickTips.</span><b class="itemname">unregister</b>
 436
 437                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
 438
 439
 440
 441                 </div>
 442                 <div class="mdesc">
 443
 444                    <div class="short">Removes this quick tip from its element and destroys it.</div>
 445
 446
 447
 448                     <div class="long">
 449
 450                                 Removes this quick tip from its element and destroys it.
 451
 452
 453
 454
 455
 456
 457                                 <dl class="detailList">
 458                                 <dt class="heading">Parameters:</dt>
 459
 460                                         <dt>
 461                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
 462
 463                                         </dt>
 464                                         <dd>The element from which the quick tip is to be removed.</dd>
 465
 466                                 </dl>
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478                     </div>
 479                 </div>
 480
 481             </td>
 482             <td class="msource">
 483
 484                         Roo.QuickTips
 485                 &nbsp;
 486             </td>
 487         </tr>
 488
 489
 490     </table>
 491
 492
 493   <!-- ============================== events summary / details ======================== -->
 494
 495
 496   <a id="Roo.QuickTips-events"></a>
 497
 498
 499
 500
 501
 502      <table cellspacing="0" class="member-table">
 503       <caption class="Empty">Events - Has None</caption>
 504      </table>
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514 <!-- ============================== footer ================================= -->
 515                 <div class="fineprint" style="clear:both">
 516
 517                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
 518                         Based on
 519                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 520                 </div>
 521         </body>
 522 </html>