Requires

• module:ht-propertypane.js

Methods

addProperties(attributes) → {void}

批量增加属性信息

Parameters:

Name	Type	Description
attributes	Array.<object>	批量增加的属性

Returns:

void

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

增加自身属性变化事件监听器

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	any	<optional>	监听器函数域
ahead	boolean	<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

drawHeaderLabel(g, label, x, y, width, height) → {void}

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
label	string	标题文本
x	number	绘制范围左上角x坐标
y	number	绘制范围左上角y坐标
width	number	绘制范围宽度
height	number	绘制范围高度

Returns:

void

firePropertyChange(property, oldValue, newValue, equalFunc, params) → {void}

派发属性变化事件，可使用fp的简写方式

Parameters:

Name	Type	Attributes	Description
property	string		属性
oldValue	any		旧值
newValue	any		新值
equalFunc	function	<optional>	相等判断函数
params	any	<optional>	其它参数

Returns:

void

See:

• fp

fireViewEvent(kind) → {void}

Parameters:

Name	Type	Description
kind	string

Returns:

void

fp(property, oldValue, newValue, equalFunc, params) → {void}

派发属性变化事件

Parameters:

Name	Type	Attributes	Description
property	string		属性
oldValue	any		旧值
newValue	any		新值
equalFunc	function	<optional>	相等判断函数
params	any	<optional>	其它参数

Returns:

void

See:

• firePropertyChange

getCategoryIcon() → {any}

获取列表图标

Returns:

any -

图标

getClass() → {function}

获取类声明(构造函数)

Returns:

function -

类声明(构造函数)

getClassName() → {string}

获取类全名

Returns:

string -

类全名

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:

HTMLElement -

被禁用组件的div

getHeaderHeight() → {number}

获取表头高度

Returns:

number -

表头高度

getHeaderLabelAlign() → {string}

获取表头文本对齐方式

Returns:

string -

表头文本对齐方式

getHeaderLabelColor() → {string}

获取表头文本颜色

Returns:

string -

表头文本颜色

getHeaderLabelFont() → {string}

获取表头文本字体

Returns:

string -

表头文本字体

getHeaderLabels() → {Array.<string>}

获取所有表头文本

Returns:

Array.<string> -

所有表头文本

getHeight() → {number}

获取布局高度

Returns:

number -

布局高度

getIndent() → {number}

获取组件缩进

Returns:

number -

组件缩进

getPropertyView() → {ht.widget.PropertyView}

获取属性视图

Returns:

ht.widget.PropertyView -

属性视图

getSelectBackground() → {string}

获取选中元素的背景色，可重载自定义

Returns:

string -

选中元素的背景色

getSortFunc() → {function}

获取排序函数

Returns:

function -

排序函数

getSortIcon() → {any}

获取排序图标

Returns:

any -

排序图标

getSuperClass() → {function}

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

Returns:

function -

父类声明(构造函数)

getToolbarHeight() → {number}

获取工具栏高度

Returns:

number -

工具栏高度

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

isCaseSensitive() → {boolean}

获取过滤是否考虑大小写

Returns:

boolean -

过滤是否考虑大小写

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

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

增加自身属性变化事件监听器的缩写

Parameters:

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

Returns:

void

See:

• addPropertyChangeListener

onPropertyChanged() → {void}

属性变化回调函数，可重载做后续处理

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

setCaseSensitive(saseSensitive) → {void}

过滤是否考虑大小写

Parameters:

Name	Type	Description
saseSensitive	boolean	过滤是否考虑大小写

Returns:

void

setCategoryIcon(image) → {void}

设置列表图标

Parameters:

Name	Type	Description
image	any	图标

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

setFocus() → {void}

设置视图聚焦

Returns:

void

setHeaderHeight(height) → {void}

设置表头高度

Parameters:

Name	Type	Description
height	number	表头高度

Returns:

void

setHeaderLabelAlign(align) → {void}

设置表头对齐方式

Parameters:

Name	Type	Description
align	string	表头对齐方式

Returns:

void

setHeaderLabelColor(color) → {void}

设置表头文本颜色

Parameters:

Name	Type	Description
color	string	表头文本颜色

Returns:

void

setHeaderLabelFont(font) → {void}

设置表头文本字体

Parameters:

Name	Type	Description
font	string	表头文本字体

Returns:

void

setHeaderLabels(labels) → {void}

设置表头文本

Parameters:

Name	Type	Description
labels	Array.<string>	表头文本

Returns:

void

setHeight(height) → {void}

设置布局高度

Parameters:

Name	Type	Description
height	number	高度值

Returns:

void

setIndent(indent) → {void}

设置组件缩进

Parameters:

Name	Type	Description
indent	number	组件缩进

Returns:

void

setSelectBackground(color) → {void}

设置选中元素的背景色

Parameters:

Name	Type	Description
color	string	选中元素的背景色

Returns:

void

setSortFunc(func) → {void}

设置排序函数

Parameters:

Name	Type	Description
func	function	排序函数

Returns:

void

setSortIcon(image) → {void}

设置排序图标

Parameters:

Name	Type	Description
image	any	排序图标

Returns:

void

setToolbarHeight(height) → {void}

设置工具栏高度

Parameters:

Name	Type	Description
height	number	工具栏高度

Returns:

void

setWidth(v) → {void}

设置布局宽度

Parameters:

Name	Type	Description
v	number	宽度值

Returns:

void

ump(listener, scope) → {void}

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

Parameters:

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

Returns:

void

See:

• removePropertyChangeListener

validate() → {void}

立刻刷新拓扑

Returns:

void

validateImpl() → {void}

刷新

Returns:

void