Zimlet Developers Guide:Zimlet Tab

Revision as of 21:36, 6 September 2011 by Gayle (talk | contribs)
Zdg-6-menu-icon-zimbra.jpg Introduction Zdg-6-menu-icon-green-flag.png Getting Started Zdg-6-menu-icon-terminal.png Dev Environment Setup Zdg-6-menu-icon-gear.png Developing Zimlets Zdg-6-menu-icon-advanced.jpg
Advanced Concepts
Application Context
Java & JSP
Zimlet Tab
Zdg-6-menu-icon-library.jpg API Specifications Zdg-6-menu-icon-checkbox.jpg Example Zimlets

Developer Article

Article Information

This article applies to the following ZCS versions.

ZCS 7.0 Article ZCS 7.0 ZCS 6.0 Article ZCS 6.0

You can create zimlets as tab applications. After creating your application (using ZmZimletBase.createApp()), your Zimlet Handler Object will receive application events such as ZmZimletBase.appActive() and ZmZimletBase.appLaunch(). Additionally, you can create and manage the content on the tab application page.

Creating Tab Application

A tab application is created by using the ZmZimletBase.createApp() method. This method can be called when your zimlet is initialized. The method returns the newly created tab application name. You will likely use this name often so a good practice is to save the name to a zimlet property that can be accessed in the future (shown here as this._tabAppName).

// create the tab application
this._tabAppName = this.createApp("Tab Label", "zimbraIcon", "Tab Tool Tip");


Life Cycle

A zimlet that is running as a tab application will receive application life cycle events. The following illustrates the tab application events. A tab is "launched" the first-time a user clicks on the tab. When a tab is made "active", a user clicks on the tab and the tab content is displayed. When a tab is made "inactive", the user has switched to a different tab.


Tab Areas

A tab application has three primary content areas on the page:

  • Main Content Area
  • Toolbar Area
  • Overview Area

How to retrieve the area objects and set the content (i.e. the HTML) for the areas is shown in the Tab Overview example.


Useful Links

Verified Against: Zimbra Collaboration Server 7.0 Date Created: 01/05/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimlet_Developers_Guide:Zimlet_Tab Date Modified: 2011-09-06

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search