Introduction

Getting Started

Dev Environment Setup

Developing Zimlets

Advanced Concepts

API Specifications

Example Zimlets

Article Information
This article applies to the following ZCS versions.
ZCS 7.0
ZCS 6.0

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

Useful Links

• Zimlet Definition File Reference
• Zimlet Tab