Zimlet JavaScript API Reference - ZmContactAlphabetBar

Class ZmContactAlphabetBar


Extends DwtComposite.

This class represents the contact alphabet bar.

Defined in: ZmContactsBaseView.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates the alphabet bar.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmContactAlphabetBar.alphabetClicked(cell, letter, endLetter)
Sets the cell as selected and performs a new search based on the selection.
 
enable(enable)
Enables the bar.
 
Checks if the bar is enabled.
 
Gets the current cell.
 
Gets the current cell letter.
 
determine if contact belongs in the current alphabet bar.
 
reset(useCell)
Resets the bar.
 
Sets the button index.
 
setSelected(cell, selected)
Sets the cell as selected.
 
Returns a string representation of the object.
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, setContent, 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
ZmContactAlphabetBar(parent)
Creates the alphabet bar.
Parameters:
{DwtComposite} parent
the parent
Method Detail
<static> ZmContactAlphabetBar.alphabetClicked(cell, letter, endLetter)
Sets the cell as selected and performs a new search based on the selection.
Parameters:
{Object} cell
the cell
{String} letter
the letter to begin the search with
{String} endLetter
the letter to end the search with

enable(enable)
Enables the bar.
Parameters:
{Boolean} enable
if true, enable the bar

{Boolean} enabled()
Checks if the bar is enabled.
Returns:
{Boolean} true if enabled

{Object} getCurrent()
Gets the current cell.
Returns:
{Object} the cell

{String} getCurrentLetter()
Gets the current cell letter.
Returns:
{String} the cell letter, or null for "all"

{boolean} isItemInAlphabetLetter(item)
determine if contact belongs in the current alphabet bar. Used when creating a new contact and not doing a reload -- such as new contact group from action menu.
Parameters:
item
{ZmContact}
Returns:
{boolean} true/false if item belongs in alphabet selection

{Boolean} reset(useCell)
Resets the bar.
Parameters:
{Object} useCell
the cell or null
Returns:
{Boolean} Whether the cell was changed (false if it was already set to useCell)

setButtonByIndex(index)
Sets the button index.
Parameters:
{int} index
the index

setSelected(cell, selected)
Sets the cell as selected.
Parameters:
{Object} cell
the cell
{Boolean} selected
if true, set as selected

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

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