1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.SplitButton</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
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
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_SplitButton.js.html">Roo/SplitButton.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">SplitButton</td></tr>
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>
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.
89 <!-- ============================== Class comment block... ========================== -->
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>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.SplitButton.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.SplitButton-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
139 <div class="short">A function called when the arrow button is clicked (can be used instead of click event)</div>
143 <div class="long">A function called when the arrow button is clicked (can be used instead of click event)</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
169 <div class="short">The title attribute of the arrow</div>
173 <div class="long">The title attribute of the arrow</div>
197 <!-- ============================== public properties ==================== -->
201 <a id="Roo.SplitButton-props"></a>
207 <table cellspacing="0" class="member-table">
208 <caption class="Empty">Public Properties - Has None</caption>
214 <!-- ============================== methods summary / details ======================== -->
217 <a id="Roo.SplitButton-methods"></a>
218 <!-- constructor?? -->
225 <!-- then dynamics first -->
232 <table cellspacing="0" class="member-table">
233 <caption>Public Methods</caption>
235 <th class="sig-header" colspan="2">Method</th>
236 <th class="msource-header">Defined By</th>
246 <tr class="method-row config-row-alt0 expandable notInherited">
247 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
263 <div class="short">Create a new Roo.SplitButton</div>
270 Create a new Roo.SplitButton
273 <dl class="detailList">
274 <dt class="heading">Parameters:</dt>
277 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>renderTo</b>
280 <dd>The element to append the button to</dd>
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>
286 <dd>The config object</dd>
310 <tr class="method-row config-row-alt1 expandable notInherited">
311 <td class="micon"><a class="exi" href="#expand"> </a></td>
315 <a id="Roo.SplitButton-method-focus" name=".focus"></a>
316 <div class="fixedFont">
317 <span class="attributes"></span><b class="itemname">focus</b>
326 <div class="short">Focus the button</div>
361 <tr class="method-row config-row-alt0 expandable notInherited">
362 <td class="micon"><a class="exi" href="#expand"> </a></td>
366 <a id="Roo.SplitButton-method-setArrowHandler" name=".setArrowHandler"></a>
367 <div class="fixedFont">
368 <span class="attributes"></span><b class="itemname">setArrowHandler</b>
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>)
377 <div class="short">Sets this button's arrow click handler</div>
383 Sets this button's arrow click handler
390 <dl class="detailList">
391 <dt class="heading">Parameters:</dt>
394 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
397 <dd>The function to call when the arrow is clicked</dd>
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>
403 <dd>(optional) Scope for the function passed above</dd>
429 <tr class="method-row config-row-alt1 expandable notInherited">
430 <td class="micon"><a class="exi" href="#expand"> </a></td>
434 <a id="Roo.SplitButton-method-setHandler" name=".setHandler"></a>
435 <div class="fixedFont">
436 <span class="attributes"></span><b class="itemname">setHandler</b>
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>)
445 <div class="short">Sets this button's click handler</div>
451 Sets this button's click handler
458 <dl class="detailList">
459 <dt class="heading">Parameters:</dt>
462 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
465 <dd>The function to call when the button is clicked</dd>
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>
471 <dd>(optional) Scope for the function passed above</dd>
500 <!-- ============================== events summary / details ======================== -->
503 <a id="Roo.SplitButton-events"></a>
512 <table cellspacing="0" class="member-table">
513 <caption>Events</caption>
516 <th class="sig-header" colspan="2">Event</th>
517 <th class="msource-header">Defined By</th>
526 <tr class="method-row expandable config-row-alt0 notInherited">
527 <td class="micon"><a class="exi" href="#expand"> </a></td>
530 <a id="Roo.SplitButton-event-*arrowclick"></a>
532 <div class="fixedFont">
533 <b class="itemname">arrowclick</b> (SplitButton <B><i>this</i></B>, EventObject <B><i>e</i></B>)
539 <div class="short">Fires when this button's arrow is clicked
545 Fires when this button's arrow is clicked
551 <dl class="detailList">
552 <dt class="heading">Parameters:</dt>
555 <span class="fixedFont">SplitButton</span> <b>this</b>
561 <span class="fixedFont">EventObject</span> <b>e</b>
564 <dd>The click event</dd>
594 <!-- ============================== footer ================================= -->
595 <div class="fineprint" style="clear:both">
597 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:43:08 GMT+0800 (HKT)
599 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>