API Docs for: TWaver HTML5 5.7.5
Show:

twaver.SelectionModel Class

Extends twaver.PropertyChangeDispatcher

选择容器对象

选择容器是包含在数据容器中的。选择容器用于管理数据容器中所有选中的对象。例如当选中某个对象时，它将会同时添加到选择容器中，当取消选中某个对象时，便会从选择容器中删除。

通过选择容器，可以更方便的访问或遍历所有选中的数据，也可以更方便地选中和取消某个数据

Constructor

twaver.SelectionModel

(
  • dataBox
)
twaver.SelectionModel

Parameters:

Returns:

twaver.SelectionModel:

选择容器对象本身

Methods

twaver.PropertyChangeDispatcher.addPropertyChangeListener

(
  • listener
  • [scope]
  • [ahead]
)

Inherited from twaver.PropertyChangeDispatcher:

添加属性变化监听器，用于监听属性变化

Parameters:

  • listener Function

    属性变化监听器

  • [scope] Object optional

    可选，属性变化监听器的作用域，默认为null，即全局

  • [ahead] Boolean optional

    可选，是否将此监听放在最前面，默认为false

Example:

var dispatcher = new twaver.PropertyChangeDispatcher(); dispatcher.addPropertyChangeListener(function (e) { console.log(e.property, e.newValue, e.oldValue); });

twaver.PropertyChangeDispatcher.firePropertyChange

(
  • property
  • oldValue
  • newValue
)
Boolean

Inherited from twaver.PropertyChangeDispatcher:

派发属性变化事件，属性变化时调用此方法

Parameters:

  • property String

    发生变化的属性

  • oldValue Object

    和此属性相关的旧值

  • newValue Object

    和此属性相关的新值

Returns:

Boolean:

如果新值和旧值相等则返回false，否则返回true

twaver.PropertyChangeDispatcher.getClassName

() String

Inherited from twaver.PropertyChangeDispatcher:

获取此类的字符串类名

Returns:

String:

返回此类的字符串类名

twaver.PropertyChangeDispatcher.onPropertyChanged

(
  • e
)

Inherited from twaver.PropertyChangeDispatcher:

属性变化时（firePropertyChange）触发的动作，不需要调用此方法，但可以重载此方法执行自定义逻辑

Parameters:

  • e Object

    属性变化事件，包含property、oldValue和newValue的Object对象

twaver.PropertyChangeDispatcher.removePropertyChangeListener

(
  • listener
  • [scope]
)

Inherited from twaver.PropertyChangeDispatcher:

删除指定作用域的属性变化监听器，作用域必须和添加监听器时的作用域一致，相同的作用域的相同监听器只能成功添加一次

Parameters:

  • listener Function

    属性变化监听器

  • [scope] Object optional

    属性变化监听器的作用域，可选，默认为null，代表全局

twaver.SelectionModel.addSelectionChangeListener

(
  • listener
  • [scope]
  • [ahead]
)

添加网元选中更改事件的监听器，当网元的选中状态发生变化时可以通过此监听器监听

Parameters:

  • listener Function

    选中更改的监听器

  • [scope] Object optional

    监听器的作用域，为空时指的是window

  • [ahead] Boolean optional

    是否添加在监听器列表的最前方，如果为空，则添加在最后一个位置

twaver.SelectionModel.appendSelection

(
  • datas
)

追加指定的选中数据

Parameters:

twaver.SelectionModel.clearSelection

()

清空所有选中的数据

twaver.SelectionModel.contains

(
  • data
)
Boolean

判断是否包含某个数据

Parameters:

Returns:

Boolean:

true为包含，否则为false

twaver.SelectionModel.dispose

()

释放选择容器中所有的资源。包括选择容器上的监听器和选择容器中的数据

twaver.SelectionModel.fireSelectionChange

(
  • kind
  • datas
  • oldSelection
)

派发出选中数据更改的事件

Parameters:

  • kind String

    数据更改的类型

  • datas twaver.List

    选中数据集合的新值

  • oldSelection twaver.List

    选中数据集合的老值

twaver.SelectionModel.getDataBox

() twaver.DataBox

获取绑定的数据容器

Returns:

twaver.DataBox:

绑定的数据容器

twaver.SelectionModel.getFilterFunction

() Function

获取选择过滤器，它是用于过滤哪些数据可以选择，哪些数据不可以选择。如果想要使某些数据一直处于不可选中的状态，可以使用此过滤器。

Returns:

Function:

选择过滤器

twaver.SelectionModel.getFirstData

() twaver.Data

获取第一个选中的数据

Returns:

twaver.Data:

第一个选中的数据对象

twaver.SelectionModel.getLastData

() twaver.Data

获取最后一个选中的数据

Returns:

twaver.Data:

最后一个选中的数据对象

twaver.SelectionModel.getSelection

() twaver.List

获取数据容器中所有选中的数据

Returns:

twaver.List:

选中数据的集合

twaver.SelectionModel.getSelectionMode

() String

获取选择模型的类型，默认是多选。 选择模型的类型可选值： noneSelection:不可选中 singleSelection:单选 multipleSelection:多选

Returns:

String:

选择模型的类型

twaver.SelectionModel.handleDataBoxChange

(
  • e
)

处理数据容器更改的事件的方法。TWaver内部使用

Parameters:

  • e Object

    数据容器更改的事件

twaver.SelectionModel.isSelectable

(
  • data
)
Boolean

判断某个数据是否是选中状态

Parameters:

Returns:

Boolean:

true为选中，否则为false

twaver.SelectionModel.removeSelection

(
  • datas
)

删除指定选中的数据

Parameters:

twaver.SelectionModel.removeSelectionChangeListener

(
  • listener
  • [scope]
)

删除网元选中更改事件的监听器，当网元的选中状态发生变化时可以通过此监听器监听

Parameters:

  • listener Function

    网元选中更改事件的监听器

  • [scope] Object optional

    监听器的作用域，为空时指的是window

twaver.SelectionModel.selectAll

()

选中数据容器中所有的数据

twaver.SelectionModel.setFilterFunction

(
  • filterFunction
)

设置选择过滤器，它是用于过滤哪些数据可以选择，哪些数据不可以选择。如果想要使某些数据一直处于不可选中的状态，可以使用此过滤器。

Parameters:

  • filterFunction Function

    选择过滤器

twaver.SelectionModel.setSelection

(
  • datas
)

将某些数据设置为选中状态

Parameters:

twaver.SelectionModel.setSelectionMode

(
  • selectionMode
)

设置选择模型的类型。 选择模型的类型可选值： noneSelection:不可选中 singleSelection:单选 multipleSelection:多选

Parameters:

  • selectionMode String

    选择模型的类型

twaver.SelectionModel.size

() Number

选中数据的大小

Returns:

Number:

选中数据的大小

twaver.SelectionModel.toSelection

(
  • matchFunction
  • [scope]
)
twaver.List

将选择容器中的数据转换成List

Parameters:

  • matchFunction Function

    转换集合时的过滤器

  • [scope] Object optional

    过滤器的作用域。为空时值为window

Returns:

twaver.List:

数据集合