egroupware/phpgwapi/js/jsapi/egw_message.js

164 lines
4.3 KiB
JavaScript

/**
* EGroupware clientside API object
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package etemplate
* @subpackage api
* @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker@outdoor-training.de>
* @version $Id$
*/
"use strict";
/*egw:uses
egw_core;
*/
/**
* Methods to display a success or error message and the app-header
*
* @augments Class
* @param {string} _app application name object is instanciated for
* @param {object} _wnd window object is instanciated for
*/
egw.extend('message', egw.MODULE_WND_LOCAL, function(_app, _wnd)
{
_app; // not used, but required by function signature
var message_timer;
var error_reg_exp;
var on_click_remove_installed = false;
// Register an 'error' plugin, displaying using the message system
this.registerJSONPlugin(function(type, res, req) {
if (typeof res.data == 'string')
{
egw.message(res.data,'error');
return true;
}
throw 'Invalid parameters';
}, null, 'error');
return {
/**
* Display an error or regular message
*
* @param {string} _msg message to show or empty to remove previous message
* @param {string} _type 'error', 'warning' or 'success' (default)
*/
message: function(_msg, _type)
{
var framework = _wnd.framework;
var jQuery = _wnd.jQuery;
if (_msg && typeof _type == 'undefined')
{
if (typeof error_reg_exp == 'undefined') error_reg_exp = new RegExp('(error|'+egw.lang('error')+')', 'i');
_type = _msg.match(error_reg_exp) ? 'error' : 'success';
}
// if we are NOT in a popup and have a framwork --> let it deal with it
if (!this.is_popup() && typeof framework != 'undefined')
{
// currently not using framework, but top windows message
//framework.setMessage.call(framework, _msg, _type);
if (_wnd !== _wnd.top)
{
egw(_wnd.top).message(_msg, _type);
return;
}
}
// handle message display for non-framework templates, eg. idots or jerryr
if (message_timer)
{
_wnd.clearTimeout(message_timer);
message_timer = null;
}
var parent = jQuery('div#divAppboxHeader');
// popup has no app-header (idots) or it is hidden by onlyPrint class (jdots) --> use body
if (!parent.length || parent.hasClass('onlyPrint'))
{
parent = jQuery('body');
}
jQuery('div#egw_message').remove();
if (_msg) // empty _msg just removes pervious message
{
if (!on_click_remove_installed)
{
// install handler to remove message on click
jQuery('body').on('click', 'div#egw_message', function(e) {
jQuery('div#egw_message').remove();
});
on_click_remove_installed = true;
}
parent.prepend(jQuery(_wnd.document.createElement('div'))
.attr('id','egw_message')
.text(_msg)
.addClass(_type+'_message')
.css('position', 'absolute'));
if (_type != 'error') // clear message again after some time, if no error
{
message_timer = _wnd.setTimeout(function() {
jQuery('div#egw_message').remove();
}, 5000);
}
}
},
/**
* Are we running in a popup
*
* @returns {boolean} true: popup, false: main window
*/
is_popup: function ()
{
var popup = false;
try {
if (_wnd.opener && typeof _wnd.opener.top.egw == 'object')
{
popup = true;
}
}
catch(e) {
// ignore SecurityError exception if opener is different security context / cross-origin
}
return popup;
},
/**
* Active app independent if we are using a framed template-set or not
*
* @returns {string}
*/
app_name: function()
{
return !this.is_popup() && _wnd.framework && _wnd.framework.activeApp ? _wnd.framework.activeApp.appName : _wnd.egw_appName;
},
/**
* Update app-header and website-title
*
* @param {string} _header
* @param {string} _app Application name, if not for the current app
*/
app_header: function(_header,_app)
{
// not for popups and only for framed templates
if (!this.is_popup() && _wnd.framework && _wnd.framework.setWebsiteTitle)
{
var app = _app || this.app_name();
var title = _wnd.document.title.replace(/[.*]$/, '['+_header+']');
_wnd.framework.setWebsiteTitle.call(_wnd.framework, app, title, _header);
return;
}
_wnd.jQuery('div#divAppboxHeader').text(_header);
_wnd.document.title = _wnd.document.title.replace(/[.*]$/, '['+_header+']');
}
};
});