bbbfly-cjs-controls

Index Files Packages Globals

bbbfly. SearchEdit class control

new bbbfly.SearchEdit (def, ref, parent)

base/search.js, line 461

Parameters

Name Type Description
def bbbfly.SearchEdit.Definition optional Descendant definition
ref object optional Reference owner
parent object | string optional Parent DIV element or it's ID

Properties

Name Type Default Description
HintMessages object
noresults resource 'bbbfly_searchedit_noresults'
SearchImg bbbfly.Renderer.image null Search button image

Extends

In Packages

Type Definitions

searchResults object

Properties:
Name Type Description
count integer Number of result items
results Array.<object> Result items
current integer | null Currently displayed result item index

Interfaces

Methods

ClearSearch ()

base/search.js, line 534
See:

abstract DoSearch (text){boolean}

base/search.js, line 554
Use this method to implement searching process.
Parameters:
Name Type Description
text string Searched text
See:
Returns:
Type Description
boolean If text was valid

inherited GetButton (buttonId){bbbfly.Edit.Button|null}

base/edit.js, line 165
Parameters:
Name Type Description
buttonId string Required button's ButtonId
Returns:
Type Description
bbbfly.Edit.Button | null - Button with passes ButtonId
base/search.js, line 517
Search for passed text or text filled in edit.
Parameters:
Name Type Description
text string optional Edit text will be used if undefined
See:
Returns:
Type Description
boolean If text was valid

inherited SetFocusAfter ()

base/edit.js, line 186
Focus edit with caret at the text end.
See:

inherited SetFocusBefore ()

base/edit.js, line 175
Focus edit with caret at the text begining.
See:

SetSearchResults (results){boolean}

base/search.js, line 542
Parameters:
Name Type Description
results bbbfly.SearchEdit.searchResults
See:
Returns:
Type Description
boolean If results were valid

Events

inherited OnInvalidChanged ()

base/edit.js, line 155

OnNoSearchResults ()

base/search.js, line 504
Called when nothing was found.
See:

OnSearch (text){boolean}

base/search.js, line 479
Parameters:
Name Type Description
text string
See:
Returns:
Type Description
boolean If continue to search

OnSearchResults (results)

base/search.js, line 491
Called when any anything was found.
Parameters:
Name Type Description
results bbbfly.SearchEdit.searchResults
See: