forked from dojo/dijit-oldmirror
/
StackController.js
353 lines (309 loc) · 11.1 KB
/
StackController.js
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
define([
"dojo/_base/array", // array.forEach array.indexOf array.map
"dojo/_base/declare", // declare
"dojo/dom-class",
"dojo/_base/event", // event.stop
"dojo/keys", // keys
"dojo/_base/lang", // lang.getObject
"dojo/on",
"../focus", // focus.focus()
"../registry", // registry.byId
"../_Widget",
"../_TemplatedMixin",
"../_Container",
"../form/ToggleButton",
"dojo/i18n!../nls/common"
], function(array, declare, domClass, event, keys, lang, on,
focus, registry, _Widget, _TemplatedMixin, _Container, ToggleButton){
// module:
// dijit/layout/StackController
// summary:
// Set of buttons to select a page in a `dijit.layout.StackContainer`
var StackButton = declare("dijit.layout._StackButton", ToggleButton, {
// summary:
// Internal widget used by StackContainer.
// description:
// The button-like or tab-like object you click to select or delete a page
// tags:
// private
// Override _FormWidget.tabIndex.
// StackContainer buttons are not in the tab order by default.
// Probably we should be calling this.startupKeyNavChildren() instead.
tabIndex: "-1",
// closeButton: Boolean
// When true, display close button for this tab
closeButton: false,
_aria_attr: "aria-selected",
buildRendering: function(/*Event*/ evt){
this.inherited(arguments);
(this.focusNode || this.domNode).setAttribute("role", "tab");
}
});
var StackController = declare("dijit.layout.StackController", [_Widget, _TemplatedMixin, _Container], {
// summary:
// Set of buttons to select a page in a `dijit.layout.StackContainer`
// description:
// Monitors the specified StackContainer, and whenever a page is
// added, deleted, or selected, updates itself accordingly.
baseClass: "dijitStackController",
templateString: "<span role='tablist' data-dojo-attach-event='onkeypress'></span>",
// containerId: [const] String
// The id of the page container that I point to
containerId: "",
// buttonWidget: [const] Constructor
// The button widget to create to correspond to each page
buttonWidget: StackButton,
// buttonWidgetClass: String
// CSS class of button widget, used by event delegation code to tell when the button was clicked
buttonWidgetClass: "dijitToggleButton",
// buttonWidgetCloseClass: String
// CSS class of [x] close icon, used by event delegation code to tell when close button was clicked
buttonWidgetCloseClass: "dijitStackCloseButton",
constructor: function(){
this.pane2button = {}; // mapping from pane id to buttons
},
postCreate: function(){
this.inherited(arguments);
// Listen to notifications from StackContainer.
// TODO: do this through bubbled events instead of topics
this.subscribe(this.containerId+"-startup", "onStartup");
this.subscribe(this.containerId+"-addChild", "onAddChild");
this.subscribe(this.containerId+"-removeChild", "onRemoveChild");
this.subscribe(this.containerId+"-selectChild", "onSelectChild");
this.subscribe(this.containerId+"-containerKeyPress", "onContainerKeyPress");
// Listen for click events to select or close tabs.
// No need to worry about ENTER/SPACe key handling: tabs are selected via left/right arrow keys,
// and closed via shift-F10 (to show the close menu).
this.connect(this.containerNode, 'click', function(evt){
var button = registry.getEnclosingWidget(evt.target),
page = button.page;
for(var target = evt.target; target !== this.containerNode; target = target.parentNode){
if(domClass.contains(target, this.buttonWidgetCloseClass)){
this.onCloseButtonClick(button);
break;
}else if(domClass.contains(target, this.buttonWidgetClass)){
this.onButtonClick(button);
break;
}
}
});
},
onStartup: function(/*Object*/ info){
// summary:
// Called after StackContainer has finished initializing
// tags:
// private
array.forEach(info.children, this.onAddChild, this);
if(info.selected){
// Show button corresponding to selected pane (unless selected
// is null because there are no panes)
this.onSelectChild(info.selected);
}
// Reflect events like page title changes to tab buttons
var containerNode = registry.byId(this.containerId).containerNode,
pane2button = this.pane2button,
paneToButtonAttr = {
"title": "label",
"showtitle": "showLabel",
"iconclass": "iconClass",
"closable": "closeButton",
"tooltip": "title"
},
connectFunc = function(attr, buttonAttr){
return on(containerNode, "attrmodified-" + attr, function(evt){
var button = pane2button[evt.detail && evt.detail.widget && evt.detail.widget.id];
if(button){
button.set(buttonAttr, evt.detail.newValue);
}
});
};
for(var attr in paneToButtonAttr){
this._adoptHandles(connectFunc(attr, paneToButtonAttr[attr]));
}
},
destroy: function(){
for(var pane in this.pane2button){
this.onRemoveChild(registry.byId(pane));
}
this.inherited(arguments);
},
onAddChild: function(/*dijit._Widget*/ page, /*Integer?*/ insertIndex){
// summary:
// Called whenever a page is added to the container.
// Create button corresponding to the page.
// tags:
// private
// create an instance of the button widget
// (remove typeof buttonWidget == string support in 2.0)
var Cls = lang.isString(this.buttonWidget) ? lang.getObject(this.buttonWidget) : this.buttonWidget;
var button = new Cls({
id: this.id + "_" + page.id,
label: page.title,
dir: page.dir,
lang: page.lang,
textDir: page.textDir,
showLabel: page.showTitle,
iconClass: page.iconClass,
closeButton: page.closable,
title: page.tooltip,
page: page
});
this.addChild(button, insertIndex);
this.pane2button[page.id] = button;
page.controlButton = button; // this value might be overwritten if two tabs point to same container
if(!this._currentChild){
// If this is the first child then StackContainer will soon publish that it's selected,
// but before that StackContainer calls layout(), and before layout() is called the
// StackController needs to have the proper height... which means that the button needs
// to be marked as selected now. See test_TabContainer_CSS.html for test.
this.onSelectChild(page);
}
},
onRemoveChild: function(/*dijit._Widget*/ page){
// summary:
// Called whenever a page is removed from the container.
// Remove the button corresponding to the page.
// tags:
// private
if(this._currentChild === page){ this._currentChild = null; }
var button = this.pane2button[page.id];
if(button){
this.removeChild(button);
delete this.pane2button[page.id];
button.destroy();
}
delete page.controlButton;
},
onSelectChild: function(/*dijit._Widget*/ page){
// summary:
// Called when a page has been selected in the StackContainer, either by me or by another StackController
// tags:
// private
if(!page){ return; }
if(this._currentChild){
var oldButton=this.pane2button[this._currentChild.id];
oldButton.set('checked', false);
oldButton.focusNode.setAttribute("tabIndex", "-1");
}
var newButton=this.pane2button[page.id];
newButton.set('checked', true);
this._currentChild = page;
newButton.focusNode.setAttribute("tabIndex", "0");
var container = registry.byId(this.containerId);
container.containerNode.setAttribute("aria-labelledby", newButton.id);
},
onButtonClick: function(/*dijit._Widget*/ button){
// summary:
// Called whenever one of my child buttons is pressed in an attempt to select a page
// tags:
// private
// For TabContainer where the tabs are <span>, need to set focus explicitly when left/right arrow
focus.focus(button.focusNode);
var page = button.page;
if(this._currentChild.id === page.id) {
//In case the user clicked the checked button, keep it in the checked state because it remains to be the selected stack page.
var button=this.pane2button[page.id];
button.set('checked', true);
}
var container = registry.byId(this.containerId);
container.selectChild(page);
},
onCloseButtonClick: function(/*dijit._Widget*/ button){
// summary:
// Called whenever one of my child buttons [X] is pressed in an attempt to close a page
// tags:
// private
var page = button.page,
container = registry.byId(this.containerId);
container.closeChild(page);
if(this._currentChild){
var b = this.pane2button[this._currentChild.id];
if(b){
focus.focus(b.focusNode || b.domNode);
}
}
},
// TODO: this is a bit redundant with forward, back api in StackContainer
adjacent: function(/*Boolean*/ forward){
// summary:
// Helper for onkeypress to find next/previous button
// tags:
// private
if(!this.isLeftToRight() && (!this.tabPosition || /top|bottom/.test(this.tabPosition))){ forward = !forward; }
// find currently focused button in children array
var children = this.getChildren();
var current = array.indexOf(children, this.pane2button[this._currentChild.id]);
// pick next button to focus on
var offset = forward ? 1 : children.length - 1;
return children[ (current + offset) % children.length ]; // dijit._Widget
},
onkeypress: function(/*Event*/ e){
// summary:
// Handle keystrokes on the page list, for advancing to next/previous button
// and closing the current page if the page is closable.
// tags:
// private
if(this.disabled || e.altKey ){ return; }
var forward = null;
if(e.ctrlKey || !e._djpage){
switch(e.charOrCode){
case keys.LEFT_ARROW:
case keys.UP_ARROW:
if(!e._djpage){ forward = false; }
break;
case keys.PAGE_UP:
if(e.ctrlKey){ forward = false; }
break;
case keys.RIGHT_ARROW:
case keys.DOWN_ARROW:
if(!e._djpage){ forward = true; }
break;
case keys.PAGE_DOWN:
if(e.ctrlKey){ forward = true; }
break;
case keys.HOME:
case keys.END:
var children = this.getChildren();
if(children && children.length){
this.onButtonClick(children[e.charOrCode == keys.HOME ? 0 : children.length-1]);
}
event.stop(e);
break;
case keys.DELETE:
if(this._currentChild.closable){
this.onCloseButtonClick(this.pane2button[this._currentChild.id]);
}
event.stop(e);
break;
default:
if(e.ctrlKey){
if(e.charOrCode === keys.TAB){
this.onButtonClick(this.adjacent(!e.shiftKey));
event.stop(e);
}else if(e.charOrCode == "w"){
if(this._currentChild.closable){
this.onCloseButtonClick(this.pane2button[this._currentChild.id]);
}
event.stop(e); // avoid browser tab closing.
}
}
}
// handle next/previous page navigation (left/right arrow, etc.)
if(forward !== null){
this.onButtonClick(this.adjacent(forward));
event.stop(e);
}
}
},
onContainerKeyPress: function(/*Object*/ info){
// summary:
// Called when there was a keypress on the container
// tags:
// private
info.e._djpage = info.page;
this.onkeypress(info.e);
}
});
StackController.StackButton = StackButton; // for monkey patching
return StackController;
});