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>
137 <div class="long">The id or element that will contain the toolbar</div>
151 <tr class="config-row expandable config-row-alt1 notInherited">
152 <td class="micon"><a class="exi" href="#expand"> </a></td>
155 <a id="Roo.Toolbar-cfg-items" name=".items"></a>
156 <div class="fixedFont">
157 <b class="itemname">items</b> : <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
163 <div class="short">array of button configs or elements to add</div>
167 <div class="long">array of button configs or elements to add</div>
191 <!-- ============================== public properties ==================== -->
195 <a id="Roo.Toolbar-props"></a>
201 <table cellspacing="0" class="member-table">
202 <caption class="Empty">Public Properties - Has None</caption>
208 <!-- ============================== methods summary / details ======================== -->
211 <a id="Roo.Toolbar-methods"></a>
212 <!-- constructor?? -->
219 <!-- then dynamics first -->
226 <table cellspacing="0" class="member-table">
227 <caption>Public Methods</caption>
229 <th class="sig-header" colspan="2">Method</th>
230 <th class="msource-header">Defined By</th>
240 <tr class="method-row config-row-alt0 expandable notInherited">
241 <td class="micon"><a class="exi" href="#expand"> </a></td>
245 <a id="Roo-method-Toolbar" name=".Toolbar"></a>
246 <div class="fixedFont">
247 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Toolbar</b>
249 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
257 <div class="short">Create a new Roo.Toolbar</div>
264 Create a new Roo.Toolbar
267 <dl class="detailList">
268 <dt class="heading">Parameters:</dt>
271 <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>
274 <dd>The config object</dd>
298 <tr class="method-row config-row-alt1 expandable notInherited">
299 <td class="micon"><a class="exi" href="#expand"> </a></td>
303 <a id="Roo.Toolbar-method-add" name=".add"></a>
304 <div class="fixedFont">
305 <span class="attributes"></span><b class="itemname">add</b>
307 (Mixed <B><i>arg1</i></B>, Mixed <B><i>arg2</i></B>)
314 <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>
320 Adds element(s) to the toolbar -- this function takes a variable number of <br/>arguments of mixed type and adds them to the toolbar.
327 <dl class="detailList">
328 <dt class="heading">Parameters:</dt>
331 <span class="fixedFont">Mixed</span> <b>arg1</b>
334 <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>
337 <span class="fixedFont">Mixed</span> <b>arg2</b>
343 <span class="fixedFont">Mixed</span> <b>etc.</b>
372 <tr class="method-row config-row-alt0 expandable notInherited">
373 <td class="micon"><a class="exi" href="#expand"> </a></td>
377 <a id="Roo.Toolbar-method-addButton" name=".addButton"></a>
378 <div class="fixedFont">
379 <span class="attributes"></span><b class="itemname">addButton</b>
381 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/Array <B><i>config</i></B>)
387 <a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>/Array
396 <div class="short">Adds a button (or buttons).</div>
402 Adds a button (or buttons). See {<b>link</b> Roo.Toolbar.Button} for more info on the config.
409 <dl class="detailList">
410 <dt class="heading">Parameters:</dt>
413 <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>
416 <dd>A button config or array of configs</dd>
424 <dl class="detailList">
425 <dt class="heading">Returns:</dt>
427 <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>
449 <tr class="method-row config-row-alt1 expandable notInherited">
450 <td class="micon"><a class="exi" href="#expand"> </a></td>
454 <a id="Roo.Toolbar-method-addDom" name=".addDom"></a>
455 <div class="fixedFont">
456 <span class="attributes"></span><b class="itemname">addDom</b>
458 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
464 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
473 <div class="short">Adds a new element to the toolbar from the passed {<b>link</b> Roo.DomHelper} config.</div>
479 Adds a new element to the toolbar from the passed {<b>link</b> Roo.DomHelper} config.
486 <dl class="detailList">
487 <dt class="heading">Parameters:</dt>
490 <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>
501 <dl class="detailList">
502 <dt class="heading">Returns:</dt>
504 <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>
526 <tr class="method-row config-row-alt0 expandable notInherited">
527 <td class="micon"><a class="exi" href="#expand"> </a></td>
531 <a id="Roo.Toolbar-method-addElement" name=".addElement"></a>
532 <div class="fixedFont">
533 <span class="attributes"></span><b class="itemname">addElement</b>
535 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
541 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
550 <div class="short">Adds any standard HTML element to the toolbar</div>
556 Adds any standard HTML element to the toolbar
563 <dl class="detailList">
564 <dt class="heading">Parameters:</dt>
567 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
570 <dd>The element or id of the element to add</dd>
578 <dl class="detailList">
579 <dt class="heading">Returns:</dt>
581 <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>
603 <tr class="method-row config-row-alt1 expandable notInherited">
604 <td class="micon"><a class="exi" href="#expand"> </a></td>
608 <a id="Roo.Toolbar-method-addField" name=".addField"></a>
609 <div class="fixedFont">
610 <span class="attributes"></span><b class="itemname">addField</b>
612 (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>field</i></B>)
627 <div class="short">Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).</div>
633 Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc). Note: the field should not have<br/>been rendered yet. For a field that has already been rendered, use {<b>link</b> <b>addElement</b>}.
640 <dl class="detailList">
641 <dt class="heading">Parameters:</dt>
644 <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>
655 <dl class="detailList">
656 <dt class="heading">Returns:</dt>
658 <dd><span class="fixedFont">Roo.ToolbarItem</span> </dd>
680 <tr class="method-row config-row-alt0 expandable notInherited">
681 <td class="micon"><a class="exi" href="#expand"> </a></td>
685 <a id="Roo.Toolbar-method-addFill" name=".addFill"></a>
686 <div class="fixedFont">
687 <span class="attributes"></span><b class="itemname">addFill</b>
695 <a href="./Roo.Toolbar.Fill.html#constructor" roo:cls="Roo.Toolbar.Fill.html#constructor">Roo.Toolbar.Fill</a>
704 <div class="short">Adds a fill element that forces subsequent additions to the right side of the toolbar</div>
710 Adds a fill element that forces subsequent additions to the right side of the toolbar
721 <dl class="detailList">
722 <dt class="heading">Returns:</dt>
724 <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>
746 <tr class="method-row config-row-alt1 expandable notInherited">
747 <td class="micon"><a class="exi" href="#expand"> </a></td>
751 <a id="Roo.Toolbar-method-addItem" name=".addItem"></a>
752 <div class="fixedFont">
753 <span class="attributes"></span><b class="itemname">addItem</b>
755 (<a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a> <B><i>item</i></B>)
761 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
770 <div class="short">Adds any Toolbar.Item or subclass</div>
776 Adds any Toolbar.Item or subclass
783 <dl class="detailList">
784 <dt class="heading">Parameters:</dt>
787 <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>
798 <dl class="detailList">
799 <dt class="heading">Returns:</dt>
801 <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>
823 <tr class="method-row config-row-alt0 expandable notInherited">
824 <td class="micon"><a class="exi" href="#expand"> </a></td>
828 <a id="Roo.Toolbar-method-addSeparator" name=".addSeparator"></a>
829 <div class="fixedFont">
830 <span class="attributes"></span><b class="itemname">addSeparator</b>
838 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
847 <div class="short">Adds a separator</div>
864 <dl class="detailList">
865 <dt class="heading">Returns:</dt>
867 <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>
889 <tr class="method-row config-row-alt1 expandable notInherited">
890 <td class="micon"><a class="exi" href="#expand"> </a></td>
894 <a id="Roo.Toolbar-method-addSpacer" name=".addSpacer"></a>
895 <div class="fixedFont">
896 <span class="attributes"></span><b class="itemname">addSpacer</b>
904 <a href="./Roo.Toolbar.Spacer.html#constructor" roo:cls="Roo.Toolbar.Spacer.html#constructor">Roo.Toolbar.Spacer</a>
913 <div class="short">Adds a spacer element</div>
919 Adds a spacer element
930 <dl class="detailList">
931 <dt class="heading">Returns:</dt>
933 <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>
955 <tr class="method-row config-row-alt0 expandable notInherited">
956 <td class="micon"><a class="exi" href="#expand"> </a></td>
960 <a id="Roo.Toolbar-method-addText" name=".addText"></a>
961 <div class="fixedFont">
962 <span class="attributes"></span><b class="itemname">addText</b>
964 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
970 <a href="./Roo.Toolbar.Item.html#constructor" roo:cls="Roo.Toolbar.Item.html#constructor">Roo.Toolbar.Item</a>
979 <div class="short">Adds text to the toolbar</div>
985 Adds text to the toolbar
992 <dl class="detailList">
993 <dt class="heading">Parameters:</dt>
996 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
999 <dd>The text to add</dd>
1007 <dl class="detailList">
1008 <dt class="heading">Returns:</dt>
1010 <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>
1024 <td class="msource">
1032 <tr class="method-row config-row-alt1 expandable notInherited">
1033 <td class="micon"><a class="exi" href="#expand"> </a></td>
1037 <a id="Roo.Toolbar-method-addxtype" name=".addxtype"></a>
1038 <div class="fixedFont">
1039 <span class="attributes"></span><b class="itemname">addxtype</b>
1041 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>xtype</i></B>)
1047 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1056 <div class="short">Add an Xtype element</div>
1062 Add an Xtype element
1069 <dl class="detailList">
1070 <dt class="heading">Parameters:</dt>
1073 <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>
1076 <dd>Xtype Object</dd>
1084 <dl class="detailList">
1085 <dt class="heading">Returns:</dt>
1087 <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>
1101 <td class="msource">
1109 <tr class="method-row config-row-alt0 expandable notInherited">
1110 <td class="micon"><a class="exi" href="#expand"> </a></td>
1114 <a id="Roo.Toolbar-method-getEl" name=".getEl"></a>
1115 <div class="fixedFont">
1116 <span class="attributes"></span><b class="itemname">getEl</b>
1124 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1133 <div class="short">Returns the Element for this toolbar.</div>
1139 Returns the Element for this toolbar.
1150 <dl class="detailList">
1151 <dt class="heading">Returns:</dt>
1153 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1167 <td class="msource">
1175 <tr class="method-row config-row-alt1 expandable notInherited">
1176 <td class="micon"><a class="exi" href="#expand"> </a></td>
1180 <a id="Roo.Toolbar-method-hide" name=".hide"></a>
1181 <div class="fixedFont">
1182 <span class="attributes"></span><b class="itemname">hide</b>
1191 <div class="short">Hide the toolbar</div>
1218 <td class="msource">
1226 <tr class="method-row config-row-alt0 expandable notInherited">
1227 <td class="micon"><a class="exi" href="#expand"> </a></td>
1231 <a id="Roo.Toolbar-method-insertButton" name=".insertButton"></a>
1232 <div class="fixedFont">
1233 <span class="attributes"></span><b class="itemname">insertButton</b>
1235 (<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>)
1241 <a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>/Item
1250 <div class="short">Inserts any {<b>link</b> Roo.Toolbar.Item}/{<b>link</b> Roo.Toolbar.Button} at the specified index.</div>
1256 Inserts any {<b>link</b> Roo.Toolbar.Item}/{<b>link</b> Roo.Toolbar.Button} at the specified index.
1263 <dl class="detailList">
1264 <dt class="heading">Parameters:</dt>
1267 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1270 <dd>The index where the item is to be inserted</dd>
1273 <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>
1276 <dd>The button, or button config object to be inserted.</dd>
1284 <dl class="detailList">
1285 <dt class="heading">Returns:</dt>
1287 <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>
1301 <td class="msource">
1309 <tr class="method-row config-row-alt1 expandable notInherited">
1310 <td class="micon"><a class="exi" href="#expand"> </a></td>
1314 <a id="Roo.Toolbar-method-show" name=".show"></a>
1315 <div class="fixedFont">
1316 <span class="attributes"></span><b class="itemname">show</b>
1325 <div class="short">Show the toolbar</div>
1352 <td class="msource">
1363 <!-- ============================== events summary / details ======================== -->
1366 <a id="Roo.Toolbar-events"></a>
1372 <table cellspacing="0" class="member-table">
1373 <caption class="Empty">Events - Has None</caption>
1384 <!-- ============================== footer ================================= -->
1385 <div class="fineprint" style="clear:both">
1387 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:08:32 GMT+0800 (HKT)
1389 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>