Requires

• module:ht-form.js

Methods

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

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

Parameters:

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

Returns:

void

See:

• mp

addToDOM(parentNode) → {void}

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

Parameters:

Name	Type	Attributes	Description
parentNode	HTMLElement	<optional>	父 DOM,默认为 document.body

Returns:

void

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

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

Parameters:

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

Returns:

void

close() → {void}

关闭下拉框

Returns:

void

disableToolTip() → {void}

关闭文字提示

Returns:

void

drawRow(g, data, isSelected, x, y, width, height) → {void}

绘制下拉框行，可重载自定义绘制

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
data	ht.Data	行对象
isSelected	boolean	行是否选中
x	number	矩形左上角 x 坐标
y	number	矩形左上角 y 坐标
width	number	矩形宽度
height	number	矩形高度

Returns:

void

drawValue(g, data, isSelected, x, y, width, height) → {void}

绘制下拉框行文本，可重载自定义绘制

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
data	ht.Data	行对象
isSelected	boolean	行是否选中
x	number	矩形左上角 x 坐标
y	number	矩形左上角 y 坐标
width	number	矩形宽度
height	number	矩形高度

Returns:

void

enableToolTip() → {void}

启用ToolTip

Returns:

void

firePropertyChange(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:

• fp

fireViewEvent(kind) → {void}

Parameters:

Name	Type	Description
kind	string

Returns:

void

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

派发属性变化事件，firePropertyChange 方法的简写

Parameters:

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

Returns:

void

See:

• firePropertyChange

getBackground() → {string}

获取按钮背景颜色

Returns:

string -

按钮背景颜色

getClass() → {function}

获取类声明(构造函数)

Returns:

function -

类声明(构造函数)

getClassName() → {string}

获取类全名

Returns:

string -

类全名

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:

HTMLElement -

被禁用组件的div

getDropDownBackground() → {string}

获取下拉背景颜色

Returns:

string -

背景颜色

getDropDownIcon() → {string}

获取下拉箭头图标

Returns:

string -

下拉箭头图标

getDropDownWidth() → {number}

获取下拉列表宽

Returns:

number -

下拉列表宽

getHeight() → {number}

获取布局高度

Returns:

number -

布局高度

getIcons() → {Array.<string>}

获取下拉可选值对应图标列表

Returns:

Array.<string> -

Array

getIndent() → {number}

获取图标缩进

Returns:

number -

图标缩进

getInput() → {HTMLElement}

获取输入框，需要开启可编辑 setEditable

Returns:

HTMLElement -

输入框

getLabelColor(label, isSelected) → {string}

获取下拉文本颜色

Parameters:

Name	Type	Description
label	string	文本
isSelected	boolean	是否选中

Returns:

string -

下拉文本颜色

getLabelFont(label, isSelected) → {string}

获取下拉文本字体

Parameters:

Name	Type	Description
label	string	文本
isSelected	boolean	是否选中

Returns:

string -

下拉文本字体

getLabels() → {Array.<string>}

获取下拉可选值对应文本

Returns:

Array.<string> -

下拉文本列表

getLabelSelectColor() → {string}

获取下拉选中项文本颜色

Returns:

string -

下拉文本颜色

getListView() → {ht.widget.ListView}

获取下拉列表视图组件

Returns:

ht.widget.ListView -

下拉列表视图组件

getMaxHeight() → {number}

获取组件下拉框最大高度

Returns:

number -

组件下拉框最大高度

getSelectBackground() → {string}

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

Returns:

string -

背景颜色

getSuperClass() → {function}

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

Returns:

function -

父类声明(构造函数)

getToolTip() → {string}

获取ToolTip文字，可重载返回自定义的toolTip文字

Returns:

string -

toolTip文字

getValue() → {any}

获取属性值

Returns:

any -

属性值

getValues() → {Array.<any>}

获取下拉可选值

Returns:

Array.<any> -

下拉可选值

getView() → {HTMLElement}

获取组件的根层div

Returns:

HTMLElement -

组件的根层div

getWidth() → {number}

获取布局宽度

Returns:

number -

布局宽度

invalidate(delay) → {void}

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

Parameters:

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

Returns:

void

See:

• iv

isDisabled() → {boolean}

获取组件是否可用

Returns:

boolean

isEditable() → {boolean}

获取组件是否编辑

Returns:

boolean

isEqual(label1, label2) → {boolean}

判断值是否相等

Parameters:

Name	Type	Description
label1	any	值1
label2	any	值2

Returns:

boolean

isOpened() → {boolean}

获取下拉框是否打开

Returns:

boolean

isStrict() → {boolean}

获取组件是否精确

Returns:

boolean

iv(delay) → {void}

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

Parameters:

Name	Type	Description
delay	number	延迟刷新的间隔事件(单位: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

onInputCreated() → {void}

输入框创建后，可重载监听

Returns:

void

onPropertyChanged(event) → {void}

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

Parameters:

Name	Type	Description
event	Object	属性变化事件

Returns:

void

Example

//event格式：
{
	property: 'name',//发生变化的属性
	oldValue: 'oldValue',//旧值
	newValue: 'newValue',''新值
	data: data//发生变化的data
}

onValueChanged(oldValue, newValue) → {void}

值改变，可重载监听

Parameters:

Name	Type	Description
oldValue	string	旧值
newValue	string	新值

Returns:

void

open() → {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

setBackground(color) → {void}

设置背景颜色

Parameters:

Name	Type	Description
color	string	颜色

Returns:

void

setCursor(style) → {void}

设置 css 的鼠标样式，cursor

Parameters:

Name	Type	Description
style	string	css 的鼠标样式

Returns:

void

setDisabled(value, iconUrl) → {void}

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

Parameters:

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

Returns:

void

setDropDownBackground(color) → {void}

设置下拉框背景颜色

Parameters:

Name	Type	Description
color	string	颜色

Returns:

void

setDropDownIcon(icon) → {void}

设置下拉箭头图标

Parameters:

Name	Type	Description
icon	string	下拉箭头图标

Returns:

void

setDropDownWidth(width) → {void}

设置下拉列表宽

Parameters:

Name	Type	Description
width	number	下拉列表宽

Returns:

void

setEditable(editable) → {void}

设置组件是否可编辑

Parameters:

Name	Type	Description
editable	boolean

Returns:

void

setFocus(value) → {void}

根据值给组件设置焦点

Parameters:

Name	Type	Attributes	Description
value	string	<optional>

Returns:

void

setHeight(height) → {void}

设置布局高度

Parameters:

Name	Type	Description
height	number	高度值

Returns:

void

setIcons(icons) → {void}

设置下拉可选值对应图标列表，数组长度需与values一致

Parameters:

Name	Type	Description
icons	Array.<string>	图标列表

Returns:

void

setIndent(indent) → {void}

设置图标缩进

Parameters:

Name	Type	Description
indent	number	缩进

Returns:

void

setInputValue(value) → {void}

设置输入框值

Parameters:

Name	Type	Description
value	string | number	值

Returns:

void

setLabelColor(color) → {void}

设置下拉文本颜色

Parameters:

Name	Type	Description
color	string	文本颜色

Returns:

void

setLabelFont(font) → {void}

设置下拉文本字体

Parameters:

Name	Type	Description
font	string	文本字体

Returns:

void

setLabels(labels) → {void}

设置下拉可选值对应文本，数组长度需与values一致

Parameters:

Name	Type	Description
labels	Array.<string>	下拉文本列表

Returns:

void

setLabelSelectColor(color) → {void}

设置下拉选中项文本颜色

Parameters:

Name	Type	Description
color	string	下拉文本颜色

Returns:

void

setMaxHeight(height) → {void}

设置组件下拉框最大高度

Parameters:

Name	Type	Description
height	number	组件下拉框最大高度

Returns:

void

setSelectBackground(color) → {void}

设置选中元素的背景色

Parameters:

Name	Type	Description
color	string	背景颜色

Returns:

void

setStrict(strict) → {void}

设置组件是否精确

Parameters:

Name	Type	Description
strict	boolean

Returns:

void

setToolTip(toolTip) → {void}

设置文字提示信息

Parameters:

Name	Type	Description
toolTip	string	文字提示

Returns:

void

setToolTipEnabled(enable) → {void}

设置提示是否可用

Parameters:

Name	Type	Description
enable	boolean

Returns:

void

setValue(value) → {void}

设置值

Parameters:

Name	Type	Description
value	any

Returns:

void

setValues(values) → {void}

获取和设置下拉可选值，其值类型需与 value 一致

Parameters:

Name	Type	Description
values	Array.<any>

Returns:

void

setWidth(width) → {void}

设置布局宽度

Parameters:

Name	Type	Description
width	number	宽度值

Returns:

void

toggle() → {void}

切换下拉框打开状态

Returns:

void

toIcon(value) → {string}

根据 value 值在 icons 中获取对应的 icon

Parameters:

Name	Type	Description
value	any

Returns:

string

ump(listener, scope) → {void}

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

Parameters:

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

Returns:

void

See:

• removePropertyChangeListener

validate() → {void}

立刻刷新拓扑

Returns:

void

validateImpl() → {void}

刷新

Returns:

void