HT for web Class: DockManager

new DockManager()

此类用于配合 SplitLayout 和 TabLayout 实现 dock 任意停靠功能

Example

// 正常创建和初始化 SplitLayout 和 TabLayout 对象
var splitLayout = new ht.ui.SplitLayout();
var tabLayout = new ht.ui.TabLayout();
tabLayout.addView(new ht.ui.Button());
tabLayout.addView(new ht.ui.TextField());
tabLayout.addView(new ht.ui.Button());
splitLayout.addView(tabLayout, {region: 'first'})

// 在 SplitLayout 布局器对象上启用 dock
new ht.ui.DockManager(splitLayout);

Methods

addPropertyChangeListener(listener, scope, ahead)

增加属性事件变化监听函数

Parameters:

Name	Type	Argument	Description
`listener`	function		监听器函数
`scope`	Object	<optional>	函数域
`ahead`	Boolean	<optional>	是否将当前监听器插入到监听器列表开头

firePropertyChange(property, oldValue, newValue, compareFunc) → {Boolean}

派发属性变化事件

Parameters:

Name	Type	Argument	Description
`property`	String		属性名
`oldValue`	Object		属性变化之前的值
`newValue`	Object		属性变化之后的值
`compareFunc`	function	<optional>	比较函数，用于比较新值和旧值是否一致，如果一致则不会派发事件

Returns:

事件是否派发成功

Type: Boolean

fp(property, oldValue, newValue, compareFunc) → {Boolean}

派发属性变化事件，firePropertyChange 的缩写

Parameters:

Name	Type	Argument	Description
`property`	String		属性名
`oldValue`	Object		属性变化之前的值
`newValue`	Object		属性变化之后的值
`compareFunc`	function	<optional>	比较函数，用于比较新值和旧值是否一致，如果一致则不会派发事件

Returns:

事件是否派发成功

Type: Boolean

getInsertLineColor() → {color}

获取拖拽插入线的颜色

Returns:

Type: color

getMaskBackground() → {color}

获取拖拽提示遮罩的背景颜色

Returns:

Type: color

getRootHitSize() → {int}

获取拖拽到根容器时的点击范围

Returns:

Type: int

getRootMaskBackground() → {color}

获取拖拽到根容器时提示遮罩的背景颜色

Returns:

Type: color

getViewGroup() → {ht.ui.SplitLayout}

获取绑定的 SplitLayout 布局器对象

Returns:

Type: ht.ui.SplitLayout

mp(listener, scope, ahead)

增加属性事件变化监听函数，addPropertyChangeListener 的缩写

Parameters:

Name	Type	Argument	Description
`listener`	function		监听器函数
`scope`	Object	<optional>	函数域
`ahead`	Boolean	<optional>	是否将当前监听器插入到监听器列表开头

removePropertyChangeListener(listener, scope)

删除属性事件变化监听器

Parameters:

Name	Type	Argument	Description
`listener`	function		监听器函数
`scope`	Object	<optional>	函数域

setInsertLineColor(color)

设置拖拽插入线的颜色

Parameters:

Name	Type	Description
`color`	color	颜色，如 '#ff0000'

setMaskBackground(color)

设置拖拽提示遮罩的背景颜色

Parameters:

Name	Type	Description
`color`	color	背景颜色，如 '#ff0000'

setRootHitSize(size)

设置拖拽到根容器时的点击范围

Parameters:

Name	Type	Description
`size`	int

setRootMaskBackground(color)

设置拖拽到根容器时提示遮罩的背景颜色

Parameters:

Name	Type	Description
`color`	color	背景颜色，如 '#ff0000'

setViewGroup(splitLayout)

绑定 SplitLayout 布局器并在此布局器上启用 dock 功能

Parameters:

Name	Type	Description
`splitLayout`	ht.ui.SplitLayout

ump(listener, scope)

删除属性事件变化监听器，removePropertyChangeListener 的缩写

Parameters:

Name	Type	Argument	Description
`listener`	function		监听器函数
`scope`	Object	<optional>	函数域