ZCS 6.0:Zimlet Developers Guide:Examples:Tab iFrame

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_tabiframe" version="0.2" description="Demos a tab that loads an iframe">
    <include>com_zimbra_tabiframe.js</include>
    <handlerObject>com_zimbra_tabiframeHandlerObject</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_tabiframeHandlerObject.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_tabiframeHandlerObject.prototype.appLaunch =
function(appName) {
  switch (appName) {
    case this._simpleAppName: {
      var app = appCtxt.getApp(appName); // get access to ZmZimletApp
      app.setContent("<iframe name=\"tabiframe-app\" src=\"http://www.yahoo.com/\" width=\"100%\" height=\"100%\" /></iframe>"); // write HTML to app
      break;
    }
  }
};

Download

Zimlet Package

com_zimbra_tabiframe.zip

Useful Links

• Zimlet Definition File Reference
• Tab Zimlets Life Cycle