Class: FilterMenu

FilterMenu

This sample plugin creates a UI which activates on Header Cell dropdown menu click. UI reposition itself below the dropdown menu button

new FilterMenu()

Source:

Extends

Members

<static> EventType :string

Events on Plugin
Type:
  • string
Properties:
Name Type Default Description
APPLY_FILTER string on-apply-filter On apply of filter
CLEAR_FILTER string on-clear-filter on clear of filter
Source:

headerCell_ :pear.plugin.FilterMenuButton

Type:
Source:

Methods

disable(grid)

disable the plugin
Parameters:
Name Type Description
grid pear.ui.Grid
Inherited From:
Source:

disposeInternal()

Source:

enable(grid)

enable the plugin
Parameters:
Name Type Description
grid pear.ui.Grid
Inherited From:
Source:

getClassId()

Source:

getCSSClassName() → {string}

Source:
Returns:
Type
string

getElement() → {Element}

get root element
Source:
Returns:
Type
Element

getGrid() → {pear.ui.Grid}

Get Instance of Grid , on which this plugin is registered
Inherited From:
Source:
Returns:
Type
pear.ui.Grid

getHeaderMenuButtons() → {?Array.<pear.plugin.FilterMenuButton>}

Get the list of header menu button
Source:
Returns:
Type
?Array.<pear.plugin.FilterMenuButton>

getLabelInput() → {goog.ui.LabelInput}

get the label input for Filter UI
Source:
Returns:
Type
goog.ui.LabelInput

init()

init
Source:

isEnabled(gridObject) → {boolean}

Is plugin enabled ?
Parameters:
Name Type Description
gridObject pear.ui.Grid
Inherited From:
Source:
Returns:
Type
boolean

registerGrid(grid)

Parameters:
Name Type Description
grid pear.ui.Grid
Inherited From:
Source:

unregisterGrid(grid)

disabling the plugin from the grid , this will call disable on the Plugin
Parameters:
Name Type Description
grid pear.ui.Grid
Inherited From:
Source: