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