examples/docs/output/Ext.ux.form.ItemSelector.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.form.ItemSelector-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.form.ItemSelector-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.form.ItemSelector-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.form.ItemSelector-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.form.ItemSelector"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/ItemSelector.html#cls-Ext.ux.form.ItemSelector">Ext.ux.form.ItemSelector</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.form</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/ItemSelector.html#cls-Ext.ux.form.ItemSelector">ItemSelector.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/ItemSelector.html#cls-Ext.ux.form.ItemSelector">ItemSelector</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">A control that allows selection of between two Ext.ux.form.MultiSelect controls.</div><div class="hr"></div><a id="Ext.ux.form.ItemSelector-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.form.ItemSelector-multiselects"></a><b><a href="source/ItemSelector.html#cfg-Ext.ux.form.ItemSelector-multiselects">multiselects</a></b> : Array<div class="mdesc">An array of <a href="output/Ext.ux.form.MultiSelect.html" ext:cls="Ext.ux.form.MultiSelect">Ext.ux.form.MultiSelect</a> config objects, with at least all required parameters (e.g., store)</div></td><td class="msource">ItemSelector</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.ItemSelector-multiselects"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.form.ItemSelector-multiselects">multiselects</a></b> : Array<div class="mdesc">An array of <a href="output/Ext.ux.form.MultiSelect.html" ext:cls="Ext.ux.form.MultiSelect">Ext.ux.form.MultiSelect</a> config objects, with at least all required parameters (e.g., store)</div></td><td class="msource">ItemSelector</td></tr></tbody></table><a id="Ext.ux.form.ItemSelector-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.form.ItemSelector-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.form.ItemSelector-ItemSelector"></a><b><a href="source/ItemSelector.html#cls-Ext.ux.form.ItemSelector">ItemSelector</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
   2     <div class="mdesc"><div class="short">Create a new ItemSelector</div><div class="long">Create a new ItemSelector<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">ItemSelector</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.form.ItemSelector-getLockedCount"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.form.ItemSelector-getLockedCount">getLockedCount</a></b>()
   3     :
   4                                         Number<div class="mdesc"><div class="short">Returns the total number of locked columns</div><div class="long">Returns the total number of locked columns<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The number of locked columns</div></li></ul></div></div></div></td><td class="msource">ItemSelector</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.form.ItemSelector-getTotalLockedWidth"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.form.ItemSelector-getTotalLockedWidth">getTotalLockedWidth</a></b>()
   5     :
   6                                         Number<div class="mdesc"><div class="short">Returns the total width of all locked columns</div><div class="long">Returns the total width of all locked columns<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The width of all locked columns</div></li></ul></div></div></div></td><td class="msource">ItemSelector</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.form.ItemSelector-isLocked"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.form.ItemSelector-isLocked">isLocked</a></b>(&nbsp;<code>Number&nbsp;colIndex</code>&nbsp;)
   7     :
   8                                         Boolean<div class="mdesc"><div class="short">Returns true if the given column index is currently locked</div><div class="long">Returns true if the given column index is currently locked<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the column is locked</div></li></ul></div></div></div></td><td class="msource">ItemSelector</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.form.ItemSelector-moveColumn"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.form.ItemSelector-moveColumn">moveColumn</a></b>(&nbsp;<code>Number&nbsp;oldIndex</code>,&nbsp;<code>Number&nbsp;newIndex</code>&nbsp;)
   9     :
  10                                         void<div class="mdesc"><div class="short">Moves a column from one position to another</div><div class="long">Moves a column from one position to another<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>oldIndex</code> : Number<div class="sub-desc">The current column index</div></li><li><code>newIndex</code> : Number<div class="sub-desc">The destination column index</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ItemSelector</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.form.ItemSelector-setLocked"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.form.ItemSelector-setLocked">setLocked</a></b>(&nbsp;<code>Number&nbsp;colIndex</code>,&nbsp;<code>Boolean&nbsp;value</code>,&nbsp;<code>Boolean&nbsp;suppressEvent</code>&nbsp;)
  11     :
  12                                         void<div class="mdesc"><div class="short">Locks or unlocks a given column</div><div class="long">Locks or unlocks a given column<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>value</code> : Boolean<div class="sub-desc">True to lock, false to unlock</div></li><li><code>suppressEvent</code> : Boolean<div class="sub-desc">Pass false to cause the columnlockchange event not to fire</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ItemSelector</td></tr></tbody></table><a id="Ext.ux.form.ItemSelector-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>