API Docs for: TWaver HTML5 5.7.5
Show:

twaver.controls.SplitPane Class

劈分面板

是用于将一块面板劈分成两块的面板,两块面板所占的比例大小是由劈分条的位置来决定的,并且可以通过移动劈分条来动态改变这两块面板的大小。 劈分面板通过设置orientation来进行水平和垂直劈分

Constructor

twaver.controls.SplitPane

(
  • [firstView]
  • [nextView]
  • [orientation]
  • [position]
)
twaver.controls.SplitPane

Parameters:

  • [firstView] Object optional

    劈分面版的第一块面板,面板可以为DIV或ControlBase类型的对象

  • [nextView] Object optional

    劈分面版的第二块面板,面板可以为DIV或ControlBase类型的对象

  • [orientation] String optional

    劈分的方向,可以为'horizontal'或 'vertical'

  • [position] Number optional

    劈分的百分比

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.SplitPane.getDividerBackground

() String

设置劈分条的背景色,默认为twaver.Defaults.SPLITPANE_DIVIDER_BACKGROUND

Returns:

String:

劈分条的背景颜色值

twaver.controls.SplitPane.getDividerDiv

() HTMLDivElement

获取劈分条的DIV

Returns:

HTMLDivElement:

劈分条的DIV

twaver.controls.SplitPane.getDividerOpacity

() Number

获取劈分条的透明度,默认为twaver.Defaults.SPLITPANE_DIVIDER_OPACITY

Returns:

Number:

劈分条的透明度,透明度的值的范围为0-1

twaver.controls.SplitPane.getDividerWidth

() Number

设置劈分条的宽度,默认为twaver.Defaults.SPLITPANE_DIVIDER_WIDTH

Returns:

Number:

劈分条的宽度

twaver.controls.SplitPane.getDownExpandIcon

() String

获取下面展开图标

Returns:

String:

图标名称

twaver.controls.SplitPane.getFirstView

() Object

获取劈分面板中的第一块面板

Returns:

Object:

劈分面版的第一块面板,面板可以为DIV或ControlBase类型的对象

twaver.controls.SplitPane.getLeftExpandIcon

() String

获取左侧展开图标

Returns:

String:

图标名称

twaver.controls.SplitPane.getMaskBackground

() String

获取劈分面板中劈分条拖动时显示的颜色,默认为twaver.Defaults.SPLITPANE_MASK_BACKGROUND

Returns:

String:

拖动劈分条时的颜色值

twaver.controls.SplitPane.getNextView

() Object

获取劈分面板中的第二块面板

Returns:

Object:

劈分面版的第二块面板,面板可以为DIV或ControlBase类型的对象

twaver.controls.SplitPane.getOrientation

() String

获取劈分面板的劈分方向,默认为twaver.Defaults.SPLITPANE_ORIENTATION 可选值有: 'vertical':垂直, 'horizontal':水平

Returns:

String:

劈分面板的劈分方向

twaver.controls.SplitPane.getPosition

() Number

获取劈分条的位置,劈分条的位置决定了两块面板的大小。比如设置为0.7,那么第一块面板占70%,第二块占30%。默认为twaver.Defaults.SPLITPANE_POSITION

Returns:

Number:

劈分条的位置,取值范围0-1

twaver.controls.SplitPane.getRightExpandIcon

() String

获取右侧展开图标

Returns:

String:

图标名称

twaver.controls.SplitPane.getUpExpandIcon

() String

获取上方展开图标

Returns:

String:

图标名称

twaver.controls.SplitPane.isDividerDraggable

() Boolean

获取分隔条是否可拖拽

Returns:

Boolean:

返回分隔条是否可拖拽,默认问true

twaver.controls.SplitPane.isExpandable

() Boolean

判断当前面板是否展开

Returns:

Boolean:

是否展开

twaver.controls.SplitPane.setDividerBackground

(
  • v
)

获取劈分条的背景色,默认为twaver.Defaults.SPLITPANE_DIVIDER_BACKGROUND

Parameters:

  • v String

    劈分条的背景色

twaver.controls.SplitPane.setDividerDraggable

(
  • v
)

设置分隔条是否可拖拽

Parameters:

  • v Boolean

    分隔条是否可拖拽

twaver.controls.SplitPane.setDividerOpacity

(
  • v
)

设置劈分条的透明度,默认为twaver.Defaults.SPLITPANE_DIVIDER_OPACITY

Parameters:

  • v Number

    劈分条的透明度,透明度的值为0-1

twaver.controls.SplitPane.setDividerWidth

(
  • v
)

设置劈分条的宽度,默认为twaver.Defaults.SPLITPANE_DIVIDER_WIDTH

Parameters:

  • v Number

    劈分条的宽度

twaver.controls.SplitPane.setDownExpandIcon

(
  • v
)

设置下方展开图标

Parameters:

  • v String

    图标名称

twaver.controls.SplitPane.setExpandable

(
  • v
)

设置是否展开

Parameters:

  • v String

    图标名称

twaver.controls.SplitPane.setFirstView

(
  • value
)

设置劈分面板中的第一块面板

Parameters:

  • value Object

    劈分面版的第一块面板,面板可以为DIV或ControlBase类型的对象

twaver.controls.SplitPane.setLeftExpandIcon

(
  • v
)

设置左侧展开图标

Parameters:

  • v String

    图标名称

twaver.controls.SplitPane.setMaskBackground

(
  • v
)

设置劈分面板中劈分条拖动时显示的颜色,默认为twaver.Defaults.SPLITPANE_MASK_BACKGROUND

Parameters:

  • v String

    拖到劈分条时的颜色值

twaver.controls.SplitPane.setNextView

(
  • value
)

设置劈分面板中的第二块面板

Parameters:

  • value Object

    劈分面版的第二块面板,面板可以为DIV或ControlBase类型的对象

twaver.controls.SplitPane.setOrientation

(
  • v
)

设置劈分面板的劈分方向,默认为twaver.Defaults.SPLITPANE_ORIENTATION 可选值有: 'vertical':垂直, 'horizontal':水平

Parameters:

  • v String

    劈分面板的劈分方向

twaver.controls.SplitPane.setPosition

(
  • value
)

设置劈分条的位置,劈分条的位置决定了两块面板的大小。比如设置为0.7,那么第一块面板占70%,第二块占30%。默认为twaver.Defaults.SPLITPANE_POSITION

Parameters:

  • value Number

    劈分条的位置,取值范围0-1

twaver.controls.SplitPane.setRightExpandIcon

(
  • v
)

设置右侧展开图标

Parameters:

  • v String

    图标名称

twaver.controls.SplitPane.setUpExpandIcon

(
  • v
)

设置上方展开图标

Parameters:

  • v String

    图标名称

twaver.PropertyChangeDispatcher.addPropertyChangeListener

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

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

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

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

Parameters:

  • property String

    发生变化的属性

  • oldValue Object

    和此属性相关的旧值

  • newValue Object

    和此属性相关的新值

Returns:

Boolean:

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

twaver.PropertyChangeDispatcher.getClassName

() String

获取此类的字符串类名

Returns:

String:

返回此类的字符串类名

twaver.PropertyChangeDispatcher.onPropertyChanged

(
  • e
)

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

Parameters:

  • e Object

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

twaver.PropertyChangeDispatcher.removePropertyChangeListener

(
  • listener
  • [scope]
)

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

Parameters:

  • listener Function

    属性变化监听器

  • [scope] Object optional

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