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.Toolbar</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.Toolbar-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Toolbar-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Toolbar-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Toolbar-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 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_Toolbar.js.html">Roo/Toolbar.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">Toolbar</td></tr>
65 <tr><td class="label">Subclasses:</td><td class="hd-info">
66 <a href="./Roo.PagingToolbar.html#constructor" roo:cls="Roo.PagingToolbar.html#constructor">Roo.PagingToolbar</a>
77 <!-- ============================== class summary ========================== -->
78 <div class="description">
83 <!-- ============================== Class comment block... ========================== -->
85 <div class="comments">
86 <b>Class Comments / Notes</B> =>
87 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Toolbar';">[Add Your comment/notes about this class]</u>
89 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
90 src="/blog.php/GtkDjsComments/Roo.Toolbar.html"></iframe>
95 <!-- ============================== config options ========================== -->
100 <div class="hr"></div>
101 <a id="Roo.Toolbar-configs"></a>
107 <table cellspacing="0" class="member-table">
108 <caption>Config Options (Usually are also Properties)</caption>
112 <th class="sig-header" colspan="2">Options</th>
114 <th class="msource-header">Defined By</th>
121 <tr class="config-row expandable config-row-alt0 notInherited">
122 <td class="micon"><a class="exi" href="#expand"> </a></td>
125 <a id="Roo.Toolbar-cfg-container" name=".container"></a>
126 <div class="fixedFont">
127 <b class="itemname">container</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
133 <div class="short">The id or element that will contain the toolbar</div>
138 The id or element that will contain the toolbar
154 <tr class="config-row expandable config-row-alt1">
155 <td class="micon"><a class="exi" href="#expand"> </a></td>
158 <a id="Roo-cfg-items" name=".items"></a>
159 <div class="fixedFont">
160 <b class="itemname">items</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
166 <div class="short">array of button configs or elements to add (will be converted to a MixedCollection)</div>
171 array of button configs or elements to add (will be converted to a MixedCollection)
181 <a href="./Roo.html#constructor" roo:cls="Roo.html#constructor">Roo</a>
197 <!-- ============================== public properties ==================== -->
201 <a id="Roo.Toolbar-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.Toolbar-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-Toolbar" name=".Toolbar"></a>
252 <div class="fixedFont">
253 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Toolbar</b>
255 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>container</i></B>)
263 <div class="short">Create a new Roo.Toolbar</div>
270 Create a new Roo.Toolbar
273 <dl class="detailList">
274 <dt class="heading">Parameters:</dt>
277 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>container</b>
280 <dd>The config object</dd>
304 <tr class="method-row config-row-alt1 expandable notInherited">
305 <td class="micon"><a class="exi" href="#expand"> </a></td>
309 <a id="Roo.Toolbar-method-add" name=".add"></a>
310 <div class="fixedFont">
311 <span class="attributes"></span><b class="itemname">add</b>
313 (Mixed <B><i>arg1</i></B>, Mixed <B><i>arg2</i></B>)
320 <div class="short">Adds element(s) to the toolbar -- this function takes a variable number of <br/>arguments of mixed type and adds them to the toolbar.</div>
326 Adds element(s) to the toolbar -- this function takes a variable number of <br/>arguments of mixed type and adds them to the toolbar.
333 <dl class="detailList">
334 <dt class="heading">Parameters:</dt>
337 <span class="fixedFont">Mixed</span> <b>arg1</b>
340 <dd>The following types of arguments are all valid:<br /><br/><ul><br/><li>{<b>link</b> Roo.Toolbar.Button} config: A valid button config object (equivalent to {<b>link</b> <b>addButton</b>})</li><br/><li>HtmlElement: Any standard HTML element (equivalent to {<b>link</b> <b>addElement</b>})</li><br/><li>Field: Any form field (equivalent to {<b>link</b> <b>addField</b>})</li><br/><li>Item: Any subclass of {<b>link</b> Roo.Toolbar.Item} (equivalent to {<b>link</b> <b>addItem</b>})</li><br/><li>String: Any generic string (gets wrapped in a {<b>link</b> Roo.Toolbar.TextItem}, equivalent to {<b>link</b> <b>addText</b>}).<br/>Note that there are a few special strings that are treated differently as explained nRoo.</li><br/><li>'separator' or '-': Creates a separator element (equivalent to {<b>link</b> <b>addSeparator</b>})</li><br/><li>' ': Creates a spacer element (equivalent to {<b>link</b> <b>addSpacer</b>})</li><br/><li>'->': Creates a fill element (equivalent to {<b>link</b> <b>addFill</b>})</li><br/></ul></dd>
343 <span class="fixedFont">Mixed</span> <b>arg2</b>
349 <span class="fixedFont">Mixed</span> <b>etc.</b>
378 <tr class="method-row config-row-alt0 expandable notInherited">
379 <td class="micon"><a class="exi" href="#expand"> </a></td>
383 <a id="Roo.Toolbar-method-addButton" name=".addButton"></a>
384 <div class="fixedFont">
385 <span class="attributes"></span><b class="itemname">addButton</b>
387 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/Array <B><i>config</i></B>)
393 <a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>/Array
402 <div class="short">Adds a button (or buttons).</div>
408 Adds a button (or buttons). See {<b>link</b> Roo.Toolbar.Button} for more info on the config.
415 <dl class="detailList">
416 <dt class="heading">Parameters:</dt>
419 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/Array</span> <b>config</b>
422 <dd>A button config or array of configs</dd>
430 <dl class="detailList">
431 <dt class="heading">Returns:</dt>
433 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>/Array</span> </dd>
455 <tr class="method-row config-row-alt1 expandable notInherited">
456 <td class="micon"><a class="exi" href="#expand"> </a></td>
460 <a id="Roo.Toolbar-method-addDom" name=".addDom"></a>
461 <div class="fixedFont">
462 <span class="attributes"></span><b class="itemname">addDom</b>
464 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
470 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
479 <div class="short">Adds a new element to the toolbar from the passed {<b>link</b> Roo.DomHelper} config.</div>
485 Adds a new element to the toolbar from the passed {<b>link</b> Roo.DomHelper} config.
492 <dl class="detailList">
493 <dt class="heading">Parameters:</dt>
496 <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>
507 <dl class="detailList">
508 <dt class="heading">Returns:</dt>
510 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a></span> The element's item</dd>
532 <tr class="method-row config-row-alt0 expandable notInherited">
533 <td class="micon"><a class="exi" href="#expand"> </a></td>
537 <a id="Roo.Toolbar-method-addElement" name=".addElement"></a>
538 <div class="fixedFont">
539 <span class="attributes"></span><b class="itemname">addElement</b>
541 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
547 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
556 <div class="short">Adds any standard HTML element to the toolbar</div>
562 Adds any standard HTML element to the toolbar
569 <dl class="detailList">
570 <dt class="heading">Parameters:</dt>
573 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
576 <dd>The element or id of the element to add</dd>
584 <dl class="detailList">
585 <dt class="heading">Returns:</dt>
587 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a></span> The element's item</dd>
609 <tr class="method-row config-row-alt1 expandable notInherited">
610 <td class="micon"><a class="exi" href="#expand"> </a></td>
614 <a id="Roo.Toolbar-method-addField" name=".addField"></a>
615 <div class="fixedFont">
616 <span class="attributes"></span><b class="itemname">addField</b>
618 (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>field</i></B>)
633 <div class="short">Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).</div>
639 Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).<br/>Note: the field should not have been rendered yet. For a field that has already been<br/>rendered, use {<b>link</b> <b>addElement</b>}.
646 <dl class="detailList">
647 <dt class="heading">Parameters:</dt>
650 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>field</b>
661 <dl class="detailList">
662 <dt class="heading">Returns:</dt>
664 <dd><span class="fixedFont">Roo.ToolbarItem</span> </dd>
686 <tr class="method-row config-row-alt0 expandable notInherited">
687 <td class="micon"><a class="exi" href="#expand"> </a></td>
691 <a id="Roo.Toolbar-method-addFill" name=".addFill"></a>
692 <div class="fixedFont">
693 <span class="attributes"></span><b class="itemname">addFill</b>
701 <a href="./Roo.Toolbar.Fill.html#constructor" roo:cls="Roo.Toolbar.Fill.html#constructor">Roo.Toolbar.Fill</a>
710 <div class="short">Adds a fill element that forces subsequent additions to the right side of the toolbar</div>
716 Adds a fill element that forces subsequent additions to the right side of the toolbar
727 <dl class="detailList">
728 <dt class="heading">Returns:</dt>
730 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Fill.html#constructor" roo:cls="Roo.Toolbar.Fill.html#constructor">Roo.Toolbar.Fill</a></span> The fill item</dd>
752 <tr class="method-row config-row-alt1 expandable notInherited">
753 <td class="micon"><a class="exi" href="#expand"> </a></td>
757 <a id="Roo.Toolbar-method-addItem" name=".addItem"></a>
758 <div class="fixedFont">
759 <span class="attributes"></span><b class="itemname">addItem</b>
761 (<a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a> <B><i>item</i></B>)
767 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
776 <div class="short">Adds any Toolbar.Item or subclass</div>
782 Adds any Toolbar.Item or subclass
789 <dl class="detailList">
790 <dt class="heading">Parameters:</dt>
793 <span class="fixedFont"><a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a></span> <b>item</b>
804 <dl class="detailList">
805 <dt class="heading">Returns:</dt>
807 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a></span> The item</dd>
829 <tr class="method-row config-row-alt0 expandable notInherited">
830 <td class="micon"><a class="exi" href="#expand"> </a></td>
834 <a id="Roo.Toolbar-method-addSeparator" name=".addSeparator"></a>
835 <div class="fixedFont">
836 <span class="attributes"></span><b class="itemname">addSeparator</b>
844 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
853 <div class="short">Adds a separator</div>
870 <dl class="detailList">
871 <dt class="heading">Returns:</dt>
873 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a></span> The separator item</dd>
895 <tr class="method-row config-row-alt1 expandable notInherited">
896 <td class="micon"><a class="exi" href="#expand"> </a></td>
900 <a id="Roo.Toolbar-method-addSpacer" name=".addSpacer"></a>
901 <div class="fixedFont">
902 <span class="attributes"></span><b class="itemname">addSpacer</b>
910 <a href="./Roo.Toolbar.Spacer.html#constructor" roo:cls="Roo.Toolbar.Spacer.html#constructor">Roo.Toolbar.Spacer</a>
919 <div class="short">Adds a spacer element</div>
925 Adds a spacer element
936 <dl class="detailList">
937 <dt class="heading">Returns:</dt>
939 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Spacer.html#constructor" roo:cls="Roo.Toolbar.Spacer.html#constructor">Roo.Toolbar.Spacer</a></span> The spacer item</dd>
961 <tr class="method-row config-row-alt0 expandable notInherited">
962 <td class="micon"><a class="exi" href="#expand"> </a></td>
966 <a id="Roo.Toolbar-method-addText" name=".addText"></a>
967 <div class="fixedFont">
968 <span class="attributes"></span><b class="itemname">addText</b>
970 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
976 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
985 <div class="short">Adds text to the toolbar</div>
991 Adds text to the toolbar
998 <dl class="detailList">
999 <dt class="heading">Parameters:</dt>
1002 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
1005 <dd>The text to add</dd>
1013 <dl class="detailList">
1014 <dt class="heading">Returns:</dt>
1016 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a></span> The element's item</dd>
1030 <td class="msource">
1038 <tr class="method-row config-row-alt1 expandable notInherited">
1039 <td class="micon"><a class="exi" href="#expand"> </a></td>
1043 <a id="Roo.Toolbar-method-addxtype" name=".addxtype"></a>
1044 <div class="fixedFont">
1045 <span class="attributes"></span><b class="itemname">addxtype</b>
1047 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>xtype</i></B>)
1053 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1062 <div class="short">Add an Xtype element</div>
1068 Add an Xtype element
1075 <dl class="detailList">
1076 <dt class="heading">Parameters:</dt>
1079 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>xtype</b>
1082 <dd>Xtype Object</dd>
1090 <dl class="detailList">
1091 <dt class="heading">Returns:</dt>
1093 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> created Object</dd>
1107 <td class="msource">
1115 <tr class="method-row config-row-alt0 expandable notInherited">
1116 <td class="micon"><a class="exi" href="#expand"> </a></td>
1120 <a id="Roo.Toolbar-method-getEl" name=".getEl"></a>
1121 <div class="fixedFont">
1122 <span class="attributes"></span><b class="itemname">getEl</b>
1130 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1139 <div class="short">Returns the Element for this toolbar.</div>
1145 Returns the Element for this toolbar.
1156 <dl class="detailList">
1157 <dt class="heading">Returns:</dt>
1159 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1173 <td class="msource">
1181 <tr class="method-row config-row-alt1 expandable notInherited">
1182 <td class="micon"><a class="exi" href="#expand"> </a></td>
1186 <a id="Roo.Toolbar-method-hide" name=".hide"></a>
1187 <div class="fixedFont">
1188 <span class="attributes"></span><b class="itemname">hide</b>
1197 <div class="short">Hide the toolbar</div>
1224 <td class="msource">
1232 <tr class="method-row config-row-alt0 expandable notInherited">
1233 <td class="micon"><a class="exi" href="#expand"> </a></td>
1237 <a id="Roo.Toolbar-method-insertButton" name=".insertButton"></a>
1238 <div class="fixedFont">
1239 <span class="attributes"></span><b class="itemname">insertButton</b>
1241 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array) <B><i>item</i></B>)
1247 <a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>/Item
1256 <div class="short">Inserts any {<b>link</b> Roo.Toolbar.Item}/{<b>link</b> Roo.Toolbar.Button} at the specified index.</div>
1262 Inserts any {<b>link</b> Roo.Toolbar.Item}/{<b>link</b> Roo.Toolbar.Button} at the specified index.
1269 <dl class="detailList">
1270 <dt class="heading">Parameters:</dt>
1273 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1276 <dd>The index where the item is to be inserted</dd>
1279 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)</span> <b>item</b>
1282 <dd>The button, or button config object to be inserted.</dd>
1290 <dl class="detailList">
1291 <dt class="heading">Returns:</dt>
1293 <dd><span class="fixedFont"><a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>/Item</span> </dd>
1307 <td class="msource">
1315 <tr class="method-row config-row-alt1 expandable notInherited">
1316 <td class="micon"><a class="exi" href="#expand"> </a></td>
1320 <a id="Roo.Toolbar-method-show" name=".show"></a>
1321 <div class="fixedFont">
1322 <span class="attributes"></span><b class="itemname">show</b>
1331 <div class="short">Show the toolbar</div>
1358 <td class="msource">
1369 <!-- ============================== events summary / details ======================== -->
1372 <a id="Roo.Toolbar-events"></a>
1378 <table cellspacing="0" class="member-table">
1379 <caption class="Empty">Events - Has None</caption>
1390 <!-- ============================== footer ================================= -->
1391 <div class="fineprint" style="clear:both">
1393 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Nov 06 2015 16:43:58 GMT+0800 (HKT)
1395 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>