examples/docs/output/Ext.ux.DataViewTransition.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.DataViewTransition-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.DataViewTransition-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.DataViewTransition-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.DataViewTransition-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.DataViewTransition"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/DataViewTransition.html#cls-Ext.ux.DataViewTransition">Ext.ux.DataViewTransition</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/DataViewTransition.html#cls-Ext.ux.DataViewTransition">DataViewTransition.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DataViewTransition.html#cls-Ext.ux.DataViewTransition">DataViewTransition</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"></div><div class="hr"></div><a id="Ext.ux.DataViewTransition-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.DataViewTransition-enableTabbing"></a><b><a href="source/Focus.html#cfg-Ext.ux.DataViewTransition-enableTabbing">enableTabbing</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable tabbing. Default is <tt>false</tt>.</div></td><td class="msource">DataViewTransition</td></tr></tbody></table><a id="Ext.ux.DataViewTransition-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.DataViewTransition-cachedStoreData"></a><b><a href="source/DataViewTransition.html#prop-Ext.ux.DataViewTransition-cachedStoreData">cachedStoreData</a></b> : Object
   2 A cache of existing store data, keyed by id. This is used to determine
   3 whether any items were added or removed from the store on data change<div class="mdesc"></div></td><td class="msource">DataViewTransition</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.DataViewTransition-dataview"></a><b><a href="source/DataViewTransition.html#prop-Ext.ux.DataViewTransition-dataview">dataview</a></b> : Ext.DataView
   4 Reference to the DataView this instance is bound to<div class="mdesc"></div></td><td class="msource">DataViewTransition</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.DataViewTransition-dataviewID"></a><b><a href="source/DataViewTransition.html#prop-Ext.ux.DataViewTransition-dataviewID">dataviewID</a></b> : String
   5 The string ID of the DataView component. This is used internally when animating child objects<div class="mdesc"></div></td><td class="msource">DataViewTransition</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.DataViewTransition-defaults"></a><b><a href="source/DataViewTransition.html#prop-Ext.ux.DataViewTransition-defaults">defaults</a></b> : Object
   6 Default configuration options for all DataViewTransition instances<div class="mdesc"></div></td><td class="msource">DataViewTransition</td></tr></tbody></table><a id="Ext.ux.DataViewTransition-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.DataViewTransition-cacheStoreData"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-cacheStoreData">cacheStoreData</a></b>(&nbsp;<code>Ext.data.Store&nbsp;store</code>&nbsp;)
   7     :
   8                                         void<div class="mdesc"><div class="short">Caches the records from a store locally for comparison later</div><div class="long">Caches the records from a store locally for comparison later<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>store</code> : Ext.data.Store<div class="sub-desc">The store to cache data from</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DataViewTransition</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.DataViewTransition-constructor"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-constructor">constructor</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
   9     :
  10                                         void<div class="mdesc"><div class="short">Creates the plugin instance, applies defaults</div><div class="long">Creates the plugin instance, applies defaults<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">Optional config object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DataViewTransition</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.DataViewTransition-getAdded"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-getAdded">getAdded</a></b>(&nbsp;<code>Ext.data.Store&nbsp;store</code>&nbsp;)
  11     :
  12                                         Object<div class="mdesc"><div class="short">Returns all records in the given store that were not already present</div><div class="long">Returns all records in the given store that were not already present<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>store</code> : Ext.data.Store<div class="sub-desc">The updated store instance</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">Object of records not already present in the dataview in format {id: record}</div></li></ul></div></div></div></td><td class="msource">DataViewTransition</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.DataViewTransition-getExisting"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-getExisting">getExisting</a></b>()
  13     :
  14                                         Object<div class="mdesc"><div class="short">Returns all records that were already in the DataView</div><div class="long">Returns all records that were already in the DataView<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">All existing records</div></li></ul></div></div></div></td><td class="msource">DataViewTransition</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.DataViewTransition-getExistingCount"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-getExistingCount">getExistingCount</a></b>()
  15     :
  16                                         Number<div class="mdesc"><div class="short">Returns the total number of items that are currently visible in the DataView</div><div class="long">Returns the total number of items that are currently visible in the DataView<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 existing items</div></li></ul></div></div></div></td><td class="msource">DataViewTransition</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.DataViewTransition-getRemaining"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-getRemaining">getRemaining</a></b>(&nbsp;<code>Ext.data.Store&nbsp;store</code>&nbsp;)
  17     :
  18                                         Object<div class="mdesc"><div class="short">Returns all records that are already present and are still present in the new store</div><div class="long">Returns all records that are already present and are still present in the new store<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>store</code> : Ext.data.Store<div class="sub-desc">The updated store instance</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">Object of records that are still present from last time in format {id: record}</div></li></ul></div></div></div></td><td class="msource">DataViewTransition</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.DataViewTransition-getRemoved"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-getRemoved">getRemoved</a></b>(&nbsp;<code>Ext.data.Store&nbsp;store</code>&nbsp;)
  19     :
  20                                         Array<div class="mdesc"><div class="short">Returns all records that are present in the DataView but not the new store</div><div class="long">Returns all records that are present in the DataView but not the new store<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>store</code> : Ext.data.Store<div class="sub-desc">The updated store instance</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">Array of records that used to be present</div></li></ul></div></div></div></td><td class="msource">DataViewTransition</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.DataViewTransition-init"></a><b><a href="source/DataViewTransition.html#method-Ext.ux.DataViewTransition-init">init</a></b>(&nbsp;<code>Ext.DataView&nbsp;dataview</code>&nbsp;)
  21     :
  22                                         void<div class="mdesc"><div class="short">Initializes the transition plugin. Overrides the dataview's default refresh function</div><div class="long">Initializes the transition plugin. Overrides the dataview's default refresh function<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>dataview</code> : Ext.DataView<div class="sub-desc">The dataview</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DataViewTransition</td></tr></tbody></table><a id="Ext.ux.DataViewTransition-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>