View source for ZCS 6.0:Zimlet Developers Guide:Examples:Simple Dialog with Template

{{BC|Community Sandbox}}
__FORCETOC__
<div class="col-md-12 ibox-content">
=ZCS 6.0: Zimlet Developer Guide:Examples:Siample Dialog with Template=
{{KB|{{Unsupported}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}
{{Archive}}
{{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.}} 
{{WIP}}{| 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]]
|[[ZCS 6.0:Zimlet Developers Guide:Introduction|Introduction]]
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-green-flag.png|20px]]
|[[ZCS 6.0:Zimlet Developers Guide:Getting Started|Getting Started]]
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-terminal.png|20px]]
|[[ZCS 6.0:Zimlet Developers Guide:Dev Environment Setup|Dev Environment Setup]]
|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]]
|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]]
|[[ZCS 6.0:Zimlet Developers Guide:Zimlet API Specifications|API Specifications]]
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-checkbox.jpg|20px]]
|[[ZCS 6.0:Zimlet Developers Guide:Example Zimlets|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 uses a template to create the HTML mark-up for the dialog. The Zimlet Definition File includes the compiled template file <code>Simple.template.js</code> using the <code><include></code> element.

== Screenshot ==

[[Image:zcs-6-examples-simpledialogtemplate.png]]

== Definition File ==

<pre>
<zimlet name="com_zimbra_example_simpledialogtemplate" version="1.0" description="Create a custom dialog using a template.">
    <include>com_zimbra_example_simpledialogtemplate.js</include>
	<include>templates/Simple.template.js</include>
    <handlerObject>com_zimbra_example_simpledialogtemplate_HandlerObject</handlerObject>
    <zimletPanelItem label="Simple Dialog Template Example" icon="zimbraIcon">
      <toolTipText>${msg.simpledialog_tooltip}</toolTipText>
   </zimletPanelItem>
</zimlet>
</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 by getting the template:

<pre>
/**
 * Creates the dialog view.
 * 
 */
com_zimbra_example_simpledialogtemplate_HandlerObject.prototype._createDialogView =
function() {
    var html = AjxTemplate.expand("com_zimbra_example_simpledialogtemplate.templates.Simple#Main");		
    return html;
};
</pre> 

== Template ==

The following is the <code>Simple.template</code> file (before compilation). The HTML code is wrapped in the <code><template></code> tag (with the template id "Main").

<pre>
<template id="Main">
  <table cellpadding="2" cellspacing="0" border="0" width="100%">
    <tr>
      <td colspan="2">
      This is a sample dialog with HTML code...
      </td>
    </tr>
    <tr>
      <td colspan="2">&nbsp;</td>
    </tr>
    <tr>
      <td>
      <b>Text Property:</b>
      </td>
      <td>
      <input type="text" name="simpledialog_text_prop" />
      </td>
    </tr>
    <tr>
      <td>
      <b>Password Property:</b>
      </td>
      <td>
      <input type="password" name="simpledialog_password_prop" />
      </td>
    </tr>
  </table>
</template>
</pre>
== Download ==

{| cellspacing="0" cellpadding="5" border="1"
|Zimlet Package
|[https://github.com/Zimbra-Community/zimlets-foss/raw/master/Zimlet/src/zimlet/com_zimbra_example_simpledialogtemplate.zip com_zimbra_example_simpledialogtemplate.zip]
|}

== Useful Links ==

<ul>
<li>[[ZCS_6.0:Zimlet_Developers_Guide:Examples:Simple_Dialog|Simple Dialog]]</li>
<li>[[ZCS_6.0:Zimlet_Developers_Guide:Templates|Templates]]</li>
<li>[[ZCS_6.0:Zimlet_Developers_Guide:Templates#Compiling_the_Template|Templates > Compiling the Template]]</li>
</ul>



{{Article Footer|Zimbra Collaboration Suite 6.0|12/22/2009}}


[[Category:Developers]]
[[Category:Zimlets]]
[[Category:ZCS 6.0]]