1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.state.Manager</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.state.Manager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.state.Manager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.state.Manager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.state.Manager-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
50 Class Roo.state.Manager
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.state</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_state_Manager.js.html">Roo/state/Manager.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">Manager</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 This is the global state manager. By default all components that are "state aware" check this class<br/>for state information if you don't pass them a custom state provider. In order for this class<br/>to be useful, it must be initialized with a provider when your application initializes.<br/> <pre><code><br/>// in your initialization function<br/>init : function(){<br/> Roo.state.Manager.setProvider(new Roo.state.CookieProvider());<br/> ...<br/> // supposed you have a {<b>link</b> Roo.BorderLayout}<br/> var layout = new Roo.BorderLayout(...);<br/> layout.restoreState();<br/> // or a {Roo.BasicDialog}<br/> var dialog = new Roo.BasicDialog(...);<br/> dialog.restoreState();<br/> </code></pre>
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.state.Manager';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo.state" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.state.Manager.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.state.Manager-configs"></a>
98 <table cellspacing="0" class="member-table">
99 <caption class="Empty">Config Options - Has None</caption>
113 <!-- ============================== public properties ==================== -->
117 <a id="Roo.state.Manager-props"></a>
123 <table cellspacing="0" class="member-table">
124 <caption class="Empty">Public Properties - Has None</caption>
130 <!-- ============================== methods summary / details ======================== -->
133 <a id="Roo.state.Manager-methods"></a>
134 <!-- constructor?? -->
141 <!-- then dynamics first -->
148 <table cellspacing="0" class="member-table">
149 <caption>Public Methods</caption>
151 <th class="sig-header" colspan="2">Method</th>
152 <th class="msource-header">Defined By</th>
162 <tr class="method-row config-row-alt0 expandable notInherited">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
167 <a id="Roo.state.Manager-method-clear" name=".clear"></a>
168 <div class="fixedFont">
169 <span class="attributes">Roo.state.Manager.</span><b class="itemname">clear</b>
171 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
178 <div class="short">Clears a value from the state</div>
184 Clears a value from the state
191 <dl class="detailList">
192 <dt class="heading">Parameters:</dt>
195 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
198 <dd>The key name</dd>
224 <tr class="method-row config-row-alt1 expandable notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
229 <a id="Roo.state.Manager-method-get" name=".get"></a>
230 <div class="fixedFont">
231 <span class="attributes">Roo.state.Manager.</span><b class="itemname">get</b>
233 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
248 <div class="short">Returns the current value for a key</div>
254 Returns the current value for a key
261 <dl class="detailList">
262 <dt class="heading">Parameters:</dt>
265 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
268 <dd>The key name</dd>
271 <span class="fixedFont">Mixed</span> <b>defaultValue</b>
274 <dd>The default value to return if the key lookup does not match</dd>
282 <dl class="detailList">
283 <dt class="heading">Returns:</dt>
285 <dd><span class="fixedFont">Mixed</span> The state data</dd>
307 <tr class="method-row config-row-alt0 expandable notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
312 <a id="Roo.state.Manager-method-getProvider" name=".getProvider"></a>
313 <div class="fixedFont">
314 <span class="attributes">Roo.state.Manager.</span><b class="itemname">getProvider</b>
331 <div class="short">Gets the currently configured state provider</div>
337 Gets the currently configured state provider
348 <dl class="detailList">
349 <dt class="heading">Returns:</dt>
351 <dd><span class="fixedFont">Provider</span> The state provider</dd>
373 <tr class="method-row config-row-alt1 expandable notInherited">
374 <td class="micon"><a class="exi" href="#expand"> </a></td>
378 <a id="Roo.state.Manager-method-set" name=".set"></a>
379 <div class="fixedFont">
380 <span class="attributes">Roo.state.Manager.</span><b class="itemname">set</b>
382 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
389 <div class="short">Sets the value for a key</div>
395 Sets the value for a key
402 <dl class="detailList">
403 <dt class="heading">Parameters:</dt>
406 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
409 <dd>The key name</dd>
412 <span class="fixedFont">Mixed</span> <b>value</b>
415 <dd>The state data</dd>
441 <tr class="method-row config-row-alt0 expandable notInherited">
442 <td class="micon"><a class="exi" href="#expand"> </a></td>
446 <a id="Roo.state.Manager-method-setProvider" name=".setProvider"></a>
447 <div class="fixedFont">
448 <span class="attributes">Roo.state.Manager.</span><b class="itemname">setProvider</b>
450 (Provider <B><i>stateProvider</i></B>)
457 <div class="short">Configures the default state provider for your application</div>
463 Configures the default state provider for your application
470 <dl class="detailList">
471 <dt class="heading">Parameters:</dt>
474 <span class="fixedFont">Provider</span> <b>stateProvider</b>
477 <dd>The state provider to set</dd>
506 <!-- ============================== events summary / details ======================== -->
509 <a id="Roo.state.Manager-events"></a>
515 <table cellspacing="0" class="member-table">
516 <caption class="Empty">Events - Has None</caption>
527 <!-- ============================== footer ================================= -->
528 <div class="fineprint" style="clear:both">
530 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Sep 08 2016 17:33:07 GMT+0800 (HKT)
532 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>