git.roojs.org Git - roojs1/blob - docs/symbols/Roo.menu.BaseItem.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.menu.BaseItem</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.menu.BaseItem-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.menu.BaseItem-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.menu.BaseItem-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.menu.BaseItem-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.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.menu.BaseItem
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.menu.BaseItem
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.menu</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_menu_BaseItem.js.html">Roo/menu/BaseItem.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">BaseItem</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         The base class for all items that render into menus.  BaseItem provides default rendering, activated state<br/>management and base configuration options shared by all menu components.
  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.menu.BaseItem';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.menu" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.menu.BaseItem.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.menu.BaseItem-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.menu.BaseItem-cfg-activeClass" name=".activeClass"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">activeClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.menu.BaseItem
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.menu.BaseItem-cfg-canActivate" name=".canActivate"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">canActivate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">True if this item can be visually activated (defaults to false)</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">True if this item can be visually activated (defaults to false)</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.menu.BaseItem
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.menu.BaseItem-cfg-handler" name=".handler"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">handler</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">A function that will handle the click event of this menu item (defaults to undefined)</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">A function that will handle the click event of this menu item (defaults to undefined)</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.menu.BaseItem
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.menu.BaseItem-cfg-hideDelay" name=".hideDelay"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">hideDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">Length of time in milliseconds to wait before hiding after a click (defaults to 100)</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">Length of time in milliseconds to wait before hiding after a click (defaults to 100)</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.menu.BaseItem
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.menu.BaseItem-cfg-hideOnClick" name=".hideOnClick"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">hideOnClick</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">True to hide the containing menu after this item is clicked (defaults to true)</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">True to hide the containing menu after this item is clicked (defaults to true)</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.menu.BaseItem
 272
 273                     </td>
 274                 </tr>
 275
 276
 277     </table>
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287   <!-- ============================== public properties ==================== -->
 288
 289
 290
 291     <a id="Roo.menu.BaseItem-props"></a>
 292
 293
 294
 295
 296
 297      <table cellspacing="0" class="member-table">
 298       <caption class="Empty">Public Properties - Has None</caption>
 299      </table>
 300
 301
 302
 303
 304   <!-- ============================== methods summary / details ======================== -->
 305
 306
 307   <a id="Roo.menu.BaseItem-methods"></a>
 308         <!-- constructor?? -->
 309
 310         <!-- static's first
 311
 312
 313         -->
 314
 315         <!-- then dynamics first -->
 316
 317
 318
 319
 320
 321
 322       <table cellspacing="0" class="member-table">
 323       <caption>Public Methods</caption>
 324         <tr>
 325             <th class="sig-header" colspan="2">Method</th>
 326             <th class="msource-header">Defined By</th>
 327
 328         </tr>
 329
 330
 331
 332
 333
 334
 335
 336           <tr class="method-row config-row-alt0 expandable notInherited">
 337             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 338
 339
 340             <td class="sig">
 341                 <a id="Roo.menu-method-BaseItem"   name=".BaseItem"></a>
 342                 <div class="fixedFont">
 343                         <span class="attributes">new <B>Roo.menu.</B></span><b class="itemname">BaseItem</b>
 344
 345                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 346
 347
 348
 349                 </div>
 350                 <div class="mdesc">
 351
 352
 353                         <div class="short">Create a new Roo.menu.BaseItem</div>
 354
 355
 356                     <div class="long">
 357
 358
 359
 360                                 Create a new Roo.menu.BaseItem
 361
 362
 363                                 <dl class="detailList">
 364                                 <dt class="heading">Parameters:</dt>
 365
 366                                         <dt>
 367                                                 <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>
 368
 369                                         </dt>
 370                                         <dd>Configuration options</dd>
 371
 372                                 </dl>
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384                     </div>
 385                 </div>
 386
 387             </td>
 388             <td class="msource">
 389                 &nbsp;
 390             </td>
 391         </tr>
 392
 393
 394     </table>
 395
 396
 397   <!-- ============================== events summary / details ======================== -->
 398
 399
 400   <a id="Roo.menu.BaseItem-events"></a>
 401
 402
 403
 404
 405
 406
 407
 408
 409       <table cellspacing="0" class="member-table">
 410                 <caption>Events</caption>
 411               <thead>
 412                 <tr>
 413                     <th class="sig-header" colspan="2">Event</th>
 414                     <th class="msource-header">Defined By</th>
 415
 416                 </tr>
 417               </thead>
 418
 419
 420
 421
 422
 423           <tr class="method-row expandable config-row-alt0 notInherited">
 424             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 425
 426             <td class="sig">
 427                 <a id="Roo.menu.BaseItem-event-*activate"></a>
 428
 429                <div class="fixedFont">
 430                 <b class="itemname">activate</b> (<a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a> <B><i>this</i></B>)
 431
 432                 </div>
 433
 434                 <div class="mdesc">
 435
 436                    <div class="short">Fires when this item is activated
 437
 438                 </div>
 439
 440                     <div class="long">
 441
 442                         Fires when this item is activated
 443
 444
 445
 446
 447
 448                                 <dl class="detailList">
 449                                 <dt class="heading">Parameters:</dt>
 450
 451                                         <dt>
 452                                                 <span class="fixedFont"><a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a></span> <b>this</b>
 453
 454                                         </dt>
 455                                         <dd></dd>
 456
 457                                 </dl>
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469                     </div>
 470                 </div>
 471
 472             </td>
 473             <td class="msource">
 474                 Roo.menu.BaseItem
 475             </td>
 476         </tr>
 477
 478           <tr class="method-row expandable config-row-alt1 notInherited">
 479             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 480
 481             <td class="sig">
 482                 <a id="Roo.menu.BaseItem-event-*click"></a>
 483
 484                <div class="fixedFont">
 485                 <b class="itemname">click</b> (<a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a> <B><i>this</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
 486
 487                 </div>
 488
 489                 <div class="mdesc">
 490
 491                    <div class="short">Fires when this item is clicked
 492
 493                 </div>
 494
 495                     <div class="long">
 496
 497                         Fires when this item is clicked
 498
 499
 500
 501
 502
 503                                 <dl class="detailList">
 504                                 <dt class="heading">Parameters:</dt>
 505
 506                                         <dt>
 507                                                 <span class="fixedFont"><a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a></span> <b>this</b>
 508
 509                                         </dt>
 510                                         <dd></dd>
 511
 512                                         <dt>
 513                                                 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
 514
 515                                         </dt>
 516                                         <dd></dd>
 517
 518                                 </dl>
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530                     </div>
 531                 </div>
 532
 533             </td>
 534             <td class="msource">
 535                 Roo.menu.BaseItem
 536             </td>
 537         </tr>
 538
 539           <tr class="method-row expandable config-row-alt0 notInherited">
 540             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 541
 542             <td class="sig">
 543                 <a id="Roo.menu.BaseItem-event-*deactivate"></a>
 544
 545                <div class="fixedFont">
 546                 <b class="itemname">deactivate</b> (<a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a> <B><i>this</i></B>)
 547
 548                 </div>
 549
 550                 <div class="mdesc">
 551
 552                    <div class="short">Fires when this item is deactivated
 553
 554                 </div>
 555
 556                     <div class="long">
 557
 558                         Fires when this item is deactivated
 559
 560
 561
 562
 563
 564                                 <dl class="detailList">
 565                                 <dt class="heading">Parameters:</dt>
 566
 567                                         <dt>
 568                                                 <span class="fixedFont"><a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a></span> <b>this</b>
 569
 570                                         </dt>
 571                                         <dd></dd>
 572
 573                                 </dl>
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585                     </div>
 586                 </div>
 587
 588             </td>
 589             <td class="msource">
 590                 Roo.menu.BaseItem
 591             </td>
 592         </tr>
 593
 594
 595     </table>
 596
 597
 598
 599
 600
 601 <!-- ============================== footer ================================= -->
 602                 <div class="fineprint" style="clear:both">
 603
 604                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:28 GMT+0800 (HKT)
 605                         Based on
 606                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 607                 </div>
 608         </body>
 609 </html>