Zimlet JavaScript API Reference - ZmSearchToolBar

Class ZmSearchToolBar


Extends DwtComposite.

This class represent a search toolbar. The components are some set of: an input field, a search button, a save button, and a button to choose what type of item to search for.

Defined in: ZmSearchToolBar.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmSearchToolBar(params, parent, id)
Method Summary
Method Attributes Method Name and Description
<static>  
ZmSearchToolBar.addMenuItem(id, params)
Defines a menu item to add when the types menu is created.
 
Initializes search autocomplete.
 
Removes a menu item from the types menu.
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
ZmSearchToolBar(params, parent, id)
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
<static> ZmSearchToolBar.addMenuItem(id, params)
Defines a menu item to add when the types menu is created. Static so that it can be called before the toolbar has been created.
Parameters:
{string} id
ID of menu item
{hash} params
menu item properties

initAutocomplete()
Initializes search autocomplete.

removeMenuItem(id)
Removes a menu item from the types menu.
Parameters:
{string} id
ID of menu item

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