OptionTransfer.js
19 KB
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
512
513
514
515
516
// ===================================================================
// Author: Matt Kruse <matt@mattkruse.com>
// WWW: http://www.mattkruse.com/
//
// NOTICE: You may use this code for any purpose, commercial or
// private, without any further permission from the author. You may
// remove this notice from your final code if you wish, however it is
// appreciated by the author if at least my web site address is kept.
//
// You may *NOT* re-distribute this code in any way except through its
// use. That means, you can include it in your product, or your web
// site, or any other form where the code is actually being used. You
// may not put the plain javascript up on your site for download or
// include it in your javascript libraries for download.
// If you wish to share this code with others, please just point them
// to the URL instead.
// Please DO NOT link directly to my .js files from your site. Copy
// the files to your server and use them there. Thank you.
// ===================================================================
/* SOURCE FILE: selectbox.js */
// -------------------------------------------------------------------
// selectUnselectMatchingOptions(select_object,regex,select/unselect,true/false)
// This is a general function used by the select functions below, to
// avoid code duplication
// -------------------------------------------------------------------
function selectUnselectMatchingOptions(obj,regex,which,only) {
if (window.RegExp) {
if (which == "select") {
var selected1=true;
var selected2=false;
}
else if (which == "unselect") {
var selected1=false;
var selected2=true;
}
else {
return;
}
var re = new RegExp(regex);
for (var i=0; i<obj.options.length; i++) {
if (re.test(obj.options[i].text)) {
obj.options[i].selected = selected1;
}
else {
if (only == true) {
obj.options[i].selected = selected2;
}
}
}
}
}
// -------------------------------------------------------------------
// selectMatchingOptions(select_object,regex)
// This function selects all options that match the regular expression
// passed in. Currently-selected options will not be changed.
// -------------------------------------------------------------------
function selectMatchingOptions(obj,regex) {
selectUnselectMatchingOptions(obj,regex,"select",false);
}
// -------------------------------------------------------------------
// selectOnlyMatchingOptions(select_object,regex)
// This function selects all options that match the regular expression
// passed in. Selected options that don't match will be un-selected.
// -------------------------------------------------------------------
function selectOnlyMatchingOptions(obj,regex) {
selectUnselectMatchingOptions(obj,regex,"select",true);
}
// -------------------------------------------------------------------
// unSelectMatchingOptions(select_object,regex)
// This function Unselects all options that match the regular expression
// passed in.
// -------------------------------------------------------------------
function unSelectMatchingOptions(obj,regex) {
selectUnselectMatchingOptions(obj,regex,"unselect",false);
}
// -------------------------------------------------------------------
// sortSelect(select_object)
// Pass this function a SELECT object and the options will be sorted
// by their text (display) values
// -------------------------------------------------------------------
function sortSelect(obj) {
var o = new Array();
if (obj.options==null) { return; }
for (var i=0; i<obj.options.length; i++) {
o[o.length] = new Option( obj.options[i].text, obj.options[i].value, obj.options[i].defaultSelected, obj.options[i].selected) ;
}
if (o.length==0) { return; }
o = o.sort(
function(a,b) {
if ((a.text+"") < (b.text+"")) { return -1; }
if ((a.text+"") > (b.text+"")) { return 1; }
return 0;
}
);
for (var i=0; i<o.length; i++) {
obj.options[i] = new Option(o[i].text, o[i].value, o[i].defaultSelected, o[i].selected);
}
}
// -------------------------------------------------------------------
// selectAllOptions(select_object)
// This function takes a select box and selects all options (in a
// multiple select object). This is used when passing values between
// two select boxes. Select all options in the right box before
// submitting the form so the values will be sent to the server.
// -------------------------------------------------------------------
function selectAllOptions(obj) {
for (var i=0; i<obj.options.length; i++) {
obj.options[i].selected = true;
}
}
// -------------------------------------------------------------------
// moveSelectedOptions(select_object,select_object[,autosort(true/false)[,regex]])
// This function moves options between select boxes. Works best with
// multi-select boxes to create the common Windows control effect.
// Passes all selected values from the first object to the second
// object and re-sorts each box.
// If a third argument of 'false' is passed, then the lists are not
// sorted after the move.
// If a fourth string argument is passed, this will function as a
// Regular Expression to match against the TEXT or the options. If
// the text of an option matches the pattern, it will NOT be moved.
// It will be treated as an unmoveable option.
// You can also put this into the <SELECT> object as follows:
// onDblClick="moveSelectedOptions(this,this.form.target)
// This way, when the user double-clicks on a value in one box, it
// will be transferred to the other (in browsers that support the
// onDblClick() event handler).
// -------------------------------------------------------------------
function moveSelectedOptions(from,to) {
// Unselect matching options, if required
if (arguments.length>3) {
var regex = arguments[3];
if (regex != "") {
unSelectMatchingOptions(from,regex);
}
}
// Move them over
for (var i=0; i<from.options.length; i++) {
var o = from.options[i];
if (o.selected) {
to.options[to.options.length] = new Option( o.text, o.value, false, false);
}
}
// Delete them from original
for (var i=(from.options.length-1); i>=0; i--) {
var o = from.options[i];
if (o.selected) {
from.options[i] = null;
}
}
if ((arguments.length<3) || (arguments[2]==true)) {
sortSelect(from);
sortSelect(to);
}
from.selectedIndex = -1;
to.selectedIndex = -1;
}
// -------------------------------------------------------------------
// copySelectedOptions(select_object,select_object[,autosort(true/false)])
// This function copies options between select boxes instead of
// moving items. Duplicates in the target list are not allowed.
// -------------------------------------------------------------------
function copySelectedOptions(from,to) {
var options = new Object();
for (var i=0; i<to.options.length; i++) {
options[to.options[i].text] = true;
}
for (var i=0; i<from.options.length; i++) {
var o = from.options[i];
if (o.selected) {
if (options[o.text] == null || options[o.text] == "undefined") {
to.options[to.options.length] = new Option( o.text, o.value, false, false);
}
}
}
if ((arguments.length<3) || (arguments[2]==true)) {
sortSelect(to);
}
from.selectedIndex = -1;
to.selectedIndex = -1;
}
// -------------------------------------------------------------------
// moveAllOptions(select_object,select_object[,autosort(true/false)[,regex]])
// Move all options from one select box to another.
// -------------------------------------------------------------------
function moveAllOptions(from,to) {
selectAllOptions(from);
if (arguments.length==2) {
moveSelectedOptions(from,to);
}
else if (arguments.length==3) {
moveSelectedOptions(from,to,arguments[2]);
}
else if (arguments.length==4) {
moveSelectedOptions(from,to,arguments[2],arguments[3]);
}
}
// -------------------------------------------------------------------
// copyAllOptions(select_object,select_object[,autosort(true/false)])
// Copy all options from one select box to another, instead of
// removing items. Duplicates in the target list are not allowed.
// -------------------------------------------------------------------
function copyAllOptions(from,to) {
selectAllOptions(from);
if (arguments.length==2) {
copySelectedOptions(from,to);
}
else if (arguments.length==3) {
copySelectedOptions(from,to,arguments[2]);
}
}
// -------------------------------------------------------------------
// swapOptions(select_object,option1,option2)
// Swap positions of two options in a select list
// -------------------------------------------------------------------
function swapOptions(obj,i,j) {
var o = obj.options;
var i_selected = o[i].selected;
var j_selected = o[j].selected;
var temp = new Option(o[i].text, o[i].value, o[i].defaultSelected, o[i].selected);
var temp2= new Option(o[j].text, o[j].value, o[j].defaultSelected, o[j].selected);
o[i] = temp2;
o[j] = temp;
o[i].selected = j_selected;
o[j].selected = i_selected;
}
// -------------------------------------------------------------------
// moveOptionUp(select_object)
// Move selected option in a select list up one
// -------------------------------------------------------------------
function moveOptionUp(obj) {
// If > 1 option selected, do nothing
var selectedCount=0;
for (i=0; i<obj.options.length; i++) {
if (obj.options[i].selected) {
selectedCount++;
}
}
if (selectedCount!=1) {
return;
}
// If this is the first item in the list, do nothing
var i = obj.selectedIndex;
if (i == 0) {
return;
}
swapOptions(obj,i,i-1);
obj.options[i-1].selected = true;
}
// -------------------------------------------------------------------
// moveOptionDown(select_object)
// Move selected option in a select list down one
// -------------------------------------------------------------------
function moveOptionDown(obj) {
// If > 1 option selected, do nothing
var selectedCount=0;
for (i=0; i<obj.options.length; i++) {
if (obj.options[i].selected) {
selectedCount++;
}
}
if (selectedCount != 1) {
return;
}
// If this is the last item in the list, do nothing
var i = obj.selectedIndex;
if (i == (obj.options.length-1)) {
return;
}
swapOptions(obj,i,i+1);
obj.options[i+1].selected = true;
}
// -------------------------------------------------------------------
// removeSelectedOptions(select_object)
// Remove all selected options from a list
// (Thanks to Gene Ninestein)
// -------------------------------------------------------------------
function removeSelectedOptions(from) {
for (var i=(from.options.length-1); i>=0; i--) {
var o=from.options[i];
if (o.selected) {
from.options[i] = null;
}
}
from.selectedIndex = -1;
}
/* SOURCE FILE: OptionTransfer.js */
/*
OptionTransfer.js
Last Modified: 11/18/2002
DESCRIPTION: This widget is used to easily and quickly create an interface
where the user can transfer choices from one select box to another. For
example, when selecting which columns to show or hide in search results.
This object adds value by automatically storing the values that were added
or removed from each list, as well as the state of the final list.
COMPATABILITY: Should work on all Javascript-compliant browsers.
USAGE:
// Create a new OptionTransfer object. Pass it the field names of the left
// select box and the right select box.
var ot = new OptionTransfer("from","to");
// Optionally tell the lists whether or not to auto-sort when options are
// moved. By default, the lists will be sorted.
ot.setAutoSort(true);
// Optionally set the delimiter to be used to separate values that are
// stored in hidden fields for the added and removed options, as well as
// final state of the lists. Defaults to a comma.
ot.setDelimiter("|");
// These functions assign the form fields which will store the state of
// the lists. Each one is optional, so you can pick to only store the
// new options which were transferred to the right list, for example.
// Each function takes the name of a HIDDEN or TEXT input field.
// Store list of options removed from left list into an input field
ot.saveRemovedLeftOptions("removedLeft");
// Store list of options removed from right list into an input field
ot.saveRemovedRightOptions("removedRight");
// Store list of options added to left list into an input field
ot.saveAddedLeftOptions("addedLeft");
// Store list of options radded to right list into an input field
ot.saveAddedRightOptions("addedRight");
// Store all options existing in the left list into an input field
ot.saveNewLeftOptions("newLeft");
// Store all options existing in the right list into an input field
ot.saveNewRightOptions("newRight");
// IMPORTANT: This step is required for the OptionTransfer object to work
// correctly.
// Add a call to the BODY onLoad="" tag of the page, and pass a reference to
// the form which contains the select boxes and input fields.
BODY onLoad="ot.init(document.forms[0])"
// ADDING ACTIONS INTO YOUR PAGE
// Finally, add calls to the object to move options back and forth, either
// from links in your page or from double-clicking the options themselves.
// See example page, and use the following methods:
ot.transferRight();
ot.transferAllRight();
ot.transferLeft();
ot.transferAllLeft();
NOTES:
1) Requires the functions in selectbox.js
*/
function OT_transferLeft() { moveSelectedOptions(this.right,this.left,this.autoSort); this.update(); }
function OT_transferRight() { moveSelectedOptions(this.left,this.right,this.autoSort); this.update(); }
function OT_transferAllLeft() { moveAllOptions(this.right,this.left,this.autoSort); this.update(); }
function OT_transferAllRight() { moveAllOptions(this.left,this.right,this.autoSort); this.update(); }
function OT_saveRemovedLeftOptions(f) { this.removedLeftField = f; }
function OT_saveRemovedRightOptions(f) { this.removedRightField = f; }
function OT_saveAddedLeftOptions(f) { this.addedLeftField = f; }
function OT_saveAddedRightOptions(f) { this.addedRightField = f; }
function OT_saveNewLeftOptions(f) { this.newLeftField = f; }
function OT_saveNewRightOptions(f) { this.newRightField = f; }
function OT_update() {
var removedLeft = new Object();
var removedRight = new Object();
var addedLeft = new Object();
var addedRight = new Object();
var newLeft = new Object();
var newRight = new Object();
for (var i=0;i<this.left.options.length;i++) {
var o=this.left.options[i];
newLeft[o.value]=1;
if (typeof(this.originalLeftValues[o.value])=="undefined") {
addedLeft[o.value]=1;
removedRight[o.value]=1;
}
}
for (var i=0;i<this.right.options.length;i++) {
var o=this.right.options[i];
newRight[o.value]=1;
if (typeof(this.originalRightValues[o.value])=="undefined") {
addedRight[o.value]=1;
removedLeft[o.value]=1;
}
}
if (this.removedLeftField!=null) { this.removedLeftField.value = OT_join(removedLeft,this.delimiter); }
if (this.removedRightField!=null) { this.removedRightField.value = OT_join(removedRight,this.delimiter); }
if (this.addedLeftField!=null) { this.addedLeftField.value = OT_join(addedLeft,this.delimiter); }
if (this.addedRightField!=null) { this.addedRightField.value = OT_join(addedRight,this.delimiter); }
if (this.newLeftField!=null) { this.newLeftField.value = OT_join(newLeft,this.delimiter); }
if (this.newRightField!=null) { this.newRightField.value = OT_join(newRight,this.delimiter); }
}
function OT_join(o,delimiter) {
var val; var str="";
for(val in o){
if (str.length>0) { str=str+delimiter; }
str=str+val;
}
return str;
}
function OT_setDelimiter(val) { this.delimiter=val; }
function OT_setAutoSort(val) { this.autoSort=val; }
function OT_init(theform) {
this.form = theform;
if(!theform[this.left]){alert("OptionTransfer init(): Left select list does not exist in form!");return false;}
if(!theform[this.right]){alert("OptionTransfer init(): Right select list does not exist in form!");return false;}
this.left=theform[this.left];
this.right=theform[this.right];
for(var i=0;i<this.left.options.length;i++) {
this.originalLeftValues[this.left.options[i].value]=1;
}
for(var i=0;i<this.right.options.length;i++) {
this.originalRightValues[this.right.options[i].value]=1;
}
if(this.removedLeftField!=null) { this.removedLeftField=theform[this.removedLeftField]; }
if(this.removedRightField!=null) { this.removedRightField=theform[this.removedRightField]; }
if(this.addedLeftField!=null) { this.addedLeftField=theform[this.addedLeftField]; }
if(this.addedRightField!=null) { this.addedRightField=theform[this.addedRightField]; }
if(this.newLeftField!=null) { this.newLeftField=theform[this.newLeftField]; }
if(this.newRightField!=null) { this.newRightField=theform[this.newRightField]; }
this.update();
}
// -------------------------------------------------------------------
// OptionTransfer()
// This is the object interface.
// -------------------------------------------------------------------
function OptionTransfer(l,r) {
this.form = null;
this.left=l;
this.right=r;
this.autoSort=true;
this.delimiter=",";
this.originalLeftValues = new Object();
this.originalRightValues = new Object();
this.removedLeftField = null;
this.removedRightField = null;
this.addedLeftField = null;
this.addedRightField = null;
this.newLeftField = null;
this.newRightField = null;
this.transferLeft=OT_transferLeft;
this.transferRight=OT_transferRight;
this.transferAllLeft=OT_transferAllLeft;
this.transferAllRight=OT_transferAllRight;
this.saveRemovedLeftOptions=OT_saveRemovedLeftOptions;
this.saveRemovedRightOptions=OT_saveRemovedRightOptions;
this.saveAddedLeftOptions=OT_saveAddedLeftOptions;
this.saveAddedRightOptions=OT_saveAddedRightOptions;
this.saveNewLeftOptions=OT_saveNewLeftOptions;
this.saveNewRightOptions=OT_saveNewRightOptions;
this.setDelimiter=OT_setDelimiter;
this.setAutoSort=OT_setAutoSort;
this.init=OT_init;
this.update=OT_update;
this.sortSelectMatch=OT_sortSelectMatch;
}
// -------------------------------------------------------------------
// sortSelectMatch(select_object, pattern)
// Pass this function a SELECT object and the options will be sorted
// matching pattern string. It select also matching options
// -------------------------------------------------------------------
function OT_sortSelectMatch(obj, pattern) {
sortSelect(obj);
var o = new Array();
// Store original array in "o"
if (obj.options==null) { return; }
for (var i=0; i<obj.options.length; i++){
o[o.length] = new Option(obj.options[i].text, obj.options[i].value, obj.options[i].defaultSelected, obj.options[i].selected) ;
}
// Match / NoMatch Array
match = new Array();
nomatch = new Array();
for (var i=0; i<o.length; i++){
if (o[i].text.toLowerCase().indexOf(pattern.toLowerCase())!=-1) {
match[match.length] = new Option(o[i].text, o[i].value, o[i].defaultSelected, true);
} else {
nomatch[nomatch.length] = new Option(o[i].text, o[i].value, o[i].defaultSelected, false);
}
}
// Now rewrite sorted array
for (var i=0; i<match.length; i++){
obj.options[i] = new Option(match[i].text, match[i].value, match[i].defaultSelected, match[i].selected);
}
for (var i=0; i<nomatch.length; i++){
obj.options[i+match.length] = new Option(nomatch[i].text, nomatch[i].value, nomatch[i].defaultSelected, nomatch[i].selected);
}
return;
}