examples/docs/output/Ext.ux.menu.ListMenu.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.menu.ListMenu-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.menu.ListMenu-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.menu.ListMenu-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.menu.ListMenu-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.menu.ListMenu"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/ListMenu.html#cls-Ext.ux.menu.ListMenu">Ext.ux.menu.ListMenu</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.menu</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/ListMenu.html#cls-Ext.ux.menu.ListMenu">ListMenu.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/ListMenu.html#cls-Ext.ux.menu.ListMenu">ListMenu</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">This is a supporting class for <a href="output/Ext.ux.grid.filter.ListFilter.html" ext:cls="Ext.ux.grid.filter.ListFilter">Ext.ux.grid.filter.ListFilter</a>.
   2 Although not listed as configuration options for this class, this class
   3 also accepts all configuration options from <a href="output/Ext.ux.grid.filter.ListFilter.html" ext:cls="Ext.ux.grid.filter.ListFilter">Ext.ux.grid.filter.ListFilter</a>.</div><div class="hr"></div><a id="Ext.ux.menu.ListMenu-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.menu.ListMenu-labelField"></a><b><a href="source/ListMenu.html#cfg-Ext.ux.menu.ListMenu-labelField">labelField</a></b> : String<div class="mdesc">Defaults to 'text'.</div></td><td class="msource">ListMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.menu.ListMenu-labelField"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.menu.ListMenu-labelField">labelField</a></b> : String<div class="mdesc">Defaults to 'text'.</div></td><td class="msource">ListMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.menu.ListMenu-loadOnShow"></a><b><a href="source/ListMenu.html#cfg-Ext.ux.menu.ListMenu-loadOnShow">loadOnShow</a></b> : Boolean<div class="mdesc">Defaults to true.</div></td><td class="msource">ListMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.menu.ListMenu-loadOnShow"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.menu.ListMenu-loadOnShow">loadOnShow</a></b> : Boolean<div class="mdesc">Defaults to true.</div></td><td class="msource">ListMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.menu.ListMenu-paramPrefix"></a><b><a href="source/ListMenu.html#cfg-Ext.ux.menu.ListMenu-paramPrefix">paramPrefix</a></b> : String<div class="mdesc">Defaults to 'Loading...'.</div></td><td class="msource">ListMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.menu.ListMenu-paramPrefix"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.menu.ListMenu-paramPrefix">paramPrefix</a></b> : String<div class="mdesc">Defaults to 'Loading...'.</div></td><td class="msource">ListMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.menu.ListMenu-single"></a><b><a href="source/ListMenu.html#cfg-Ext.ux.menu.ListMenu-single">single</a></b> : Boolean<div class="mdesc">Specify true to group all items in this list into a single-select
   4 radio button group. Defaults to false.</div></td><td class="msource">ListMenu</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.menu.ListMenu-single"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.menu.ListMenu-single">single</a></b> : Boolean<div class="mdesc">Specify true to group all items in this list into a single-select
   5 radio button group. Defaults to false.</div></td><td class="msource">ListMenu</td></tr></tbody></table><a id="Ext.ux.menu.ListMenu-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.menu.ListMenu-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.menu.ListMenu-checkChange"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.menu.ListMenu-checkChange">checkChange</a></b>(&nbsp;<code>Object&nbsp;item</code>,&nbsp;<code>Object&nbsp;checked</code>&nbsp;)
   6     :
   7                                         void<div class="mdesc"><div class="short">Handler for the 'checkchange' event from an check item in this menu</div><div class="long">Handler for the 'checkchange' event from an check item in this menu<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>item</code> : Object<div class="sub-desc">Ext.menu.CheckItem</div></li><li><code>checked</code> : Object<div class="sub-desc">The checked value that was set</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ListMenu</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.menu.ListMenu-getSelected"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.menu.ListMenu-getSelected">getSelected</a></b>()
   8     :
   9                                         Array<div class="mdesc"><div class="short">Get the selected items.</div><div class="long">Get the selected items.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">selected</div></li></ul></div></div></div></td><td class="msource">ListMenu</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.menu.ListMenu-show"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.menu.ListMenu-show">show</a></b>()
  10     :
  11                                         void<div class="mdesc"><div class="short">Lists will initially show a 'loading' item while the data is retrieved from the store.
  12 In some cases the loaded data ...</div><div class="long">Lists will initially show a 'loading' item while the data is retrieved from the store.
  13 In some cases the loaded data will result in a list that goes off the screen to the
  14 right (as placement calculations were done with the loading item). This adapter will
  15 allow show to be called with no arguments to show with the previous arguments and
  16 thus recalculate the width and potentially hang the menu from the left.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ListMenu</td></tr></tbody></table><a id="Ext.ux.menu.ListMenu-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</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.menu.ListMenu-checkchange"></a><b><a href="source/ListMenu.html#event-Ext.ux.menu.ListMenu-checkchange">checkchange</a></b> :
  17                                       (&nbsp;<code>Object&nbsp;item</code>,&nbsp;<code>Object&nbsp;checked</code>&nbsp;)
  18     <div class="mdesc"><div class="short">Fires when there is a change in checked items from this list</div><div class="long">Fires when there is a change in checked items from this list<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>item</code> : Object<div class="sub-desc">Ext.menu.CheckItem</div></li><li><code>checked</code> : Object<div class="sub-desc">The checked value that was set</div></li></ul></div></div></div></td><td class="msource">ListMenu</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.menu.ListMenu-checkchange"></a><b><a href="source/ux-all-debug.html#event-Ext.ux.menu.ListMenu-checkchange">checkchange</a></b> :
  19                                       (&nbsp;<code>Object&nbsp;item</code>,&nbsp;<code>Object&nbsp;checked</code>&nbsp;)
  20     <div class="mdesc"><div class="short">Fires when there is a change in checked items from this list</div><div class="long">Fires when there is a change in checked items from this list<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>item</code> : Object<div class="sub-desc">Ext.menu.CheckItem</div></li><li><code>checked</code> : Object<div class="sub-desc">The checked value that was set</div></li></ul></div></div></div></td><td class="msource">ListMenu</td></tr></tbody></table></div>