forked from christianyates/jQuery-ColumnView
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jquery.columnview.js
executable file
·511 lines (443 loc) · 16.2 KB
/
jquery.columnview.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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
/*!
* mapAttributes jQuery Plugin v1.0.0
*
* Copyright 2010, Michael Riddle
* Licensed under the MIT
* http://jquery.org/license
*
* Date: Sun Mar 28 05:49:39 2010 -0900
*/
jQuery.fn.mapAttributes = function(prefix) {
var maps = [];
$(this).each(function() {
var map = {};
for(var key in this.attributes) {
if(!isNaN(key)) {
if(!prefix || this.attributes[key].name.substr(0,prefix.length) == prefix) {
map[this.attributes[key].name] = this.attributes[key].value;
}
}
}
maps.push(map);
});
return (maps.length > 1 ? maps : maps[0]);
};
/**
* jquery.columnview-1.4.js
*
* Created by Chris Yates on 2009-02-26.
* http://christianyates.com
*
* Copyright 2009 Christian Yates and ASU Mars Space Flight Facility. All rights reserved.
* Copyright 2011 Manuel Odendahl <[email protected]>
* Copyright 2012 James Roberts <[email protected]>
* Copyright 2016 Caleb Gregory <[email protected]>
*
* Supported under jQuery 1.5.x or later
*
* Dual licensed under MIT and GPL.
*/
(function($) {
var defaults = {
height: '200px', // Height of containerobj
multi: false, // Allow multiple selections
preview: true, // Handler for preview pane - true for default handeler, false for no preview
fixedwidth: false, // Use fixed width columns
addCSS: true, // enable to have columnview automatically insert its CSS
useCanvas: false, // enable to have columnview generate a canvas arrow to indicate subcategories. Disable to use CSS instead
attrs: [], // attributes to pull from original items
autoFocus: true, // focus to column onclick
getSubtree: getSubtree, // callback for getting new data. Default: getSubtree
onChange: undefined, // callback for onclick
};
// Firefox doesn't repeat keydown events when the key is held, so we use
// keypress with FF/Gecko/Mozilla to enable continuous keyboard scrolling.
var isFirefox = typeof InstallTrigger !== 'undefined'; //kind of a hack to check whether browser is FF (http://stackoverflow.com/a/9851769/3437608)
var key_event = isFirefox ? 'keypress' : 'keydown';
/**
* default subtree function, returns child elements of the original list.
**/
var getSubtree = function (elt) { //elt stands for element - this should return the children of elt.
var children = $(elt).data("sub");
if (children) {
return children.children('li');
} else {
return $(elt).children('li');
}
};
var methods = {
//init: initial setup
init: function (options) {
var $this = $(this);
var data = $this.data("columnview");
if (data) {
/* plugin has already been initialized */
console.log("already initialized");
return $this;
}
var settings = $.extend({}, defaults, options);
/* fix order of declaration */
if (!settings.getSubtree) {
settings.getSubtree = getSubtree;
}
//whether to add the CSS to document
if (settings.addCSS) {
addCSS();
}
// Hide original list
$(this).hide();
// Reset the original list's id
var origid = $this.attr('id');
// Create new top container (first column)
var $container = $('<div/>').addClass('containerobj').css({'height':settings.height}).attr({'id':origid + '-columnview-container'}).insertAfter($this);
var $topdiv = $('<div class="top"></div>').appendTo($container);
data = { settings: settings,
container: $container,
origElt: $this };
$this.data("columnview", data);
$container.data("columnview", data);
/* populate the first column */
submenu($container, $this, $topdiv);
/* bind events on the newly created column entries */
$container.bind("click dblclick " + key_event, methods.handleEvent);
return $this;
},
container: function () {
var data = $(this).data("columnview");
if (!data) {
return;
}
return data.container;
},
/**
* Handle a click event on an item inside the menu.
*
* Pass shiftKey and metaKey for multiple selection purposes.
**/
handleClick: function (self, shiftKey, metaKey) {
var $self = $(self);
var $container = $self.parents('div.containerobj:first');
var data = $container.data("columnview");
if (!data) {
return;
}
var container = data.container;
var origElt = data.origElt;
var settings = data.settings;
$self.focus();
if ($self.closest('.feature').length) {
//it's a preview, so don't do anything
return;
}
var level = $('div', container).index($self.parents('div'));
// Remove blocks to the right in the tree, and 'deactivate' other
// links within the same level, if metakey is not being used
$('div:gt('+level+')', container).remove();
if (metaKey) {
/* on meta key, toggle selections, and remove nothing */
if ($self.hasClass('active')) {
$self.removeClass('active');
} else {
$self.addClass('active');
}
} else if (shiftKey) {
// Select intermediate items when shift clicking
// Sorry, only works with jQuery 1.4 due to changes in the .index() function
var first = $('a.active:first', $self.parent()).index();
var cur = $self.index();
var range = [first, cur].sort(function(a,b) { return a - b; });
$('div:eq('+level+') a', container).slice(range[0], range[1]).addClass('active');
$self.addClass('active');
} else {
//no shift key, and no meta key.
//remove classes active and inpath in anchors in same level
$('div:eq('+level+') a', container)
.removeClass('active')
.removeClass('inpath');
//add class inpath to currently selected item, and remove class active
$('.active', container).addClass('inpath');
$('div:lt('+level+') a', container).removeClass('active');
//highlight the new one (that just got clicked)
$self.addClass('active');
//if the new item has children add another menu
if ($self.hasClass("hasChildMenu")) {
// Menu has children, so add another submenu
submenu(container, $self);
/* triggering will happen in submenu */
return;
} else {
// No children; show preview (title if it exists, or a just text)
if (settings.preview) {
// If preview, append preview pane
var previewcontainer = $('<div/>').addClass('feature').appendTo(container);
// Fire preview handler function (set manually in settings, else default)
if ($.isFunction(settings.preview)) {
// We're passing the element back to the callback
var preview = settings.preview($self);
} else {
// If preview is not a function, use default behavior
var title = $('<span/>')
.attr({href: $self.attr('href')})
.text($self.attr('title') ? $self.attr('title') : $self.text());
$(previewcontainer).html(title);
}
}
// Set the width
var remainingspace = 0;
$.each($(container).children('div').slice(0,-1),function(i,item){
remainingspace += $(item).width();
});
var fillwidth = $(container).width() - remainingspace;
$(previewcontainer).css({'top':0,'left':remainingspace}).width(fillwidth).show();
}
}
origElt.trigger("columnview_select", [container.find(".active")]);
},
/**
* Navigate to an item with attrName = key.
*
* attrName is "name" by default.
*
* This looks up the item in the original list, and clicks its way
* through the parents to reach it (it will thus call onchange on
* the intermediate items, just as if the user navigated to it).
*
**/
navigateTo: function (key, attrName) {
var $this = $(this);
var $container;
if ($this.hasClass('containerobj')) {
$container = $this;
} else {
$container = $this.parents('div.containerobj:first');
}
var data = $container.data("columnview");
if (!data) {
return;
}
var container = data.container;
var origElt = data.origElt;
var settings = data.settings;
if (!attrName) {
attrName = "name";
}
var origLinks = origElt.find("[" + attrName + "=" + key + "]").parentsUntil(origElt).filter("li").find(":eq(0)");
var keys = origLinks.map(function (i, elt) { return $(elt).attr(attrName); }).toArray().reverse();
$.each(keys, function (i, elt) {
var entry = container.find("[" + attrName + "=" + elt + "]");
methods.handleClick(entry);
});
},
// Event handling functions
handleEvent: function (event) {
var $this = $(this);
var $self = undefined;
var data = $this.data("columnview");
if (!data) {
return;
}
var container = data.container;
var origElt = data.origElt;
var settings = data.settings;
var $target = $(event.target);
if ($target.is("a,span")) {
if ($target.is("span")){
$self = $target.parent(); //if it's a span, set $self to the span's parent element (should be an anchor)
}
else {
$self = $target; //if it's an anchor, set $self to it.
}
//if multiple selection is disabled, ignore the shift and meta keys.
if (!settings.multi) {
delete event.shiftKey;
delete event.metaKey;
}
$self.focus();
//if the event was a doubleclick, call the doubleclick function
if (event.type == "dblclick") {
origElt.trigger("columnview_dblclick", [$self]);
}
// Handle clicks
if (event.type == "click") {
//call the handleClick method
methods.handleClick($self, event.shiftKey, event.metaKey);
//if autoFocus is set to true, give this column focus
if(settings.autoFocus) container.scrollLeft($self.offsetParent().offset().left);
if (!$self.closest('.feature').length) {
//it's not a preview (that got clicked), so if there's a handler for onChange, call that
if(settings.onChange) settings.onChange(container.find(".active"));
}
}
// Handle Keyboard navigation
if (event.type == key_event){
console.log(event.keyCode);
switch (event.keyCode){
case (37): //left
$self.parent().prev().children('.inpath').focus().trigger("click");
event.preventDefault();
break;
case (38): //up
$self.prev().focus().trigger("click");
event.preventDefault();
break;
case (39): //right
if ($self.hasClass('hasChildMenu')) {
$self.parent().next().children('a:first').focus().trigger("click");
event.preventDefault();
}
break;
case (40): //down
$self.next().focus().trigger("click");
event.preventDefault();
break;
case (13): //enter
$self.trigger("dblclick");
event.preventDefault();
break;
}
}
}
}
};
/**
* Dispatcher method for the jQuery plugin. Call without arguments
* or options to call the initializer, or pass a method name and
* arguments:
*
* $(elt).columnview();
* $(elt).columnview('navigateTo', 'foobar');
*
**/
$.fn.columnview = function(method) {
if ( methods[method] ) {
return methods[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));
} else if ( typeof method === 'object' || ! method ) {
return methods.init.apply( this, arguments );
} else {
$.error( 'Method ' + method + ' does not exist on jQuery.columnview ');
}
};
// Generate deeper level menus
function submenu(container, node, submenu) {
var data = container.data("columnview");
if (!data) {
return;
}
var origElt = data.origElt;
var settings = data.settings;
var width = false;
var isIE = /*@cc_on!@*/false || !!document.documentMode; //http://stackoverflow.com/a/9851769/3437608 - to replace $.browser.msie, which is gone since jQuery 1.9
if (settings.fixedwidth || isIE) {
width = typeof settings.fixedwidth == "string" ? settings.fixedwidth : '200px';
}
var leftPos = 0;
$.each($(container).children('div'), function(i, mydiv){
leftPos += $(mydiv).width();
});
if (!submenu) {
submenu = $('<div/>').css({'top':0, 'left':leftPos}).appendTo(container);
}
// Set column width
if (width) {
$(submenu).width(width);
}
var appendItems = function (items) {
submenu.html('');
$.each($(items), function(i, item) {
var $item = $(item);
var $subitem = $('a:eq(0)', $item)
.clone(true)
.wrapInner('<span class="label" />')
.data('sub', $item.children('ul'))
.appendTo(submenu);
if (!$subitem.length) {
/* something went wrong with finding an inner item */
return;
}
if(settings.attrs && settings.attrs.length > 0){
$.each(settings.attrs,function(i,attr){
if($item.attr(attr)) $subitem.attr(attr,$item.attr(attr)).data(attr,$item.attr(attr));
});
}
if (width) {
$subitem.css({'text-overflow': 'ellipsis',
'-o-text-overflow': 'ellipsis',
'-ms-text-overflow': 'ellipsis'} );
}
if ($subitem.data('sub').length || $item.attr("hasChildren")) {
$subitem.addClass('hasChildMenu');
addWidget(settings, $subitem);
}
});
/* trigger only after the data is added, not in handleEvent as there could be a deferred in between */
origElt.trigger("columnview_select", [$(node)]);
};
var res = settings.getSubtree($(node), $(node).attr("id") == $(origElt).attr("id"));
/* check if getSubtree returned a deferred promise. */
if (res && res.promise) {
$(submenu.append('<span class="loading">Loading...</span>'));
res.promise().then(appendItems);
} else {
appendItems(res);
}
}
/***************************************************************************
*
* Graphics and CSS stuff
*
***************************************************************************/
// Uses canvas, if available, to draw a triangle to denote that item is a parent
function addWidget(settings, item, color){
var useCss = false;
if (!settings.useCanvas) {
useCss = true;
} else {
var triheight = $(item).height();
var canvas = $("<canvas></canvas>")
.attr({height: triheight,
width: 10})
.addClass('widget').appendTo(item);
if (!color) {
color = $(canvas).css('color');
}
canvas = $(canvas).get(0);
if (canvas.getContext){
var context = canvas.getContext('2d');
context.fillStyle = color;
context.beginPath();
context.moveTo(3,(triheight/2 - 3));
context.lineTo(10,(triheight/2));
context.lineTo(3,(triheight/2 + 3));
context.fill();
} else {
useCss = true;
}
}
if (useCss) {
/**
* Canvas not supported - put something in there anyway that can be
* suppressed later if desired. We're using a decimal character here
* representing a "black right-pointing pointer" in Windows since IE
* is the likely case that doesn't support canvas.
*/
$("<span>►</span>").addClass('widget').css({'height':triheight,'width':10}).prependTo(item);
}
$('.widget').bind('click', function(event){
event.preventDefault();
});
}
function addCSS() {
// Add stylesheet, but only once
var cssId = 'columnViewCss'; // you could encode the css path itself to generate id..
if (!document.getElementById(cssId)) {
var head = document.getElementsByTagName('head')[0];
var link = document.createElement('link');
link.id = cssId;
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = 'css/jquery.columnview.css';
link.media = 'all';
head.appendChild(link);
}
}
})(jQuery);