/**
* general.js
*
* This function contains all functions that are generic enough to be used throughout
* the script.
*/
if (typeof g == "undefined")
g = {};
/**
* Bootstrap function. All onload handlers should be added through this function, rather than
* explicitly set through window.onload (or through the body onload attribute!)
*
* TODO deprecate!
*/
g.addOnloadEvent = function(func)
{
if (window.onload != "function")
window.onload = func;
else
{
var old_onload = window.onload;
window.onload = function()
{
old_onload();
func();
}
}
}
/**
* Helper function to include external JS files on the fly.
*
* @param string file the absolute or relative path to the javascript file
* @param string file_id a unique ID for the file
*/
g.importJSFile = function(file, file_id)
{
// if this file is already included, just return
if ($(file_id))
return;
// add the file by appending it to the end of the
var head = document.getElementsByTagName("head")[0];
script = document.createElement('script');
script.id = file_id;
script.type = 'text/javascript';
script.src = file + "?id=" + g.version;
head.appendChild(script);
}
/**
* Helper function to include external JS files on the fly.
*
* @param string file the absolute or relative path to the javascript file
* @param string file_id a unique ID for the file
*/
g.importCSSFile = function(file, file_id)
{
// if this file is already included, just return
if ($(file_id))
return;
// add the file by appending it to the end of the
var head = document.getElementsByTagName("head")[0];
var cssLink = document.createElement('link');
cssLink.rel = "stylesheet";
cssLink.id = file_id;
cssLink.type = 'text/css';
cssLink.href = file + "?id=" + g.version
head.appendChild(cssLink);
}
/**
* The default error handler for the rsv validation library.
*/
function g_rsvErrors(f, errorInfo)
{
var errorHTML = rsv.errorTextIntro + "
";
for (var i=0; i";
if (rsv.styleOffendingFields)
rsv.styleField(errorInfo[i][0], i==0);
}
if (errorInfo.length > 0)
{
g.displayMessage(rsv.errorTargetElementId, 0, errorHTML);
return false;
}
return true;
}
/**
* Generic function for displaying a message in the UI, as returned from an Ajax response handler. This
* does all the fancy-pants stuff like blind-downing the message, and changing the colour on the message
* with the Fade Anything Technique (fat.js) to draw attention to it.
*
* Assumption: the element with the target_id contains a single DIV tag. This is done so that the styles
* may be applied to the inner DIV, allowing the outer div to be smoothly blind-upped and -downed.
*
* @param string target_id the HTML target element
* @param boolean success whether this is an error or a notification
* @param string message the message to display
*/
g.displayMessage = function(target_id, success, message)
{
var messageClass = (success == 1) ? "notify" : "error";
// remove all old class names
$(target_id).classNames().each(function(s) { $(target_id).removeClassName(s); });
// add the new one
$(target_id).addClassName(messageClass);
$(target_id).innerHTML = "";
$(target_id).style.display = "block";
// add the nice fade effect for the notification message
Fat.fade_element(target_id, 60, 1500, '#FFFC05', '#ffffdd');
}
/**
* Hides a message on the screen by fading it out and blinding up at the same time.
*/
g.hideMessage = function(target_id)
{
Effect.BlindUp($(target_id));
Effect.Fade($(target_id));
return false;
}
/**
* Simple helper function that's called on all server-side requests; it checks that the
* person is currently logged in. If they're not, it sends them to the logout page.
*/
g.checkLoggedIn = function(is_logged_in)
{
if (!is_logged_in)
top.location = g.logoutURL + "?session_timeout=1";
}
// DEPRECATE THIS for prototype's include()
Array.prototype.contains = function(value)
{
var found = false;
for (var i=0; i 0)
lastItem = this.pop();
// now, if there's still 1 or more items left, join them with the glue
if (this.length > 0)
{
var str = this.join(glue);
str += finalGlue + lastItem;
}
// otherwise there was only one item: just return the string
else
str = lastItem;
return str;
}
/**
* Helper function to uncheck a list of elements, specified by an array of IDs.
*/
g.uncheck = function(id_arr)
{
for (var i=0; i