Requires

• module:ht-cssanimation.js
• module:ht-panel.js

Methods

addEventListener(property, fun, scope) → {void}

增加事件监听

Parameters:

Name	Type	Attributes	Description
property	string		监听名称
fun	function		监听函数
scope	Object	<optional>	监听器函数域

Returns:

void

addToDOM(parentNode) → {void}

将视图插入到 dom 中

Parameters:

Name	Type	Attributes	Description
parentNode	HTMLDivElement	<optional>	父DOM

Returns:

void

addViewListener(listener, scope, ahead) → {void}

监听视图事件，如布局、刷新等

Parameters:

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

Returns:

void

fireViewEvent(kind) → {void}

Parameters:

Name	Type	Description
kind	string

Returns:

void

getClass() → {function}

获取类声明(构造函数)

Returns:

function -

类声明(构造函数)

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:

HTMLElement -

被禁用组件的div

getDragContainment() → {boolean}

获取是否限制在父容器中拖拽

Returns:

boolean -

是否限制在父容器中拖拽

getHeight() → {number}

获取布局高度

Returns:

number -

布局高度

getIconStretch() → {string}

获取图标拉伸方式

Returns:

string

getPanelConfig(id) → {PanelConfig}

根据 id 获得面板配置，在配置中可获得 width、contentHeight、expanded 等状态，只可查询，不可修改

Parameters:

Name	Type	Description
id	string | number

Returns:

PanelConfig -

面板配置

getPanelView(id) → {HTMLDivElement}

根据id获得面板的 DIV

Parameters:

Name	Type	Description
id	string | number

Returns:

HTMLDivElement -

面板的 DIV

getPosition() → {object}

获取面板相对父节点位置

Returns:

object -

面板位置

getPositionRelativeTo() → {string}

获取面板位置

Returns:

string -

面板位置

getSuperClass() → {function}

获取父类声明(构造函数)

Returns:

function -

父类声明(构造函数)

getView() → {HTMLDivElement}

获取组件的根层div

Returns:

HTMLDivElement

getWidth() → {number}

获取布局宽度

Returns:

number -

布局宽度

invalidate(delay) → {void}

无效组件，并调用延时刷新

Parameters:

Name	Type	Attributes	Description
delay	number	<optional>	延迟刷新的间隔事件(单位:ms)

Returns:

void

See:

• iv

isDisabled() → {boolean}

组件是否处于不可用状态，处于此状态时不能进行任何操作并且会遮挡一层蒙板

Returns:

boolean

iv(delay) → {void}

无效组件，并调用延时刷新

Parameters:

Name	Type	Attributes	Description
delay	number	<optional>	延迟刷新的间隔事件(单位:ms)

Returns:

void

See:

• invalidate

layout(x, y, width, height) → {void}

执行布局

Parameters:

Name	Type	Description
x	number	视图左上角布局 x 点位置
y	number	视图左上角布局 y 点位置
width	number	视图宽度
height	number	视图高度

Returns:

void

minimize() → {void}

最小化面板

Returns:

void

removeInnerPanel(id) → {void}

根据id删除子面板

Parameters:

Name	Type	Description
id	string | number	子面板 id

Returns:

void

removePropertyChangeListener(listener, scope) → {void}

删除自身属性变化事件监听器

Parameters:

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

Returns:

void

removeViewListener(listener, scope) → {void}

删除视图事件监听器

Parameters:

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

Returns:

void

restore() → {void}

将面板从最小化状态恢复

Returns:

void

setConfig(config) → {void}

配置面板参数

Parameters:

Name	Type	Description
config	PanelConfig

Returns:

void

setCursor(style) → {void}

设置 css 的鼠标样式，cursor

Parameters:

Name	Type	Description
style	string

Returns:

void

setDisabled(value, iconUrl) → {void}

设置组件是否处于不可用状态，处于不可用状态时不能进行任何操作并且会遮挡一层蒙板

Parameters:

Name	Type	Attributes	Description
value	boolean		是否禁用组件
iconUrl	string	<optional>	蒙板上显示的icon的路径

Returns:

void

setDragContainment(value) → {void}

设置是否限制在父容器中拖拽，默认为parent，改为null可取消限制

Parameters:

Name	Type	Description
value	string

Returns:

void

setFocus() → {void}

设置视图聚焦

Returns:

void

setHeight(height) → {void}

设置布局高度

Parameters:

Name	Type	Description
height	number	高度值

Returns:

void

setInnerPanel(config) → {void}

传入一个指定配置参数的 js 对象，如果对象的id与面板中某个子面板id重复则更新那个子面板，否则新增一个子面板

Parameters:

Name	Type	Description
config	PanelConfig

Returns:

void

setPosition(x, y) → {void}

设置面板在父容器中的位置

Parameters:

Name	Type	Description
x	number	x轴位置
y	number	y轴位置

Returns:

void

setPositionRelativeTo(relativeTo) → {void}

设置面板相对父容器哪个角落定位，参数枚举：leftTop、leftBottom、rightTop、rightBottom

Parameters:

Name	Type	Description
relativeTo	string	位置

Returns:

void

setTitle(title, id) → {void}

设置面板标题，不设置 id 即为设置最外层标题

Parameters:

Name	Type	Attributes	Description
title	string		标题内容
id	string | number	<optional>	面板 id

Returns:

void

setWidth(v) → {void}

设置布局宽度

Parameters:

Name	Type	Description
v	number	宽度值

Returns:

void

togglePanel(id) → {void}

根据 id 切换面板状态(展开或合并)

Parameters:

Name	Type	Description
id	string | number	面板 id

Returns:

void

validate() → {void}

立刻刷新拓扑

Returns:

void

validateImpl() → {void}

刷新

Returns:

void