live_results.js

Summary
live_results.js
bbop.widget.live_resultsBBOP JS widget to display the results of a search on callback.
Functions
live_resultsContructor for the bbop.widget.live_results object.
item_nameReturn a string of the name attribute used by the checkboxes if we selected for checkboxes to be displayed.
toggle_idReturn a string of the id of the checkbox in the header if we selected for checkboxes to be displayed.
get_selected_itemsThe idea is to return a list of the items selected (with checkboxes) in the display.

bbop.widget.live_results

BBOP JS widget to display the results of a search on callback.

TODO: Button insertion in other non-internal places.

This is a Bootstrap 3 widget.

Summary
Functions
live_resultsContructor for the bbop.widget.live_results object.
item_nameReturn a string of the name attribute used by the checkboxes if we selected for checkboxes to be displayed.
toggle_idReturn a string of the id of the checkbox in the header if we selected for checkboxes to be displayed.
get_selected_itemsThe idea is to return a list of the items selected (with checkboxes) in the display.

Functions

live_results

bbop.widget.live_results = function(interface_id,
manager,
conf_class,
handler,
linker,
in_argument_hash)

Contructor for the bbop.widget.live_results object.

Results table and optional buttons.

Optional options looks like

callback_prioritydefault 0
user_buttonsdefault [], should be any passable renderable button
user_buttons_div_iddefault null
selectable_phave selectable side buttons (default true)

Arguments

interface_idstring id of the element to build on
managerthe shared GOlr manager to use
conf_classthe profile of the specific conf to use
handlerhandler to use in rendering
linkerlinker to use in rendering
in_argument_hash[optional] optional hash of optional arguments, described above

Returns

this object

item_name

this.item_name = function()

Return a string of the name attribute used by the checkboxes if we selected for checkboxes to be displayed.

Parameters

n/a

Returns

string or null if displaying checkboxes was false

toggle_id

this.toggle_id = function()

Return a string of the id of the checkbox in the header if we selected for checkboxes to be displayed.

Parameters

n/a

Returns

string or null if displaying checkboxes was false

get_selected_items

this.get_selected_items = function()

The idea is to return a list of the items selected (with checkboxes) in the display.  This means that there are three possibilities.  1) We are not using checkboxes or the display has not been established, so we return null; 2) no or all items have been selected, so we get back an empty list (all == none in our view); 3) a subset list of strings (ids).

NOTE: Naturally, does not function until the display is established.

Parameters

n/a

Returns string list or null

bbop.widget.live_results = function(interface_id,
manager,
conf_class,
handler,
linker,
in_argument_hash)
Contructor for the bbop.widget.live_results object.
this.item_name = function()
Return a string of the name attribute used by the checkboxes if we selected for checkboxes to be displayed.
this.toggle_id = function()
Return a string of the id of the checkbox in the header if we selected for checkboxes to be displayed.
this.get_selected_items = function()
The idea is to return a list of the items selected (with checkboxes) in the display.
Close