ZCS 6.0:Zimlet Developers Guide:Examples:Simple Dialog: Difference between revisions
(New page: {| cellspacing="0" cellpadding="5" style="border: 1px solid rgb(153, 153, 170); margin: 0pt 0.5em 0.5em 0pt; float: none; background-color: rgb(249, 249, 255);" |[[Image:zdg-6-menu-icon-zi...) |
No edit summary |
||
(14 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{BC|Community Sandbox}} | |||
__FORCETOC__ | |||
<div class="col-md-12 ibox-content"> | |||
=ZCS 6.0: Zimlet Developer Guide:Examples:Simple Dialog= | |||
{{KB|{{Unsupported}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}} | |||
{{WIP}} | |||
{{warning|1=You are looking at legacy Zimlet documentation. For Zimbra Modern UI Zimlet development go to: https://wiki.zimbra.com/wiki/DevelopersGuide#Zimlet_Development_Guide.}} | |||
{| cellspacing="0" cellpadding="5" style="border: 1px solid rgb(153, 153, 170); margin: 0pt 0.5em 0.5em 0pt; float: none; background-color: rgb(249, 249, 255);" | {| cellspacing="0" cellpadding="5" style="border: 1px solid rgb(153, 153, 170); margin: 0pt 0.5em 0.5em 0pt; float: none; background-color: rgb(249, 249, 255);" | ||
|[[Image:zdg-6-menu-icon-zimbra.jpg|20px]] | |[[Image:zdg-6-menu-icon-zimbra.jpg|20px]] | ||
Line 8: | Line 15: | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-gear.png|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-gear.png|20px]] | ||
|[[ZCS 6.0:Zimlet Developers Guide:Developing Zimlets|Developing Zimlets]] | |[[ZCS 6.0:Zimlet Developers Guide:Developing Zimlets|Developing Zimlets]] | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-advanced.jpg|20px]] | |||
|[[ZCS 6.0:Zimlet Developers Guide:Advanced Concepts|Advanced Concepts]] | |||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-library.jpg|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-library.jpg|20px]] | ||
|[[ZCS 6.0:Zimlet Developers Guide:Zimlet API Specifications|API Specifications]] | |[[ZCS 6.0:Zimlet Developers Guide:Zimlet API Specifications|API Specifications]] | ||
Line 13: | Line 22: | ||
|[[ZCS 6.0:Zimlet Developers Guide:Example Zimlets|Example Zimlets]] | |[[ZCS 6.0:Zimlet Developers Guide:Example Zimlets|Example Zimlets]] | ||
|} | |} | ||
== Description == | == Description == | ||
This zimlet shows-up as a panel item and will display a simple custom dialog on a single or double-click. This example also uses internationalization properties. | This zimlet shows-up as a panel item and will display a simple custom dialog on a single or double-click. This example also uses internationalization properties. | ||
== Screenshot == | |||
[[Image:zcs-6-examples-simpledialog.png]] | |||
== Definition File == | == Definition File == | ||
<pre> | <pre> | ||
<zimlet name=" | <zimlet name="com_zimbra_example_simpledialog" version="1.0" description="Create a simple custom dialog."> | ||
<include> | <include>com_zimbra_example_simpledialog.js</include> | ||
<handlerObject> | <handlerObject>com_zimbra_example_simpledialog_HandlerObject</handlerObject> | ||
<zimletPanelItem label="${msg.simpledialog_label}" icon="zimbraIcon"> | <zimletPanelItem label="${msg.simpledialog_label}" icon="zimbraIcon"> | ||
<toolTipText>${msg.simpledialog_tooltip}</toolTipText> | <toolTipText>${msg.simpledialog_tooltip}</toolTipText> | ||
Line 30: | Line 42: | ||
</pre> | </pre> | ||
== Creating the Dialog == | |||
Here is snippet from the Zimlet Handler Object (<code>_displayDialog()</code> method) where we create and show the dialog: | |||
<pre> | |||
var sDialogTitle = this.getMessage("simpledialog_dialog_title"); // get i18n resource string | |||
var sStatusMsg = this.getMessage("simpledialog_status_launch"); // get i18n resource string | |||
this.pView = new DwtComposite(this.getShell()); //creates an empty div as a child of main shell div | |||
this.pView.setSize("250", "150"); // set width and height | |||
this.pView.getHtmlElement().style.overflow = "auto"; // adds scrollbar | |||
this.pView.getHtmlElement().innerHTML = this._createDialogView(); // insert html to the dialogbox | |||
// pass the title, view & buttons information to create dialog box | |||
this.pbDialog = new ZmDialog({title:sDialogTitle, view:this.pView, parent:this.getShell(), standardButtons:[DwtDialog.DISMISS_BUTTON]}); | |||
this.pbDialog.setButtonListener(DwtDialog.DISMISS_BUTTON, new AjxListener(this, this._okBtnListener)); | |||
this.pbDialog.popup(); //show the dialog | |||
</pre> | |||
The <code>_createDialogView()</code> method creates the html mark-up using an Array: | |||
<pre> | <pre> | ||
** | /** | ||
* | * Creates the dialog view. | ||
* | * | ||
*/ | */ | ||
com_zimbra_example_simpledialog_HandlerObject.prototype._createDialogView = | |||
function( | function() { | ||
var html = new Array(); | |||
var i = 0; | |||
html[i++] = "<table>"; | |||
html[i++] = "<tr>"; | |||
html[i++] = "<td colspan='2'>"; | |||
html[i++] = "This is a sample dialog with HTML code"; | |||
html[i++] = "</td>"; | |||
html[i++] = "</tr>"; | |||
html[i++] = "<tr>"; | |||
html[i++] = "<td>"; | |||
html[i++] = "Some field ONE:"; | |||
html[i++] = "</td>"; | |||
html[i++] = "<td>"; | |||
html[i++] = "<input id='simpledlg_someField1' type='text'/>"; | |||
html[i++] = "</td>"; | |||
html[i++] = "</tr>"; | |||
html[i++] = "<tr>"; | |||
html[i++] = "<td>"; | |||
html[i++] = "Some field TWO:"; | |||
html[i++] = "</td>"; | |||
html[i++] = "<td>"; | |||
html[i++] = "<input id='simpledlg_someField2' type='text'/>"; | |||
html[i++] = "</td>"; | |||
html[i++] = "</tr>"; | |||
html[i++] = "</table>"; | |||
return html.join(""); | |||
}; | }; | ||
</pre> | </pre> | ||
== Download == | == Download == | ||
Line 70: | Line 106: | ||
{| cellspacing="0" cellpadding="5" border="1" | {| cellspacing="0" cellpadding="5" border="1" | ||
|Zimlet Package | |Zimlet Package | ||
|[ | |[https://github.com/Zimbra-Community/zimlets-foss/raw/master/Zimlet/src/zimlet/com_zimbra_example_simpledialog.zip com_zimbra_example_simpledialog.zip] | ||
|} | |} | ||
== Useful Links == | == Useful Links == | ||
<ul> | <ul> | ||
<li>[[ | <li>[[ZCS_6.0:Zimlet_Developers_Guide:Examples:Simple_Dialog_with_Template|Simple Dialog using a Template]]</li> | ||
<li>[[ZCS_6.0:Zimlet_Developers_Guide:Developing_Zimlets#Internationalization|Internationalization]]</li> | |||
</ul> | </ul> | ||
{{Article Footer|Zimbra Collaboration Server 7.0|12/22/2009}} | |||
[[Category:Developers]] | |||
[[Category:Zimlets]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] |
Latest revision as of 06:04, 17 July 2021
ZCS 6.0: Zimlet Developer Guide:Examples:Simple Dialog
- This article is a Work in Progress, and may be unfinished or missing sections.
You are looking at legacy Zimlet documentation. For Zimbra Modern UI Zimlet development go to: https://wiki.zimbra.com/wiki/DevelopersGuide#Zimlet_Development_Guide. |
Introduction | Getting Started | Dev Environment Setup | Developing Zimlets | Advanced Concepts | API Specifications | Example Zimlets |
Description
This zimlet shows-up as a panel item and will display a simple custom dialog on a single or double-click. This example also uses internationalization properties.
Screenshot
Definition File
<zimlet name="com_zimbra_example_simpledialog" version="1.0" description="Create a simple custom dialog."> <include>com_zimbra_example_simpledialog.js</include> <handlerObject>com_zimbra_example_simpledialog_HandlerObject</handlerObject> <zimletPanelItem label="${msg.simpledialog_label}" icon="zimbraIcon"> <toolTipText>${msg.simpledialog_tooltip}</toolTipText> </zimletPanelItem> </zimlet>
Creating the Dialog
Here is snippet from the Zimlet Handler Object (_displayDialog()
method) where we create and show the dialog:
var sDialogTitle = this.getMessage("simpledialog_dialog_title"); // get i18n resource string var sStatusMsg = this.getMessage("simpledialog_status_launch"); // get i18n resource string this.pView = new DwtComposite(this.getShell()); //creates an empty div as a child of main shell div this.pView.setSize("250", "150"); // set width and height this.pView.getHtmlElement().style.overflow = "auto"; // adds scrollbar this.pView.getHtmlElement().innerHTML = this._createDialogView(); // insert html to the dialogbox // pass the title, view & buttons information to create dialog box this.pbDialog = new ZmDialog({title:sDialogTitle, view:this.pView, parent:this.getShell(), standardButtons:[DwtDialog.DISMISS_BUTTON]}); this.pbDialog.setButtonListener(DwtDialog.DISMISS_BUTTON, new AjxListener(this, this._okBtnListener)); this.pbDialog.popup(); //show the dialog
The _createDialogView()
method creates the html mark-up using an Array:
/** * Creates the dialog view. * */ com_zimbra_example_simpledialog_HandlerObject.prototype._createDialogView = function() { var html = new Array(); var i = 0; html[i++] = "<table>"; html[i++] = "<tr>"; html[i++] = "<td colspan='2'>"; html[i++] = "This is a sample dialog with HTML code"; html[i++] = "</td>"; html[i++] = "</tr>"; html[i++] = "<tr>"; html[i++] = "<td>"; html[i++] = "Some field ONE:"; html[i++] = "</td>"; html[i++] = "<td>"; html[i++] = "<input id='simpledlg_someField1' type='text'/>"; html[i++] = "</td>"; html[i++] = "</tr>"; html[i++] = "<tr>"; html[i++] = "<td>"; html[i++] = "Some field TWO:"; html[i++] = "</td>"; html[i++] = "<td>"; html[i++] = "<input id='simpledlg_someField2' type='text'/>"; html[i++] = "</td>"; html[i++] = "</tr>"; html[i++] = "</table>"; return html.join(""); };
Download
Zimlet Package | com_zimbra_example_simpledialog.zip |
Useful Links