source:
trunk/workshop-routing-foss4g/web/GeoExt/docs/_sources/lib/GeoExt/state/PermalinkProvider.txt
@
76
Revision 76, 2.1 KB checked in by djay, 12 years ago (diff) | |
---|---|
|
Rev | Line | |
---|---|---|
[76] | 1 | |
2 | .. currentmodule:: GeoExt.state | |
3 | ||
4 | :class:`GeoExt.state.PermalinkProvider` | |
5 | ================================================================================ | |
6 | ||
7 | ||
8 | .. cssclass:: meta | |
9 | ||
10 | ||
11 | Extends | |
12 | * `Ext.state.Provider <http://dev.sencha.com/deploy/dev/docs/?class=Ext.state.Provider>`_ | |
13 | ||
14 | ||
15 | ||
16 | ||
17 | ||
18 | ||
19 | ||
20 | .. class:: PermalinkProvider(config) | |
21 | ||
22 | Create a permalink provider. | |
23 | ||
24 | ||
25 | ||
26 | ||
27 | Example Use | |
28 | ----------- | |
29 | ||
30 | Sample code displaying a new permalink each time the map is moved. | |
31 | ||
32 | .. code-block:: javascript | |
33 | ||
34 | // create permalink provider | |
35 | var permalinkProvider = new GeoExt.state.PermalinkProvider(); | |
36 | ||
37 | // set it in the state manager | |
38 | Ext.state.Manager.setProvider(permalinkProvider); | |
39 | ||
40 | // create a map panel, and make it stateful | |
41 | var mapPanel = new GeoExt.MapPanel({ | |
42 | renderTo: "map", | |
43 | layers: [ | |
44 | new OpenLayers.Layer.WMS( | |
45 | "Global Imagery", | |
46 | "http://maps.opengeo.org/geowebcache/service/wms", | |
47 | {layers: "bluemarble"} | |
48 | ) | |
49 | ], | |
50 | stateId: "map", | |
51 | prettyStateKeys: true // for pretty permalinks | |
52 | }); | |
53 | ||
54 | // display permalink each time state is changed | |
55 | permalinkProvider.on({ | |
56 | statechanged: function(provider, name, value) { | |
57 | alert(provider.getLink()); | |
58 | } | |
59 | }); | |
60 | ||
61 | ||
62 | ||
63 | ||
64 | Config Options | |
65 | -------------- | |
66 | ||
67 | Configuration properties in addition to | |
68 | those listed for `Ext.state.Provider <http://dev.sencha.com/deploy/dev/docs/?class=Ext.state.Provider>`_. | |
69 | ||
70 | ||
71 | .. describe:: encodeType | |
72 | ||
73 | ``Boolean`` Specifies whether type of state values should be encoded | |
74 | and decoded. Set it to false if you work with components that don't | |
75 | require encoding types, and want pretty permalinks. Defaults to true. | |
76 | ||
77 | ||
78 | ||
79 | ||
80 | ||
81 | ||
82 | Public Methods | |
83 | -------------- | |
84 | ||
85 | Public methods in addition to those | |
86 | listed for `Ext.state.Provider <http://dev.sencha.com/deploy/dev/docs/?class=Ext.state.Provider>`_. | |
87 | ||
88 | ||
89 | .. method:: PermalinkProvider.getLink | |
90 | ||
91 | :param base: ``String`` The base URL, optional. | |
92 | :return: ``String`` The permalink. | |
93 | ||
94 | Return the permalink corresponding to the current state. | |
95 | ||
96 | ||
97 | ||
98 | ||
99 |
Note: See TracBrowser
for help on using the repository browser.