Zimlet Developers Guide:Zimlet Tab: Difference between revisions
(Adding categories) |
No edit summary |
||
Line 32: | Line 32: | ||
|} | |} | ||
You can create zimlets as application | You can create zimlets as tab application. After creating your application (using <code>ZmZimletBase.createApp()</code>), your Zimlet Handler Object will receive application events such as <code>ZmZimletBase.appActive()</code> and <code>ZmZimletBase.appLaunch()</code>. Additionally, you can create and manage the content on the tab application page. | ||
The following illustrates the tab application events | == Creating Tab Application == | ||
A tab application is created by using the <code>ZmZimletBase.createApp({String}, {String}, {String})</code> method. This method can be called when your zimlet is initialized. The method returns the newly created tab application name. You will use this name often in your zimlet so a good practice is to save the name to a zimlet property that can be access (shown here as <code>this._tabAppName</code>). | |||
<pre> | |||
// create the tab application | |||
this._tabAppName = this.createApp("Tab Label", "zimbraIcon", "Tab Tool Tip"); | |||
</pre> | |||
== Life Cycle == | |||
The zimlet tab application, the zimlet 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 is displayed to the user. When a tab is made "inactive", the user has switched to a different tab. | |||
[[Image:zcs-6-tab-zimlet-lifecycle.png]] | [[Image:zcs-6-tab-zimlet-lifecycle.png]] | ||
== Tab Areas == | |||
A tab application has three primary content areas on the page: | |||
<ul> | |||
<li>Main Content Area</li> | |||
<li>Toolbar Area</li> | |||
<li>Overview Area</li> | |||
</ul> | |||
== Useful Links == | == Useful Links == |
Revision as of 06:47, 15 January 2010
You can create zimlets as tab application. 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({String}, {String}, {String})
method. This method can be called when your zimlet is initialized. The method returns the newly created tab application name. You will use this name often in your zimlet so a good practice is to save the name to a zimlet property that can be access (shown here as this._tabAppName
).
// create the tab application this._tabAppName = this.createApp("Tab Label", "zimbraIcon", "Tab Tool Tip");
Life Cycle
The zimlet tab application, the zimlet 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 is displayed to the user. 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
Useful Links