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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/* 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/store/Memory',
'dojo/_base/array',
'dojo/_base/lang',
'dojo/store/Observable',
'dojo/Evented',
'../reg',
'../text'
], function(declare, Memory_store, array, lang, Observable, Evented, reg, text) {
/**
* Menu store
*
* Maintains menu hierarchy and selection state.
*/
return declare([Evented], {
/**
* Following properties can be specified in menu item spec:
* @property {String} name
* @property {String} label
* @property {String} title
* @property {Number} position: position among siblings
* @property {menu_item_spec_array} children
* @property {String} entity: entity name
* @property {String} facet: facet name
* @property {Boolean} hidden: menu item is no visible, but can serve for
* other evaluations (nested entities)
*
* Following properties are not in created menu item:
* - children
*
*
* Following properties can be stored in menu item at runtime:
*
* @property {Boolean} selected
* @property {String} parent: name of parent menu item
* @property {String} selected_child: last selected child. Can be set even
* if the child is not selected
*
*/
/**
* Menu name
* @type String
*/
name: null,
/**
* Dojo Store of menu items
* @type: Store
*/
items: null,
/**
* Delimiter used in name creation
* To avoid having multiple menu items with the same name.
* @type String
*/
path_delimiter: '/',
/**
* Selected menu items
* @type Array of menu items
*/
selected: [],
/**
* Default search options: sort by position
*
* @type Object
*/
search_options: { sort: [{attribute:'position'}]},
/**
* Takes a spec of menu item.
* Normalizes item's name, parent, adds children if specified
*
* @param {menu_item} items
* @param {String|menu_item} parent
* @param {Object} options
*/
add_item: function(item, parent, options) {
item = lang.clone(item); //don't modify original spec
// each item must have a name and a label
// FIXME: consider to move entity and facet stuff outside of this object
item.name = item.name || item.facet || item.entity;
if (!name) throw 'Missing menu item property: name';
if (item.label) item.label = text.get(item.label);
if (item.title) item.title = text.get(item.title);
if (item.entity) {
var entity = reg.entity.get(item.entity);
if (!entity) {
return false; //quit
}
if (!item.label) item.label = entity.label;
if (!item.title) item.title = entity.title;
} else if (item.facet) {
var facet = reg.facet.get(item.facet);
if (!facet) {
return false; //quit
}
item.name = facet.name;
if (!item.label) item.label = facet.label;
if (!item.title) item.title = facet.title;
}
item.selected = false;
// check parent
if (typeof parent === 'string') {
parent = this.items.get(parent);
if (!parent) throw 'Menu item\'s parent doesn\t exist';
} else if (typeof parent === 'object') {
if (!this.items.getIdentity(parent)) {
throw 'Supplied parent isn\'t menu item';
}
}
var parent_name = parent ? parent.name : null;
var siblings = this.items.query({ parent: parent_name });
if (!item.position) item.position = siblings.total;
// TODO: add reordering of siblings when position set
item.parent = parent_name;
if (parent) {
// names have to be unique
item.name = parent.name + this.path_delimiter + item.name;
}
// children will be added separately
var children = item.children;
delete item.children;
// finally add the item
this.items.add(item);
// add children
if (children) {
array.forEach(children, function(child) {
this.add_item(child, item);
}, this);
}
return true;
},
add_items: function(/* Array */ items) {
array.forEach(items, function(item) {
this.add_item(item);
}, this);
},
/**
* Query internal data store by using default search options.
*
* @param Object Query filter
* @return QueryResult
*/
query: function(query) {
return this.items.query(query, this.search_options);
},
/**
* Marks item and all its parents as selected.
*/
_select: function(item) {
item.selected = true;
this.selected.push(item);
this.items.put(item);
if (item.parent) {
var parent = this.items.get(item.parent);
parent.selected_child = item.name;
this._select(parent);
}
},
/**
* Selects a menu item and all it's ancestors.
* @param {string|menu_item} Menu item to select
*/
select: function(item) {
if (typeof item == 'string') {
item = this.items.get(item);
}
// FIXME: consider to raise an exception
if (!item || !this.items.getIdentity(item)) return false;
// deselect previous
var old_selection = lang.clone(this.selected);
array.forEach(this.selected, function(mi) {
mi.selected = false;
this.items.put(mi);
}, this);
this.selected = [];
// select new
this._select(item);
var select_state = {
item: item,
new_selection: this.selected,
old_selection: old_selection
};
this.emit('selected', select_state);
return select_state;
},
constructor: function(spec) {
spec = spec || {};
this.items = new Observable( new Memory_store({
idProperty: 'name'
}));
spec = lang.clone(spec);
this.add_items(spec.items || []);
delete spec.items;
declare.safeMixin(this, spec);
}
}); //declare freeipa.menu
}); //define
|
