Zimlet JavaScript API Reference - ZmContactPicker

Class ZmContactPicker


Extends DwtDialog.

This class creates and manages a dialog that lets the user select addresses from a contact list. Two lists are maintained, one with contacts to select from, and one that contains the selected addresses. Between them are buttons to shuffle addresses back and forth between the two lists.

Defined in: ZmContactPicker.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmContactPicker(buttonInfo)
Creates a dialog that lets the user select addresses from a contact list.
Method Summary
Method Attributes Method Name and Description
 
Gets a sub-list of contacts.
 
Closes the dialog.
 
popup(buttonId, addrs, str, account)
Displays the contact picker dialog.
Methods borrowed from class DwtDialog:
associateEnterWithButton, getButton, getButtonEnabled, registerCallback, resetButtonStates, setButtonEnabled, setButtonListener, setButtonVisible, setEnterListener, unregisterCallback
Methods borrowed from class DwtBaseDialog:
addEnterListener, addPopdownListener, addPopupListener, cleanup, isPoppedUp, removePopdownListener, removePopupListener, reset, setContent, setTitle, setView
Methods borrowed from class DwtComposite:
addChild, cleanupSeparators, clear, dispose, getChild, getChildren, getNumChildren, getTabGroupMember, removeChild, removeChildren
Methods borrowed from class DwtControl:
addClassName, addControlListener, addDisposeListener, addListener, appendElement, blur, clearContent, clearHandler, condClassName, delClassName, focus, getBounds, getClassName, getContent, getCursor, getData, getDragBox, getDragSource, getDropTarget, getEnabled, getFocusElement, getH, getHtmlElement, getHTMLElId, getInsetBounds, getInsets, getLocation, getMargins, getOpacity, getOuterSize, getPosition, getScrollContainer, getScrollStyle, getSize, getTooltipBase, getToolTipContent, getVisibility, getVisible, getW, getX, getXW, getY, getYH, getZIndex, hasFocus, isAlertShown, isDisposed, isInitialized, isListenerRegistered, notifyListeners, preventContextMenu, preventSelection, removeAllListeners, removeControlListener, removeDisposeListener, removeListener, reparent, reparentHtmlElement, replaceElement, setBounds, setClassName, setCursor, setData, setDisplay, setDisplayState, setDragBox, setDragSource, setDropTarget, setEnabled, setEventPropagation, setFocusElement, setHandler, setHtmlElementId, setLocation, setOpacity, setPosition, setScrollStyle, setSize, setToolTipContent, setVisibility, setVisible, setZIndex, showAlert, zShow
Class Detail
ZmContactPicker(buttonInfo)
Creates a dialog that lets the user select addresses from a contact list.
Author: Conrad Damon.
Parameters:
{Array} buttonInfo
the transfer button IDs and labels
Method Detail
{AjxVector} getSubList()
Gets a sub-list of contacts.
Returns:
{AjxVector} a vector of {ZmContact} objects

popdown()
Closes the dialog.

popup(buttonId, addrs, str, account)
Displays the contact picker dialog. The source list is populated with contacts, and the target list is populated with any addresses that are passed in. The address button that was used to popup the dialog is set as the active button.
Parameters:
{String} buttonId
the button ID of the button that called us
{Hash} addrs
a hash of 3 vectors (one for each type of address)
{String} str
initial search string
account

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:31 GMT-0400 (EDT)