ht.widget.FormPane()

new FormPane()

表单面板类,使用表单插件需要在引入ht.js核心库之后,再引入一个ht-form.js的表单插件库。

Methods

addPropertyChangeListener(listener, scope, ahead)

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

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

ahead Boolean <optional>

是否将当前监听器插入到监听器列表开头

See:

addRow(items, widths, height, params)

添加一行组件

Parameters:
Name Type Description
items Object

元素数组,元素可为字符串、json格式描述的组件参数信息、html元素或者为null的空

widths Array

每个元素宽度信息数组,宽度值大于1代表固定绝对值,小于等于1代表相对值,也可为80+0.3的组合

height Number

行高信息,值大于1代表固定绝对值,小于等于1代表相对值,也可为80+0.3的组合,为空时采用默认行高

params Object

json格式的额外参数,例如插入行索引以及行边框或背景颜色等,如{index: 2, background: 'yellow', borderColor: 'red'}

addToDOM(parentNode)

将组件加入到指定的DOM元素底下,不指定则加入到 document.body 下

Parameters:
Name Type Description
parentNode DOM

DOM元素,默认为 document.body

addViewListener(listener, scope, ahead)

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

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

ahead Boolean <optional>

是否将当前监听器插入到监听器列表开头

clear()

清除所有行信息

getHGap() → {Number}

获取表单的行垂直间距,默认值为6

Returns:
Number

getHPadding() → {Number}

获取表单左边和右边与组件内容的间距,默认值为8

Returns:
Number

getItemById(id) → {Object}

根据id值找到对应的item元素

Parameters:
Name Type Description
id String
Returns:
Object -

item元素

getLabelHPadding() → {Number}

获取文字左边和右边的间距,默认值为2

Returns:
Number

getLabelVPadding() → {Number}

获取文字顶部和顶部的间距,默认值为0

Returns:
Number

getRowHeight() → {Number}

获取默认行高

Returns:
Number

getScrollBarColor() → {color}

获取滚动条颜色

Returns:
color

getScrollBarSize() → {Number}

获取滚动条宽度,默认值为7

Returns:
Number

getTranslateX() → {Number}

获取水平平移值

Returns:
Number -

水平平移值

See:

getTranslateY() → {Number}

获取垂直平移值

Returns:
Number -

垂直平移值

See:

getValue(id) → {String}

根据id获取对应item元素值

Parameters:
Name Type Description
id String
Returns:
String -

对应item元素值

See:

getVGap() → {Number}

获取表单组件水平间距,默认值为6

Returns:
Number

getVPadding() → {Number}

获取表单顶部和顶部与组件内容的间距,默认值为8

Returns:
Number

isAutoHideScrollBar() → {Boolean}

获取是否自动隐藏滚动条,默认为true

Returns:
Boolean

mp(listener, scope, ahead)

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

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

ahead Boolean <optional>

是否将当前监听器插入到监听器列表开头

See:

removeRow(index)

删除指定的行

Parameters:
Name Type Description
index Number

行号

setAutoHideScrollBar(v)

设置是否自动隐藏滚动条,默认为true

Parameters:
Name Type Description
v Boolean

setHGap(hGap)

设置表单的行垂直间距,默认值为6

Parameters:
Name Type Description
hGap Number

setHPadding(hPadding)

设置表单左边和右边与组件内容的间距,默认值为8

Parameters:
Name Type Description
hPadding Number

setLabelHPadding(hPadding)

设置文字左边和右边的间距,默认值为2

Parameters:
Name Type Description
hPadding Number

setLabelVPadding(vPadding)

设置文字顶部和顶部的间距,默认值为0

Parameters:
Name Type Description
vPadding Number

setRowHeight(height)

设置默认行高

Parameters:
Name Type Description
height Number

setScrollBarColor(height)

设置滚动条颜色

Parameters:
Name Type Description
height color

setScrollBarSize(size)

设置滚动条宽度,默认值为7

Parameters:
Name Type Description
size Number

setTranslateX(v)

设置水平平移值

Parameters:
Name Type Description
v Number

水平平移值

See:

setTranslateY(v)

设置垂直平移值

Parameters:
Name Type Description
v Number

垂直平移值

See:

setValue(id, value)

根据id设置对应item元素值

Parameters:
Name Type Description
id String
value String
See:

setVGap(vGap)

设置表单组件水平间距,默认值为6

Parameters:
Name Type Description
vGap Number

setVPadding(vPadding)

设置表单顶部和顶部与组件内容的间距,默认值为8

Parameters:
Name Type Description
vPadding Number

tx(value)

获取或设置水平平移值,没有参数时相当于getTranslateX,有参数时相当于setTranslateY

Parameters:
Name Type Description
value Number

平移值

ty(value)

获取或设置垂直平移值,没有参数时相当于getTranslateY,有参数时相当于setTranslateY

Parameters:
Name Type Description
value Number

平移值

v(id, value) → {Object}

根据id获取或设置对应item元素值
1、一个参数:
· 当参数为 String 时相当于 getValue
· 当参数为 Object 时,则会遍历该 Object 中的属性,逐个调用 setValue 设置item元素值;
2、两个参数:
· 相当于 setValue

Parameters:
Name Type Description
id String | Object
value String
Returns:
Object