API Docs for: TWaver HTML5 5.7.5
Show:

twaver.QuickFinder Class

快速查找器

速查器提供了一种快速搜索DataBox的功能，用户可以通过这个类中提供的方法来根据数据上的某个属性快速地查询出匹配的数据。当然用户也可以通过遍历Databox实现查找的功能，但是如果是频繁的遍历和循环，会对性能有一定的影响。而且它没有快速查找这个类的效率高。

快速查找通过构造函数来绑定数据容器和需要进行索引的属性，一旦绑定之后，当数据容器中索引的属性值发生变化时，快速查找中数据也会进行相应的修改

Constructor

twaver.QuickFinder

(
  • dataBox
  • propertyName
  • [propertyType]
  • [valueFunction]
  • [filterFunction]
)
twaver.QuickFinder

Parameters:

  • dataBox twaver.DataBox

    绑定的数据容器对象

  • propertyName String

    索引的属性名称

  • [propertyType] String optional

    索引的属性类型，属性类型的可选值为： 'accessor':get/set方法的属性 'style'：样式属性 'client'：自定义的属性。默认为‘accessor’

  • [valueFunction] Function optional

    需要包含在返回结果中值的函数

  • [filterFunction] Function optional

    过滤出不包含在返回结果中的值的过滤器

Returns:

twaver.QuickFinder:

快速查找对象本身

Methods

twaver.QuickFinder.dispose

()

释放所有绑定的资源。当调用这个方法时，绑定在快速查找上的数据容器将被释放

twaver.QuickFinder.find

(
  • value
)
twaver.List

通过指定的值查询出所有匹配的数据

Parameters:

  • value String

    指定查询的值

Returns:

twaver.List:

匹配的数据集合

twaver.QuickFinder.findFirst

(
  • value
)
twaver.Data

通过给定的值查询出匹配数据集合的第一个数据

Parameters:

  • value Object

    给定查询的值

Returns:

twaver.Data:

数据集合的第一个数据

twaver.QuickFinder.getClassName

() String

获取这个类的类名

Returns:

String:

类名

twaver.QuickFinder.getDataBox

() twaver.DataBox

获取绑定的数据容器

Returns:

twaver.DataBox:

数据容器对象

twaver.QuickFinder.getFilterFunction

() Function

获取过滤的方法

Returns:

Function:

过滤的方法

twaver.QuickFinder.getPropertyName

() String

获取绑定的属性名称

Returns:

String:

绑定的属性名称

twaver.QuickFinder.getPropertyType

() String

获取绑定的属性类型。属性类型的可选值为： 'accessor':get/set方法的属性 'style'：样式属性 'client：自定义的属性

Returns:

String:

属性类型

twaver.QuickFinder.getValue

(
  • data
)
String

获取对象的属性值。TWaver内部使用

Parameters:

Returns:

String:

数据对象的属性值

twaver.QuickFinder.getValueFunction

() Function

获取返回值的方法。这个方法用于指出哪些值应该包含在返回的值中。

Returns:

Function:

返回值的方法

twaver.QuickFinder.handleDataBoxChange

(
  • e
)

当数据容器发生变化时，调用此方法。TWaver内部使用

Parameters:

  • e Object

    数据发生变化的事件

twaver.QuickFinder.handleDataPropertyChange

(
  • e
)

当数据容器中数据的属性发生变化时调用此方法

Parameters:

  • e Object

    数据属性发生变化的事件

twaver.QuickFinder.isInterested

(
  • data
)
Boolean

指定的数据是否符合当前的快速查找类的条件

Parameters:

Returns:

Boolean:

true为符合，否则为false