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