ZCS 6.0:Zimlet Developers Guide:Examples:Dialogs

Revision as of 11:58, 3 November 2020 by Barry de Graaff (talk | contribs) (ZCS 6.0: Zimlet Developer Guide:Examples:Dialogs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

ZCS 6.0: Zimlet Developer Guide:Examples:Dialogs

   KB 3306        Last updated on 2020-11-3  




0.00
(0 votes)
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 Zdg-6-menu-icon-library.jpg API Specifications Zdg-6-menu-icon-checkbox.jpg Example Zimlets

Description

This zimlet shows-up as a panel item and will display series of dialogs based on your selection from the zimlet menu items.

Screenshots

Zcs-6-examples-dialogs-menus.png

Menu Item Dialog Image
Message Dialog (info) Creates a message dialog with "info" style (DwtMessageDialog.INFO_STYLE) Zcs-6-examples-dialogs-info.png
Message Dialog (warn) Creates a message dialog with "info" style (DwtMessageDialog.WARNING_STYLE) Zcs-6-examples-dialogs-warn.png
Message Dialog (critical) Creates a message dialog with "info" style (DwtMessageDialog.CRITICAL_STYLE) Zcs-6-examples-dialogs-critical.png
Error Dialog Creates an error dialog that has the ability to show error details and send an error report. Zcs-6-examples-dialogs-error.png
Yes/No Dialog Creates a dialog with Yes-No buttons. Zcs-6-examples-dialogs-yn.png
Yes/No/Cancel Dialog Creates a dialog with Yes-No-Cancel buttons. Zcs-6-examples-dialogs-ync.png

Definition File

<zimlet name="com_zimbra_example_dialogs" version="1.0" description="Creates various dialogs">
  <include>com_zimbra_example_dialogs.js</include>
  <handlerObject>com_zimbra_example_dialogs_HandlerObject</handlerObject>
  <zimletPanelItem label="Dialogs Zimlet">
    <contextMenu>
      <menuItem label="Message Dialog (info)" icon="zimbraIcon" id="com_zimbra_dialogs_msgInfodlg"/>
      <menuItem label="Message Dialog (warn)" icon="zimbraIcon" id="com_zimbra_dialogs_msgWarndlg"/>
      <menuItem label="Message Dialog (critical)" icon="zimbraIcon" id="com_zimbra_dialogs_msgCriticaldlg"/>
      <menuItem label="Error" icon="zimbraIcon" id="com_zimbra_dialogs_errordlg"/>
      <menuItem label="Yes/No Dialog" icon="zimbraIcon" id="com_zimbra_dialogs_yesnodlg"/>
      <menuItem label="Yes/No/Cancel Dialog" icon="zimbraIcon" id="com_zimbra_dialogs_yesnocanceldlg"/>			 
    </contextMenu>
  </zimletPanelItem>
</zimlet>

Creating the Dialogs

Here is snippet from the Zimlet Handler Object. The application context object is used to create the dialogs.

Message Dialogs

this._dialog = appCtxt.getMsgDialog(); // returns DwtMessageDialog

We attach a listener on the "OK" button of the message dialog. When the "OK" button is pressed, the okBtnListener method is called.

this._dialog.setButtonListener(DwtDialog.OK_BUTTON, new AjxListener(this, this._okBtnListener)); // listens for OK button events

Error Dialog

this._dialog = appCtxt.getErrorDialog(); // returns ZmErrorDialog

We attach a listener on the "OK" button of the error dialog. When the "OK" button is pressed, the _okBtnListener method is called.

this._dialog.setButtonListener(DwtDialog.OK_BUTTON, new AjxListener(this, this._okBtnListener)); // listens for OK button events

Yes-No Dialog

this._dialog = appCtxt.getYesNoMsgDialog(); // returns DwtMessageDialog

We attach a listener on the "YES" and "NO" buttons of the dialog. When the "YES" or "NO" buttons are pressed, the _yesBtnListener and _noBtnListener methods are called respectively.

this._dialog.setButtonListener(DwtDialog.YES_BUTTON, new AjxListener(this, this._yesBtnListener)); // listens for YES button events
this._dialog.setButtonListener(DwtDialog.NO_BUTTON, new AjxListener(this, this._noBtnListener)); // listens for NO button events

Yes-No-Cancel Dialog

this._dialog = appCtxt.getYesNoCancelMsgDialog(); // returns DwtMessageDialog

We attach a listener on the "YES", "NO", and "CANCEL" buttons of the dialog. When the "YES", "NO" or "CANCEL" buttons are pressed, the _yesBtnListener, _noBtnListener and _cancelBtnListener methods are called respectively.

this._dialog.setButtonListener(DwtDialog.YES_BUTTON, new AjxListener(this, this._yesBtnListener)); // listens for YES button events
this._dialog.setButtonListener(DwtDialog.NO_BUTTON, new AjxListener(this, this._noBtnListener)); // listens for NO button events
this._dialog.setButtonListener(DwtDialog.CANCEL_BUTTON, new AjxListener(this, this._cancelBtnListener)); // listens for CANCEL button events

Download

Zimlet Package com_zimbra_example_dialogs.zip

Useful Links


Verified Against: Zimbra Collaboration Server 7.0 Date Created: 01/15/2010
Article ID: https://wiki.zimbra.com/index.php?title=ZCS_6.0:Zimlet_Developers_Guide:Examples:Dialogs Date Modified: 2020-11-03



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