com.opensymphony.webwork.static.webwork.Util.js Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webwork Show documentation

WebWork is a Java web-application development framework. It is built specifically with developer productivity and code simplicity in mind, providing robust support for building reusable UI templates, such as form controls, UI themes, internationalization, dynamic form parameter mapping to JavaBeans, robust client and server side validation, and much more.

The newest version!

dojo.provide("webwork.Util");

/*
 * This function will copy over all args to target
 * except for dojo related arguments eg. "dojoType" or "dojotype".
 * 
 * @param taget - obj where the arguments are copied over to
 * @param args - array of arguments
 */
webwork.Util.passThroughArgs = function(args, target){
	// pass through the extra args, catering for special cases of style and class for html elements
	var str = '';
	for (n in args) {
		var v = args[n];
		if (n == "style") {
			target.style.cssText = v;
			str = str + n+"="+v+"\n";
		}else if (n == "class") {
			target.className = v;
		}else if (n == "dojoType") {
		}else if (n == "dojotype") {
		}else{
			target[n] = v;
			str = str + n+"="+v+"\n";
		}
	}
	// alert(str);
}

/*
 * This function copied over the innerHTML from widget to 
 * target through the frag (dojo parsed 
 * fragment).
 *
 * @param widget
 * @param frag
 * @param target
 */
webwork.Util.passThroughWidgetTagContent = function(widget, frag, target) {
	// fill in the target with the contents of the widget tag
	var _tmp = frag["dojo:" + widget.widgetType.toLowerCase()];
	var widgetTag = null;
	if(_tmp) {
		widgetTag = _tmp.nodeRef;
	}
	else {
		_tmp = frag["webwork:" + widget.widgetType.toLowerCase()];
		if (_tmp) {
			widgetTag = _tmp.nodeRef;
		}
	}
	if(widgetTag) {
		target.innerHTML = widgetTag.innerHTML;
	}
}

/*
 * This function copy over all the properties in source
 * to target
 *
 * @param source
 * @param target
 */
webwork.Util.copyProperties = function(source, target){
	// pass through the extra args, catering for special cases of style and class for html elements
	for (key in source) target[key] = source[key];
}


webwork.Util.globalCallbackCount = 0;

/*
 * This function register target with a unique name under
 * the global scope (js window object) and return the unique name such that
 * it could be referred latter on using window[the_unique_name_returned]. 
 * The unique name is 'callback_hack_' followed by a global incrementing 
 * number starting from 0.
 *
 * @param target
 * @return a unique name to identified target
 */
webwork.Util.makeGlobalCallback = function(target) {
	var name = 'callback_hack_' + webwork.Util.globalCallbackCount++;
	window[name] = target;
	return name;
}

/*
 * This function allow a callback's method
 * to be called when a timeout identified millismiliseconds 
 * is reached, and return an id (which could be used if one need to stop this 
 * timeout execution using webwork.Util.clearTimeout(id))
 *
 * @param callback
 * @param method
 * @param milis
 * @return - the id
 */
webwork.Util.setTimeout = function(callback, method, millis) {
	window.setTimeout(callback + "." + method + "()", millis);
}

/*
 * This function clear the timeout of callback.
 * This callback will have to be the id returned from 
 * webwork.Util.setTimeout(....)
 *
 * @param callback
 */
webwork.Util.clearTimeout = function(callback) {
	window.clearTimeout(callback);
}


webwork.Util.nextIdValue = 0;

/*
 * This function generate a unique id based on the scope
 * supplied which could be 'null'.
 * 
 * @param scope
 * @return unique id
 */
webwork.Util.nextId = function(scope) {
	return (scope==null?"id":scope) + webwork.Util.nextIdValue++;
}

/*
 * This function trims leading and trailing spaces froma
 * and return the result
 *
 * @param a
 * @return trimed result
 */
webwork.Util.trim = function(a) {
        a = a.replace( /^\s+/g, "" );// strip leading
        return a.replace( /\s+$/g, "" );// strip trailing
}