live_search.js

Summary
live_search.js
bbop.widget.display.live_searchAmiGO object to draw various UI elements that have to do with things dealing with a fully faceted searcher/browser.
Functions
live_searchContructor for the bbop.widget.display.live_search object.
setup_querySetup the free text query display under contructed tags for later population.
setup_global_reset_buttonAdd a bit of a place for the global reset button.
setup_current_filtersSetup current filters display under contructed tags for later population.
setup_accordionSetup the accordion skeleton under contructed tags for later population.
setup_resultsSetup basic results table using the class conf.
draw_metaDraw meta results.
reset_querySetup and draw the query widget.
reset_global_reset_buttonAdd events and redraw to the global reset button section.
draw_current_filters(Re)draw the information in the current filter set.
draw_accordion(Re)draw the information in the accordion controls/filters.
draw_resultsDraw results using hints from the golr class configuration.
draw_errorSomehow report an error to the user.

bbop.widget.display.live_search

AmiGO object to draw various UI elements that have to do with things dealing with a fully faceted searcher/browser.

It is probably not particularly useful directly, but rather used as the framework for more specialized interfaces.

See Also

search_pane.js

Summary
Functions
live_searchContructor for the bbop.widget.display.live_search object.
setup_querySetup the free text query display under contructed tags for later population.
setup_global_reset_buttonAdd a bit of a place for the global reset button.
setup_current_filtersSetup current filters display under contructed tags for later population.
setup_accordionSetup the accordion skeleton under contructed tags for later population.
setup_resultsSetup basic results table using the class conf.
draw_metaDraw meta results.
reset_querySetup and draw the query widget.
reset_global_reset_buttonAdd events and redraw to the global reset button section.
draw_current_filters(Re)draw the information in the current filter set.
draw_accordion(Re)draw the information in the accordion controls/filters.
draw_resultsDraw results using hints from the golr class configuration.
draw_errorSomehow report an error to the user.

Functions

live_search

bbop.widget.display.live_search = function (interface_id,
conf_class)

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

Arguments

interface_idstring id of the div to build on
conf_classbbop.golr.conf_class for hints and other settings

Returns

BBOP GOlr UI object

setup_query

this.setup_query = function(label_str)

Setup the free text query display under contructed tags for later population.

Parameters

label_str[optional] string or bbop.html for input label

Returns

n/a

setup_global_reset_button

this.setup_global_reset_button = function()

Add a bit of a place for the global reset button.

Parameters

n/a

Returns

n/a

setup_current_filters

this.setup_current_filters = function()

Setup current filters display under contructed tags for later population.  The seeding information is coming in through the GOlr conf class.

Add in the filter state up here.

Parameters

n/a

Returns

n/a

setup_accordion

this.setup_accordion = function()

Setup the accordion skeleton under contructed tags for later population.  The seeding information is coming in through the GOlr conf class.  Start building the accordion here.  Not an updatable part.

Parameters

n/a

Returns

n/a

setup_results

this.setup_results = function(args)

Setup basic results table using the class conf.  For actual results rendering, see .draw_results.  While there is a meta block supplied, its use is optional.

Parameters

hash; the only option is {‘meta’: true}.

Returns

n/a

draw_meta

this.draw_meta = function(json_data,
manager)

Draw meta results.  TODO: paging, etc.

Parameters

json_datathe raw returned JSON response from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

reset_query

this.reset_query = function(json_data,
manager)

Setup and draw the query widget.  This function makes it active as well.

Due to the nature of this, it is only reset when called.

Parameters

json_datathe raw returned JSON response from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

reset_global_reset_button

this.reset_global_reset_button = function(json_data,
manager)

Add events and redraw to the global reset button section.

Parameters

n/a

Returns

n/a

draw_current_filters

this.draw_current_filters = function(json_data,
manager)

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

Parameters

json_datathe raw returned JSON response from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

draw_accordion

this.draw_accordion = function(json_data,
manager)

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

Parameters

json_datathe raw returned JSON response from the server
managerbbop.golr.manager that we initially registered with

Returns

n/a

draw_results

this.draw_results = function(json_data,
manager)

Draw results using hints from the golr class configuration.

Parameters

json_datathe raw returned JSON response 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.display.live_search = function (interface_id,
conf_class)
Contructor for the bbop.widget.display.live_search object.
this.setup_query = function(label_str)
Setup the free text query display under contructed tags for later population.
this.setup_global_reset_button = function()
Add a bit of a place for the global reset button.
this.setup_current_filters = function()
Setup current filters display under contructed tags for later population.
this.setup_accordion = function()
Setup the accordion skeleton under contructed tags for later population.
this.setup_results = function(args)
Setup basic results table using the class conf.
this.draw_meta = function(json_data,
manager)
Draw meta results.
this.reset_query = function(json_data,
manager)
Setup and draw the query widget.
this.reset_global_reset_button = function(json_data,
manager)
Add events and redraw to the global reset button section.
this.draw_current_filters = function(json_data,
manager)
(Re)draw the information in the current filter set.
this.draw_accordion = function(json_data,
manager)
(Re)draw the information in the accordion controls/filters.
this.draw_results = function(json_data,
manager)
Draw results using hints from the golr class configuration.
this.draw_error = function(error_message,
manager)
Somehow report an error to the user.
Generic BBOP manager for dealing with gross GOlr configuration and management.
Close