mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-11-23 00:13:35 +01:00
Add dialog widget
This commit is contained in:
Nathan Gray
parent
b66a74ff03
commit
5555edcb98
457
etemplate/js/et2_widget_dialog.js
Normal file
457
etemplate/js/et2_widget_dialog.js
Normal file
@ -0,0 +1,457 @@
|
||||
/**
|
||||
* 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$
|
||||
*/
|
||||
|
||||
"use strict";
|
||||
|
||||
/*egw:uses
|
||||
et2_core_widget;
|
||||
jquery.jquery-ui;
|
||||
*/
|
||||
|
||||
/**
|
||||
* 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",
|
||||
* 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 - text to display
|
||||
* title - Dialog title
|
||||
* dialog_type - et2_dialog *_MESSAGE constant
|
||||
* buttons - et2_dialog BUTTONS_* constant, or an array of button settings
|
||||
* icon - URL of icon
|
||||
* value (for prompt)
|
||||
*
|
||||
* 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) {...},
|
||||
* 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:
|
||||
* $j(this).dialog("close")
|
||||
* }, class="ui-state-error"},
|
||||
*
|
||||
* ],
|
||||
* title: 'Why would you want to do <span style="color: red">this</span>?',
|
||||
* template:"/egroupware/addressbook/templates/default/edit.xet",
|
||||
* value: { content: {...default values}, sel_options: {...}...}
|
||||
* });
|
||||
* </code>
|
||||
* @augments et2_widget
|
||||
* @see http://api.jqueryui.com/dialog/
|
||||
*/
|
||||
var et2_dialog = et2_widget.extend({
|
||||
|
||||
|
||||
attributes: {
|
||||
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);}
|
||||
},
|
||||
message: {
|
||||
name: "Message",
|
||||
type: "string",
|
||||
description: "Dialog message",
|
||||
"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",
|
||||
"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
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Details for dialog type options
|
||||
*/
|
||||
_dialog_types: [
|
||||
//PLAIN_MESSAGE: 0
|
||||
{icon: ""},
|
||||
//INFORMATION_MESSAGE: 1,
|
||||
{icon: egw.image("dialog_info")},
|
||||
//QUESTION_MESSAGE: 2,
|
||||
{icon: egw.image("dialog_help")},
|
||||
//WARNING_MESSAGE: 3,
|
||||
{icon: egw.image("dialog_warning")},
|
||||
//ERROR_MESSAGE: 4,
|
||||
{icon: egw.image("dialog_error")},
|
||||
],
|
||||
|
||||
_buttons: [
|
||||
/*
|
||||
Pre-defined Button combos
|
||||
- button ids copied from et2_dialog static, since the constants are not defined yet
|
||||
*/
|
||||
//BUTTONS_OK: 0,
|
||||
[{"button_id": 1,"text": egw.lang('ok'),"default":true}],
|
||||
//BUTTONS_OK_CANCEL: 1,
|
||||
[
|
||||
{"button_id": 1,"text": egw.lang('ok'), "default":true},
|
||||
{"button_id": 0,"text": egw.lang('cancel')}
|
||||
],
|
||||
//BUTTONS_YES_NO: 2,
|
||||
[
|
||||
{"button_id": 2,"text": egw.lang('yes'),"default":true},
|
||||
{"button_id": 3,"text": egw.lang('no')}
|
||||
],
|
||||
//BUTTONS_YES_NO_CANCEL: 3,
|
||||
[
|
||||
{"button_id": 2,"text": egw.lang('yes'),"default":true},
|
||||
{"button_id": 3,"text": egw.lang('no')},
|
||||
{"button_id": 0,"text": egw.lang('cancel')}
|
||||
]
|
||||
],
|
||||
|
||||
// Define this as null to avoid breaking any hierarchies (eg: destroy())
|
||||
_parent: null,
|
||||
|
||||
init: function() {
|
||||
// Call the inherited constructor
|
||||
this._super.apply(this, arguments);
|
||||
|
||||
// Button callbacks need a reference to this
|
||||
var self = this;
|
||||
for(var i = 0; i < this._buttons.length; i++)
|
||||
{
|
||||
for(var 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);
|
||||
}
|
||||
}
|
||||
|
||||
this.div = $j(document.createElement("div"));
|
||||
this.div.attr("id", this.id);
|
||||
|
||||
this._createDialog();
|
||||
},
|
||||
|
||||
/**
|
||||
* Clean up dialog
|
||||
*/
|
||||
destroy: function() {
|
||||
// Un-dialog the dialog
|
||||
this.div.dialog("destroy");
|
||||
|
||||
if(this.template)
|
||||
{
|
||||
this.template.clear();
|
||||
this.template = null;
|
||||
}
|
||||
|
||||
this.div = null;
|
||||
|
||||
// Call the inherited constructor
|
||||
this._super.apply(this, arguments)
|
||||
},
|
||||
|
||||
/**
|
||||
* 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: function(target, button_id) {
|
||||
var value = this.options.value;
|
||||
if(this.template)
|
||||
{
|
||||
value = this.template.getValues(this.template.widgetContainer);
|
||||
}
|
||||
if(this.options.callback)
|
||||
{
|
||||
this.options.callback.call(this,button_id,value);
|
||||
}
|
||||
// Triggers destroy too
|
||||
this.div.dialog("close");
|
||||
},
|
||||
|
||||
/**
|
||||
* Set the displayed prompt message
|
||||
*
|
||||
* @param string New message for the dialog
|
||||
*/
|
||||
set_message: function(message) {
|
||||
this.options.message = message;
|
||||
|
||||
this.div.empty()
|
||||
.append("<img class='dialog_icon' />")
|
||||
.append(message);
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* Set the dialog type to a pre-defined type
|
||||
*
|
||||
* @param integer Type constant from et2_dialog
|
||||
*/
|
||||
set_dialog_type: function(type) {
|
||||
if(this.options.dialog_type != type && typeof this._dialog_types[type] == "object")
|
||||
{
|
||||
this.options.dialog_type = type;
|
||||
}
|
||||
var type_info = this._dialog_types[type];
|
||||
this.set_icon(type_info.icon);
|
||||
},
|
||||
|
||||
/**
|
||||
* Set the icon for the dialog
|
||||
*
|
||||
* @param string icon
|
||||
*/
|
||||
set_icon: function(icon_url) {
|
||||
if(icon_url == "")
|
||||
{
|
||||
$j("img.dialog_icon",this.div).hide();
|
||||
}
|
||||
else
|
||||
{
|
||||
$j("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
|
||||
*/
|
||||
set_buttons: function(buttons) {
|
||||
this.options.buttons = buttons;
|
||||
if(typeof buttons == "number" && typeof this._buttons[buttons] != "undefined")
|
||||
{
|
||||
this.div.dialog("option", "buttons", this._buttons[buttons]);
|
||||
}
|
||||
else if (typeof buttons == "array")
|
||||
{
|
||||
for (var i = 0; i < buttons.length; i++)
|
||||
{
|
||||
if(!buttons[i].click)
|
||||
{
|
||||
buttons[i].click = jQuery.proxy(this.click,this,buttons[i].id);
|
||||
}
|
||||
}
|
||||
this.options.buttons = buttons;
|
||||
this.div.dialog("option", "buttons", buttons);
|
||||
}
|
||||
// Focus default button so enter works
|
||||
$j('.ui-dialog-buttonpane button[default]',this.div.parent()).focus();
|
||||
},
|
||||
|
||||
/**
|
||||
* Set the dialog title
|
||||
*
|
||||
* @param string New title for the dialog
|
||||
*/
|
||||
set_title: function(title) {
|
||||
this.options.title = title;
|
||||
this.div.dialog("option","title",title);
|
||||
},
|
||||
|
||||
/**
|
||||
* Block interaction with the page behind the dialog
|
||||
*
|
||||
* @param boolean Block page behind dialog
|
||||
*/
|
||||
set_modal: function(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: function(template) {
|
||||
if(this.template && this.options.template != template)
|
||||
{
|
||||
this.template.clear();
|
||||
}
|
||||
|
||||
this.template = new etemplate2(this.div[0], false);
|
||||
this.template.load("",template,this.options.value||{});
|
||||
},
|
||||
|
||||
/**
|
||||
* Actually create and display the dialog
|
||||
*/
|
||||
_createDialog: function() {
|
||||
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.div.dialog({
|
||||
// Pass the internal object, not the option
|
||||
buttons: typeof this.options.buttons == "number" ? this._buttons[this.options.buttons] : this.options.buttons,
|
||||
modal: this.options.modal,
|
||||
resizable: this.options.resizable,
|
||||
title: this.options.title,
|
||||
open: function() {
|
||||
// Focus default button so enter works
|
||||
$j(this).parents('.ui-dialog-buttonpane button[default]').focus();
|
||||
},
|
||||
close: jQuery.proxy(function() {this.destroy()},this)
|
||||
});
|
||||
}
|
||||
});
|
||||
et2_register_widget(et2_dialog, ["dialog"]);
|
||||
|
||||
// Static class stuff
|
||||
jQuery.extend(et2_dialog,
|
||||
/** @lends et2_dialog */
|
||||
{
|
||||
// Some class constants //
|
||||
|
||||
/**
|
||||
* Types
|
||||
* @constant
|
||||
*/
|
||||
PLAIN_MESSAGE: 0,
|
||||
INFORMATION_MESSAGE: 1,
|
||||
QUESTION_MESSAGE: 2,
|
||||
WARNING_MESSAGE: 3,
|
||||
ERROR_MESSAGE: 4,
|
||||
|
||||
/* Pre-defined Button combos */
|
||||
BUTTONS_OK: 0,
|
||||
BUTTONS_OK_CANCEL: 1,
|
||||
BUTTONS_YES_NO: 2,
|
||||
BUTTONS_YES_NO_CANCEL: 3,
|
||||
|
||||
/* Button constants */
|
||||
CANCEL_BUTTON: 0,
|
||||
OK_BUTTON: 1,
|
||||
YES_BUTTON: 2,
|
||||
NO_BUTTON: 3,
|
||||
|
||||
/**
|
||||
* 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. Usually just text, but DOM nodes will work too.
|
||||
* @param String title Text in the top bar of the dialog.
|
||||
* @param integer 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 Object value Default values for display
|
||||
*/
|
||||
show_dialog: function(callback, message, title, buttons, type, icon, value) {
|
||||
if(!callback || typeof callback == "undefined")
|
||||
{
|
||||
callback = function() {return;};
|
||||
}
|
||||
// Just pass them along, widget handles defaults & missing
|
||||
return et2_createWidget("dialog", {
|
||||
callback: callback,
|
||||
message: message,
|
||||
title: title,
|
||||
buttons: buttons,
|
||||
dialog_type: type,
|
||||
icon: icon,
|
||||
value: value
|
||||
});
|
||||
}
|
||||
});
|
||||
@ -28,6 +28,7 @@
|
||||
et2_widget_checkbox;
|
||||
et2_widget_radiobox;
|
||||
et2_widget_date;
|
||||
et2_widget_dialog;
|
||||
et2_widget_diff;
|
||||
et2_widget_dropdown_button;
|
||||
et2_widget_styles;
|
||||
|
||||
@ -344,6 +344,30 @@ span.et2_date span {
|
||||
font-size: 9pt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dialog widget
|
||||
* It uses jQueryUI, so this is just our little bits - icon on left
|
||||
*/
|
||||
.ui-dialog-content .dialog_icon {
|
||||
margin-right: 2ex;
|
||||
vertical-align: middle;
|
||||
}
|
||||
.ui-dialog-content {
|
||||
vertical-align: middle;
|
||||
}
|
||||
/* These change button alignment, but it seems the standard is right-aligned for
|
||||
action buttons, left aligned for "extra" controls
|
||||
.ui-dialog .ui-dialog-buttonpane {
|
||||
text-align: left;
|
||||
}
|
||||
.ui-dialog .ui-dialog-buttonpane .ui-dialog-buttonset {
|
||||
float: none;
|
||||
}
|
||||
.ui-dialog .ui-dialog-buttonpane button {
|
||||
float: none;
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* Diff widget
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user