Zimlet JavaScript API Reference - ZmConvView2

Class ZmConvView2


Extends ZmMailItemView.

This class displays and manages a conversation.

Defined in: ZmConvView2.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmConvView2(id, controller)
Creates a view that will later display one conversation at a time.
Method Summary
Method Attributes Method Name and Description
 
getExpanded(expanded)
Returns a list of IDs for msg views whose expanded state matches the given one.
 
getLoaded(loaded)
Returns a list of IDs for msg views whose msg's loaded state matches the given one.
 
getMsgViewIndex(msgView)
Returns the index of the given msg view within the other msg views.
 
is the user actively focused on the quick reply? This is used from ZmConvListController.prototype.getKeyMapName to determine what key mapping we should use
 
renderObjects(view, content, htmlEncode)
Creates an object manager and returns findObjects content
 
set(conv)
Displays the given conversation.
 
setExpanded(expanded, force)
Expands or collapses the conv view as a whole by expanding or collapsing each of its message views.
Methods borrowed from class ZmMailItemView:
getItem
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
ZmConvView2(id, controller)
Creates a view that will later display one conversation at a time.
Author: Conrad Damon.
Parameters:
{string} id
ID for HTML element
{ZmConvListController} controller
containing controller
Method Detail
getExpanded(expanded)
Returns a list of IDs for msg views whose expanded state matches the given one.
Parameters:
{boolean} expanded
if true, look for expanded msg views

getLoaded(loaded)
Returns a list of IDs for msg views whose msg's loaded state matches the given one.
Parameters:
{boolean} loaded
if true, look for msg views whose msg has been loaded

{int} getMsgViewIndex(msgView)
Returns the index of the given msg view within the other msg views.
Parameters:
{ZmMailMsgCapsuleView} msgView
Returns:
{int}

isActiveQuickReply()
is the user actively focused on the quick reply? This is used from ZmConvListController.prototype.getKeyMapName to determine what key mapping we should use

renderObjects(view, content, htmlEncode)
Creates an object manager and returns findObjects content
Parameters:
view
{Object} the view used by ZmObjectManager to set mouse events
content
{String} content to scan
htmlEncode
{boolean}

set(conv)
Displays the given conversation.
Parameters:
{ZmConv} conv
the conversation to display

setExpanded(expanded, force)
Expands or collapses the conv view as a whole by expanding or collapsing each of its message views. If at least one message view is collapsed, then expansion is done.
Parameters:
{boolean} expanded
if true, expand message views; otherwise, collapse them
{boolean} force
if true, do not check for unsent quick reply content

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