Class Index | File Index

Classes


Class AjaxSolr.AbstractTextWidget


Extends AjaxSolr.AbstractWidget.
AbstractTextWidget
Defined in: AbstractTextWidget.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Baseclass for all free-text widgets.
Method Summary
Method Attributes Method Name and Description
 
An abstract hook for child implementations.
 
changeSelection(Selection)
Helper for selection functions.
 
Sets the main Solr query to the empty string.
 
clickHandler(value)
Returns a function to set the main Solr query.
 
constructor(attributes)
 
set(q)
Sets the main Solr query to the given string.
 
Returns a function to unset the main Solr query.
Methods borrowed from class AjaxSolr.AbstractWidget:
afterRequest, beforeRequest, doRequest, init
Class Detail
AjaxSolr.AbstractTextWidget()
Baseclass for all free-text widgets.
Method Detail
afterChangeSelection(value)
An abstract hook for child implementations.

This method is executed after the main Solr query changes.

Parameters:
{String} value
The current main Solr query.

{Boolean} changeSelection(Selection)
Helper for selection functions.
Parameters:
{Function} Selection
function to call.
Returns:
{Boolean} Whether the selection changed.

{Boolean} clear()
Sets the main Solr query to the empty string.
Returns:
{Boolean} Whether the selection changed.

{Function} clickHandler(value)
Returns a function to set the main Solr query.
Parameters:
{String} value
The new Solr query.
Returns:
{Function}

constructor(attributes)
Parameters:
{Object} attributes Optional
{Number} attributes.start Optional
This widget will by default set the offset parameter to 0 on each request.

{Boolean} set(q)
Sets the main Solr query to the given string.
Parameters:
{String} q
The new Solr query.
Returns:
{Boolean} Whether the selection changed.

{Function} unclickHandler()
Returns a function to unset the main Solr query.
Returns:
{Function}

Documentation generated by JsDoc Toolkit 2.3.0 on Mon Apr 29 2013 14:55:20 GMT-0400 (EDT)