live_filters.js

Summary
live_filters.js
bbop.widget.live_filtersBBOP JS object to allow the live probing of a GOlr personality.
Functions
live_filtersContructor for the bbop.widget.live_filters object.
spin_upTurn on the spinner.
spin_downTurn off the spinner.
establish_displayCompletely redraw the display.
draw_metaDraw meta results.
draw_queryDraw the query widget.
draw_accordion(Re)draw the information in the accordion controls/filters.
draw_current_filters(Re)draw the information on the current filter set.
draw_sticky_filters(Re)draw the information on the sticky filter set.
draw_errorSomehow report an error to the user.

bbop.widget.live_filters

BBOP JS object to allow the live probing of a GOlr personality.

Very much like a separated accordion and filter from the search pane.

This is a Bootstrap 3 widget.

See Also

search_pane.js live_search.js

Summary
Functions
live_filtersContructor for the bbop.widget.live_filters object.
spin_upTurn on the spinner.
spin_downTurn off the spinner.
establish_displayCompletely redraw the display.
draw_metaDraw meta results.
draw_queryDraw the query widget.
draw_accordion(Re)draw the information in the accordion controls/filters.
draw_current_filters(Re)draw the information on the current filter set.
draw_sticky_filters(Re)draw the information on the sticky filter set.
draw_errorSomehow report an error to the user.

Functions

live_filters

bbop.widget.live_filters = function(interface_id,
manager,
golr_conf_obj,
in_argument_hash)

Contructor for the bbop.widget.live_filters object.

Widget interface to interactively explore a search personality with no direct side effects.

Arguments

interface_idstring id of the element to build on
managerthe shared GOlr manager to use
golr_conf_objthe profile of the specific
in_argument_hash[optional] optional hash of optional arguments

Returns

this object

spin_up

this.spin_up = function()

Turn on the spinner.

Parameters

n/a

Returns n/a

spin_down

this.spin_down = function()

Turn off the spinner.

Parameters

n/a

Returns n/a

establish_display

this.establish_display = function()

Completely redraw the display.

Required to display after setting up the manager.

Also may be useful after a major change to the manager to reset it.

Parameters

n/a

Returns n/a

draw_meta

this.draw_meta = function(response,
manager)

Draw meta results.  Includes selector for drop down.

(Re)draw the count control with the current information in the manager.  This also tries to set the selector to the response number (to keep things in sync), unbinds any current “change” event, and adds a new change event.

Parameters

responsethe bbop.golr.response returned from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

draw_query

this.draw_query = function(response,
manager)

Draw the query widget.  This function makes it active as well.

Clicking the reset button will reset the query to ‘’.

NOTE: Since this is part of the “persistant” interface (i.e. it does not get wiped after every call), we make sure to clear the event listeners when we redraw the function to prevent them from building up.

Parameters

responsethe bbop.golr.response returned from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

draw_accordion

this.draw_accordion = function(response,
manager)

(Re)draw the information in the accordion controls/filters.  This function makes them active as well.

Parameters

responsethe bbop.golr.response returned from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

draw_current_filters

this.draw_current_filters = function(response,
manager)

(Re)draw the information on the current filter set.  This function makes them active as well.

Parameters

responsethe bbop.golr.response returned from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

draw_sticky_filters

this.draw_sticky_filters = function(response,
manager)

(Re)draw the information on the sticky filter set.

Parameters

responsethe bbop.golr.response returned from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

draw_error

this.draw_error = function(error_message,
manager)

Somehow report an error to the user.

Parameters

error_messagea string(?) describing the error
managerbbop.golr.manager that we initially registered with

Returns

n/a

bbop.widget.live_filters = function(interface_id,
manager,
golr_conf_obj,
in_argument_hash)
Contructor for the bbop.widget.live_filters object.
this.spin_up = function()
Turn on the spinner.
this.spin_down = function()
Turn off the spinner.
this.establish_display = function()
Completely redraw the display.
this.draw_meta = function(response,
manager)
Draw meta results.
this.draw_query = function(response,
manager)
Draw the query widget.
this.draw_accordion = function(response,
manager)
(Re)draw the information in the accordion controls/filters.
this.draw_current_filters = function(response,
manager)
(Re)draw the information on the current filter set.
this.draw_sticky_filters = function(response,
manager)
(Re)draw the information on the sticky filter set.
this.draw_error = function(error_message,
manager)
Somehow report an error to the user.
Generic BBOP handler for dealing with the gross parsing of responses from a GOlr server (whereas golr_conf deals with the reported configuration).
Generic BBOP manager for dealing with gross GOlr configuration and management.
Close