ZCS 6.0:Zimlet Developers Guide:Examples:Tab iFrame: Difference between revisions
No edit summary |
|||
(10 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:Tab iFrame= | |||
{{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 15: | Line 22: | ||
|[[ZCS 6.0:Zimlet Developers Guide:Example Zimlets|Example Zimlets]] | |[[ZCS 6.0:Zimlet Developers Guide:Example Zimlets|Example Zimlets]] | ||
|} | |} | ||
== Description == | == Description == | ||
Line 28: | Line 34: | ||
<pre> | <pre> | ||
<zimlet name=" | <zimlet name="com_zimbra_example_tabiframe" version="1.0" description="Demos a tab that loads an iframe"> | ||
<include>com_zimbra_example_tabiframe.js</include> | |||
<handlerObject>com_zimbra_example_tabiframe_HandlerObject</handlerObject> | |||
</zimlet> | </zimlet> | ||
</pre> | </pre> | ||
== Handler Object == | == Handler Object == | ||
Line 44: | Line 49: | ||
* | * | ||
*/ | */ | ||
com_zimbra_example_tabiframe_HandlerObject.prototype.init = | |||
function() { | function() { | ||
this._simpleAppName = this.createApp("Tab iFrame App", "zimbraIcon", "An app in a new tab"); | |||
}; | }; | ||
</pre> | </pre> | ||
Line 58: | Line 63: | ||
* @param {String} appName the application name | * @param {String} appName the application name | ||
*/ | */ | ||
com_zimbra_example_tabiframe_HandlerObject.prototype.appLaunch = | |||
function(appName) { | function(appName) { | ||
switch (appName) { | |||
case this._simpleAppName: { | |||
// do something | |||
var app = appCtxt.getApp(appName); // get access to ZmZimletApp | |||
app.setContent("<iframe id=\"tabiframe-app\" name=\"tabiframe-app\" src=\"http://www.yahoo.com\" width=\"100%\" height=\"100%\" /></iframe>"); // write HTML to app | |||
break; | |||
} | |||
} | |||
}; | }; | ||
</pre> | </pre> | ||
Line 74: | Line 80: | ||
{| 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_tabiframe.zip com_zimbra_example_tabiframe.zip] | ||
|} | |} | ||
== Useful Links == | == Useful Links == | ||
Line 82: | Line 87: | ||
<ul> | <ul> | ||
<li>[[ZCS 6.0:Zimlet Developers Guide:Zimlet_Definition_File_Reference|Zimlet Definition File Reference]]</li> | <li>[[ZCS 6.0:Zimlet Developers Guide:Zimlet_Definition_File_Reference|Zimlet Definition File Reference]]</li> | ||
<li>[[ZCS 6.0:Zimlet Developers Guide: | <li>[[ZCS 6.0:Zimlet Developers Guide:Zimlet_Tab|Zimlet Tab]]</li> | ||
</ul> | </ul> | ||
{{Article Footer|Zimbra Collaboration | {{Article Footer|Zimbra Collaboration Server 7.0|01/06/2010}} | ||
[[Category:Developers]] | |||
[[Category:Zimlets]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] |
Latest revision as of 06:01, 17 July 2021
ZCS 6.0: Zimlet Developer Guide:Examples:Tab iFrame
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 will create a "tab" application that loads an iframe as the tab content.
Screen Shot
Definition File
<zimlet name="com_zimbra_example_tabiframe" version="1.0" description="Demos a tab that loads an iframe"> <include>com_zimbra_example_tabiframe.js</include> <handlerObject>com_zimbra_example_tabiframe_HandlerObject</handlerObject> </zimlet>
Handler Object
Below is a snippet from the Handler Object from the zimlet JavaScript file. In zimlet init()
, the "tab" application is created. The newly created application name is returned and set as a local zimlet property _simpleAppName
for later use.
/** * This method gets called by the Zimlet framework when the zimlet loads. * */ com_zimbra_example_tabiframe_HandlerObject.prototype.init = function() { this._simpleAppName = this.createApp("Tab iFrame App", "zimbraIcon", "An app in a new tab"); };
In this snippet, when the tab application is launched, HTML code (that produces an iframe
) is loaded into the tab application content:
/** * This method gets called by the Zimlet framework when the application is opened for the first time. * * @param {String} appName the application name */ com_zimbra_example_tabiframe_HandlerObject.prototype.appLaunch = function(appName) { switch (appName) { case this._simpleAppName: { // do something var app = appCtxt.getApp(appName); // get access to ZmZimletApp app.setContent("<iframe id=\"tabiframe-app\" name=\"tabiframe-app\" src=\"http://www.yahoo.com\" width=\"100%\" height=\"100%\" /></iframe>"); // write HTML to app break; } } };
Download
Zimlet Package | com_zimbra_example_tabiframe.zip |
Useful Links