Subversion Repositories eFlore/Applications.cel

Rev

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