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.Provider</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.Provider-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.state.Provider-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.state.Provider-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.state.Provider-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.Provider
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_Provider.js.html">Roo/state/Provider.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">Provider</td></tr>
65 <tr><td class="label">Subclasses:</td><td class="hd-info">
66 <a href="./Roo.state.CookieProvider.html#constructor" roo:cls="Roo.state.CookieProvider.html#constructor">Roo.state.CookieProvider</a>
77 <!-- ============================== class summary ========================== -->
78 <div class="description">
79 Abstract base class for state provider implementations. This class provides methods<br/>for encoding and decoding <b>typed</b> variables including dates and defines the <br/>Provider interface.
83 <!-- ============================== Class comment block... ========================== -->
85 <div class="comments">
86 <b>Class Comments / Notes</B> =>
87 <u onclick="parent.CommentDialog.showCommentId = 'Roo.state.Provider';">[Add Your comment/notes about this class]</u>
89 <iframe frameborder="0" id="comments-Roo.state" style="border: none;width:100%;"
90 src="/blog.php/GtkDjsComments/Roo.state.Provider.html"></iframe>
95 <!-- ============================== config options ========================== -->
100 <div class="hr"></div>
101 <a id="Roo.state.Provider-configs"></a>
105 <table cellspacing="0" class="member-table">
106 <caption class="Empty">Config Options - Has None</caption>
120 <!-- ============================== public properties ==================== -->
124 <a id="Roo.state.Provider-props"></a>
130 <table cellspacing="0" class="member-table">
131 <caption class="Empty">Public Properties - Has None</caption>
137 <!-- ============================== methods summary / details ======================== -->
140 <a id="Roo.state.Provider-methods"></a>
141 <!-- constructor?? -->
148 <!-- then dynamics first -->
155 <table cellspacing="0" class="member-table">
156 <caption>Public Methods</caption>
158 <th class="sig-header" colspan="2">Method</th>
159 <th class="msource-header">Defined By</th>
169 <tr class="method-row config-row-alt0 notInherited">
170 <td class="micon"><a class="exi" href="#expand"> </a></td>
174 <a id="Roo.state-method-Provider" name=".Provider"></a>
175 <div class="fixedFont">
176 <span class="attributes">new <B>Roo.state.</B></span><b class="itemname">Provider</b>
186 <div class="short">Create a new Roo.state.Provider</div>
193 Create a new Roo.state.Provider
216 <tr class="method-row config-row-alt1 expandable notInherited">
217 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.state.Provider-method-clear" name=".clear"></a>
222 <div class="fixedFont">
223 <span class="attributes"></span><b class="itemname">clear</b>
225 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
232 <div class="short">Clears a value from the state</div>
238 Clears a value from the state
245 <dl class="detailList">
246 <dt class="heading">Parameters:</dt>
249 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
252 <dd>The key name</dd>
278 <tr class="method-row config-row-alt0 expandable notInherited">
279 <td class="micon"><a class="exi" href="#expand"> </a></td>
283 <a id="Roo.state.Provider-method-decodeValue" name=".decodeValue"></a>
284 <div class="fixedFont">
285 <span class="attributes"></span><b class="itemname">decodeValue</b>
287 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
302 <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div>
308 Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
315 <dl class="detailList">
316 <dt class="heading">Parameters:</dt>
319 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
322 <dd>The value to decode</dd>
330 <dl class="detailList">
331 <dt class="heading">Returns:</dt>
333 <dd><span class="fixedFont">Mixed</span> The decoded value</dd>
355 <tr class="method-row config-row-alt1 expandable notInherited">
356 <td class="micon"><a class="exi" href="#expand"> </a></td>
360 <a id="Roo.state.Provider-method-encodeValue" name=".encodeValue"></a>
361 <div class="fixedFont">
362 <span class="attributes"></span><b class="itemname">encodeValue</b>
364 (Mixed <B><i>value</i></B>)
370 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
379 <div class="short">Encodes a value including type information.</div>
385 Encodes a value including type information. Decode with {<b>link</b> <b>decodeValue</b>}.
392 <dl class="detailList">
393 <dt class="heading">Parameters:</dt>
396 <span class="fixedFont">Mixed</span> <b>value</b>
399 <dd>The value to encode</dd>
407 <dl class="detailList">
408 <dt class="heading">Returns:</dt>
410 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The encoded value</dd>
432 <tr class="method-row config-row-alt0 expandable notInherited">
433 <td class="micon"><a class="exi" href="#expand"> </a></td>
437 <a id="Roo.state.Provider-method-get" name=".get"></a>
438 <div class="fixedFont">
439 <span class="attributes"></span><b class="itemname">get</b>
441 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
456 <div class="short">Returns the current value for a key</div>
462 Returns the current value for a key
469 <dl class="detailList">
470 <dt class="heading">Parameters:</dt>
473 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
476 <dd>The key name</dd>
479 <span class="fixedFont">Mixed</span> <b>defaultValue</b>
482 <dd>A default value to return if the key's value is not found</dd>
490 <dl class="detailList">
491 <dt class="heading">Returns:</dt>
493 <dd><span class="fixedFont">Mixed</span> The state data</dd>
515 <tr class="method-row config-row-alt1 expandable notInherited">
516 <td class="micon"><a class="exi" href="#expand"> </a></td>
520 <a id="Roo.state.Provider-method-set" name=".set"></a>
521 <div class="fixedFont">
522 <span class="attributes"></span><b class="itemname">set</b>
524 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
531 <div class="short">Sets the value for a key</div>
537 Sets the value for a key
544 <dl class="detailList">
545 <dt class="heading">Parameters:</dt>
548 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
551 <dd>The key name</dd>
554 <span class="fixedFont">Mixed</span> <b>value</b>
557 <dd>The value to set</dd>
586 <!-- ============================== events summary / details ======================== -->
589 <a id="Roo.state.Provider-events"></a>
598 <table cellspacing="0" class="member-table">
599 <caption>Events</caption>
602 <th class="sig-header" colspan="2">Event</th>
603 <th class="msource-header">Defined By</th>
612 <tr class="method-row expandable config-row-alt0 notInherited">
613 <td class="micon"><a class="exi" href="#expand"> </a></td>
616 <a id="Roo.state.Provider-event-*statechange"></a>
618 <div class="fixedFont">
619 <b class="itemname">statechange</b> (Provider <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>key</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
625 <div class="short">Fires when a state change occurs.
631 Fires when a state change occurs.
637 <dl class="detailList">
638 <dt class="heading">Parameters:</dt>
641 <span class="fixedFont">Provider</span> <b>this</b>
644 <dd>This state provider</dd>
647 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
650 <dd>The state key which was changed</dd>
653 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
656 <dd>The encoded value for the state</dd>
686 <!-- ============================== footer ================================= -->
687 <div class="fineprint" style="clear:both">
689 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Sep 09 2016 14:38:14 GMT+0800 (HKT)
691 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>