[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
This patch introduces a new 'server-response' event and
deprecates the 'ajax-loaded' event.
- 'server-response' is triggered by postAjaxLoad() (instead of
'ajax-loaded').
- 'server-response' is also triggered on document.ready().
- The add_onload() method binds the javascript code the
'server-response' event whether or not it's an ajax
request, thus removing the need of the jsoncall hackish
parameter. The binding is done with jQuery.one() instead
of jQuery.bind().
- The javascript callbacks will be passed two extra parameters :
a boolean to indicate if it's an ajax request or not, the DOM
node (result of the HTTP query). As javascript is what it is,
callbacks can safely ignore those two parameters if they don't
need them.
Backward compatibility is maintained by triggerring an 'ajax-loaded'
event when a 'server-response' is emitted.
CubicWeb.require('python.js');
CubicWeb.require('jquery.corner.js');
/* returns the document's baseURI. (baseuri() uses document.baseURI if
* available and inspects the <base> tag manually otherwise.)
*/
function baseuri() {
var uri = document.baseURI;
if (uri) { // some browsers don't define baseURI
return uri;
}
var basetags = document.getElementsByTagName('base');
if (basetags.length) {
return getNodeAttribute(basetags[0], 'href');
}
return '';
}
/* set body's cursor to 'progress' */
function setProgressCursor() {
var body = document.getElementsByTagName('body')[0];
body.style.cursor = 'progress';
}
/* reset body's cursor to default (mouse cursor). The main
* purpose of this function is to be used as a callback in the
* deferreds' callbacks chain. */
function resetCursor(result) {
var body = document.getElementsByTagName('body')[0];
body.style.cursor = 'default';
// pass result to next callback in the callback chain
return result;
}
function updateMessage(msg) {
var msgdiv = DIV({'class':'message'});
// don't pass msg to DIV() directly because DIV will html escape it
// and msg should alreay be html escaped at this point.
msgdiv.innerHTML = msg;
jQuery('#appMsg').removeClass('hidden').empty().append(msgdiv);
}
/* builds an url from an object (used as a dictionnary)
*
* >>> asURL({'rql' : "RQL", 'x': [1, 2], 'itemvid' : "oneline"})
* rql=RQL&vid=list&itemvid=oneline&x=1&x=2
* >>> asURL({'rql' : "a&b", 'x': [1, 2], 'itemvid' : "oneline"})
* rql=a%26b&x=1&x=2&itemvid=oneline
*/
function asURL(props) {
var chunks = [];
for(key in props) {
var value = props[key];
// generate a list of couple key=value if key is multivalued
if (isArrayLike(value)) {
for (var i=0; i<value.length;i++) {
chunks.push(key + '=' + urlEncode(value[i]));
}
} else {
chunks.push(key + '=' + urlEncode(value));
}
}
return chunks.join('&');
}
/* return selected value of a combo box if any
*/
function firstSelected(selectNode) {
var selection = filter(attrgetter('selected'), selectNode.options);
return (selection.length > 0) ? getNodeAttribute(selection[0], 'value'):null;
}
/* toggle visibility of an element by its id
*/
function toggleVisibility(elemId) {
jqNode(elemId).toggleClass('hidden');
}
/* toggles visibility of login popup div */
// XXX used exactly ONCE in basecomponents
function popupLoginBox() {
toggleVisibility('popupLoginBox');
jQuery('#__login:visible').focus();
}
/* returns the list of elements in the document matching the tag name
* and the properties provided
*
* @param tagName the tag's name
* @param properties a js Object used as a dict
* @return an iterator (if a *real* array is needed, you can use the
* list() function)
*/
function getElementsMatching(tagName, properties, /* optional */ parent) {
parent = parent || document;
return filter(function elementMatches(element) {
for (prop in properties) {
if (getNodeAttribute(element, prop) != properties[prop]) {
return false;}}
return true;},
parent.getElementsByTagName(tagName));
}
/*
* sets checked/unchecked status of checkboxes
*/
function setCheckboxesState(nameprefix, checked){
// XXX: this looks in *all* the document for inputs
var elements = getElementsMatching('input', {'type': "checkbox"});
filterfunc = function(cb) { return nameprefix && cb.name.startsWith(nameprefix); };
forEach(filter(filterfunc, elements), function(cb) {cb.checked=checked;});
}
function setCheckboxesState2(nameprefix, value, checked){
// XXX: this looks in *all* the document for inputs
var elements = getElementsMatching('input', {'type': "checkbox"});
filterfunc = function(cb) { return nameprefix && cb.name.startsWith(nameprefix) && cb.value == value; };
forEach(filter(filterfunc, elements), function(cb) {cb.checked=checked;});
}
/* this function is a hack to build a dom node from html source */
function html2dom(source) {
var tmpNode = SPAN();
tmpNode.innerHTML = source;
if (tmpNode.childNodes.length == 1) {
return tmpNode.firstChild;
}
else {
// we leave the span node when `source` has no root node
// XXX This is cleary not the best solution, but css/html-wise,
/// a span not should not be too much disturbing
return tmpNode;
}
}
// *** HELPERS **************************************************** //
function rql_for_eid(eid) { return 'Any X WHERE X eid ' + eid; }
function isTextNode(domNode) { return domNode.nodeType == 3; }
function isElementNode(domNode) { return domNode.nodeType == 1; }
function autogrow(area) {
if (area.scrollHeight > area.clientHeight && !window.opera) {
if (area.rows < 20) {
area.rows += 2;
}
}
}
//============= page loading events ==========================================//
CubicWeb.rounded = [
['div.sideBoxBody', 'bottom 6px'],
['div.boxTitle, div.sideBoxTitle, th.month', 'top 6px']
];
function roundedCorners(node) {
node = jQuery(node);
for(var r=0; r < CubicWeb.rounded.length; r++) {
node.find(CubicWeb.rounded[r][0]).corner(CubicWeb.rounded[r][1]);
}
}
jQuery(document).ready(function () {roundedCorners(this.body);});
CubicWeb.provide('corners.js');
CubicWeb.provide('htmlhelpers.js');