ZCS 6.0:Zimlet Developers Guide:Examples:Simple JSP via Ajax Async: Difference between revisions
No edit summary |
|||
(7 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{| 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);" | {{BC|Community Sandbox}} | ||
__FORCETOC__ | |||
<div class="col-md-12 ibox-content"> | |||
=ZCS 6.0: Zimlet Developer Guide:Examples:Simple JSP via AJAX Async= | |||
{{KB|{{Unsupported}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}} | |||
{{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]] | |[[Image:zdg-6-menu-icon-zimbra.jpg|20px]] | ||
|[[ZCS 6.0:Zimlet Developers Guide:Introduction|Introduction]] | |[[ZCS 6.0:Zimlet Developers Guide:Introduction|Introduction]] | ||
Line 15: | Line 20: | ||
|[[ZCS 6.0:Zimlet Developers Guide:Example Zimlets|Example Zimlets]] | |[[ZCS 6.0:Zimlet Developers Guide:Example Zimlets|Example Zimlets]] | ||
|} | |} | ||
== Description == | == Description == | ||
Line 23: | Line 27: | ||
<pre> | <pre> | ||
<zimlet name=" | <zimlet name="com_zimbra_example_simplejspasync" version="1.0" description="An example zimlet using a JSP file."> | ||
<include> | <include>com_zimbra_example_simplejspasync.js</include> | ||
<handlerObject> | <handlerObject>com_zimbra_example_simplejspasync_HandlerObject</handlerObject> | ||
<zimletPanelItem label="JSP Example (via Ajax)" icon="zimbraIcon"> | <zimletPanelItem label="JSP Example (via Ajax)" icon="zimbraIcon"> | ||
<toolTipText>Click to launch the JSP Example</toolTipText> | <toolTipText>Click to launch the JSP Example</toolTipText> | ||
Line 41: | Line 45: | ||
* | * | ||
*/ | */ | ||
com_zimbra_example_simplejspasyncHandlerObject.prototype._displayDialog = | |||
function() { | function() { | ||
var jspUrl = this.getResource("jspfile.jsp"); | var jspUrl = this.getResource("jspfile.jsp"); | ||
Line 50: | Line 54: | ||
}; | }; | ||
</pre> | </pre> | ||
When the JSP page response is received, the callback method is executed: | |||
<pre> | |||
/** | |||
* Called from the ajax callback. | |||
* | |||
*/ | |||
com_zimbra_example_simplejspasyncHandlerObject.prototype._rpcCallback = | |||
function(p1, p2, response) { | |||
if (response.success == true) { | |||
appCtxt.getAppController().setStatusMsg(response.text); | |||
} | |||
}; | |||
</pre> | |||
== Download == | == Download == | ||
{| 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_simplejspasync.zip com_zimbra_example_simplejspasync.zip] | ||
|} | |} | ||
{{Article Footer|Zimbra Collaboration | {{Article Footer|Zimbra Collaboration Server 7.0|12/22/2009}} | ||
[[Category:Developers]] | |||
[[Category:Zimlets]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] |
Revision as of 12:11, 3 November 2020
ZCS 6.0: Zimlet Developer Guide:Examples:Simple JSP via AJAX Async
- This article is a Work in Progress, and may be unfinished or missing sections.
Introduction | Getting Started | Dev Environment Setup | Developing Zimlets | Advanced Concepts | API Specifications | Example Zimlets |
Description
This zimlet shows how to launch a JSP from within the Zimlet Handler Object using Ajax and read the response asynchronously.
Definition File
<zimlet name="com_zimbra_example_simplejspasync" version="1.0" description="An example zimlet using a JSP file."> <include>com_zimbra_example_simplejspasync.js</include> <handlerObject>com_zimbra_example_simplejspasync_HandlerObject</handlerObject> <zimletPanelItem label="JSP Example (via Ajax)" icon="zimbraIcon"> <toolTipText>Click to launch the JSP Example</toolTipText> </zimletPanelItem> </zimlet>
Handler Object
The following code snippet from the zimlet JavaScript Handler Object show making the Ajax call to the JSP file and setting the callback method to read the response asyncrhonously:
/** * Displays the zimlet jsp page. * */ com_zimbra_example_simplejspasyncHandlerObject.prototype._displayDialog = function() { var jspUrl = this.getResource("jspfile.jsp"); var callback = new AjxCallback(this, this._rpcCallback, ["param1", "param2"]) AjxRpc.invoke(null, jspUrl, null, callback, true); };
When the JSP page response is received, the callback method is executed:
/** * Called from the ajax callback. * */ com_zimbra_example_simplejspasyncHandlerObject.prototype._rpcCallback = function(p1, p2, response) { if (response.success == true) { appCtxt.getAppController().setStatusMsg(response.text); } };
Download
Zimlet Package | com_zimbra_example_simplejspasync.zip |