docs/output/Ext.state.Provider.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.state.Provider-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.state.Provider-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.state.Provider-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                         <a class="bookmark" href="../docs/?class=Ext.state.Provider"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   7         </div>
   8                 <h1>Class Ext.state.Provider</h1>
   9         <table cellspacing="0">
  10             <tr><td class="label">Package:</td><td class="hd-info">Ext.state</td></tr>
  11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Provider.js" target="_blank">Provider.js</a></td></tr>
  12             <tr><td class="label">Class:</td><td class="hd-info">Provider</td></tr>
  13                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.air.FileProvider" href="output/Ext.air.FileProvider.html">FileProvider</a>, <a ext:cls="Ext.state.CookieProvider" href="output/Ext.state.CookieProvider.html">CookieProvider</a></td></tr>
  14                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  15                     </table>
  16         <div class="description">
  17             *
  18 Abstract base class for state provider implementations. This class provides methods
  19 for encoding and decoding <b>typed</b> variables including dates and defines the
  20 Provider interface.        </div>
  21
  22         <div class="hr"></div>
  23                 <a id="Ext.state.Provider-props"></a>
  24         <h2>Public Properties</h2>
  25         <div class="no-members">This class has no public properties.</div>        <a id="Ext.state.Provider-methods"></a>
  26         <h2>Public Methods</h2>
  27                 <table cellspacing="0" class="member-table">
  28             <tr>
  29                 <th class="sig-header" colspan="2">Method</th>
  30                 <th class="msource-header">Defined By</th>
  31             </tr>
  32                 <tr class="method-row expandable">\r
  33         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  34         <td class="sig">\r
  35         <a id="Ext.state.Provider-clear"></a>\r
  36             <b>clear</b>(&nbsp;<code>String name</code>&nbsp;) : void            <div class="mdesc">\r
  37                         <div class="short">Clears a value from the state</div>\r
  38             <div class="long">\r
  39                 Clears a value from the state    <div class="mdetail-params">\r
  40         <strong>Parameters:</strong>\r
  41         <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li>        </ul>\r
  42         <strong>Returns:</strong>\r
  43         <ul>\r
  44             <li><code>void</code></li>\r
  45         </ul>\r
  46     </div>\r
  47                 </div>\r
  48                         </div>\r
  49         </td>\r
  50         <td class="msource">Provider</td>\r
  51     </tr>\r
  52         <tr class="method-row alt expandable">\r
  53         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  54         <td class="sig">\r
  55         <a id="Ext.state.Provider-decodeValue"></a>\r
  56             <b>decodeValue</b>(&nbsp;<code>String value</code>&nbsp;) : Mixed            <div class="mdesc">\r
  57                         <div class="short">Decodes a string previously encoded with <a ext:cls="Ext.state.Provider" ext:member="encodeValue" href="output/Ext.state.Provider.html#encodeValue">encodeValue</a>.</div>\r
  58             <div class="long">\r
  59                 Decodes a string previously encoded with <a ext:cls="Ext.state.Provider" ext:member="encodeValue" href="output/Ext.state.Provider.html#encodeValue">encodeValue</a>.    <div class="mdetail-params">\r
  60         <strong>Parameters:</strong>\r
  61         <ul><li><code>value</code> : String<div class="sub-desc">The value to decode</div></li>        </ul>\r
  62         <strong>Returns:</strong>\r
  63         <ul>\r
  64             <li><code>Mixed</code><div class="sub-desc">The decoded value</div></li>\r
  65         </ul>\r
  66     </div>\r
  67                 </div>\r
  68                         </div>\r
  69         </td>\r
  70         <td class="msource">Provider</td>\r
  71     </tr>\r
  72         <tr class="method-row expandable">\r
  73         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  74         <td class="sig">\r
  75         <a id="Ext.state.Provider-encodeValue"></a>\r
  76             <b>encodeValue</b>(&nbsp;<code>Mixed value</code>&nbsp;) : String            <div class="mdesc">\r
  77                         <div class="short">Encodes a value including type information.  Decode with <a ext:cls="Ext.state.Provider" ext:member="decodeValue" href="output/Ext.state.Provider.html#decodeValue">decodeValue</a>.</div>\r
  78             <div class="long">\r
  79                 Encodes a value including type information.  Decode with <a ext:cls="Ext.state.Provider" ext:member="decodeValue" href="output/Ext.state.Provider.html#decodeValue">decodeValue</a>.    <div class="mdetail-params">\r
  80         <strong>Parameters:</strong>\r
  81         <ul><li><code>value</code> : Mixed<div class="sub-desc">The value to encode</div></li>        </ul>\r
  82         <strong>Returns:</strong>\r
  83         <ul>\r
  84             <li><code>String</code><div class="sub-desc">The encoded value</div></li>\r
  85         </ul>\r
  86     </div>\r
  87                 </div>\r
  88                         </div>\r
  89         </td>\r
  90         <td class="msource">Provider</td>\r
  91     </tr>\r
  92         <tr class="method-row alt expandable">\r
  93         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  94         <td class="sig">\r
  95         <a id="Ext.state.Provider-get"></a>\r
  96             <b>get</b>(&nbsp;<code>String name</code>, <code>Mixed defaultValue</code>&nbsp;) : Mixed            <div class="mdesc">\r
  97                         <div class="short">Returns the current value for a key</div>\r
  98             <div class="long">\r
  99                 Returns the current value for a key    <div class="mdetail-params">\r
 100         <strong>Parameters:</strong>\r
 101         <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li><li><code>defaultValue</code> : Mixed<div class="sub-desc">A default value to return if the key's value is not found</div></li>        </ul>\r
 102         <strong>Returns:</strong>\r
 103         <ul>\r
 104             <li><code>Mixed</code><div class="sub-desc">The state data</div></li>\r
 105         </ul>\r
 106     </div>\r
 107                 </div>\r
 108                         </div>\r
 109         </td>\r
 110         <td class="msource">Provider</td>\r
 111     </tr>\r
 112         <tr class="method-row expandable">\r
 113         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 114         <td class="sig">\r
 115         <a id="Ext.state.Provider-set"></a>\r
 116             <b>set</b>(&nbsp;<code>String name</code>, <code>Mixed value</code>&nbsp;) : void            <div class="mdesc">\r
 117                         <div class="short">Sets the value for a key</div>\r
 118             <div class="long">\r
 119                 Sets the value for a key    <div class="mdetail-params">\r
 120         <strong>Parameters:</strong>\r
 121         <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li><li><code>value</code> : Mixed<div class="sub-desc">The value to set</div></li>        </ul>\r
 122         <strong>Returns:</strong>\r
 123         <ul>\r
 124             <li><code>void</code></li>\r
 125         </ul>\r
 126     </div>\r
 127                 </div>\r
 128                         </div>\r
 129         </td>\r
 130         <td class="msource">Provider</td>\r
 131     </tr>\r
 132             </table>
 133                 <a id="Ext.state.Provider-events"></a>
 134         <h2>Public Events</h2>
 135                 <table cellspacing="0" class="member-table">
 136             <tr>
 137                 <th class="sig-header" colspan="2">Event</th>
 138                 <th class="msource-header">Defined By</th>
 139             </tr>
 140                 <tr class="event-row expandable">\r
 141         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 142         <td class="sig">\r
 143         <a id="Ext.state.Provider-statechange"></a>\r
 144             <b>statechange</b> : (&nbsp;<code>Provider this</code>, <code>String key</code>, <code>String value</code>&nbsp;)            <div class="mdesc">\r
 145                         <div class="short">Fires when a state change occurs.</div>\r
 146             <div class="long">\r
 147                 Fires when a state change occurs.    <div class="mdetail-params">\r
 148         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 149         <ul><li><code>this</code> : Provider<div class="sub-desc">This state provider</div></li><li><code>key</code> : String<div class="sub-desc">The state key which was changed</div></li><li><code>value</code> : String<div class="sub-desc">The encoded value for the state</div></li>        </ul>\r
 150     </div>\r
 151                 </div>\r
 152                         </div>\r
 153         </td>\r
 154         <td class="msource">Provider</td>\r
 155     </tr>\r
 156             </table>
 157
 158         </div>