filter_shield.js

Summary

filter_shield.js
bbop.widget.display.filter_shield	BBOP object to produce a self-constructing/self-destructing shield to support very large filter selection in the live search/search pane genre.
Functions
filter_shield	Contructor for the bbop.widget.display.filter_shield object.
start_wait	Render an unpopulated modal shield with some kind of waiting element.
draw	Render a temporary modal filter shield.

bbop.widget.display.filter_shield

BBOP object to produce a self-constructing/self-destructing shield to support very large filter selection in the live search/search pane genre.

Summary

Functions
filter_shield	Contructor for the bbop.widget.display.filter_shield object.
start_wait	Render an unpopulated modal shield with some kind of waiting element.
draw	Render a temporary modal filter shield.

Functions

filter_shield

bbop.widget.display.filter_shield = function( spinner_img_src,
wait_msg )

Contructor for the bbop.widget.display.filter_shield object.

Support for bbop.widget.search_pane by way of bbop.widget.display.live_search

Arguments

spinner_img_src	[optional] optional source of a spinner image to use
wait_msg	[optional] the wait message to use; may be a string or bbop.html; defaults to “Waiting...”

Returns

self

start_wait

this.start_wait = function()

Render an unpopulated modal shield with some kind of waiting element. This is to act as a block for the IO if desired--calling this before .draw() is not required (as .draw() will call it anyways if you haven’t).

Arguments

n/a

Returns

n/a

draw

this.draw = function( field_name,
filter_list,
manager )

Render a temporary modal filter shield.

Arguments

field_name	the name (id) of the filter field to display
filter_list	a list of [[filter_id, filter_count], ...]
manager	the manager that we’ll use for the callbacks

Returns

n/a