Zimlet JavaScript API Reference - ZmSearchResultsFilterPanel

Class ZmSearchResultsFilterPanel


This class represents a panel used to modify the current search.

Defined in: ZmSearchResultsFilterPanel.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmSearchResultsFilterPanel(params, parent, controller, resultsApp)
Method Summary
Method Attributes Method Name and Description
 
Resets the filter panel by unchecking the basic filter checkboxes.
 
update(id, newTerms, noPopdown)
Updates the current search with the given search term.
Class Detail
ZmSearchResultsFilterPanel(params, parent, controller, resultsApp)
Parameters:
{hash} params
a hash of parameters:
{DwtComposite} parent
parent widget
{ZmController} controller
search results controller
{constant} resultsApp
name of app corresponding to type of results TODO: Add change listeners to update filters as necessary, eg folders and tags.
Method Detail
reset()
Resets the filter panel by unchecking the basic filter checkboxes.

update(id, newTerms, noPopdown)
Updates the current search with the given search term. A check is done to see if any of the current search terms should be removed first. Some search operators should only appear once in a query (eg "in"), and some conflict with others (eg "is:read" and "is:unread").
Parameters:
{string} id
filter ID
{ZmSearchToken} newTerms
search term(s)
{boolean} noPopdown
if true, don't popdown menu after update

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