docs/output/Ext.air.FileProvider.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.air.FileProvider-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.air.FileProvider-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.air.FileProvider-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.air.FileProvider-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
   7                         <a class="bookmark" href="../docs/?class=Ext.air.FileProvider"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   8         </div>
   9                 <div class="inheritance res-block">
  10 <pre class="res-block-inner"><a ext:cls="Ext.state.Provider" ext:member="" href="output/Ext.state.Provider.html">Provider</a>
  11   <img src="resources/elbow-end.gif"/>FileProvider</pre></div>
  12                 <h1>Class Ext.air.FileProvider</h1>
  13         <table cellspacing="0">
  14             <tr><td class="label">Package:</td><td class="hd-info">Ext.air</td></tr>
  15             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/FileProvider.js" target="_blank">FileProvider.js</a></td></tr>
  16             <tr><td class="label">Class:</td><td class="hd-info">FileProvider</td></tr>
  17                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.state.Provider" ext:member="" href="output/Ext.state.Provider.html">Provider</a></td></tr>
  18                     </table>
  19         <div class="description">
  20             *
  21 An Ext state provider implementation for Adobe AIR that stores state in the application
  22 storage directory.        </div>
  23
  24         <div class="hr"></div>
  25                 <a id="Ext.air.FileProvider-configs"></a>
  26         <h2>Config Options</h2>
  27         <table cellspacing="0" class="member-table">
  28             <tr>
  29                 <th class="sig-header" colspan="2">Config Options</th>
  30                 <th class="msource-header">Defined By</th>
  31             </tr>
  32                 <tr class="config-row">\r
  33         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  34         <td class="sig">\r
  35         <a id="Ext.air.FileProvider-defaultState"></a>\r
  36             <b>defaultState</b> : Object            <div class="mdesc">\r
  37                             The default state if no state file can be found                        </div>\r
  38         </td>\r
  39         <td class="msource">FileProvider</td>\r
  40     </tr>\r
  41         <tr class="config-row alt">\r
  42         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  43         <td class="sig">\r
  44         <a id="Ext.air.FileProvider-file"></a>\r
  45             <b>file</b> : String            <div class="mdesc">\r
  46                             The file name to use for the state file in the application storage directory                        </div>\r
  47         </td>\r
  48         <td class="msource">FileProvider</td>\r
  49     </tr>\r
  50             </table>
  51                 <a id="Ext.air.FileProvider-props"></a>
  52         <h2>Public Properties</h2>
  53         <div class="no-members">This class has no public properties.</div>        <a id="Ext.air.FileProvider-methods"></a>
  54         <h2>Public Methods</h2>
  55                 <table cellspacing="0" class="member-table">
  56             <tr>
  57                 <th class="sig-header" colspan="2">Method</th>
  58                 <th class="msource-header">Defined By</th>
  59             </tr>
  60                 <tr class="method-row expandable">\r
  61         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  62         <td class="sig">\r
  63         <a id="Ext.air.FileProvider-FileProvider"></a>\r
  64             <b>FileProvider</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
  65                         <div class="short"></div>\r
  66             <div class="long">\r
  67                     <div class="mdetail-params">\r
  68         <strong>Parameters:</strong>\r
  69         <ul><li><code>config</code> : Object<div class="sub-desc"></div></li>        </ul>\r
  70         <strong>Returns:</strong>\r
  71         <ul>\r
  72             <li><code></code></li>\r
  73         </ul>\r
  74     </div>\r
  75                 </div>\r
  76                         </div>\r
  77         </td>\r
  78         <td class="msource">FileProvider</td>\r
  79     </tr>\r
  80         <tr class="method-row inherited alt expandable">\r
  81         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  82         <td class="sig">\r
  83         <a id="Ext.air.FileProvider-clear"></a>\r
  84             <b>clear</b>(&nbsp;<code>String name</code>&nbsp;) : void            <div class="mdesc">\r
  85                         <div class="short">Clears a value from the state</div>\r
  86             <div class="long">\r
  87                 Clears a value from the state    <div class="mdetail-params">\r
  88         <strong>Parameters:</strong>\r
  89         <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li>        </ul>\r
  90         <strong>Returns:</strong>\r
  91         <ul>\r
  92             <li><code>void</code></li>\r
  93         </ul>\r
  94     </div>\r
  95                 </div>\r
  96                         </div>\r
  97         </td>\r
  98         <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#clear" href="output/Ext.state.Provider.html#clear">Provider</a></td>\r
  99     </tr>\r
 100         <tr class="method-row inherited expandable">\r
 101         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 102         <td class="sig">\r
 103         <a id="Ext.air.FileProvider-decodeValue"></a>\r
 104             <b>decodeValue</b>(&nbsp;<code>String value</code>&nbsp;) : Mixed            <div class="mdesc">\r
 105                         <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
 106             <div class="long">\r
 107                 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
 108         <strong>Parameters:</strong>\r
 109         <ul><li><code>value</code> : String<div class="sub-desc">The value to decode</div></li>        </ul>\r
 110         <strong>Returns:</strong>\r
 111         <ul>\r
 112             <li><code>Mixed</code><div class="sub-desc">The decoded value</div></li>\r
 113         </ul>\r
 114     </div>\r
 115                 </div>\r
 116                         </div>\r
 117         </td>\r
 118         <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#decodeValue" href="output/Ext.state.Provider.html#decodeValue">Provider</a></td>\r
 119     </tr>\r
 120         <tr class="method-row inherited alt expandable">\r
 121         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 122         <td class="sig">\r
 123         <a id="Ext.air.FileProvider-encodeValue"></a>\r
 124             <b>encodeValue</b>(&nbsp;<code>Mixed value</code>&nbsp;) : String            <div class="mdesc">\r
 125                         <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
 126             <div class="long">\r
 127                 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
 128         <strong>Parameters:</strong>\r
 129         <ul><li><code>value</code> : Mixed<div class="sub-desc">The value to encode</div></li>        </ul>\r
 130         <strong>Returns:</strong>\r
 131         <ul>\r
 132             <li><code>String</code><div class="sub-desc">The encoded value</div></li>\r
 133         </ul>\r
 134     </div>\r
 135                 </div>\r
 136                         </div>\r
 137         </td>\r
 138         <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#encodeValue" href="output/Ext.state.Provider.html#encodeValue">Provider</a></td>\r
 139     </tr>\r
 140         <tr class="method-row inherited expandable">\r
 141         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 142         <td class="sig">\r
 143         <a id="Ext.air.FileProvider-get"></a>\r
 144             <b>get</b>(&nbsp;<code>String name</code>, <code>Mixed defaultValue</code>&nbsp;) : Mixed            <div class="mdesc">\r
 145                         <div class="short">Returns the current value for a key</div>\r
 146             <div class="long">\r
 147                 Returns the current value for a key    <div class="mdetail-params">\r
 148         <strong>Parameters:</strong>\r
 149         <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
 150         <strong>Returns:</strong>\r
 151         <ul>\r
 152             <li><code>Mixed</code><div class="sub-desc">The state data</div></li>\r
 153         </ul>\r
 154     </div>\r
 155                 </div>\r
 156                         </div>\r
 157         </td>\r
 158         <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#get" href="output/Ext.state.Provider.html#get">Provider</a></td>\r
 159     </tr>\r
 160         <tr class="method-row inherited alt expandable">\r
 161         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 162         <td class="sig">\r
 163         <a id="Ext.air.FileProvider-set"></a>\r
 164             <b>set</b>(&nbsp;<code>String name</code>, <code>Mixed value</code>&nbsp;) : void            <div class="mdesc">\r
 165                         <div class="short">Sets the value for a key</div>\r
 166             <div class="long">\r
 167                 Sets the value for a key    <div class="mdetail-params">\r
 168         <strong>Parameters:</strong>\r
 169         <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
 170         <strong>Returns:</strong>\r
 171         <ul>\r
 172             <li><code>void</code></li>\r
 173         </ul>\r
 174     </div>\r
 175                 </div>\r
 176                         </div>\r
 177         </td>\r
 178         <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#set" href="output/Ext.state.Provider.html#set">Provider</a></td>\r
 179     </tr>\r
 180             </table>
 181                 <a id="Ext.air.FileProvider-events"></a>
 182         <h2>Public Events</h2>
 183                 <table cellspacing="0" class="member-table">
 184             <tr>
 185                 <th class="sig-header" colspan="2">Event</th>
 186                 <th class="msource-header">Defined By</th>
 187             </tr>
 188                 <tr class="event-row inherited expandable">\r
 189         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 190         <td class="sig">\r
 191         <a id="Ext.air.FileProvider-statechange"></a>\r
 192             <b>statechange</b> : (&nbsp;<code>Provider this</code>, <code>String key</code>, <code>String value</code>&nbsp;)            <div class="mdesc">\r
 193                         <div class="short">Fires when a state change occurs.</div>\r
 194             <div class="long">\r
 195                 Fires when a state change occurs.    <div class="mdetail-params">\r
 196         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 197         <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
 198     </div>\r
 199                 </div>\r
 200                         </div>\r
 201         </td>\r
 202         <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#event-statechange" href="output/Ext.state.Provider.html#event-statechange">Provider</a></td>\r
 203     </tr>\r
 204             </table>
 205
 206         </div>