root/js/webpac.js

// WebPAC AJAX API
//
// Documented in this code only, I'm afraid. Beware of dragons!
// Dobrica Pavlinusic dpavlin(at)rot13(dot)org 2005-11-22

/*
        load another template
*/
function load_template(template_name) {

        var old_template = $('template_name').value;

        Logger.info('load_template: '+template_name+' (old: '+old_template+')');

        if (template_name == old_template) {
                Logger.error('why reload same template?');
                return false;
        }

        $('template_name').value = template_name;
        submit_results_form();
        return false;
}

/*
        pager
*/
function load_results_page(page_nr) {

        if (parseInt(page_nr) != page_nr) {
                Logger.error("load_results_page can't parseInt "+page_nr);
                return false;
        }

        var old_page = get_page_nr();

        if (page_nr < 1) {
                Logger.error("load_results_page called with '"+page_nr+"' < 1");
                return false;
        }

        Logger.info('load_results_page: '+page_nr+' (from page: '+old_page+')');

        if (page_nr == old_page) {
                Logger.error('why reload same page?');
                return false;
        }

        $('page_nr').value = page_nr;
        submit_results_form();

        return false;
}

function get_page_nr() {
        var page_nr = parseInt( $('page_nr').value ) || 1;
        return page_nr;
}

function reset_page_nr( nr ) {
        if (! nr) nr = 1;
        Logger.info('reset_page_nr to '+nr);
        page_nr = nr;
        $('page_nr').value = page_nr;
}

/* syntaxtic sugar */
function set_page_nr(nr) {
        return load_results_page(nr);
}

function next_page() {
        load_results_page( get_page_nr() + 1 );
        return false;
}

function prev_page() {
        load_results_page( get_page_nr() - 1 );
        return false;
}

/* toggle visibility and replace text with something else */
function toggleLinkAndElement ( link, elementID, text ) {

        if ( link.innerHTML != text ) {
                // change link text
                link.oldInnerHTML = link.innerHTML;
                link.innerHTML = text;    
        } else {
                // change it back
                link.innerHTML = link.oldInnerHTML;
        }

        Logger.debug('toggleLinkAndElement '+elementID+': '+Element.visible( elementID )+' text: '+text);

        Element.toggle( elementID );

        // why is this needed, Firefox 1.5?
        if (Element.visible( elementID )) $( elementID ).style.display = 'block';

        return false;
}


/*
        submit results form using AJAX
*/
function submit_results_form() {
        var results_form = $('results_form');

        if (results_form) {
                var form_params = Form.serialize( results_form );

                Logger.debug('Ajax.Updater(results,/results/ajax) '+form_params);

                new Ajax.Updater( 'results', '/search/results/ajax', {
                        parameters: form_params,
                        asynchronous: 1,
                        onLoading: function(request) {
                                show_searching();
                        },
                        onLoaded: function(request) {
                                hide_searching();
                        }
                } ) ;
                return false;
        } else {
                Logger.debug('no results_form element');
                return undef;
        }
        return false;
}

/*
        helper functions for submit_results_form()
*/
function show_searching() {
        Logger.debug('show_searching');
        Element.show('searching');
//      new Effect.Fade('results', { duration: 0.3 });
        return false;
}

function hide_searching() {
        Logger.debug('hide_searching');
        Element.hide('searching');
//      new Effect.Highlight('results');
//      new Effect.Appear('results', { duration: 0.3 });
        return false;
}

/*
        load record nr in some template
*/

function load_rec(record_uri, tmp_template_filename) {
        if (! tmp_template_filename) tmp_template_filename = template_filename;
        Logger.info('load_rec '+record_uri+' in '+tmp_template_filename);

        var results_form = $('results_form');

        if (results_form) {
                var args = '?record_uri='+record_uri+'&template_filename='+tmp_template_filename;
                Logger.debug('Ajax.Updater(results,/search/record) '+args);

                new Ajax.Updater( 'results', '/search/record'+args, {
                        asynchronous: 1,
                        onLoading: function(request) {
                                show_searching();
                        },
                        onLoaded: function(request) {
                                hide_searching();
                        }
                } ) ;
                return false;
        } else {
                Logger.debug('no results_form element');
                return undef;
        }
        return false;
}

var WebPAC = { };

/*
        autocompleter which isn't (a suggest box)
        - don't just on first option on appear
        - removed fade-in/out effect
        - added configurable width (content width? centered?)
        - add icon which means suggest

        hopefully, this implementation won't break (much) when I update
        prototype next time :-)
*/


WebPAC.Suggest = Class.create();
Logger.debug('Created WebPAC.Suggest Class');
Object.extend(Object.extend(WebPAC.Suggest.prototype, Ajax.Autocompleter.prototype), {
  initialize: function(element, update, url, options) {
    this.baseInitialize(element, update, options);
    this.options.asynchronous  = true;
    this.options.onComplete    = this.onComplete.bind(this);
    this.options.defaultParams = this.options.parameters || null;
    this.url                   = url;
    this.ignoreReturn = true;

    Logger.debug('WebPAC.Sugget initialize '+element+','+update+','+url);

    this.options.onShow = function(element, update) {
      if(!update.style.position || update.style.position=='absolute') {
        update.style.position = 'absolute';
        Position.clone(element, update, {setHeight: false, offsetTop: element.offsetHeight});
      }
      new Element.show(update);
      Logger.debug('WebPAC.Suggest.onShow');
    };

    this.options.onHide = function(element, update) {
        new Element.hide(update);
        Logger.debug('WebPAC.Suggest.onHide');
    };
  },

  getUpdatedChoices: function() {
    entry = encodeURIComponent(this.options.paramName) + '=' +
      encodeURIComponent(this.getToken());

    this.options.parameters = this.options.callback ?
      this.options.callback(this.element, entry) : entry;

    if(this.options.defaultParams)
      this.options.parameters += '&' + this.options.defaultParams;

    Logger.debug('WebPAC.Suggest called '+this.url);
    new Ajax.Request(this.url, this.options);
  },

  onComplete: function(request) {
    Logger.debug('WebPAC.Suggest onComplete called');
    this.updateChoices(request.responseText);
  },

  markPrevious: function() {
    if(this.index > 0) this.index--
    //  else this.index = this.entryCount-1;
  },

  markNext: function() {
    if(this.index < this.entryCount-1) this.index++
    //  else this.index = 0;
  }

});

/*
        WebPAC.Updater
*/

WebPAC.Updater = Class.create();
Logger.debug('Created WebPAC.Updater Class');
Object.extend(WebPAC.Updater.prototype, {
  initialize: function(container, url, options) {
    Logger.debug('WebPAC.Updater initialize '+container+','+url+','+options);
    url += '/ajax';
    this.updater = new Ajax.Updater(container, url, options);
    $('_ajax').value = 1;
    if ($('_ajax').value) Logger.info("using AJAX");
  }
});

1	// WebPAC AJAX API
2	//
3	// Documented in this code only, I'm afraid. Beware of dragons!
4	// Dobrica Pavlinusic dpavlin(at)rot13(dot)org 2005-11-22
5
6	/*
7	load another template
8	*/
9	function load_template(template_name) {
10
11	var old_template = $('template_name').value;
12
13	Logger.info('load_template: '+template_name+' (old: '+old_template+')');
14
15	if (template_name == old_template) {
16	Logger.error('why reload same template?');
17	return false;
18	}
19
20	$('template_name').value = template_name;
21	submit_results_form();
22	return false;
23	}
24
25	/*
26	pager
27	*/
28	function load_results_page(page_nr) {
29
30	if (parseInt(page_nr) != page_nr) {
31	Logger.error("load_results_page can't parseInt "+page_nr);
32	return false;
33	}
34
35	var old_page = get_page_nr();
36
37	if (page_nr < 1) {
38	Logger.error("load_results_page called with '"+page_nr+"' < 1");
39	return false;
40	}
41
42	Logger.info('load_results_page: '+page_nr+' (from page: '+old_page+')');
43
44	if (page_nr == old_page) {
45	Logger.error('why reload same page?');
46	return false;
47	}
48
49	$('page_nr').value = page_nr;
50	submit_results_form();
51
52	return false;
53	}
54
55	function get_page_nr() {
56	var page_nr = parseInt( $('page_nr').value ) \|\| 1;
57	return page_nr;
58	}
59
60	function reset_page_nr( nr ) {
61	if (! nr) nr = 1;
62	Logger.info('reset_page_nr to '+nr);
63	page_nr = nr;
64	$('page_nr').value = page_nr;
65	}
66
67	/* syntaxtic sugar */
68	function set_page_nr(nr) {
69	return load_results_page(nr);
70	}
71
72	function next_page() {
73	load_results_page( get_page_nr() + 1 );
74	return false;
75	}
76
77	function prev_page() {
78	load_results_page( get_page_nr() - 1 );
79	return false;
80	}
81
82	/* toggle visibility and replace text with something else */
83	function toggleLinkAndElement ( link, elementID, text ) {
84
85	if ( link.innerHTML != text ) {
86	// change link text
87	link.oldInnerHTML = link.innerHTML;
88	link.innerHTML = text;
89	} else {
90	// change it back
91	link.innerHTML = link.oldInnerHTML;
92	}
93
94	Logger.debug('toggleLinkAndElement '+elementID+': '+Element.visible( elementID )+' text: '+text);
95
96	Element.toggle( elementID );
97
98	// why is this needed, Firefox 1.5?
99	if (Element.visible( elementID )) $( elementID ).style.display = 'block';
100
101	return false;
102	}
103
104
105	/*
106	submit results form using AJAX
107	*/
108	function submit_results_form() {
109	var results_form = $('results_form');
110
111	if (results_form) {
112	var form_params = Form.serialize( results_form );
113
114	Logger.debug('Ajax.Updater(results,/results/ajax) '+form_params);
115
116	new Ajax.Updater( 'results', '/search/results/ajax', {
117	parameters: form_params,
118	asynchronous: 1,
119	onLoading: function(request) {
120	show_searching();
121	},
122	onLoaded: function(request) {
123	hide_searching();
124	}
125	} ) ;
126	return false;
127	} else {
128	Logger.debug('no results_form element');
129	return undef;
130	}
131	return false;
132	}
133
134	/*
135	helper functions for submit_results_form()
136	*/
137	function show_searching() {
138	Logger.debug('show_searching');
139	Element.show('searching');
140	// new Effect.Fade('results', { duration: 0.3 });
141	return false;
142	}
143
144	function hide_searching() {
145	Logger.debug('hide_searching');
146	Element.hide('searching');
147	// new Effect.Highlight('results');
148	// new Effect.Appear('results', { duration: 0.3 });
149	return false;
150	}
151
152	/*
153	load record nr in some template
154	*/
155
156	function load_rec(record_uri, tmp_template_filename) {
157	if (! tmp_template_filename) tmp_template_filename = template_filename;
158	Logger.info('load_rec '+record_uri+' in '+tmp_template_filename);
159
160	var results_form = $('results_form');
161
162	if (results_form) {
163	var args = '?record_uri='+record_uri+'&template_filename='+tmp_template_filename;
164	Logger.debug('Ajax.Updater(results,/search/record) '+args);
165
166	new Ajax.Updater( 'results', '/search/record'+args, {
167	asynchronous: 1,
168	onLoading: function(request) {
169	show_searching();
170	},
171	onLoaded: function(request) {
172	hide_searching();
173	}
174	} ) ;
175	return false;
176	} else {
177	Logger.debug('no results_form element');
178	return undef;
179	}
180	return false;
181	}
182
183	var WebPAC = { };
184
185	/*
186	autocompleter which isn't (a suggest box)
187	- don't just on first option on appear
188	- removed fade-in/out effect
189	- added configurable width (content width? centered?)
190	- add icon which means suggest
191
192	hopefully, this implementation won't break (much) when I update
193	prototype next time :-)
194	*/
195
196
197	WebPAC.Suggest = Class.create();
198	Logger.debug('Created WebPAC.Suggest Class');
199	Object.extend(Object.extend(WebPAC.Suggest.prototype, Ajax.Autocompleter.prototype), {
200	initialize: function(element, update, url, options) {
201	this.baseInitialize(element, update, options);
202	this.options.asynchronous = true;
203	this.options.onComplete = this.onComplete.bind(this);
204	this.options.defaultParams = this.options.parameters \|\| null;
205	this.url = url;
206	this.ignoreReturn = true;
207
208	Logger.debug('WebPAC.Sugget initialize '+element+','+update+','+url);
209
210	this.options.onShow = function(element, update) {
211	if(!update.style.position \|\| update.style.position=='absolute') {
212	update.style.position = 'absolute';
213	Position.clone(element, update, {setHeight: false, offsetTop: element.offsetHeight});
214	}
215	new Element.show(update);
216	Logger.debug('WebPAC.Suggest.onShow');
217	};
218
219	this.options.onHide = function(element, update) {
220	new Element.hide(update);
221	Logger.debug('WebPAC.Suggest.onHide');
222	};
223	},
224
225	getUpdatedChoices: function() {
226	entry = encodeURIComponent(this.options.paramName) + '=' +
227	encodeURIComponent(this.getToken());
228
229	this.options.parameters = this.options.callback ?
230	this.options.callback(this.element, entry) : entry;
231
232	if(this.options.defaultParams)
233	this.options.parameters += '&' + this.options.defaultParams;
234
235	Logger.debug('WebPAC.Suggest called '+this.url);
236	new Ajax.Request(this.url, this.options);
237	},
238
239	onComplete: function(request) {
240	Logger.debug('WebPAC.Suggest onComplete called');
241	this.updateChoices(request.responseText);
242	},
243
244	markPrevious: function() {
245	if(this.index > 0) this.index--
246	// else this.index = this.entryCount-1;
247	},
248
249	markNext: function() {
250	if(this.index < this.entryCount-1) this.index++
251	// else this.index = 0;
252	}
253
254	});
255
256	/*
257	WebPAC.Updater
258	*/
259
260	WebPAC.Updater = Class.create();
261	Logger.debug('Created WebPAC.Updater Class');
262	Object.extend(WebPAC.Updater.prototype, {
263	initialize: function(container, url, options) {
264	Logger.debug('WebPAC.Updater initialize '+container+','+url+','+options);
265	url += '/ajax';
266	this.updater = new Ajax.Updater(container, url, options);
267	$('_ajax').value = 1;
268	if ($('_ajax').value) Logger.info("using AJAX");
269	}
270	});
271