Ext.state.Manager.html
7.38 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
<div class="body-wrap">
<div class="top-tools">
<a class="inner-link" href="#Ext.state.Manager-props"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-prop">Properties</a>
<a class="inner-link" href="#Ext.state.Manager-methods"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-method">Methods</a>
<a class="inner-link" href="#Ext.state.Manager-events"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-event">Events</a>
<a class="bookmark" href="../docs/?class=Ext.state.Manager"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-fav">Direct Link</a>
</div>
<h1>Class Ext.state.Manager</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/StateManager_wev8.js" target="_blank">StateManager_wev8.js</a></td></tr>
<tr><td class="label">Class:</td><td class="hd-info">Manager</td></tr>
<tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
</table>
<div class="description">
This is the global state manager. By default all components that are "state aware" check this class
for state information if you don't pass them a custom state provider. In order for this class
to be useful, it must be initialized with a provider when your application initializes.
<pre><code><i>// <b>in</b> your initialization <b>function</b></i>
init : <b>function</b>(){
Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());
...
<i>// supposed you have a <a ext:cls=<em>"Ext.BorderLayout"</em> href=<em>"output/Ext.BorderLayout.html"</em>>Ext.BorderLayout</a></i>
<b>var</b> layout = <b>new</b> Ext.BorderLayout(...);
layout.restoreState();
<i>// or a {Ext.BasicDialog}</i>
<b>var</b> dialog = <b>new</b> Ext.BasicDialog(...);
dialog.restoreState();</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i> </div>
<div class="hr"></div>
<a id="Ext.state.Manager-props"></a>
<h2>Public Properties</h2>
<div class="no-members">This class has no public properties.</div> <a id="Ext.state.Manager-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.Manager-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">Manager</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.Manager-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">The default value to return if the key lookup does not match</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">Manager</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.state.Manager-getProvider"></a>
<b>getProvider</b>() : Provider <div class="mdesc">
<div class="short">Gets the currently configured state provider</div>
<div class="long">
Gets the currently configured state provider <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Provider</code><div class="sub-desc">The state provider</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Manager</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.Manager-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 state data</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Manager</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.state.Manager-setProvider"></a>
<b>setProvider</b>( <code>Provider stateProvider</code> ) : void <div class="mdesc">
<div class="short">Configures the default state provider for your application</div>
<div class="long">
Configures the default state provider for your application <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>stateProvider</code> : Provider<div class="sub-desc">The state provider to set</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Manager</td>
</tr>
</table>
<a id="Ext.state.Manager-events"></a>
<h2>Public Events</h2>
<div class="no-members">This class has no public events.</div>
</div>