jquery/tag_complete/jquery-tac.js

/*
        tag auto-completer written with jquery (prototype style)

        2006-08-20 Dobrica Pavlinusic <dpavlin@rot13.org>
*/

function tac(
                tag_class,      // tags are elements with this class
                tags_form_id,   // id of tags edit form
                foo
        ) {

        // all indexed by tag name
        this.t = {
                obj: new Array(),       // html objects
                exists: new Array()
        };

        this.all_tags = new Array();
        this.suggested = new Array();

        this.entered = {                // array of entered tags
                ordered: new Array(),   // tags entered in original order
                tag: new Array()        // mapping from tag name to order number
        };

        this.current_selected = null;   // current selected suggestion

        this.tags_selector = '.tag';    
        if (tag_class) this.tags_selector = '.'+tag_class;
        this.tags_form = '#tags_form';  
        if (tags_form_id) this.tags_form = '#'+tags_form_id;
        this.suggest_selector = '#suggest';
        this.tags_input = '#tags';

        // tags from previous event
        this.last_tags = '';

        // parse all tags from html
        var obj = this;
        $( this.tags_selector ).each( function(i) {
                var n = this.firstChild.nodeValue;

                obj.t.obj[n] = this;
                obj.t.exists[n] = true;
                obj.all_tags.push( n );

                this.onclick = function() {
                        return obj.tag( n );
                }
                this.href = '#'+i;      // FIXME debug
        });
        $.log.info( 'found ' + this.all_tags.length + ' tags' );

        $.log.info( 'hook onchange to '+this.tags_form );
        $( this.tags_form ).keyup( function(e) {

                $.log.debug('keyup: '+e.keyCode);

                switch (e.keyCode) {
                        case 38:        // up
                                e.preventDefault();
                                obj.move_suggested( -1 );
                                return false;
                        case 40:        // down
                                e.preventDefault();
                                obj.move_suggested( +1 );
                                return false;
                        case 9:         // tab
                                obj.focus();
                                obj.take_suggested();
                                return false;
                        case 13:        // return
                                if (obj.current_selected != null) obj.focus();
                                return true;
                        case 8:         // backspace
                        case 46:        // del
                                obj.parse();
                                return false;
                }


                var t = obj.current_tag();

                $.log.debug('tag: ' + t + ' ['+t.length+']');

                obj.clean_suggested();

                if (t == '') return false;

                obj.suggest(t);

                return true;
        }).submit( function() {
                $.log.debug('submit');
                return obj.take_suggested();
        }).blur( function() {
                $.log.debug('blur');
                return obj.take_suggested();
        });

        $.log.toggle();

        this.focus();
}

tac.prototype.suggest = function( partial ) {

        $.log.info('suggest to '+partial);

        var len = partial.length;
        var suggest = '';
        this.suggested = new Array();

        for(var i = 0; i < this.all_tags.length; i++) {
                var t = this.all_tags[i];
                if ( t.substr(0, len) == partial ) {
                        $.log.debug('suggested: ' + t );

                        jQuery.className.add( this.t.obj[t], 'suggested' );

                        suggest += '<a href="#"';
                        if (this.suggested.length == 0) suggest += ' class="suggested" ';
                        suggest += '">' + t + '</a> ';
                        this.suggested.push(t);
                }
        }

        $(this.suggest_selector).html( suggest );
        var obj = this;
        $(this.suggest_selector+' a').click( function() {
                var t = this.firstChild.nodeValue;
                $.log.debug('click add: '+ t);
                obj.clean_suggested();
                obj.add_tag( t );
        });
        this.current_suggested = 0;
        $.log.info('suggested ' + this.suggested.length + ' tags');


}

tac.prototype.clean_suggested = function() {
        for(var i = 0; i < this.suggested.length; i++) {
                var t = this.suggested[i];
                jQuery.className.remove( this.t.obj[t], 'suggested' );
        }

        var c = this.current_suggested;
        if (c == null) return c;

        $(this.suggest_selector).html('');
        this.current_suggested = null;

        return c;
}

tac.prototype.take_suggested = function() {
        var c = this.current_suggested;
        if (c == null) {
                $.log.debug('no current_select, return true');
                return true;
        }

        var s = $(this.suggest_selector+' a:nth('+c+')').html();
        if (s == null) {
                $.log.debug('no suggest, return true');
                return true;
        }

        var i = this.suggested[c].i;
        $.log.debug('take_suggested: '+s);
        this.add_tag( s );
        return false;
}

tac.prototype.move_suggested = function( where ) {
        var c = this.current_suggested;
        if (c == null) {
                $.log.error('this.current_suggested is null');
                return;
        }
        var to = c + where;
        $.log.info('move_suggested('+where+') '+c+' -> '+to);
        if (to < 0 || to >= this.suggested.length) {
                $.log.error('move to invalid element '+to);
                return;
        }
        var s = this.suggest_selector+' a:nth('+c+')';
        $( s ).removeClass('suggested');
        $.log.debug('remove suggested from '+s);
        s = this.suggest_selector+' a:nth('+to+')';
        $( s ).addClass('suggested');
        $.log.debug('add suggested to '+s);
        this.current_suggested = to;
}

/*
        tag operations
*/

tac.prototype.add_tag = function( t ) {
        $.log.info('add '+t);
        this.focus();

        jQuery.className.add( this.t.obj[t], 'entered' );

        var last = this.entered.ordered.length;
        this.entered.ordered[ last ] = t;
        this.entered.tag[t] = last;

        this.clean_suggested();

        // strip last tag and add new one
        $(this.tags_input).val(
                $(this.tags_input).val().replace(
                        /[^ ]*$/, t + ' '
                )
        );
        return false;
}

tac.prototype.remove_tag = function( t ) {
        $.log.info('remove '+t);

        this.focus();

        var o = this.entered.tag[t];
        if (o == null) {
                $.log.error('remove non-entered tag '+t);
                return false;
        }

        jQuery.className.remove( this.t.obj[t], 'entered' );

        // remove suggested tag and rebuild tags

        this.entered.ordered.splice(o,1);
        this.entered.tag[t] = null;

        for (var i = o; i < this.entered.ordered.length; i++) {
                this.entered.tag[ this.entered.ordered[i] ] = i;
        }

        this.clean_suggested();

        var tags = this.entered.ordered.join(' ');
        if (tags.length) tags += ' ';
        $.log.debug('removed '+o+' left: '+tags);
        $(this.tags_input).val( tags );
        return false;
}

tac.prototype.tag = function( t ) {
        if (this.entered.tag[t] != null) {
                this.remove_tag( t );
        } else {
                this.add_tag( t );
        }
}

/*
        parse current string into tags
*/

tac.prototype.parse = function() {
        $.log.info('re-parse tags');

        var t = $(this.tags_input).val().replace(/^  */,'').replace(/  *$/,'').split(/ /);

        this.entered = {
                ordered: new Array(),
                tag: new Array()
        };

        if (this.entered.ordered.length) $('.entered').removeClass('entered');

        var debug = '';
        for (var i = 0; i < t.length; i++) {
                var tag = t[i];
                if (this.t.exists[ tag ] != null) {
                        this.entered.tag[tag] = this.entered.ordered.length;
                        this.entered.ordered.push( tag );
                        jQuery.className.add( this.t.obj[ tag ], 'entered' );
                        debug += tag + ' '
                } else {
                        debug += '{'+tag+'} ';
                }
        }
        $.log.debug('parsed '+debug+' to '+this.entered.ordered.join(','));

}

tac.prototype.current_tag = function() {
        var tags = $(this.tags_input).val();
        if (tags != this.last_tags) {
                this.last_tags = tags;
                this.parse();
        }
        return tags.replace(/^([^ ][^ ]* )*/, '');
}

tac.prototype.focus = function() {
        // $(this.tags_input).focus() doesn't work!
        document.getElementById('tags').focus();
}

// example usage
var tags;
$(document).ready( function() {
        tags = new tac();
});

1	/*
2	tag auto-completer written with jquery (prototype style)
3
4	2006-08-20 Dobrica Pavlinusic <dpavlin@rot13.org>
5	*/
6
7	function tac(
8	tag_class, // tags are elements with this class
9	tags_form_id, // id of tags edit form
10	foo
11	) {
12
13	// all indexed by tag name
14	this.t = {
15	obj: new Array(), // html objects
16	exists: new Array()
17	};
18
19	this.all_tags = new Array();
20	this.suggested = new Array();
21
22	this.entered = { // array of entered tags
23	ordered: new Array(), // tags entered in original order
24	tag: new Array() // mapping from tag name to order number
25	};
26
27	this.current_selected = null; // current selected suggestion
28
29	this.tags_selector = '.tag';
30	if (tag_class) this.tags_selector = '.'+tag_class;
31	this.tags_form = '#tags_form';
32	if (tags_form_id) this.tags_form = '#'+tags_form_id;
33	this.suggest_selector = '#suggest';
34	this.tags_input = '#tags';
35
36	// tags from previous event
37	this.last_tags = '';
38
39	// parse all tags from html
40	var obj = this;
41	$( this.tags_selector ).each( function(i) {
42	var n = this.firstChild.nodeValue;
43
44	obj.t.obj[n] = this;
45	obj.t.exists[n] = true;
46	obj.all_tags.push( n );
47
48	this.onclick = function() {
49	return obj.tag( n );
50	}
51	this.href = '#'+i; // FIXME debug
52	});
53	$.log.info( 'found ' + this.all_tags.length + ' tags' );
54
55	$.log.info( 'hook onchange to '+this.tags_form );
56	$( this.tags_form ).keyup( function(e) {
57
58	$.log.debug('keyup: '+e.keyCode);
59
60	switch (e.keyCode) {
61	case 38: // up
62	e.preventDefault();
63	obj.move_suggested( -1 );
64	return false;
65	case 40: // down
66	e.preventDefault();
67	obj.move_suggested( +1 );
68	return false;
69	case 9: // tab
70	obj.focus();
71	obj.take_suggested();
72	return false;
73	case 13: // return
74	if (obj.current_selected != null) obj.focus();
75	return true;
76	case 8: // backspace
77	case 46: // del
78	obj.parse();
79	return false;
80	}
81
82
83	var t = obj.current_tag();
84
85	$.log.debug('tag: ' + t + ' ['+t.length+']');
86
87	obj.clean_suggested();
88
89	if (t == '') return false;
90
91	obj.suggest(t);
92
93	return true;
94	}).submit( function() {
95	$.log.debug('submit');
96	return obj.take_suggested();
97	}).blur( function() {
98	$.log.debug('blur');
99	return obj.take_suggested();
100	});
101
102	$.log.toggle();
103
104	this.focus();
105	}
106
107	tac.prototype.suggest = function( partial ) {
108
109	$.log.info('suggest to '+partial);
110
111	var len = partial.length;
112	var suggest = '';
113	this.suggested = new Array();
114
115	for(var i = 0; i < this.all_tags.length; i++) {
116	var t = this.all_tags[i];
117	if ( t.substr(0, len) == partial ) {
118	$.log.debug('suggested: ' + t );
119
120	jQuery.className.add( this.t.obj[t], 'suggested' );
121
122	suggest += '<a href="#"';
123	if (this.suggested.length == 0) suggest += ' class="suggested" ';
124	suggest += '">' + t + '</a> ';
125	this.suggested.push(t);
126	}
127	}
128
129	$(this.suggest_selector).html( suggest );
130	var obj = this;
131	$(this.suggest_selector+' a').click( function() {
132	var t = this.firstChild.nodeValue;
133	$.log.debug('click add: '+ t);
134	obj.clean_suggested();
135	obj.add_tag( t );
136	});
137	this.current_suggested = 0;
138	$.log.info('suggested ' + this.suggested.length + ' tags');
139
140
141	}
142
143	tac.prototype.clean_suggested = function() {
144	for(var i = 0; i < this.suggested.length; i++) {
145	var t = this.suggested[i];
146	jQuery.className.remove( this.t.obj[t], 'suggested' );
147	}
148
149	var c = this.current_suggested;
150	if (c == null) return c;
151
152	$(this.suggest_selector).html('');
153	this.current_suggested = null;
154
155	return c;
156	}
157
158	tac.prototype.take_suggested = function() {
159	var c = this.current_suggested;
160	if (c == null) {
161	$.log.debug('no current_select, return true');
162	return true;
163	}
164
165	var s = $(this.suggest_selector+' a:nth('+c+')').html();
166	if (s == null) {
167	$.log.debug('no suggest, return true');
168	return true;
169	}
170
171	var i = this.suggested[c].i;
172	$.log.debug('take_suggested: '+s);
173	this.add_tag( s );
174	return false;
175	}
176
177	tac.prototype.move_suggested = function( where ) {
178	var c = this.current_suggested;
179	if (c == null) {
180	$.log.error('this.current_suggested is null');
181	return;
182	}
183	var to = c + where;
184	$.log.info('move_suggested('+where+') '+c+' -> '+to);
185	if (to < 0 \|\| to >= this.suggested.length) {
186	$.log.error('move to invalid element '+to);
187	return;
188	}
189	var s = this.suggest_selector+' a:nth('+c+')';
190	$( s ).removeClass('suggested');
191	$.log.debug('remove suggested from '+s);
192	s = this.suggest_selector+' a:nth('+to+')';
193	$( s ).addClass('suggested');
194	$.log.debug('add suggested to '+s);
195	this.current_suggested = to;
196	}
197
198	/*
199	tag operations
200	*/
201
202	tac.prototype.add_tag = function( t ) {
203	$.log.info('add '+t);
204	this.focus();
205
206	jQuery.className.add( this.t.obj[t], 'entered' );
207
208	var last = this.entered.ordered.length;
209	this.entered.ordered[ last ] = t;
210	this.entered.tag[t] = last;
211
212	this.clean_suggested();
213
214	// strip last tag and add new one
215	$(this.tags_input).val(
216	$(this.tags_input).val().replace(
217	/[^ ]*$/, t + ' '
218	)
219	);
220	return false;
221	}
222
223	tac.prototype.remove_tag = function( t ) {
224	$.log.info('remove '+t);
225
226	this.focus();
227
228	var o = this.entered.tag[t];
229	if (o == null) {
230	$.log.error('remove non-entered tag '+t);
231	return false;
232	}
233
234	jQuery.className.remove( this.t.obj[t], 'entered' );
235
236	// remove suggested tag and rebuild tags
237
238	this.entered.ordered.splice(o,1);
239	this.entered.tag[t] = null;
240
241	for (var i = o; i < this.entered.ordered.length; i++) {
242	this.entered.tag[ this.entered.ordered[i] ] = i;
243	}
244
245	this.clean_suggested();
246
247	var tags = this.entered.ordered.join(' ');
248	if (tags.length) tags += ' ';
249	$.log.debug('removed '+o+' left: '+tags);
250	$(this.tags_input).val( tags );
251	return false;
252	}
253
254	tac.prototype.tag = function( t ) {
255	if (this.entered.tag[t] != null) {
256	this.remove_tag( t );
257	} else {
258	this.add_tag( t );
259	}
260	}
261
262	/*
263	parse current string into tags
264	*/
265
266	tac.prototype.parse = function() {
267	$.log.info('re-parse tags');
268
269	var t = $(this.tags_input).val().replace(/^ /,'').replace(/ $/,'').split(/ /);
270
271	this.entered = {
272	ordered: new Array(),
273	tag: new Array()
274	};
275
276	if (this.entered.ordered.length) $('.entered').removeClass('entered');
277
278	var debug = '';
279	for (var i = 0; i < t.length; i++) {
280	var tag = t[i];
281	if (this.t.exists[ tag ] != null) {
282	this.entered.tag[tag] = this.entered.ordered.length;
283	this.entered.ordered.push( tag );
284	jQuery.className.add( this.t.obj[ tag ], 'entered' );
285	debug += tag + ' '
286	} else {
287	debug += '{'+tag+'} ';
288	}
289	}
290	$.log.debug('parsed '+debug+' to '+this.entered.ordered.join(','));
291
292	}
293
294	tac.prototype.current_tag = function() {
295	var tags = $(this.tags_input).val();
296	if (tags != this.last_tags) {
297	this.last_tags = tags;
298	this.parse();
299	}
300	return tags.replace(/^([^ ][^ ]* )*/, '');
301	}
302
303	tac.prototype.focus = function() {
304	// $(this.tags_input).focus() doesn't work!
305	document.getElementById('tags').focus();
306	}
307
308	// example usage
309	var tags;
310	$(document).ready( function() {
311	tags = new tac();
312	});
313