Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | 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.Manager-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 
            <a class="inner-link" href="#Ext.state.Manager-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 
            <a class="inner-link" href="#Ext.state.Manager-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 
                        <a class="bookmark" href="../docs/?class=Ext.state.Manager"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7 
        </div>
8 
                <h1>Class Ext.state.Manager</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/StateManager.js" target="_blank">StateManager.js</a></td></tr>
12 
            <tr><td class="label">Class:</td><td class="hd-info">Manager</td></tr>
13 
                                    <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
14 
                    </table>
15 
        <div class="description">
16 
            This is the global state manager. By default all components that are "state aware" check this class
17 
for state information if you don't pass them a custom state provider. In order for this class
18 
to be useful, it must be initialized with a provider when your application initializes.
19 
 <pre><code><i>// <b>in</b> your initialization <b>function</b></i>
20 
init : <b>function</b>(){
21 
   Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());
22 
   ...
23 
   <i>// supposed you have a <a ext:cls=<em>"Ext.BorderLayout"</em> href=<em>"output/Ext.BorderLayout.html"</em>>Ext.BorderLayout</a></i>
24 
   <b>var</b> layout = <b>new</b> Ext.BorderLayout(...);
25 
   layout.restoreState();
26 
   <i>// or a {Ext.BasicDialog}</i>
27 
   <b>var</b> dialog = <b>new</b> Ext.BasicDialog(...);
28 
   dialog.restoreState();</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
29 
 
30 
        <div class="hr"></div>
31 
                <a id="Ext.state.Manager-props"></a>
32 
        <h2>Public Properties</h2>
33 
        <div class="no-members">This class has no public properties.</div>        <a id="Ext.state.Manager-methods"></a>
34 
        <h2>Public Methods</h2>
35 
                <table cellspacing="0" class="member-table">
36 
            <tr>
37 
                <th class="sig-header" colspan="2">Method</th>
38 
                <th class="msource-header">Defined By</th>
39 
            </tr>
40 
                <tr class="method-row expandable">
41 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
42 
        <td class="sig">
43 
        <a id="Ext.state.Manager-clear"></a>
44 
            <b>clear</b>(&nbsp;<code>String name</code>&nbsp;) : void            <div class="mdesc">
45 
                        <div class="short">Clears a value from the state</div>
46 
            <div class="long">
47 
                Clears a value from the state    <div class="mdetail-params">
48 
        <strong>Parameters:</strong>
49 
        <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li>        </ul>
50 
        <strong>Returns:</strong>
51 
        <ul>
52 
            <li><code>void</code></li>
53 
        </ul>
54 
    </div>
55 
                </div>
56 
                        </div>
57 
        </td>
58 
        <td class="msource">Manager</td>
59 
    </tr>
60 
        <tr class="method-row alt expandable">
61 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
62 
        <td class="sig">
63 
        <a id="Ext.state.Manager-get"></a>
64 
            <b>get</b>(&nbsp;<code>String name</code>, <code>Mixed defaultValue</code>&nbsp;) : Mixed            <div class="mdesc">
65 
                        <div class="short">Returns the current value for a key</div>
66 
            <div class="long">
67 
                Returns the current value for a key    <div class="mdetail-params">
68 
        <strong>Parameters:</strong>
69 
        <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>
70 
        <strong>Returns:</strong>
71 
        <ul>
72 
            <li><code>Mixed</code><div class="sub-desc">The state data</div></li>
73 
        </ul>
74 
    </div>
75 
                </div>
76 
                        </div>
77 
        </td>
78 
        <td class="msource">Manager</td>
79 
    </tr>
80 
        <tr class="method-row expandable">
81 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
82 
        <td class="sig">
83 
        <a id="Ext.state.Manager-getProvider"></a>
84 
            <b>getProvider</b>() : Provider            <div class="mdesc">
85 
                        <div class="short">Gets the currently configured state provider</div>
86 
            <div class="long">
87 
                Gets the currently configured state provider    <div class="mdetail-params">
88 
        <strong>Parameters:</strong>
89 
        <ul><li>None.</li>        </ul>
90 
        <strong>Returns:</strong>
91 
        <ul>
92 
            <li><code>Provider</code><div class="sub-desc">The state provider</div></li>
93 
        </ul>
94 
    </div>
95 
                </div>
96 
                        </div>
97 
        </td>
98 
        <td class="msource">Manager</td>
99 
    </tr>
100 
        <tr class="method-row alt expandable">
101 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
102 
        <td class="sig">
103 
        <a id="Ext.state.Manager-set"></a>
104 
            <b>set</b>(&nbsp;<code>String name</code>, <code>Mixed value</code>&nbsp;) : void            <div class="mdesc">
105 
                        <div class="short">Sets the value for a key</div>
106 
            <div class="long">
107 
                Sets the value for a key    <div class="mdetail-params">
108 
        <strong>Parameters:</strong>
109 
        <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>
110 
        <strong>Returns:</strong>
111 
        <ul>
112 
            <li><code>void</code></li>
113 
        </ul>
114 
    </div>
115 
                </div>
116 
                        </div>
117 
        </td>
118 
        <td class="msource">Manager</td>
119 
    </tr>
120 
        <tr class="method-row expandable">
121 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
122 
        <td class="sig">
123 
        <a id="Ext.state.Manager-setProvider"></a>
124 
            <b>setProvider</b>(&nbsp;<code>Provider stateProvider</code>&nbsp;) : void            <div class="mdesc">
125 
                        <div class="short">Configures the default state provider for your application</div>
126 
            <div class="long">
127 
                Configures the default state provider for your application    <div class="mdetail-params">
128 
        <strong>Parameters:</strong>
129 
        <ul><li><code>stateProvider</code> : Provider<div class="sub-desc">The state provider to set</div></li>        </ul>
130 
        <strong>Returns:</strong>
131 
        <ul>
132 
            <li><code>void</code></li>
133 
        </ul>
134 
    </div>
135 
                </div>
136 
                        </div>
137 
        </td>
138 
        <td class="msource">Manager</td>
139 
    </tr>
140 
            </table>
141 
                <a id="Ext.state.Manager-events"></a>
142 
        <h2>Public Events</h2>
143 
        <div class="no-members">This class has no public events.</div>
144 
        </div>