1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/* Authors:
* Petr Vobornik <pvoborni@redhat.com>
*
* Copyright (C) 2012 Red Hat
* see file 'COPYING' for use and warranty information
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
define(['dojo/_base/declare',
'dojo/_base/lang',
'dojo/Evented',
'dojo/router'
],
function(declare, lang, Evented, router) {
/**
* Router
*
* This component keeps menu and routes in sync. It signalizes
* other components to display facet by sending 'show-facet' event.
* Other components can use navigate_to_* methods to change currently
* displayed facet. This change can be canceled in 'facet-change'
* event handler.
* @class navigation.Router
*/
var navigation = declare([Evented], {
/**
* Holds references to register route handlers.
* Can be used for unregistering routes.
* @property {Array.<Function>}
*/
route_handlers: [],
/**
* Prefix of all routes for this navigation. Useful for multiple
* navigation objects in one application.
* @property {string}
*/
route_prefix: '',
/**
* Used during facet changing. Set it to true in 'facet-change'
* event handler to stop the change.
* @property {boolean}
*/
canceled: false,
/**
* Flag to indicate that next hash change should not invoke showing a
* facet.
* Main purpose: updating hash.
* @property {boolean}
*/
ignore_next: false,
/**
* Register a route-handler pair to a dojo.router
* Handler will be run in context of this object
*
* @param {string|Array.<string>} route or routes to register
* @param {Function} handler to be associated with the route(s)
*/
register_route: function(route, handler) {
if (route instanceof Array) {
for (var i=0, l=route.length; i<l; i++) {
this.register_route(route[i], handler);
}
} else {
var r = this.route_prefix + route;
this.route_handlers.push(router.register(r, lang.hitch(this, handler)));
}
},
/**
* Navigate to given hash
*
* @fires facet-change
* @fires facet-change-canceled
*/
navigate_to_hash: function(hash, facet) {
this.canceled = false;
this.emit('facet-change', { facet: facet, hash: hash });
if (this.canceled) {
this.emit('facet-change-canceled', { facet: facet, hash : hash });
return false;
}
this.update_hash(hash, false);
return true;
},
/**
* Changes hash to supplied
*
* @param {string} Hash to set
* @param {boolean} Whether to suppress following hash change handler
*/
update_hash: function(hash, ignore_change) {
this.ignore_next = !!ignore_change;
router.go(hash);
},
/**
* Returns and resets `ignore_next` property.
*/
check_clear_ignore: function() {
var ignore = this.ignore_next;
this.ignore_next = false;
return ignore;
},
/**
* Tells other component to show given facet.
*/
show_facet: function(facet) {
this.emit('facet-show', {
facet: facet
});
},
/**
* Raise 'error'
* @protected
* @fires error
*/
_error: function(msg, type, context) {
this.emit('error', {
message: msg,
type: type,
context: context
});
},
/**
* Starts routing
*/
startup: function() {
router.startup();
},
constructor: function(spec) {
spec = spec || {};
}
});
return navigation;
});
|
