Class AjaxSolr.AbstractWidget
AbstractWidget
Defined in: AbstractWidget.js.
Constructor Attributes | Constructor Name and Description |
---|---|
AjaxSolr.AbstractWidget(properties)
Baseclass for all widgets.
|
Method Attributes | Method Name and Description |
---|---|
An abstract hook for child implementations.
|
|
An abstract hook for child implementations.
|
|
constructor(attributes)
|
|
doRequest(start, servlet)
A proxy to the manager's doRequest method.
|
|
init()
An abstract hook for child implementations.
|
Class Detail
AjaxSolr.AbstractWidget(properties)
Baseclass for all widgets.
Provides abstract hooks for child classes.
- Parameters:
- properties
- A map of fields to set. May be new or public fields.
Method Detail
afterRequest()
An abstract hook for child implementations.
This method is executed after the Solr response is received.
beforeRequest()
An abstract hook for child implementations.
This method is executed before the Solr request is sent.
constructor(attributes)
- Parameters:
- {Object} attributes
- {String} attributes.id
- A unique identifier of this widget.
- {String} attributes.target Optional
- The CSS selector for this widget's target HTML element, e.g. a specific div or ul. A Widget is usually implemented to perform all its UI changes relative to its target HTML element.
- {Number} attributes.start Optional
- The offset parameter. Set this field to make the widget reset the offset parameter to the given value on each request.
- {String} attributes.servlet Optional
- The Solr servlet for this widget. You may prepend the servlet with a core if using multiple cores. If none is set, it will default to the manager's servlet.
doRequest(start, servlet)
A proxy to the manager's doRequest method.
- Parameters:
- {Boolean} start Optional
- The Solr start offset parameter.
- {String} servlet Optional
- The Solr servlet to send the request to.
init()
An abstract hook for child implementations.
This method should do any necessary one-time initializations.