Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

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