Zimlet JavaScript API Reference - ZmSearchResultsToolBar

Class ZmSearchResultsToolBar


Extends ZmSearchToolBar.

This class represents a search toolbar that shows up above search results. It can be used to refine the search results. Each search term is contained within a bubble that can easily be removed.

Defined in: ZmSearchResultsToolBar.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmSearchResultsToolBar(params, parent, id)
Method Summary
Method Attributes Method Name and Description
 
addSearchTerm(term, skipNotify, addingCond)
Adds a bubble for the given search term.
 
removeSearchTerm(term, skipNotify)
Removes the bubble with the given search term.
Methods borrowed from class ZmSearchToolBar:
initAutocomplete, removeMenuItem
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
ZmSearchResultsToolBar(params, parent, id)

Author: Conrad Damon.
Parameters:
{hash} params
a hash of parameters:
{DwtComposite} parent
the parent widget
{string} id
an explicit ID to use for the control's HTML element
Method Detail
addSearchTerm(term, skipNotify, addingCond)
Adds a bubble for the given search term.
Parameters:
{ZmSearchToken} term
search term
{boolean} skipNotify
if true, don't trigger a search
{boolean} addingCond
if true, user clicked to add a conditional term

removeSearchTerm(term, skipNotify)
Removes the bubble with the given search term.
Parameters:
{ZmSearchToken|string} term
search term or bubble ID
{boolean} skipNotify
if true, don't trigger a search

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