API Docs for: TWaver HTML5 5.7.5
Show:

twaver.controls.TabPane Class

Extends twaver.controls.ControlBase

选项卡面板

是一种视图组件，它是和选项卡容器绑定的，用于显示选项卡容器中的选项卡元素。

Constructor

twaver.controls.TabPane

() twaver.controls.TabPane

Returns:

twaver.controls.TabPane:

创建选项卡面板

Example:

var tabPane = new TabPane(); this.tabPane.setTabRadius(8); this.tabPane.setTabGap(5); this.tabPane.getTabBox().add(tab1); this.tabPane.getTabBox().add(tab2);

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.TabPane.getCloseIcon

() String

获取选项卡上关闭的图标。默认为twaver.Defaults.TABPANE_CLOSE_ICON

Returns:

String:

选项卡上关闭的图标

twaver.controls.TabPane.getContentDiv

() HTMLDivElement

获取内容DIV，它是用于存放选项卡上的视图组件

Returns:

HTMLDivElement:

选项卡面板中的内容DIV

twaver.controls.TabPane.getCurrentTab

() twaver.Tab

获取当前的选项卡，当前选项卡为选项卡容器中最后一个选中的数据

Returns:

twaver.Tab:

选项卡数据

twaver.controls.TabPane.getCurrentView

() Object

获取当前的选项卡视图，当前选项卡视图为选项卡容器中最后一个选中的数据的视图组件

Returns:

Object:

当前的选项卡视图，选项卡视图为DIV或ControlBase类型的对象

twaver.controls.TabPane.getDisabledColor

() String

获取选项卡不可用时的颜色值，默认为twaver.Defaults.TABPANE_DISABLED_COLOR

Returns:

String:

选项卡不可用时的颜色值

twaver.controls.TabPane.getHorizontalAlign

() String

获取选项卡上文字的水平对齐方式，默认为 twaver.Defaults.TABPANE_HORIZONTAL_ALIGN 文字的对齐方式可选值为： left：左对齐。 right：右对齐。
center：中间对齐。
justify: 填充对齐，使得一行上每个文字的间隔相同。
inherit：继承于父亲的对齐方式。 更多的对齐方式可以参考CSS中的text-align样式

Returns:

String:

选项卡上文字的水平对齐方式

twaver.controls.TabPane.getInsertBackground

() String

获取在移动选项卡并将其插入选项卡面板时线的颜色，默认为twaver.Defaults.TABPANE_INSERT_BACKGROUND

Returns:

String:

插入选项卡时线的颜色

twaver.controls.TabPane.getMoveBackground

() String

设置移动某一选项卡时该选项卡的背景色，默认为twaver.Defaults.TABPANE_MOVE_BACKGROUND

Returns:

String:

移动某一选项卡时该选项卡的背景色

twaver.controls.TabPane.getResizeTolerance

() Number

获取当鼠标靠近选项卡的右边框多少像素时即可以更改表头中列的列宽，默认值为twaver.Defaults.TABPANE_TAB_ORIENTATION。比如鼠标没有移动到选项卡上，但是在这个公差范围值之内，那么鼠标也会变成改变大小的状态。

Returns:

Number:

当鼠标靠近选项卡的右边框多少像素时即可以更改表头中列的列宽

twaver.controls.TabPane.getSelectBackground

() String

获取选中的选项卡的背景颜色，默认为twaver.Defaults.TABPANE_SELECT_BACKGROUND

Returns:

String:

选中的选项卡的背景颜色

twaver.controls.TabPane.getTabBackground

() String

获取选项卡的背景色，默认为twaver.Defaults.TABPANE_TAB_BACKGROUND

Returns:

String:

选项卡的背景色

twaver.controls.TabPane.getTabBox

() twaver.TabBox

获取选项卡数据容器

Returns:

twaver.TabBox:

选项卡数据容器

twaver.controls.TabPane.getTabDiv

() Object

获取选项卡的DIV

Returns:

Object:

选项卡的DIV

twaver.controls.TabPane.getTabGap

() Number

获取选项卡之间的间距，默认为twaver.Defaults.TABPANE_TAB_GAP

Returns:

Number:

选项卡之间的间距

twaver.controls.TabPane.getTabHeight

() Number

获取选项卡的高度，默认为twaver.Defaults.TABPANE_TAB_HEIGHT

Returns:

Number:

选项卡的高度

twaver.controls.TabPane.getTabOrientation

() String

获取选项卡所处的位置，默认为twaver.Defaults.TABPANE_TAB_ORIENTATION 。可选值有： 'top'，'bottom'

Returns:

String:

选项卡所处的位置

twaver.controls.TabPane.getTabRadius

() Number

获取选项卡的圆角半径，默认为twaver.Defaults.TABPANE_TAB_RADIUS

Returns:

Number:

选项卡的圆角半径

twaver.controls.TabPane.handleTabChange

(
  • e
)

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

Parameters:

  • e Object

    TabBox中的Tab发生变化的事件

twaver.controls.TabPane.invalidateTab

(
  • [delay]
)

无效选项卡，在等待指定的毫秒数后刷新选项卡界面，当选项卡的属性发生更改后，须调用此方法，让选项卡重画

Parameters:

  • [delay] Number optional

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

twaver.controls.TabPane.isSelectNextOnClose

() Boolean

当关闭当前的选项卡时，是否选中下一个Tab页。默认为twaver.Defaults.TABPANE_SELECT_NEXT_ON_CLOSE

Returns:

Boolean:

true为选中下一个选项卡，否则为false

twaver.controls.TabPane.isSelectNextOnInVisible

() Boolean

当前选项卡隐藏时是否自动选中下一个选项卡

Returns:

Boolean:

当前选项卡隐藏时是否自动选中下一个选项卡

twaver.controls.TabPane.onTabRendered

(
  • div
  • tab
)

当调用renderTab时会调用此方法，用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • div HTMLDivElement

    包含选项卡的DIV

  • tab twaver.Tab

    指定的选项卡

twaver.controls.TabPane.onViewAdded

(
  • view
)

当Tab上添加视图组件时，调用此方法。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • view Object

    Tab的视图组件添加的事件

twaver.controls.TabPane.onViewRemoved

(
  • view
)

当Tab上删除视图组件时，调用此方法。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • view Object

    Tab的视图组件删除的事件

twaver.controls.TabPane.renderTab

(
  • div
  • tab
)

绘制指定的选项卡，用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • div HTMLDivElement

    包含指定选项卡的DIV

  • tab twaver.Tab

    指定的选项卡

twaver.controls.TabPane.setCloseIcon

(
  • v
)

设置选项卡上关闭的图标。默认为twaver.Defaults.TABPANE_CLOSE_ICON

Parameters:

  • v String

    选项卡上关闭的图标

twaver.controls.TabPane.setDisabledColor

(
  • v
)

设置选项卡不可用时的颜色值，默认为twaver.Defaults.TABPANE_DISABLED_COLOR

Parameters:

  • v String

    选项卡不可用时的颜色值

twaver.controls.TabPane.setHorizontalAlign

(
  • v
)

设置选项卡上文字的水平对齐方式，默认为 twaver.Defaults.TABPANE_HORIZONTAL_ALIGN 文字的对齐方式可选值为： left：左对齐。 right：右对齐。
center：中间对齐。
justify: 填充对齐，使得一行上每个文字的间隔相同。
inherit：继承于父亲的对齐方式。 更多的对齐方式可以参考CSS中的text-align样式

Parameters:

  • v String

    选项卡上文字的水平对齐方式

twaver.controls.TabPane.setInsertBackground

(
  • v
)

设置在移动选项卡并插入选项卡时线的颜色，默认为twaver.Defaults.TABPANE_INSERT_BACKGROUND

Parameters:

  • v String

    插入选项卡时线的颜色

twaver.controls.TabPane.setMoveBackground

(
  • v
)

设置移动某一选项卡时该选项卡的背景色，默认为twaver.Defaults.TABPANE_MOVE_BACKGROUND

Parameters:

  • v String

    移动某一选项卡时该选项卡的背景色

twaver.controls.TabPane.setResizeTolerance

(
  • v
)

设置当鼠标靠近分隔条多少像素时可以改变列宽的像素数，默认值为twaver.Defaults.TABPANE_TAB_TOLERANCE。比如鼠标没有移动到选项卡上，但是在这个公差范围值之内，那么鼠标也会变成改变大小的状态。

Parameters:

  • v Number

    当鼠标靠近分隔条多少像素时可以改变列宽的像素数

twaver.controls.TabPane.setSelectBackground

(
  • v
)

设置选中的选项卡的背景颜色，默认为twaver.Defaults.TABPANE_SELECT_BACKGROUND

Parameters:

  • v String

    选中的选项卡的背景颜色

twaver.controls.TabPane.setSelectNextOnClose

(
  • v
)

当关闭当前的选项卡时，设置是否选中下一个Tab页。默认为twaver.Defaults.TABPANE_SELECT_NEXT_ON_CLOSE

Parameters:

  • v Boolean

    true为选中下一个选项卡，否则为false

twaver.controls.TabPane.setSelectNextOnInVisible

(
  • v
)

设置当前选项卡隐藏时是否自动选中下一个选项卡

Parameters:

  • v Boolean

    当前选项卡隐藏时是否自动选中下一个选项卡

twaver.controls.TabPane.setTabBackground

(
  • v
)

设置选项卡的背景色，默认为twaver.Defaults.TABPANE_TAB_BACKGROUND

Parameters:

  • v String

    选项卡的背景色

twaver.controls.TabPane.setTabGap

(
  • v
)

获取选项卡之间的间距，默认为twaver.Defaults.TABPANE_TAB_GAP

Parameters:

  • v Number

    选项卡之间的间距

twaver.controls.TabPane.setTabHeight

(
  • v
)

设置选项卡的高度，默认为twaver.Defaults.TABPANE_TAB_HEIGHT

Parameters:

  • v Number

    选项卡的高度

twaver.controls.TabPane.setTabOrientation

(
  • v
)

设置选项卡所处的位置，默认为twaver.Defaults.TABPANE_TAB_ORIENTATION 。可选值有： 'top'，'bottom'

Parameters:

  • v String

    选项卡所处的位置

twaver.controls.TabPane.setTabRadius

(
  • v
)

设置选项卡的圆角半径，默认为twaver.Defaults.TABPANE_TAB_RADIUS

Parameters:

  • v Number

    选项卡的圆角半径

twaver.controls.TabPane.validateTab

()

重画Tab页，调用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，代表全局