mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-11-08 09:04:53 +01:00
Merge branch 'typescript' of github.com:EGroupware/egroupware into typescript
This commit is contained in:
commit
bdc0c16212
@ -511,10 +511,11 @@ var et2_widget = /** @class */ (function (_super) {
|
||||
* is called with the node.
|
||||
*
|
||||
* @param _node XML node to read
|
||||
* @param _name XML node name
|
||||
*
|
||||
* @return et2_widget
|
||||
*/
|
||||
et2_widget.prototype.createElementFromNode = function (_node) {
|
||||
et2_widget.prototype.createElementFromNode = function (_node, _name) {
|
||||
var attributes = {};
|
||||
// Parse the "readonly" and "type" flag for this element here, as they
|
||||
// determine which constructor is used
|
||||
|
@ -650,10 +650,11 @@ export class et2_widget extends ClassWithAttributes
|
||||
* is called with the node.
|
||||
*
|
||||
* @param _node XML node to read
|
||||
* @param _name XML node name
|
||||
*
|
||||
* @return et2_widget
|
||||
*/
|
||||
createElementFromNode(_node)
|
||||
createElementFromNode(_node, _name?)
|
||||
{
|
||||
var attributes = {};
|
||||
|
||||
|
4
api/js/etemplate/et2_types.d.ts
vendored
4
api/js/etemplate/et2_types.d.ts
vendored
@ -155,4 +155,8 @@ declare var et2_IExposable : any;
|
||||
declare function et2_createWidget(type : string, params : {}, parent? : any) : any;
|
||||
declare function nm_action(_action : {}, _senders : [], _target : any, _ids? : any) : void;
|
||||
declare function et2_compileLegacyJS(_code : string, _widget : et2_widget, _context? : HTMLElement) : Function;
|
||||
// et2_core_xml.js
|
||||
declare function et2_loadXMLFromURL(_url : string, _callback : Function, _context? : object, _fail_callback? : Function) : void;
|
||||
declare function et2_directChildrenByTagName(_node, _tagName);
|
||||
declare function et2_filteredNodeIterator(_node, _callback, _context);
|
||||
declare function et2_readAttrWithDefault(_node, _name, _default?);
|
@ -354,4 +354,3 @@ var et2_description = /** @class */ (function (_super) {
|
||||
return et2_description;
|
||||
}(et2_core_baseWidget_1.et2_baseWidget));
|
||||
et2_core_widget_1.et2_register_widget(et2_description, ["description", "label"]);
|
||||
//# sourceMappingURL=et2_widget_description.js.map
|
File diff suppressed because it is too large
Load Diff
833
api/js/etemplate/et2_widget_dialog.ts
Normal file
833
api/js/etemplate/et2_widget_dialog.ts
Normal file
@ -0,0 +1,833 @@
|
||||
/**
|
||||
* EGroupware eTemplate2 - JS Dialog Widget class
|
||||
*
|
||||
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
|
||||
* @package etemplate
|
||||
* @link http://www.egroupware.org
|
||||
* @author Nathan Gray
|
||||
* @copyright Nathan Gray 2013
|
||||
* @version $Id$
|
||||
*/
|
||||
|
||||
/*egw:uses
|
||||
et2_core_widget;
|
||||
/vendor/bower-asset/jquery-ui/jquery-ui.js;
|
||||
*/
|
||||
|
||||
import {WidgetConfig} from "./et2_core_widget";
|
||||
import {et2_widget} from "./et2_core_widget";
|
||||
import {et2_button} from "./et2_widget_button";
|
||||
|
||||
/**
|
||||
* A common dialog widget that makes it easy to imform users or prompt for information.
|
||||
*
|
||||
* It is possible to have a custom dialog by using a template, but you can also use
|
||||
* the static method et2_dialog.show_dialog(). At its simplest, you can just use:
|
||||
* <code>
|
||||
* et2_dialog.show_dialog(false, "Operation completed");
|
||||
* </code>
|
||||
* Or a more complete example:
|
||||
* <code>
|
||||
* var callback = function (button_id)
|
||||
* {
|
||||
* if(button_id == et2_dialog.YES_BUTTON)
|
||||
* {
|
||||
* // Do stuff
|
||||
* }
|
||||
* else if (button_id == et2_dialog.NO_BUTTON)
|
||||
* {
|
||||
* // Other stuff
|
||||
* }
|
||||
* else if (button_id == et2_dialog.CANCEL_BUTTON)
|
||||
* {
|
||||
* // Abort
|
||||
* }
|
||||
* }.
|
||||
* var dialog = et2_dialog.show_dialog(
|
||||
* callback, "Erase the entire database?","Break things", {} // value
|
||||
* et2_dialog.BUTTONS_YES_NO_CANCEL, et2_dialog.WARNING_MESSAGE
|
||||
* );
|
||||
* </code>
|
||||
*
|
||||
*
|
||||
* The parameters for the above are all optional, except callback and message:
|
||||
* callback - function called when the dialog closes, or false/null.
|
||||
* The ID of the button will be passed. Button ID will be one of the et2_dialog.*_BUTTON constants.
|
||||
* The callback is _not_ called if the user closes the dialog with the X in the corner, or presses ESC.
|
||||
* message - (plain) text to display
|
||||
* title - Dialog title
|
||||
* value (for prompt)
|
||||
* buttons - et2_dialog BUTTONS_* constant, or an array of button settings
|
||||
* dialog_type - et2_dialog *_MESSAGE constant
|
||||
* icon - URL of icon
|
||||
*
|
||||
* Note that these methods will _not_ block program flow while waiting for user input.
|
||||
* The user's input will be provided to the callback.
|
||||
*
|
||||
* You can also use the standard et2_createWidget() to create a custom dialog using an etemplate, even setting all
|
||||
* the buttons yourself.
|
||||
* <code>
|
||||
* var dialog = et2_createWidget("dialog",{
|
||||
* // If you use a template, the second parameter will be the value of the template, as if it were submitted.
|
||||
* callback: function(button_id, value) {...}, // return false to prevent dialog closing
|
||||
* buttons: [
|
||||
* // These ones will use the callback, just like normal
|
||||
* {text: egw.lang("OK"),id:"OK", class="ui-priority-primary", default: true},
|
||||
* {text: egw.lang("Yes"),id:"Yes"},
|
||||
* {text: egw.lang("Sure"),id:"Sure"},
|
||||
* {text: egw.lang("Maybe"),click: function() {
|
||||
* // If you override, 'this' will be the dialog DOMNode.
|
||||
* // Things get more complicated.
|
||||
* // Do what you like, but don't forget this line:
|
||||
* jQuery(this).dialog("close")
|
||||
* }, class="ui-state-error"},
|
||||
*
|
||||
* ],
|
||||
* title: 'Why would you want to do this?',
|
||||
* template:"/egroupware/addressbook/templates/default/edit.xet",
|
||||
* value: { content: {...default values}, sel_options: {...}...}
|
||||
* });
|
||||
* </code>
|
||||
* @augments et2_widget
|
||||
* @see http://api.jqueryui.com/dialog/
|
||||
*/
|
||||
class et2_dialog extends et2_widget {
|
||||
static readonly _attributes: any = {
|
||||
callback: {
|
||||
name: "Callback",
|
||||
type: "js",
|
||||
description: "Callback function is called with the value when the dialog is closed",
|
||||
"default": function (button_id) {
|
||||
egw.debug("log", "Button ID: %d", button_id);
|
||||
}
|
||||
},
|
||||
beforeClose: {
|
||||
name: "before close callback",
|
||||
type: "js",
|
||||
description: "Callback function before dialog is closed, return false to prevent that",
|
||||
"default": function () {
|
||||
}
|
||||
},
|
||||
message: {
|
||||
name: "Message",
|
||||
type: "string",
|
||||
description: "Dialog message (plain text, no html)",
|
||||
"default": "Somebody forgot to set this..."
|
||||
},
|
||||
dialog_type: {
|
||||
name: "Dialog type",
|
||||
type: "integer",
|
||||
description: "To use a pre-defined dialog style, use et2_dialog.ERROR_MESSAGE, INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE,PLAIN_MESSAGE constants. Default is et2_dialog.PLAIN_MESSAGE",
|
||||
"default": 0 //this.PLAIN_MESSAGE
|
||||
},
|
||||
buttons: {
|
||||
name: "Buttons",
|
||||
type: "any",
|
||||
"default": 0, //this.BUTTONS_OK,
|
||||
description: "Buttons that appear at the bottom of the dialog. You can use the constants et2_dialog.BUTTONS_OK, BUTTONS_YES_NO, BUTTONS_YES_NO_CANCEL, BUTTONS_OK_CANCEL, or pass in an array for full control"
|
||||
},
|
||||
icon: {
|
||||
name: "Icon",
|
||||
type: "string",
|
||||
description: "URL of an icon for the dialog. If omitted, an icon based on dialog_type will be used.",
|
||||
"default": ""
|
||||
},
|
||||
title: {
|
||||
name: "Title",
|
||||
type: "string",
|
||||
description: "Title for the dialog box (plain text, no html)",
|
||||
"default": ""
|
||||
},
|
||||
modal: {
|
||||
name: "Modal",
|
||||
type: "boolean",
|
||||
description: "Prevent the user from interacting with the page",
|
||||
"default": true
|
||||
},
|
||||
resizable: {
|
||||
name: "Resizable",
|
||||
type: "boolean",
|
||||
description: "Allow the user to resize the dialog",
|
||||
"default": true
|
||||
},
|
||||
value: {
|
||||
"name": "Value",
|
||||
"description": "The (default) value of the dialog. Use with template.",
|
||||
"type": "any",
|
||||
"default": et2_no_init
|
||||
},
|
||||
template: {
|
||||
"name": "Template",
|
||||
"description": "Instead of displaying a simple message, a full template can be loaded instead. Set defaults with value.",
|
||||
"type": "string",
|
||||
"default": et2_no_init
|
||||
},
|
||||
minWidth: {
|
||||
name: "minimum width",
|
||||
type: "integer",
|
||||
description: "Define minimum width of dialog",
|
||||
"default": 0
|
||||
},
|
||||
minHeight: {
|
||||
name: "minimum height",
|
||||
type: "integer",
|
||||
description: "Define minimum height of dialog",
|
||||
"default": 0
|
||||
},
|
||||
width: {
|
||||
name: "width",
|
||||
type: "string",
|
||||
description: "Define width of dialog, the default is auto",
|
||||
"default": 'auto'
|
||||
},
|
||||
height: {
|
||||
name: "height",
|
||||
type: "string",
|
||||
description: "Define width of dialog, the default is auto",
|
||||
"default": 'auto'
|
||||
},
|
||||
position: {
|
||||
name: "position",
|
||||
type: "string",
|
||||
description: "Define position of dialog in the main window",
|
||||
default: "center"
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Details for dialog type options
|
||||
*/
|
||||
private readonly _dialog_types: any = [
|
||||
//PLAIN_MESSAGE: 0
|
||||
"",
|
||||
//INFORMATION_MESSAGE: 1,
|
||||
"dialog_info",
|
||||
//QUESTION_MESSAGE: 2,
|
||||
"dialog_help",
|
||||
//WARNING_MESSAGE: 3,
|
||||
"dialog_warning",
|
||||
//ERROR_MESSAGE: 4,
|
||||
"dialog_error"
|
||||
];
|
||||
|
||||
private readonly _buttons: any = [
|
||||
/*
|
||||
Pre-defined Button combos
|
||||
- button ids copied from et2_dialog static, since the constants are not defined yet
|
||||
- image get replaced by 'style="background-image: url('+egw.image(image)+')' for an image prefixing text
|
||||
*/
|
||||
//BUTTONS_OK: 0,
|
||||
[{"button_id": 1, "text": 'ok', id: 'dialog[ok]', image: 'check', "default": true}],
|
||||
//BUTTONS_OK_CANCEL: 1,
|
||||
[
|
||||
{"button_id": 1, "text": 'ok', id: 'dialog[ok]', image: 'check', "default": true},
|
||||
{"button_id": 0, "text": 'cancel', id: 'dialog[cancel]', image: 'cancel'}
|
||||
],
|
||||
//BUTTONS_YES_NO: 2,
|
||||
[
|
||||
{"button_id": 2, "text": 'yes', id: 'dialog[yes]', image: 'check', "default": true},
|
||||
{"button_id": 3, "text": 'no', id: 'dialog[no]', image: 'cancelled'}
|
||||
],
|
||||
//BUTTONS_YES_NO_CANCEL: 3,
|
||||
[
|
||||
{"button_id": 2, "text": 'yes', id: 'dialog[yes]', image: 'check', "default": true},
|
||||
{"button_id": 3, "text": 'no', id: 'dialog[no]', image: 'cancelled'},
|
||||
{"button_id": 0, "text": 'cancel', id: 'dialog[cancel]', image: 'cancel'}
|
||||
]
|
||||
];
|
||||
|
||||
/**
|
||||
* Types
|
||||
* @constant
|
||||
*/
|
||||
readonly PLAIN_MESSAGE: number = 0;
|
||||
readonly INFORMATION_MESSAGE: number = 1;
|
||||
readonly QUESTION_MESSAGE: number = 2;
|
||||
readonly WARNING_MESSAGE: number = 3;
|
||||
readonly ERROR_MESSAGE: number = 4;
|
||||
|
||||
/* Pre-defined Button combos */
|
||||
readonly BUTTONS_OK: number = 0;
|
||||
readonly BUTTONS_OK_CANCEL: number = 1;
|
||||
readonly BUTTONS_YES_NO: number = 2;
|
||||
readonly BUTTONS_YES_NO_CANCEL: number = 3;
|
||||
|
||||
/* Button constants */
|
||||
readonly CANCEL_BUTTON: number = 0;
|
||||
readonly OK_BUTTON: number = 1;
|
||||
readonly YES_BUTTON: number = 2;
|
||||
readonly NO_BUTTON: number = 3;
|
||||
|
||||
div: JQuery = null;
|
||||
template: any = null;
|
||||
|
||||
constructor(_parent?, _attrs?: WidgetConfig, _child?: object) {
|
||||
super();
|
||||
|
||||
// Define this as null to avoid breaking any hierarchies (eg: destroy())
|
||||
this._parent = null;
|
||||
|
||||
// Button callbacks need a reference to this
|
||||
let self = this;
|
||||
for (let i = 0; i < this._buttons.length; i++) {
|
||||
for (let j = 0; j < this._buttons[i].length; j++) {
|
||||
this._buttons[i][j].click = (function (id) {
|
||||
return function (event) {
|
||||
self.click(event.target, id);
|
||||
};
|
||||
})(this._buttons[i][j].button_id);
|
||||
// translate button texts, as translations are not available before
|
||||
this._buttons[i][j].text = egw.lang(this._buttons[i][j].text);
|
||||
}
|
||||
}
|
||||
|
||||
this.div = jQuery(document.createElement("div"));
|
||||
|
||||
this._createDialog();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up dialog
|
||||
*/
|
||||
destroy() {
|
||||
if (this.div != null) {
|
||||
// Un-dialog the dialog
|
||||
this.div.dialog("destroy");
|
||||
|
||||
if (this.template) {
|
||||
this.template.clear();
|
||||
this.template = null;
|
||||
}
|
||||
|
||||
this.div = null;
|
||||
}
|
||||
|
||||
// Call the inherited constructor
|
||||
super.destroy();
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal callback registered on all standard buttons.
|
||||
* The provided callback is called after the dialog is closed.
|
||||
*
|
||||
* @param target DOMNode The clicked button
|
||||
* @param button_id integer The ID of the clicked button
|
||||
*/
|
||||
click(target: HTMLElement, button_id: number) {
|
||||
if (this.options.callback) {
|
||||
if (this.options.callback.call(this, button_id, this.get_value()) === false) return;
|
||||
}
|
||||
// Triggers destroy too
|
||||
this.div.dialog("close");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the values of any widgets in the dialog. This does not include
|
||||
* the buttons, which are only supplied for the callback.
|
||||
*/
|
||||
get_value() {
|
||||
var value = this.options.value;
|
||||
if (this.template) {
|
||||
value = this.template.getValues(this.template.widgetContainer);
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the displayed prompt message
|
||||
*
|
||||
* @param {string} message New message for the dialog
|
||||
*/
|
||||
set_message(message) {
|
||||
this.options.message = message;
|
||||
|
||||
this.div.empty()
|
||||
.append("<img class='dialog_icon' />")
|
||||
.append(jQuery('<div/>').text(message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the dialog type to a pre-defined type
|
||||
*
|
||||
* @param {integer} type constant from et2_dialog
|
||||
*/
|
||||
set_dialog_type(type) {
|
||||
if (this.options.dialog_type != type && typeof this._dialog_types[type] == "string") {
|
||||
this.options.dialog_type = type;
|
||||
}
|
||||
this.set_icon(this._dialog_types[type] ? egw.image(this._dialog_types[type]) : "");
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the icon for the dialog
|
||||
*
|
||||
* @param {string} icon_url
|
||||
*/
|
||||
set_icon(icon_url) {
|
||||
if (icon_url == "") {
|
||||
jQuery("img.dialog_icon", this.div).hide();
|
||||
} else {
|
||||
jQuery("img.dialog_icon", this.div).show().attr("src", icon_url);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the dialog buttons
|
||||
*
|
||||
* Use either the pre-defined options in et2_dialog, or an array
|
||||
* @see http://api.jqueryui.com/dialog/#option-buttons
|
||||
* @param {array} buttons
|
||||
*/
|
||||
set_buttons(buttons) {
|
||||
this.options.buttons = buttons;
|
||||
if (buttons instanceof Array) {
|
||||
for (var i = 0; i < buttons.length; i++) {
|
||||
var button = buttons[i];
|
||||
if (!button.click) {
|
||||
button.click = jQuery.proxy(this.click, this, null, button.id);
|
||||
}
|
||||
// set a default background image and css class based on buttons id
|
||||
if (button.id && typeof button.class == 'undefined') {
|
||||
for (var name in et2_button.default_classes) {
|
||||
if (button.id.match(et2_button.default_classes[name])) {
|
||||
button.class = (typeof button.class == 'undefined' ? '' : button.class + ' ') + name;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (button.id && typeof button.image == 'undefined' && typeof button.style == 'undefined') {
|
||||
for (var name in et2_button.default_background_images) {
|
||||
if (button.id.match(et2_button.default_background_images[name])) {
|
||||
button.image = name;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (button.image) {
|
||||
button.style = 'background-image: url(' + this.egw().image(button.image, 'api') + ')';
|
||||
delete button.image;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If dialog already created, update buttons
|
||||
if (this.div.data('ui-dialog')) {
|
||||
this.div.dialog("option", "buttons", buttons);
|
||||
|
||||
// Focus default button so enter works
|
||||
jQuery('.ui-dialog-buttonpane button[default]', this.div.parent()).focus();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the dialog title
|
||||
*
|
||||
* @param {string} title New title for the dialog
|
||||
*/
|
||||
set_title(title) {
|
||||
this.options.title = title;
|
||||
this.div.dialog("option", "title", title);
|
||||
}
|
||||
|
||||
/**
|
||||
* Block interaction with the page behind the dialog
|
||||
*
|
||||
* @param {boolean} modal Block page behind dialog
|
||||
*/
|
||||
set_modal(modal) {
|
||||
this.options.modal = modal;
|
||||
this.div.dialog("option", "modal", modal);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an etemplate into the dialog
|
||||
*
|
||||
* @param template String etemplate file name
|
||||
*/
|
||||
set_template(template) {
|
||||
if (this.template && this.options.template != template) {
|
||||
this.template.clear();
|
||||
}
|
||||
|
||||
this.template = new etemplate2(this.div[0], false);
|
||||
if (template.indexOf('.xet') > 0) {
|
||||
// File name provided, fetch from server
|
||||
this.template.load("", template, this.options.value || {content: {}}, jQuery.proxy(function () {
|
||||
// Set focus to the first input
|
||||
jQuery('input', this.div).first().focus();
|
||||
}, this));
|
||||
} else {
|
||||
// Just template name, it better be loaded already
|
||||
this.template.load(template, '', this.options.value || {},
|
||||
// true: do NOT call et2_ready, as it would overwrite this.et2 in app.js
|
||||
undefined, undefined, true);
|
||||
}
|
||||
// set template-name as id, to allow to style dialogs
|
||||
this.div.children().attr('id', template.replace(/^(.*\/)?([^/]+)(\.xet)?$/, '$2').replace(/\./g, '-'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Actually create and display the dialog
|
||||
*/
|
||||
_createDialog() {
|
||||
if (this.options.template) {
|
||||
this.set_template(this.options.template);
|
||||
} else {
|
||||
this.set_message(this.options.message);
|
||||
this.set_dialog_type(this.options.dialog_type);
|
||||
}
|
||||
this.set_buttons(typeof this.options.buttons == "number" ? this._buttons[this.options.buttons] : this.options.buttons);
|
||||
var self = this;
|
||||
|
||||
var options = {
|
||||
// Pass the internal object, not the option
|
||||
buttons: this.options.buttons,
|
||||
modal: this.options.modal,
|
||||
resizable: this.options.resizable,
|
||||
minWidth: this.options.minWidth,
|
||||
minHeight: this.options.minHeight,
|
||||
maxWidth: 640,
|
||||
height: this.options.height,
|
||||
title: this.options.title,
|
||||
open: function () {
|
||||
// Focus default button so enter works
|
||||
jQuery(this).parents('.ui-dialog-buttonpane button[default]').focus();
|
||||
window.setTimeout(function () {
|
||||
jQuery(this).dialog('option', 'position', {
|
||||
my: "center",
|
||||
at: "center",
|
||||
of: window
|
||||
});
|
||||
}.bind(this), 0);
|
||||
},
|
||||
close: jQuery.proxy(function () {
|
||||
this.destroy();
|
||||
}, this),
|
||||
beforeClose: this.options.beforeClose,
|
||||
closeText: this.egw().lang('close'),
|
||||
position: {my: this.options.position, at: this.options.position, of: window}
|
||||
};
|
||||
// Leaving width unset lets it size itself according to contents
|
||||
if (this.options.width) {
|
||||
options.width = this.options.width;
|
||||
}
|
||||
|
||||
this.div.dialog(options);
|
||||
|
||||
// Make sure dialog is wide enough for the title
|
||||
// Arbitrary numbers that seem to work nicely.
|
||||
let title_width = 20 + 10 * this.options.title.length;
|
||||
if (this.div.width() < title_width && this.options.title.trim()) {
|
||||
// Auto-sizing chopped the title
|
||||
this.div.dialog('option', 'width', title_width);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a parent to inject application specific egw object with loaded translations into et2_dialog
|
||||
*
|
||||
* @param {string|egw} _egw_or_appname egw object with already laoded translations or application name to load translations for
|
||||
*/
|
||||
static _create_parent(_egw_or_appname) {
|
||||
if (typeof _egw_or_appname == 'undefined') {
|
||||
_egw_or_appname = egw_appName;
|
||||
}
|
||||
// create a dummy parent with a correct reference to an application specific egw object
|
||||
var parent = new et2_widget();
|
||||
// if egw object is passed in because called from et2, just use it
|
||||
if (typeof _egw_or_appname != 'string') {
|
||||
parent._egw = _egw_or_appname;
|
||||
}
|
||||
// otherwise use given appname to create app-specific egw instance and load default translations
|
||||
else {
|
||||
parent._egw = egw(_egw_or_appname);
|
||||
parent._egw.langRequireApp(parent._egw.window, _egw_or_appname);
|
||||
}
|
||||
return parent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a confirmation dialog
|
||||
*
|
||||
* @param {function} _callback Function called when the user clicks a button. The context will be the et2_dialog widget, and the button constant is passed in.
|
||||
* @param {string} _message Message to be place in the dialog.
|
||||
* @param {string} _title Text in the top bar of the dialog.
|
||||
* @param _value passed unchanged to callback as 2. parameter
|
||||
* @param {integer|array} _buttons One of the BUTTONS_ constants defining the set of buttons at the bottom of the box
|
||||
* @param {integer} _type One of the message constants. This defines the style of the message.
|
||||
* @param {string} _icon URL of an icon to display. If not provided, a type-specific icon will be used.
|
||||
* @param {string|egw} _egw_or_appname egw object with already laoded translations or application name to load translations for
|
||||
*/
|
||||
static show_dialog(_callback, _message, _title, _value, _buttons, _type, _icon, _egw_or_appname) {
|
||||
var parent = et2_dialog._create_parent(_egw_or_appname);
|
||||
|
||||
// Just pass them along, widget handles defaults & missing
|
||||
return et2_createWidget("dialog", {
|
||||
callback: _callback || function () {
|
||||
},
|
||||
message: _message,
|
||||
title: _title || parent._egw.lang('Confirmation required'),
|
||||
buttons: typeof _buttons != 'undefined' ? _buttons : et2_dialog.BUTTONS_YES_NO,
|
||||
dialog_type: typeof _type != 'undefined' ? _type : et2_dialog.QUESTION_MESSAGE,
|
||||
icon: _icon,
|
||||
value: _value,
|
||||
width: 'auto'
|
||||
}, parent);
|
||||
};
|
||||
|
||||
/**
|
||||
* Show an alert message with OK button
|
||||
*
|
||||
* @param {string} _message Message to be place in the dialog.
|
||||
* @param {string} _title Text in the top bar of the dialog.
|
||||
* @param {integer} _type One of the message constants. This defines the style of the message.
|
||||
*/
|
||||
static alert(_message, _title, _type) {
|
||||
var parent = et2_dialog._create_parent(et2_dialog._create_parent()._egw);
|
||||
et2_createWidget("dialog", {
|
||||
callback: function () {
|
||||
},
|
||||
message: _message,
|
||||
title: _title,
|
||||
buttons: et2_dialog.BUTTONS_OK,
|
||||
dialog_type: _type || et2_dialog.INFORMATION_MESSAGE
|
||||
}, parent);
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a prompt dialog
|
||||
*
|
||||
* @param {function} _callback Function called when the user clicks a button. The context will be the et2_dialog widget, and the button constant is passed in.
|
||||
* @param {string} _message Message to be place in the dialog.
|
||||
* @param {string} _title Text in the top bar of the dialog.
|
||||
* @param {string} _value for prompt, passed to callback as 2. parameter
|
||||
* @param {integer|array} _buttons One of the BUTTONS_ constants defining the set of buttons at the bottom of the box
|
||||
* @param {string|egw} _egw_or_appname egw object with already laoded translations or application name to load translations for
|
||||
*/
|
||||
static show_prompt(_callback, _message, _title, _value, _buttons, _egw_or_appname) {
|
||||
var callback = _callback;
|
||||
// Just pass them along, widget handles defaults & missing
|
||||
return et2_createWidget("dialog", {
|
||||
callback: function (_button_id, _value) {
|
||||
if (typeof callback == "function") {
|
||||
callback.call(this, _button_id, _value.value);
|
||||
}
|
||||
},
|
||||
title: _title || egw.lang('Input required'),
|
||||
buttons: _buttons || et2_dialog.BUTTONS_OK_CANCEL,
|
||||
value: {
|
||||
content: {
|
||||
value: _value,
|
||||
message: _message
|
||||
}
|
||||
},
|
||||
template: egw.webserverUrl + '/api/templates/default/prompt.xet',
|
||||
class: "et2_prompt"
|
||||
}, et2_dialog._create_parent(_egw_or_appname));
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to build a confirmation dialog only with
|
||||
* YES OR NO buttons and submit content back to server
|
||||
*
|
||||
* @param {widget} _senders widget that has been clicked
|
||||
* @param {String} _dialogMsg message shows in dialog box
|
||||
* @param {String} _titleMsg message shows as a title of the dialog box
|
||||
* @param {Bool} _postSubmit true: use postSubmit instead of submit
|
||||
*
|
||||
* @description submit the form contents including the button that has been pressed
|
||||
*/
|
||||
static confirm(_senders, _dialogMsg, _titleMsg, _postSubmit) {
|
||||
var senders = _senders;
|
||||
var buttonId = _senders.id;
|
||||
var dialogMsg = (typeof _dialogMsg != "undefined") ? _dialogMsg : '';
|
||||
var titleMsg = (typeof _titleMsg != "undefined") ? _titleMsg : '';
|
||||
var egw = _senders instanceof et2_widget ? _senders.egw() : et2_dialog._create_parent()._egw;
|
||||
var callbackDialog = function (button_id) {
|
||||
if (button_id == et2_dialog.YES_BUTTON) {
|
||||
if (_postSubmit) {
|
||||
senders.getRoot().getInstanceManager().postSubmit(buttonId);
|
||||
} else {
|
||||
senders.getRoot().getInstanceManager().submit(buttonId);
|
||||
}
|
||||
}
|
||||
};
|
||||
et2_dialog.show_dialog(callbackDialog, egw.lang(dialogMsg), egw.lang(titleMsg), {},
|
||||
et2_dialog.BUTTON_YES_NO, et2_dialog.WARNING_MESSAGE, undefined, egw);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Show a dialog for a long-running, multi-part task
|
||||
*
|
||||
* Given a server url and a list of parameters, this will open a dialog with
|
||||
* a progress bar, asynchronously call the url with each parameter, and update
|
||||
* the progress bar.
|
||||
* Any output from the server will be displayed in a box.
|
||||
*
|
||||
* When all tasks are done, the callback will be called with boolean true. It will
|
||||
* also be called if the user clicks a button (OK or CANCEL), so be sure to
|
||||
* check to avoid executing more than intended.
|
||||
*
|
||||
* @param {function} _callback Function called when the user clicks a button,
|
||||
* or when the list is done processing. The context will be the et2_dialog
|
||||
* widget, and the button constant is passed in.
|
||||
* @param {string} _message Message to be place in the dialog. Usually just
|
||||
* text, but DOM nodes will work too.
|
||||
* @param {string} _title Text in the top bar of the dialog.
|
||||
* @param {string} _menuaction the menuaction function which should be called and
|
||||
* which handles the actual request. If the menuaction is a full featured
|
||||
* url, this one will be used instead.
|
||||
* @param {Array[]} _list - List of parameters, one for each call to the
|
||||
* address. Multiple parameters are allowed, in an array.
|
||||
* @param {string|egw} _egw_or_appname egw object with already laoded translations or application name to load translations for
|
||||
*
|
||||
* @return {et2_dialog}
|
||||
*/
|
||||
static long_task(_callback, _message, _title, _menuaction, _list, _egw_or_appname) {
|
||||
var parent = et2_dialog._create_parent(_egw_or_appname);
|
||||
var egw = parent._egw;
|
||||
|
||||
// Special action for cancel
|
||||
var buttons = [
|
||||
{"button_id": et2_dialog.OK_BUTTON, "text": egw.lang('ok'), "default": true, "disabled": true},
|
||||
{
|
||||
"button_id": et2_dialog.CANCEL_BUTTON, "text": egw.lang('cancel'), click: function () {
|
||||
// Cancel run
|
||||
cancel = true;
|
||||
jQuery("button[button_id=" + et2_dialog.CANCEL_BUTTON + "]", dialog.div.parent()).button("disable");
|
||||
update.call(_list.length, '');
|
||||
}
|
||||
}
|
||||
];
|
||||
var dialog = et2_createWidget("dialog", {
|
||||
template: egw.webserverUrl + '/api/templates/default/long_task.xet',
|
||||
value: {
|
||||
content: {
|
||||
message: _message
|
||||
}
|
||||
},
|
||||
callback: function (_button_id, _value) {
|
||||
if (_button_id == et2_dialog.CANCEL_BUTTON) {
|
||||
cancel = true;
|
||||
}
|
||||
if (typeof _callback == "function") {
|
||||
_callback.call(this, _button_id, _value.value);
|
||||
}
|
||||
},
|
||||
title: _title || egw.lang('please wait...'),
|
||||
buttons: buttons
|
||||
}, parent);
|
||||
|
||||
// OK starts disabled
|
||||
jQuery("button[button_id=" + et2_dialog.OK_BUTTON + "]", dialog.div.parent()).button("disable");
|
||||
|
||||
var log = null;
|
||||
var progressbar = null;
|
||||
var cancel = false;
|
||||
var totals = {
|
||||
success: 0,
|
||||
skipped: 0,
|
||||
failed: 0,
|
||||
widget: null
|
||||
};
|
||||
|
||||
// Updates progressbar & log, calls next step
|
||||
var update = function (response) {
|
||||
// context is index
|
||||
var index = this || 0;
|
||||
|
||||
progressbar.set_value(100 * (index / _list.length));
|
||||
progressbar.set_label(index + ' / ' + _list.length);
|
||||
|
||||
// Display response information
|
||||
switch (response.type) {
|
||||
case 'error':
|
||||
jQuery("<div class='message error'></div>")
|
||||
.text(response.data)
|
||||
.appendTo(log);
|
||||
|
||||
totals.failed++;
|
||||
|
||||
// Ask to retry / ignore / abort
|
||||
et2_createWidget("dialog", {
|
||||
callback: function (button) {
|
||||
switch (button) {
|
||||
case 'dialog[cancel]':
|
||||
cancel = true;
|
||||
return update.call(index, '');
|
||||
case 'dialog[skip]':
|
||||
// Continue with next index
|
||||
totals.skipped++;
|
||||
return update.call(index, '');
|
||||
default:
|
||||
// Try again with previous index
|
||||
return update.call(index - 1, '');
|
||||
}
|
||||
|
||||
},
|
||||
message: response.data,
|
||||
title: '',
|
||||
buttons: [
|
||||
// These ones will use the callback, just like normal
|
||||
{text: egw.lang("Abort"), id: 'dialog[cancel]'},
|
||||
{text: egw.lang("Retry"), id: 'dialog[retry]'},
|
||||
{text: egw.lang("Skip"), id: 'dialog[skip]', class: "ui-priority-primary", default: true}
|
||||
],
|
||||
dialog_type: et2_dialog.ERROR_MESSAGE
|
||||
}, parent);
|
||||
// Early exit
|
||||
return;
|
||||
default:
|
||||
if (response) {
|
||||
totals.success++;
|
||||
jQuery("<div class='message'></div>")
|
||||
.text(response)
|
||||
.appendTo(log);
|
||||
}
|
||||
}
|
||||
// Scroll to bottom
|
||||
var height = log[0].scrollHeight;
|
||||
log.scrollTop(height);
|
||||
|
||||
// Update totals
|
||||
totals.widget.set_value(egw.lang(
|
||||
"Total: %1 Successful: %2 Failed: %3 Skipped: %4",
|
||||
_list.length, totals.success, totals.failed, totals.skipped
|
||||
));
|
||||
|
||||
// Fire next step
|
||||
if (!cancel && index < _list.length) {
|
||||
var parameters = _list[index];
|
||||
if (typeof parameters != 'object') parameters = [parameters];
|
||||
|
||||
// Async request, we'll take the next step in the callback
|
||||
// We can't pass index = 0, it looks like false and causes issues
|
||||
egw.json(_menuaction, parameters, update, index + 1, true, index + 1).sendRequest();
|
||||
} else {
|
||||
// All done
|
||||
if (!cancel) progressbar.set_value(100);
|
||||
jQuery("button[button_id=" + et2_dialog.CANCEL_BUTTON + "]", dialog.div.parent()).button("disable");
|
||||
jQuery("button[button_id=" + et2_dialog.OK_BUTTON + "]", dialog.div.parent()).button("enable");
|
||||
if (!cancel && typeof _callback == "function") {
|
||||
_callback.call(dialog, true, response);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
jQuery(dialog.template.DOMContainer).on('load', function () {
|
||||
// Get access to template widgets
|
||||
log = jQuery(dialog.template.widgetContainer.getWidgetById('log').getDOMNode());
|
||||
progressbar = dialog.template.widgetContainer.getWidgetById('progressbar');
|
||||
progressbar.set_label('0 / ' + _list.length);
|
||||
totals.widget = dialog.template.widgetContainer.getWidgetById('totals');
|
||||
|
||||
// Start
|
||||
window.setTimeout(function () {
|
||||
update.call(0, '');
|
||||
}, 0);
|
||||
});
|
||||
|
||||
return dialog;
|
||||
}
|
||||
}
|
File diff suppressed because it is too large
Load Diff
584
api/js/etemplate/et2_widget_tabs.ts
Normal file
584
api/js/etemplate/et2_widget_tabs.ts
Normal file
@ -0,0 +1,584 @@
|
||||
/**
|
||||
* EGroupware eTemplate2 - JS Tabs object
|
||||
*
|
||||
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
|
||||
* @package etemplate
|
||||
* @subpackage api
|
||||
* @link http://www.egroupware.org
|
||||
* @author Andreas Stöckel
|
||||
*/
|
||||
|
||||
/*egw:uses
|
||||
jsapi.egw;
|
||||
/vendor/bower-asset/jquery/dist/jquery.js;
|
||||
et2_core_valueWidget;
|
||||
*/
|
||||
|
||||
import './et2_core_common';
|
||||
import { ClassWithAttributes } from "./et2_core_inheritance";
|
||||
import { et2_widget, et2_createWidget, et2_register_widget, WidgetConfig } from "./et2_core_widget";
|
||||
import { et2_DOMWidget } from './et2_core_DOMWidget'
|
||||
import { et2_valueWidget } from './et2_core_valueWidget'
|
||||
import './et2_types';
|
||||
|
||||
/**
|
||||
* Class which implements the tabbox-tag
|
||||
*/
|
||||
class et2_tabbox extends et2_valueWidget implements et2_IInput,et2_IResizeable,et2_IPrint
|
||||
{
|
||||
static readonly _attributes : any = {
|
||||
'tabs': {
|
||||
'name': 'Tabs',
|
||||
'default': et2_no_init,
|
||||
'description': "Array of [extra] tabs. Each tab needs {label:..., template:...}. Additional optional keys are prepend, hidden and id, for access into content array"
|
||||
},
|
||||
'add_tabs': {
|
||||
'name': 'Add tabs',
|
||||
'default': false,
|
||||
'description': 'Set to true if tabs should be added to tabs from read from template, default false if not'
|
||||
},
|
||||
'tab_height': {
|
||||
name: 'Tabs innerHeight',
|
||||
default: '',
|
||||
description: 'Set the innerHeight for the tab content'
|
||||
},
|
||||
'align_tabs': {
|
||||
name: 'Tabs alignment',
|
||||
type: 'string',
|
||||
default: 'h',
|
||||
description: 'Set tabs and their headers arrangment either horizental (h) or vertical (v). Default value is horizental.'
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Currently selected tab
|
||||
*/
|
||||
selected_index: number|boolean = 0;
|
||||
tabData: any[] = [];
|
||||
container: JQuery;
|
||||
flagContainer: JQuery;
|
||||
tabContainer: JQuery;
|
||||
tab_height: number;
|
||||
value: number | boolean;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
constructor(_parent, _attrs? : WidgetConfig, _child? : object)
|
||||
{
|
||||
// Call the inherited constructor
|
||||
super(_parent, _attrs, ClassWithAttributes.extendAttributes(et2_DOMWidget._attributes, _child || {}));
|
||||
|
||||
// Create the outer tabbox container
|
||||
this.container = jQuery(document.createElement("div"))
|
||||
.addClass("et2_tabbox");
|
||||
|
||||
// Create the upper container for the tab flags
|
||||
this.flagContainer = jQuery(document.createElement("div"))
|
||||
.addClass("et2_tabheader")
|
||||
.appendTo(this.container);
|
||||
|
||||
// Create the lower tab container
|
||||
this.tabContainer = jQuery(document.createElement("div"))
|
||||
.addClass("et2_tabs")
|
||||
.appendTo(this.container);
|
||||
}
|
||||
|
||||
destroy()
|
||||
{
|
||||
super.destroy();
|
||||
|
||||
this.container = null;
|
||||
this.flagContainer = null;
|
||||
this.tabData = [];
|
||||
}
|
||||
|
||||
_readTabs(tabData, tabs)
|
||||
{
|
||||
var selected = "";
|
||||
this.selected_index = false;
|
||||
var hidden = {};
|
||||
if (this.id)
|
||||
{
|
||||
// Set the value for this element
|
||||
var contentMgr = this.getArrayMgr("content");
|
||||
if (contentMgr != null) {
|
||||
var val = contentMgr.getEntry(this.id);
|
||||
if (val !== null)
|
||||
{
|
||||
selected = val;
|
||||
}
|
||||
}
|
||||
contentMgr = this.getArrayMgr("readonlys");
|
||||
if (contentMgr != null) {
|
||||
var val = contentMgr.getEntry(this.id);
|
||||
if (val !== null && typeof val !== 'undefined')
|
||||
{
|
||||
hidden = val;
|
||||
}
|
||||
}
|
||||
}
|
||||
var i = 0;
|
||||
et2_filteredNodeIterator(tabs, function(node, nodeName) {
|
||||
if (nodeName == "tab")
|
||||
{
|
||||
var index_name = et2_readAttrWithDefault(node, "id");
|
||||
var hide = false;
|
||||
var widget_options = {};
|
||||
if(index_name) {
|
||||
if(selected == index_name) this.selected_index = i;
|
||||
if(hidden[index_name]) {
|
||||
hide = true;
|
||||
}
|
||||
// Get the class attribute and add it as widget_options
|
||||
var classAttr = et2_readAttrWithDefault(node,"class");
|
||||
if (classAttr)
|
||||
{
|
||||
widget_options = {'class':classAttr};
|
||||
}
|
||||
}
|
||||
tabData.push({
|
||||
"id": index_name,
|
||||
"label": this.egw().lang(et2_readAttrWithDefault(node, "label", "Tab")),
|
||||
"widget": null,
|
||||
"widget_options": widget_options,
|
||||
"contentDiv": null,
|
||||
"flagDiv": null,
|
||||
"hidden": hide,
|
||||
"XMLNode": null,
|
||||
"promise": null
|
||||
});
|
||||
}
|
||||
else
|
||||
{
|
||||
throw("Error while parsing: Invalid tag '" + nodeName +
|
||||
"' in tabs tag");
|
||||
}
|
||||
i++;
|
||||
}, this);
|
||||
|
||||
// Make sure we don't try to display a hidden tab
|
||||
for(var i = 0; i < tabData.length && this.selected_index === false; i++)
|
||||
{
|
||||
if(!tabData[i].hidden) this.selected_index = i;
|
||||
}
|
||||
}
|
||||
|
||||
_readTabPanels(tabData, tabpanels)
|
||||
{
|
||||
var i = 0;
|
||||
et2_filteredNodeIterator(tabpanels, function(node, nodeName) {
|
||||
if (i < tabData.length)
|
||||
{
|
||||
// Store node for later evaluation
|
||||
tabData[i].XMLNode = node;
|
||||
}
|
||||
else
|
||||
{
|
||||
throw("Error while reading tabpanels tag, too many widgets!");
|
||||
}
|
||||
i++;
|
||||
}, this);
|
||||
}
|
||||
|
||||
loadFromXML(_node)
|
||||
{
|
||||
// Get the tabs and tabpanels tags
|
||||
var tabsElems = et2_directChildrenByTagName(_node, "tabs");
|
||||
var tabpanelsElems = et2_directChildrenByTagName(_node, "tabpanels");
|
||||
var tabData = [];
|
||||
|
||||
// Check for a parent height, we'll apply it to tab panels
|
||||
var height = et2_readAttrWithDefault(_node.parentNode, "height",null);
|
||||
if(height)
|
||||
{
|
||||
this.tabContainer.css("height", height);
|
||||
}
|
||||
|
||||
// if no tabs set or they should be added to tabs from xml
|
||||
if (!this.options.tabs || this.options.add_tabs)
|
||||
{
|
||||
if (tabsElems.length == 1 && tabpanelsElems.length == 1)
|
||||
{
|
||||
var tabs = tabsElems[0];
|
||||
var tabpanels = tabpanelsElems[0];
|
||||
|
||||
// Parse the "tabs" tag
|
||||
this._readTabs(tabData, tabs);
|
||||
|
||||
// Read and create the widgets defined in the "tabpanels"
|
||||
this._readTabPanels(tabData, tabpanels);
|
||||
}
|
||||
else
|
||||
{
|
||||
this.egw().debug("error","Error while parsing tabbox, none or multiple tabs or tabpanels tags!",this);
|
||||
}
|
||||
}
|
||||
if (this.options.tabs)
|
||||
{
|
||||
var readonly = this.getArrayMgr("readonlys").getEntry(this.id) || {};
|
||||
for(var i = 0; i < this.options.tabs.length; i++)
|
||||
{
|
||||
var tab = this.options.tabs[i];
|
||||
var tab_id = tab.id || tab.template;
|
||||
var tab_options = {id: tab_id, template:tab.template, url: tab.url, content: undefined};
|
||||
if(tab.id)
|
||||
{
|
||||
tab_options.content = tab.id;
|
||||
}
|
||||
tabData[tab.prepend ? 'unshift' : 'push'].call(tabData, {
|
||||
"id": tab_id,
|
||||
"label": this.egw().lang(tab.label),
|
||||
"widget": null,
|
||||
"widget_options": tab_options,
|
||||
"contentDiv": null,
|
||||
"flagDiv": null,
|
||||
"hidden": typeof tab.hidden != "undefined" ? tab.hidden : readonly[tab_id] || false,
|
||||
"XMLNode": null,
|
||||
"promise": null
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// Create the tab DOM-Nodes
|
||||
this.createTabs(tabData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load is finished, set up tabs to load on their own
|
||||
*/
|
||||
doLoadingFinished()
|
||||
{
|
||||
var tab_deferred = jQuery.Deferred();
|
||||
var promises = [];
|
||||
var tabs = this;
|
||||
|
||||
// Specially process the selected index so it shows up right away
|
||||
this._loadTab(this.selected_index,promises);
|
||||
|
||||
// Apply parent now, which actually puts into the DOM
|
||||
// This has to be before loading the child, so the dom sub-tree is not
|
||||
// disconnected, which causes problems for things like CKEditor
|
||||
super.doLoadingFinished();
|
||||
|
||||
// We can do this and not wind up with 2 because child is a template,
|
||||
// which has special handling
|
||||
this._children[0].loadingFinished(promises);
|
||||
|
||||
// Defer parsing & loading of other tabs until later
|
||||
window.setTimeout(function() {
|
||||
for (var i = 0; i < tabs.tabData.length; i++)
|
||||
{
|
||||
if (i == tabs.selected_index) continue;
|
||||
tabs._loadTab(i,promises);
|
||||
}
|
||||
jQuery.when.apply(jQuery,promises).then(function() {
|
||||
tab_deferred.resolve();
|
||||
});
|
||||
},0);
|
||||
|
||||
return tab_deferred.promise();
|
||||
}
|
||||
|
||||
/**
|
||||
* Load & render a tab's content
|
||||
*
|
||||
* @param {number} index numerical index of tab in this.tabData array
|
||||
* @param {array} promises
|
||||
*/
|
||||
_loadTab(index,promises)
|
||||
{
|
||||
var tabData = this.tabData[index];
|
||||
if(!tabData || tabData.loaded) return;
|
||||
if(tabData.XMLNode != null)
|
||||
{
|
||||
if(tabData.hidden)
|
||||
{
|
||||
// Set hidden tab to readonly, so widgets aren't active
|
||||
// Do not modify the XMLNode, or the change will be cached for all
|
||||
tabData.XMLNode = tabData.XMLNode.cloneNode();
|
||||
tabData.XMLNode.setAttribute('readonly', true);
|
||||
}
|
||||
tabData.widget = this.createElementFromNode(tabData.XMLNode,
|
||||
tabData.XMLNode.nodeName.toLowerCase());
|
||||
|
||||
// Release the XML node
|
||||
tabData.XMLNode = null;
|
||||
}
|
||||
else if (tabData.widget_options)
|
||||
{
|
||||
tabData.widget = et2_createWidget('template',tabData.widget_options,this);
|
||||
}
|
||||
|
||||
// Set loaded flag to not do this again, even if not fully done
|
||||
tabData.loaded = true;
|
||||
|
||||
// loadingFinished() will be called either when the promise from doLoadingFinished is resolved,
|
||||
// or during the normal execution
|
||||
}
|
||||
|
||||
/**
|
||||
* Check for custom tabs
|
||||
*
|
||||
* @param {object} _attrs
|
||||
*/
|
||||
transformAttributes(_attrs)
|
||||
{
|
||||
super.transformAttributes(_attrs);
|
||||
|
||||
// Add in settings that are objects
|
||||
var data = this.getArrayMgr("modifications").getEntry(this.id);
|
||||
for(var key in data)
|
||||
{
|
||||
if(typeof data[key] === 'object' && ! _attrs[key]) _attrs[key] = data[key];
|
||||
}
|
||||
}
|
||||
|
||||
createTabs(tabData)
|
||||
{
|
||||
this.tabData = tabData;
|
||||
|
||||
this.tabContainer.empty();
|
||||
this.flagContainer.empty();
|
||||
|
||||
for (var i = 0; i < this.tabData.length; i++)
|
||||
{
|
||||
var entry = this.tabData[i];
|
||||
entry.flagDiv = jQuery(document.createElement("span"))
|
||||
.addClass("et2_tabflag")
|
||||
.appendTo(this.flagContainer);
|
||||
// Class to tab's div container
|
||||
if (entry.widget_options && typeof entry.widget_options.class != 'undefined')
|
||||
{
|
||||
entry.flagDiv.addClass(entry.widget_options.class);
|
||||
}
|
||||
entry.flagDiv.text(entry.label || "Tab");
|
||||
if(entry.hidden || this.tabData.length === 1)
|
||||
{
|
||||
entry.flagDiv.hide();
|
||||
}
|
||||
else
|
||||
{
|
||||
entry.flagDiv.click({"tabs": this, "idx": i}, function(e) {
|
||||
e.data.tabs.setActiveTab(e.data.idx);
|
||||
});
|
||||
}
|
||||
entry.contentDiv = jQuery(document.createElement("div"))
|
||||
.addClass("et2_tabcntr")
|
||||
.appendTo(this.tabContainer);
|
||||
if (this.options.align_tabs == 'v') {
|
||||
entry.flagDiv.unbind('click');
|
||||
entry.flagDiv.text("");
|
||||
jQuery(document.createElement('div'))
|
||||
.addClass('et2_tabtitle')
|
||||
.text(entry.label || "Tab")
|
||||
.click({"tabs": this, "idx": i}, function(e) {
|
||||
e.data.tabs.flagContainer.children(":eq(" + e.data.idx + ")").toggleClass('active');
|
||||
if (e.data.tabs.selected_index != e.data.idx) e.data.tabs.setActiveTab(e.data.idx);
|
||||
})
|
||||
.appendTo(entry.flagDiv);
|
||||
entry.contentDiv.appendTo(entry.flagDiv);
|
||||
}
|
||||
}
|
||||
|
||||
if (this.options.align_tabs == 'v'){
|
||||
|
||||
this.container.addClass('vertical');
|
||||
this.tabContainer.hide();
|
||||
}
|
||||
// Check for a passed in value
|
||||
if(this.options.value)
|
||||
{
|
||||
this.selected_index = 0;
|
||||
for(var i = 0; i < this.tabData.length; i++)
|
||||
{
|
||||
if(this.tabData[i].id == this.options.value)
|
||||
{
|
||||
this.selected_index = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
this.setActiveTab(this.selected_index);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the index of the currently active tab
|
||||
*
|
||||
* @returns {number}
|
||||
*/
|
||||
get_active_tab()
|
||||
{
|
||||
return this.selected_index;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the currently active tab by index
|
||||
*
|
||||
* @param {number} _idx
|
||||
*/
|
||||
setActiveTab(_idx)
|
||||
{
|
||||
this.selected_index = _idx;
|
||||
|
||||
// Remove the "active" flag from all tabs-flags
|
||||
jQuery(".et2_tabflag", this.flagContainer).removeClass("active");
|
||||
|
||||
// Hide all tab containers
|
||||
this.tabContainer.children().hide();
|
||||
|
||||
// Set the tab flag with the given index active and show the corresponding
|
||||
// container
|
||||
this.flagContainer.children(":eq(" + _idx + ")").addClass("active");
|
||||
this.tabContainer.children(":eq(" + _idx + ")").show();
|
||||
|
||||
// lookup for nm children and trigger a resize, since nm inside inactive
|
||||
// tabs are not getting render due to tab's deffer loading.
|
||||
if (this._children.length > 0 && this.tabData && this.tabData.length > 0) {
|
||||
this.tabData[_idx]['widget'].iterateOver(function(nm){
|
||||
if (nm && nm._type == 'nextmatch') nm.resize();
|
||||
}, this.tabData[_idx]['widget'], et2_nextmatch);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Activate the tab containing the given widget
|
||||
*
|
||||
* @param {et2_widget} widget
|
||||
* @return {bool} widget was found in a tab
|
||||
*/
|
||||
activateTab(widget)
|
||||
{
|
||||
var tab = widget;
|
||||
while(tab._parent && tab._parent._type !='tabbox')
|
||||
{
|
||||
tab = tab._parent;
|
||||
}
|
||||
|
||||
var child_index = this._children.indexOf(tab);
|
||||
for(var i = 0; i < this.tabData.length; i++)
|
||||
{
|
||||
if(this.tabData[i].widget == tab)
|
||||
{
|
||||
this.setActiveTab(i);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
getDOMNode(_sender)
|
||||
{
|
||||
if (_sender === this || typeof _sender === 'undefined')
|
||||
{
|
||||
return this.container[0];
|
||||
}
|
||||
else
|
||||
{
|
||||
for (var i = 0; i < this.tabData.length; i++)
|
||||
{
|
||||
if (this.tabData[i].widget == _sender)
|
||||
{
|
||||
return this.tabData[i].contentDiv[0];
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
set_tab_height(_height)
|
||||
{
|
||||
this.tab_height = _height;
|
||||
this.tabContainer.css("height", _height);
|
||||
}
|
||||
|
||||
set_height(_value)
|
||||
{
|
||||
this.height = _value;
|
||||
|
||||
this.tabContainer.css("height", _value);
|
||||
}
|
||||
|
||||
/**
|
||||
* getValue has to return the value of the input widget
|
||||
*/
|
||||
getValue()
|
||||
{
|
||||
return this.selected_index !== false ? this.tabData[<number>this.selected_index].id : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Is dirty returns true if the value of the widget has changed since it
|
||||
* was loaded.
|
||||
*/
|
||||
isDirty()
|
||||
{
|
||||
return this.selected_index != this.value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Causes the dirty flag to be reseted.
|
||||
*/
|
||||
resetDirty()
|
||||
{
|
||||
this.value = this.selected_index;
|
||||
}
|
||||
|
||||
isValid(messages)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
resize(_height)
|
||||
{
|
||||
if(_height)
|
||||
{
|
||||
this.set_height(this.tabContainer.height() + _height);
|
||||
}
|
||||
//Set the height of tabs with the heighest height
|
||||
else if(_height === 0)
|
||||
{
|
||||
this.set_height(this.tabContainer.height());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set up for printing
|
||||
*
|
||||
* @return {undefined|Deferred} Return a jQuery Deferred object if not done setting up
|
||||
* (waiting for data)
|
||||
*/
|
||||
beforePrint()
|
||||
{
|
||||
// Remove the "active" flag from all tabs-flags
|
||||
jQuery(".et2_tabflag", this.flagContainer).removeClass("active");
|
||||
|
||||
// Remove height limit
|
||||
this.tabContainer.css("height", '');
|
||||
|
||||
// Show all enabled tabs
|
||||
for (var i = 0; i < this.tabData.length; i++)
|
||||
{
|
||||
var entry = this.tabData[i];
|
||||
if(entry.hidden) continue;
|
||||
entry.flagDiv.insertBefore(entry.contentDiv);
|
||||
entry.contentDiv.show();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset after printing
|
||||
*/
|
||||
afterPrint()
|
||||
{
|
||||
for (var i = 0; i < this.tabData.length; i++)
|
||||
{
|
||||
var entry = this.tabData[i];
|
||||
entry.flagDiv.appendTo(this.flagContainer);
|
||||
}
|
||||
this.setActiveTab(this.get_active_tab());
|
||||
}
|
||||
}
|
||||
et2_register_widget(et2_tabbox, ["tabbox"]);
|
Loading…
Reference in New Issue
Block a user