Zimlet JavaScript API Reference - ZmAddressBubbleList

Class ZmAddressBubbleList


This class manages selection events (click, double-click, and right-click) of a collection of bubbles, since those events are typically meaningful within a group of bubbles. It maintains the visual state of the bubble and notifies any listeners of the selection events.

Defined in: ZmAddressInputField.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmAddressBubbleList(params, parent, normalClass, selClass, rightSelClass)
Creates an empty bubble list.
Method Summary
Method Attributes Method Name and Description
 
Adds an action listener.
 
Adds a selection listener.
 
getSelection(bubble)
Returns a list of the currently selected bubbles.
 
Removes an action listener.
 
Removes a selection listener.
 
setSelected(bubble, selected)
Sets selection of the given bubble.
Class Detail
ZmAddressBubbleList(params, parent, normalClass, selClass, rightSelClass)
Creates an empty bubble list.
Parameters:
{hash} params
hash of params:
{ZmAddressInputField} parent
parent
{string} normalClass
class for an unselected bubble
{string} selClass
class for a selected bubble
{string} rightSelClass
class for a right-clicked bubble
Method Detail
addActionListener(listener)
Adds an action listener.
Parameters:
{AjxListener} listener
the listener

addSelectionListener(listener)
Adds a selection listener.
Parameters:
{AjxListener} listener
the listener

getSelection(bubble)
Returns a list of the currently selected bubbles. If a bubble has been selected via right-click, but is not part of the current left-click selection, only it will be returned.
Parameters:
{ZmAddressBubble} bubble
reference bubble

removeActionListener(listener)
Removes an action listener.
Parameters:
{AjxListener} listener
the listener

removeSelectionListener(listener)
Removes a selection listener.
Parameters:
{AjxListener} listener
the listener

setSelected(bubble, selected)
Sets selection of the given bubble.
Parameters:
{ZmAddressBubble} bubble
bubble to select
{boolean} selected
if true, select the bubble, otherwise deselect it

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