API Docs for: TWaver HTML5 5.7.5
Show:

twaver.controls.TableHeader Class

Extends twaver.controls.ControlBase

表头对象

这个类用于管理表头

Constructor

twaver.controls.TableHeader

(
  • table
)
twaver.controls.TableHeader

Parameters:

Returns:

twaver.controls.TableHeader:

Item Index

Methods

Methods

twaver.controls.ControlBase.addPool

(
  • pool
)

Inherited from twaver.controls.ControlBase:

添加HTML元素缓存池

Parameters:

twaver.controls.ControlBase.adjustBounds

(
  • rect
)

Inherited from twaver.controls.ControlBase:

设置组件新的位置以及大小，twaver布局管理器（twaver.controls.SplitPane等）在大小变化时会调用此方法

Parameters:

  • rect Object

    新的位置以及大小，值为包含x、y、width和height属性的Object对象

twaver.controls.ControlBase.getView

() HTMLDivElement

Inherited from twaver.controls.ControlBase:

获取组件的HTML元素

Returns:

HTMLDivElement:

返回组件的HTML元素

twaver.controls.ControlBase.invalidate

(
  • [delay]
)

Inherited from twaver.controls.ControlBase:

无效组件，在等待指定毫秒数后，刷新组件（调用validate方法）,当组件属性更改后，须调用此方法，让组件重画

Parameters:

  • [delay] Number optional

    延迟刷新等待的毫秒数，可选，默认为twaver.Defaults.CALL_LATER_DELAY

twaver.controls.ControlBase.isAutoAdjustBounds

() Boolean

Inherited from twaver.controls.ControlBase:

获取视图是否自动计算Bounds（边界）

Returns:

Boolean:

是否自动调整Bounds

twaver.controls.ControlBase.removePool

(
  • pool
)

Inherited from twaver.controls.ControlBase:

删除HTML元素缓存池

Parameters:

twaver.controls.ControlBase.setAutoAdjustBounds

(
  • autoAdjustBounds
)

Inherited from twaver.controls.ControlBase:

设置视图是否自动计算Bounds

Parameters:

  • autoAdjustBounds Boolean

    是否自动计算Bounds

twaver.controls.ControlBase.validate

()

Inherited from twaver.controls.ControlBase:

重画组件，调用invalidate后，此方法会被调用

twaver.controls.ControlBase.validateImpl

()

Inherited from twaver.controls.ControlBase:

调用validate方法后，此方法会被调用，子类须重载此方法以重画组件

twaver.controls.TableHeader.getColumnLineColor

() String

设置表头上列的线的颜色，默认为twaver.Defaults.TABLEHEADER_COLUMN_LINE_COLOR

Returns:

String:

表头上列的线的颜色

twaver.controls.TableHeader.getHeight

() Number

设置表头的高度，默认为twaver.Defaults.TABLEHEADER_HEIGHT

Returns:

Number:

表头的高度

twaver.controls.TableHeader.getInsertBackground

() String

获取移动表头的某一列，将其插入表头列时线的颜色，默认为twaver.Defaults.TABLEHEADER_INSERT_BACKGROUND

Returns:

String:

移动表头的某一列，将其插入表头列时线的颜色

twaver.controls.TableHeader.getMoveBackground

() String

获取移动表头的某一列时这一列的背景色，默认为twaver.Defaults.TABLEHEADER_MOVE_BACKGROUND

Returns:

String:

移动表头的某一列时这一列的背景色

twaver.controls.TableHeader.getResizeTolerance

() Number

获取更改表头列大小时鼠标移至表头列时的公差，默认为twaver.Defaults.TABLEHEADER_RESIZE_TOLERANCE 比如设置为5，也就是当鼠标到靠近表头上的分割线5个像素之内，都能改变表头的列的大小

Returns:

Number:

鼠标移至表头列更改表头列大小时的公差值

twaver.controls.TableHeader.getRootDiv

() HTMLDivElement

获取表头对象的根DIV，这个DIV用于存放所有的表头

Returns:

HTMLDivElement:

表头上的根DIV

twaver.controls.TableHeader.getSortAscIcon

() String

获取升序排序时表头上显示的图标，默认为twaver.Defaults.TABLEHEADER_SORT_ASC_ICON

Returns:

String:

升序排序时表头上显示的图标

twaver.controls.TableHeader.getSortDescIcon

() String

获取降序排序时表头上显示的图标，默认为twaver.Defaults.TABLEHEADER_SORT_DESC_ICON

Returns:

String:

降序排序时表头上显示的图标

twaver.controls.TableHeader.getSortIconPosition

() String

获取排序时，图标显示的位置。默认为 twaver.Defaults.TABLEHEADER_SORT_ICON_POSITION。比如设置为 '70% 50%'，那么图标显示的位置为横向在表头列上70%的位置，纵向在表头上50%的位置

Returns:

String:

图标显示的位置

twaver.controls.TableHeader.handleColumnBoxChange

(
  • e
)

ColumnBox里列发生变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • e Object

    ColumnBox里列的变化事件

twaver.controls.TableHeader.handleColumnHierarchyChange

(
  • e
)

ColumnBox里列的顺序发生变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • e Object

    ColumnBox里列的顺序发生变化事件

twaver.controls.TableHeader.handleColumnPropertyChange

(
  • e
)

ColumnBox里列的属性发生变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • e Object

    ColumnBox里列的属性发生变化的事件

twaver.controls.TableHeader.invalidateDisplay

()

当组件属性更改后，须调用此方法，让组件重画

twaver.controls.TableHeader.invalidateScroll

()

当拖动表格的滚动条时，须调用此方法，让组件重画

twaver.controls.TableHeader.onColumnRendered

(
  • div
  • column
)

当调用renderColumn时，会调用此方法，用户不需要直接调用此方法，但可以重载此方法来实现自己的逻辑

Parameters:

  • div HTMLDivElement

    包含column的DIV对象

  • column twaver.Column

    指定的列对象

twaver.controls.TableHeader.renderColumn

(
  • div
  • column
)

绘制表头的列

Parameters:

  • div HTMLDivElement

    包含column的DIV对象

  • column twaver.Column

    指定的列对象

twaver.controls.TableHeader.setColumnLineColor

(
  • v
)

设置表头上列的线的颜色，默认为twaver.Defaults.TABLEHEADER_COLUMN_LINE_COLOR

Parameters:

  • v String

    表头上列的线的颜色

twaver.controls.TableHeader.setHeight

(
  • v
)

设置表头的高度，默认为twaver.Defaults.TABLEHEADER_HEIGHT

Parameters:

  • v Number

    表头的高度

twaver.controls.TableHeader.setInsertBackground

(
  • v
)

设置移动表头的列时，将其插入表头列时线的颜色，默认为twaver.Defaults.TABLEHEADER_INSERT_BACKGROUND

Parameters:

  • v String

    移动表头的列，将其插入表头列时线的颜色

twaver.controls.TableHeader.setMoveBackground

(
  • v
)

设置移动表头时的背景色，默认为twaver.Defaults.TABLEHEADER_MOVE_BACKGROUND

Parameters:

  • v String

    移动表头时的背景色

twaver.controls.TableHeader.setResizeTolerance

(
  • v
)

设置更改表头列大小时鼠标移至表头列时的公差，默认为twaver.Defaults.TABLEHEADER_RESIZE_TOLERANCE 比如设置为5，也就是当鼠标移到表头列上，容差在5个像素之内，都能更改表头列的大小

Parameters:

  • v Number

    当鼠标靠近表头中的分隔条多少像素时即可以更改表头中列的列宽。

twaver.controls.TableHeader.setSortAscIcon

(
  • v
)

设置升序排序时表头上显示的图标，默认为twaver.Defaults.TABLEHEADER_SORT_ASC_ICON

Parameters:

  • v String

    升序排序时表头上显示的图标

twaver.controls.TableHeader.setSortDescIcon

(
  • v
)

获取降序排序时表头上显示的图标，默认为twaver.Defaults.TABLEHEADER_SORT_DESC_ICON

Parameters:

  • v String

    降序排序时表头上显示的图标

twaver.controls.TableHeader.setSortIconPosition

(
  • v
)

设置排序时，图标显示的位置。默认为 twaver.Defaults.TABLEHEADER_SORT_ICON_POSITION。比如设置为 '70% 50%'，那么图标显示的位置为横向在表头列上70%的位置，纵向在表头上50%的位置

Parameters:

  • v String

    图标显示的位置

twaver.controls.TableHeader.validateDisplay

()

重画组件，调用validate方法后，此方法会被调

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，代表全局