Zimlet JavaScript API Reference - ZmFilterRulesController

Class ZmFilterRulesController


Extends ZmController.

This class represents the filter rules controller. This controller manages the filter rules page, which has a button toolbar and a list view of the rules.

Defined in: ZmFilterRulesController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmFilterRulesController(container, prefsApp, prefsView, parent, outgoing)
Creates a new, empty filter rules controller.
Method Summary
Method Attributes Method Name and Description
 
Gets the action menu.
 
Gets the filter rules view, which is comprised of a toolbar and a list view.
 
initialize(toolbar, listView, listView)
Initializes the controller.
 
The "Move Down" button has been pressed.
 
The "Move Up" button has been pressed.
 
runFilter(container, filterSel, isOutgoing)
runs a specified list of filters
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getTabGroup, getViewElements, handleKeyAction, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType, setSessionId
Class Detail
ZmFilterRulesController(container, prefsApp, prefsView, parent, outgoing)
Creates a new, empty filter rules controller.
Author: Conrad Damon.
Parameters:
{DwtShell} container
the shell
{ZmPreferencesApp} prefsApp
the preferences application
prefsView
parent
outgoing
Method Detail
{ZmActionMenu} getActionMenu()
Gets the action menu.
Returns:
{ZmActionMenu} the action menu

{ZmFilterRulesView} getFilterRulesView()
Gets the filter rules view, which is comprised of a toolbar and a list view.
Returns:
{ZmFilterRulesView} the filter rules view

initialize(toolbar, listView, listView)
Initializes the controller.
Parameters:
{ZmToolBar} toolbar
the toolbar
{ZmListView} listView
active list view
{ZmListView} listView
not active list view

moveDownListener(ev)
The "Move Down" button has been pressed.
Parameters:
ev

moveUpListener(ev)
The "Move Up" button has been pressed.
Parameters:
ev
[DwtEvent] the click event

runFilter(container, filterSel, isOutgoing)
runs a specified list of filters
Parameters:
container
{DwtControl} container reference
filterSel
{Array} array of ZmFilterRule
isOutgoing
{Boolean}

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