bbbfly-cjs-controls

Index Files Packages Globals

bbbfly. ListSearchBox class control

new bbbfly.ListSearchBox (def, ref, parent)

base/search.js, line 667

Parameters

Name Type Description
def bbbfly.ListSearchBox.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
ListID string null bbbfly.List to search in ID
DownImg bbbfly.Renderer.image null Down button image
UpImg bbbfly.Renderer.image null Up button image

Extends

In Packages

Methods

overrides ClearSearch ()

base/search.js, line 700

CompareItem (list, item, text){boolean}

base/search.js, line 714
Parameters:
Name Type Description
list bbbfly.List Searched list
item ngListItem Searched list item
text string Searched text
Returns:
Type Description
boolean If item matches searched text

overrides DoSearch ()

base/search.js, line 707

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

abstract GetItemText (item){string}

base/search.js, line 725
Return text which should be searched in.
Parameters:
Name Type Description
item ngListItem
Returns:
Type Description
string Searchable item text
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:

SetSearchList (list){boolean}

base/search.js, line 691
Parameters:
Name Type Description
list bbbfly.List
Returns:
Type Description
boolean If list was valid

inherited 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

inherited OnNoSearchResults ()

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

inherited OnSearch (text){boolean}

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

inherited OnSearchResults (results)

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