Upgrade to ExtJS 3.3.0 - Released 10/06/2010
[extjs.git] / examples / docs / output / Ext.ux.TabScrollerMenu.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.TabScrollerMenu-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.TabScrollerMenu-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.TabScrollerMenu-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.TabScrollerMenu-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.ux.TabScrollerMenu"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/ux-all-debug.html#cls-Ext.ux.TabScrollerMenu">Ext.ux.TabScrollerMenu</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/ux-all-debug.html#cls-Ext.ux.TabScrollerMenu">ux-all-debug.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/ux-all-debug.html#cls-Ext.ux.TabScrollerMenu">TabScrollerMenu</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Plugin (ptype = 'tabscrollermenu') for adding a tab scroller menu to tabs.</div><div class="hr"></div><a id="Ext.ux.TabScrollerMenu-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-maxText"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.TabScrollerMenu-maxText">maxText</a></b> : Number<div class="mdesc">How long should the title of each <a href="output/Ext.menu.Item.html" ext:cls="Ext.menu.Item">Ext.menu.Item</a> be.</div></td><td class="msource">TabScrollerMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-maxText"></a><b><a href="source/TabScrollerMenu.html#cfg-Ext.ux.TabScrollerMenu-maxText">maxText</a></b> : Number<div class="mdesc">How long should the title of each <a href="output/Ext.menu.Item.html" ext:cls="Ext.menu.Item">Ext.menu.Item</a> be.</div></td><td class="msource">TabScrollerMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-menuPrefixText"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.TabScrollerMenu-menuPrefixText">menuPrefixText</a></b> : String<div class="mdesc">Text to prefix the submenus.</div></td><td class="msource">TabScrollerMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-menuPrefixText"></a><b><a href="source/TabScrollerMenu.html#cfg-Ext.ux.TabScrollerMenu-menuPrefixText">menuPrefixText</a></b> : String<div class="mdesc">Text to prefix the submenus.</div></td><td class="msource">TabScrollerMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-pageSize"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.TabScrollerMenu-pageSize">pageSize</a></b> : Number<div class="mdesc">How many items to allow per submenu.</div></td><td class="msource">TabScrollerMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-pageSize"></a><b><a href="source/TabScrollerMenu.html#cfg-Ext.ux.TabScrollerMenu-pageSize">pageSize</a></b> : Number<div class="mdesc">How many items to allow per submenu.</div></td><td class="msource">TabScrollerMenu</td></tr></tbody></table><a id="Ext.ux.TabScrollerMenu-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.TabScrollerMenu-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-TabScrollerMenu"></a><b><a href="source/ux-all-debug.html#cls-Ext.ux.TabScrollerMenu">TabScrollerMenu</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
2     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">Configuration options</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TabScrollerMenu</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-getMaxText"></a><b><a href="source/TabScrollerMenu.html#method-Ext.ux.TabScrollerMenu-getMaxText">getMaxText</a></b>()
3     :
4                                         Number<div class="mdesc"><div class="short">Returns the current maxText length;</div><div class="long">Returns the current maxText length;<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">this.maxText The current max text length.</div></li></ul></div></div></div></td><td class="msource">TabScrollerMenu</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-getMenuPrefixText"></a><b><a href="source/TabScrollerMenu.html#method-Ext.ux.TabScrollerMenu-getMenuPrefixText">getMenuPrefixText</a></b>()
5     :
6                                         String<div class="mdesc"><div class="short">Returns the current menu prefix text String.;</div><div class="long">Returns the current menu prefix text String.;<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">this.menuPrefixText The current menu prefix text.</div></li></ul></div></div></div></td><td class="msource">TabScrollerMenu</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-getPageSize"></a><b><a href="source/TabScrollerMenu.html#method-Ext.ux.TabScrollerMenu-getPageSize">getPageSize</a></b>()
7     :
8                                         Number<div class="mdesc"><div class="short">Returns an the current page size (this.pageSize);</div><div class="long">Returns an the current page size (this.pageSize);<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">this.pageSize The current page size.</div></li></ul></div></div></div></td><td class="msource">TabScrollerMenu</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-setMaxText"></a><b><a href="source/TabScrollerMenu.html#method-Ext.ux.TabScrollerMenu-setMaxText">setMaxText</a></b>(&nbsp;<code>Number&nbsp;t</code>&nbsp;)
9     :
10                                         void<div class="mdesc"><div class="short">Sets the maximum text size for each menu item.</div><div class="long">Sets the maximum text size for each menu item.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>t</code> : Number<div class="sub-desc">The max text per each menu item.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TabScrollerMenu</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-setMenuPrefixText"></a><b><a href="source/TabScrollerMenu.html#method-Ext.ux.TabScrollerMenu-setMenuPrefixText">setMenuPrefixText</a></b>(&nbsp;<code>String&nbsp;t</code>&nbsp;)
11     :
12                                         void<div class="mdesc"><div class="short">Sets the menu prefix text String.</div><div class="long">Sets the menu prefix text String.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>t</code> : String<div class="sub-desc">The menu prefix text.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TabScrollerMenu</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.TabScrollerMenu-setPageSize"></a><b><a href="source/TabScrollerMenu.html#method-Ext.ux.TabScrollerMenu-setPageSize">setPageSize</a></b>(&nbsp;<code>Number&nbsp;pageSize</code>&nbsp;)
13     :
14                                         void<div class="mdesc"><div class="short">Sets the number of menu items per submenu "page size".</div><div class="long">Sets the number of menu items per submenu "page size".<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>pageSize</code> : Number<div class="sub-desc">The page size</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TabScrollerMenu</td></tr></tbody></table><a id="Ext.ux.TabScrollerMenu-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>