Class ZmAddressBubble
Extends
DwtControl.
This class represents an object that allows various operations to be performed on an
email address within a compose or display context.
Defined in: ZmAddressInputField.js.
Class Summary
Constructor Attributes |
Constructor Name and Description |
|
ZmAddressBubble(params, parent, id, className, address, addrObj, canRemove, canExpand, separator)
Creates a bubble that contains an email address.
|
Method Summary
Method Attributes |
Method Name and Description |
|
Adds a selection listener.
|
<static> |
Expands the distribution list address of the bubble with the given ID.
|
<static> |
ZmAddressBubble. getContent(params, parent, id, className, address, addrObj, canRemove, canExpand, noParse)
Returns HTML for the content of a bubble.
|
|
Gets the key map name.
|
|
Gets the tool tip content.
|
|
Handles a key action event.
|
|
Removes a selection listener.
|
- Methods borrowed from class DwtControl:
- addClassName, addControlListener, addDisposeListener, addListener, appendElement, blur, clearContent, clearHandler, condClassName, delClassName, dispose, focus, getBounds, getClassName, getCursor, getData, getDragBox, getDragSource, getDropTarget, getEnabled, getFocusElement, getH, getHtmlElement, getHTMLElId, getInsetBounds, getInsets, getLocation, getMargins, getOpacity, getOuterSize, getPosition, getScrollContainer, getScrollStyle, getSize, getTabGroupMember, getTooltipBase, 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
ZmAddressBubble(params, parent, id, className, address, addrObj, canRemove, canExpand, separator)
Creates a bubble that contains an email address.
- Parameters:
-
{hash} params
- the hash of parameters:
-
{ZmAddressInputField} parent
- parent control
-
{string} id
- element ID for the bubble
-
{string} className
- CSS class for the bubble
-
{string} address
- email address to display in the bubble
-
{AjxEmailAddress} addrObj
- email address (alternative form)
-
{boolean} canRemove
- if true, an x will be provided to remove the address bubble
-
{boolean} canExpand
- if true, a + will be provided to expand the DL address
-
{string} separator
- address separator
Method Detail
addSelectionListener(listener)
Adds a selection listener.
- Parameters:
-
{AjxListener} listener
- the listener
<static>
ZmAddressBubble.expandBubble(bubbleId, email)
Expands the distribution list address of the bubble with the given ID.
- Parameters:
-
{string} bubbleId
- ID of bubble
-
{string} email
- address to expand
<static>
ZmAddressBubble.getContent(params, parent, id, className, address, addrObj, canRemove, canExpand, noParse)
Returns HTML for the content of a bubble.
- Parameters:
-
{hash} params
- the hash of parameters:
-
{ZmAddressInputField} parent
- parent control
-
{string} id
- element ID for the bubble
-
{string} className
- CSS class for the bubble
-
{string} address
- email address to display in the bubble
-
{AjxEmailAddress} addrObj
- email address (alternative form)
-
{boolean} canRemove
- if true, an x will be provided to remove the address bubble
-
{boolean} canExpand
- if true, a + will be provided to expand the DL address
-
{boolean} noParse
- if true, do not parse content to see if it is an address
{string}
getKeyMapName()
Gets the key map name.
- Returns:
- {string} the key map name
{String}
getToolTipContent(ev)
Gets the tool tip content.
- Parameters:
-
{Object} ev
- the hover event
- Returns:
- {String} the tool tip content
{boolean}
handleKeyAction(actionCode, ev)
Handles a key action event.
- Parameters:
-
{constant} actionCode
- the action code (see DwtKeyMap)
-
{DwtEvent} ev
- the event
- Returns:
- {boolean}
true if the event is handled; false otherwise
- See:
- DwtKeyMap
removeSelectionListener(listener)
Removes a selection listener.
- Parameters:
-
{AjxListener} listener
- the listener
|