Class ZmZimletBase
Field Detail
<static>
ZmZimletBase.CONTENTOBJECT_MENU
This defines the Content Object Menu.
<static>
ZmZimletBase.PANEL_MENU
This defines the Panel Menu.
Method Detail
addCustomMimeHeaders(customMimeHeaders)
This Zimlet hook allows Zimlets to set custom headers to outgoing emails.
To set a custom header, they need to push header name and header value to
customMimeHeaders array.
Example:
customHeaders.push({name:"header1", _content:"headerValue"});
Note: Header name ("header1" in this case) MUST be one of the valid/allowed values of
zimbraCustomMimeHeaderNameAllowed global-config property (set by admin)
{ZmButtonToolBar}
addSearchDomainItem(icon, label, listener, id)
Adds an item to the search toolbar drop-down. A listener (if specified)
will be called when the item is selected.
appActive(appName, active)
This method gets called each time the "tab" application is opened or closed.
appendExtraSignature(contact, oldMsg)
This method is called by the Zimlet framework when adding a signature to an email message.
To append extra signature information, the zimlet should push text into the bufferArray.push("Have fun, write a Zimlet!");
appLaunch(appName)
This method gets called when the "tab" application is opened for the first time.
{AjxXmlDoc}
applyXslt(xsltUrl, doc)
This method will apply and XSL transformation to an XML document. For example, content
returned from a services call.
{boolean}
checkProperties(props)
This method is called by the zimlet framework prior to user properties being saved.
clicked(spanElement, contentObjText, matchContent, event)
This method is called when a zimlet content object is clicked.
{string}
createApp(label, image, tooltip, index, style)
Creates a "tab" application and registers this zimlet to
receive #appActive and #appLaunch events.
createPropertyEditor(callback)
This method is called if there are
<userProperties> elements specified in the
Zimlet Definition File. When the zimlet panel item is double-clicked, the property
editor will be presented to the user.
This method creates the property editor for the set of Override this method if a custom property editor is required.
displayErrorMessage(msg, data, title)
Displays the specified error message in the standard error dialog.
displayStatusMessage(msg)
Displays the specified status message.
{boolean}
doDrag(zmObject)
This method is called when an item is dragged on the Zimlet drop target
in the panel. This method is only called for the valid types that the
Zimlet accepts as defined by the
<dragSource> Zimlet Definition File XML.
doDrop(zmObject)
This method is called when an item is dropped on the Zimlet in the panel.
doubleClicked(canvas)
This method gets called when a double-click is performed. By default, this method
will create the default property editor for editing user properties.
emailErrorCheck(msg, boolAndErrorMsgArray)
This method is called by the Zimlet framework when a message is about to be sent.
To fail the error check, the zimlet must return a
enableContextMenuItem(contextMenu, menuItemId, enabled)
Enables the specified context menu item.
{string}
getConfigProperty(propertyName)
Gets the configuration property.
{string}
getMessage(msg)
Gets the message property.
{string[]}
getMessages()
Gets the message properties.
getMsgsForConv(callback, conv)
Gets the mail messages for the conversation.
{string}
getResource(resourceName)
Gets the fully qualified resource Url.
{string}
getSearchQuery()
Gets the text field value entered in the search bar.
{DwtShell}
getShell()
Gets the shell for the zimlet.
{string}
getUserID()
Gets the current user id.
{string}
getUsername()
Gets the current username.
{string}
getUserProperty(propertyName)
Gets the user property.
{string}
getUserPropertyInfo(propertyName)
Gets the user property info for the specified property.
{ZimletContext}
getZimletContext()
Gets the zimlet context.
{ZmZimletMgr}
getZimletManager()
Gets the zimlet manager.
init()
This method is called by the Zimlet framework to indicate that
the zimlet it being initialized. This method can be overridden to initialize the zimlet.
initializeToolbar(app, toolbar, controller, viewId)
This method is called by the Zimlet framework when application toolbars are initialized.
{array}
match(content, startIndex)
This method is called when content (e.g. a mail message) is being parsed.
The match method may be called multiple times for a given piece of content and
should apply the pattern matching as defined for a given zimlet
<regex> .
Zimlets should also use the "g" option when constructing their <regex> .
The return should be an array in the form: result[0...n] // should be matched string(s) result.index // should be location within line where match occurred result.input // should be the input parameter content
menuItemSelected(contextMenu, menuItemId, spanElement, contentObjText, canvas)
This method is called when a context menu item is selected.
onAction(type, action, currentViewId, lastViewId)
This method by the Zimlet framework when an application action occurs.
onActionMenuInitialized(controller, actionMenu)
This method gets called by the Zimlet framework when the action menu is initialized
on the subject/fragment of an email message.
This method is called twice:
onContactEdit(view, contact, elementId)
This method is called by the Zimlet framework when a contact is edited.
onContactView(contact, elementId)
This method is called by the Zimlet framework when a contact is clicked-on in the contact list view.
onFindMsgObjects(msg, objMgr)
This method is called by the Zimlet framework when a user clicks-on a message in either the message or conversation view).
onKeyPressSearchField(queryStr)
This method is called by the Zimlet framework when enter is pressed in the search field.
onMailConfirm(confirmView, msg)
This method is called by the Zimlet framework when the message confirmation dialog is presented.
onMailFlagClick(items, on)
This method is called by the Zimlet framework when an email message is flagged.
onMsgView(msg, oldMsg, msgView)
This method is called by the Zimlet framework when a user clicks-on a message in the mail application.
onParticipantActionMenuInitialized(controller, actionMenu)
This method gets called by the Zimlet framework when the action menu is initialized on the from/sender of an email message.
onSearch(queryStr)
This method is called by the Zimlet framework when a search is performed.
onSearchButtonClick(queryStr)
This method is called by the Zimlet framework when the search button is clicked.
onSelectApp(id)
This method by the Zimlet framework when an application button is pressed.
onShowView(view)
This method is called by the Zimlet framework when showing an application view.
onTagAction(items, tag, doTag)
This method is called by the Zimlet framework when an email message is tagged.
portletCreated(portlet)
This method is called by the Zimlet framework when the portlet is created.
portletRefreshed(portlet)
This method is called by the Zimlet framework when the portlet is refreshed.
resetToolbarOperations(parent, enable)
Reset the toolbar
{string}
saveUserProperties(callback)
Saves the user properties.
{Object}
sendRequest(requestStr, serverURL, requestHeaders, callback, useGet, passErrors)
Sends the request content (via Ajax) to the specified server.
setTooltipSticky(sticky, popdown)
This method is called when a sticky tooltip is clicked, when clicking outside
a sticky tooltip, or when a zimlet wants to stick or unstick a tooltip.
To explicitly dismiss a sticky tooltip, this method should be called with parameters (false, true)
setUserProperty(propertyName, value, save, callback)
Sets the value of a given user property
singleClicked(canvas)
This method gets called when a single-click is performed.
{string}
toolTipPoppedDown(spanElement, contentObjText, matchContent, canvas)
This method is called when the tool tip is popping-down.
toolTipPoppedUp(spanElement, contentObjText, matchContent, canvas)
This method is called when the tool tip is popping-up.
{string}
toString()
Returns a string representation of the zimlet.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:39 GMT-0400 (EDT)
|