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

adjustValue(value) → {boolean}

传入属性值，返回最终值，默认使用最大最小值进行限制，可重载限制值范围

Parameters:

Name	Type	Description
value	number	属性值

Returns:

boolean

disableToolTip() → {void}

关闭ToolTip功能

Returns:

void

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

绘制背景，可重载自定义绘制

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
x	number	矩形左上角 x 坐标
y	number	矩形左上角 y 坐标
width	number	矩形宽度
height	number	矩形高度

Returns:

void

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

绘制按钮，可重载自定义绘制

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
x	number	矩形左上角 x 坐标
y	number	矩形左上角 y 坐标
width	number	矩形宽度
height	number	矩形高度

Returns:

void

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

绘制左边背景，可重载自定义绘制

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
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

getBackground() → {string}

获取背景颜色

Returns:

string -

按钮背景颜色

getButton() → {string|Object|HTMLCanvasElement|HTMLImageElement}

获取滑动按钮

Returns:

string | Object | HTMLCanvasElement | HTMLImageElement -

滑动按钮，可以是 img对象、canvas对象、矢量对象 或 已经注册的图片名称

getButtonWidth() → {number}

获取滑块宽度

Returns:

number -

滑块宽度

getClass() → {function}

获取类声明(构造函数)

Returns:

function -

类声明(构造函数)

getClassName() → {string}

获取类全名

Returns:

string -

类全名

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:

HTMLElement -

被禁用组件的div

getHeight() → {number}

获取布局高度

Returns:

number -

布局高度

getLeftBackground() → {string}

获取左边背景颜色

Returns:

string -

背景颜色

getMax() → {number}

获取最大值

Returns:

number -

最大值

getMin() → {number}

获取最小值

Returns:

number -

最小值

getPadding() → {number}

获取内边距

Returns:

number -

内边距

getStep() → {number}

获取滑动步进

Returns:

number -

步进

getSuperClass() → {function}

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

Returns:

function -

父类声明(构造函数)

getThickness() → {number}

获取滑动条粗细

Returns:

number -

滑动条粗细

getToolTip() → {string}

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

Returns:

string -

toolTip文字

getValue() → {string}

获取属性值

Returns:

string -

属性值

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

isInstant() → {boolean}

组件是否立即使用

Returns:

boolean -

组件是否立即使用

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

onBeginValueChanged() → {void}

组件值改变之前回调，可重载做后续处理

Returns:

void

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

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

setButton(image) → {void}

设置滑动按钮

Parameters:

Name	Type	Description
image	string | Object | HTMLCanvasElement | HTMLImageElement	滑动按钮，可以是 img对象、canvas对象、矢量对象 或 已经注册的图片名称

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

setFocus(value) → {void}

根据值给组件设置焦点

Parameters:

Name	Type	Attributes	Description
value	string	<optional>

Returns:

void

setHeight(height) → {void}

设置布局高度

Parameters:

Name	Type	Description
height	number	高度值

Returns:

void

setInstant(v) → {void}

设置组件是否立即使用

Parameters:

Name	Type	Description
v	boolean

Returns:

void

setLeftBackground(color) → {void}

设置滑动条左边背景颜色

Parameters:

Name	Type	Description
color	string	颜色

Returns:

void

setMax(max) → {void}

设置滑动条最大值

Parameters:

Name	Type	Description
max	number	滑动条最大值

Returns:

void

setMin(min) → {void}

设置滑动条最小值

Parameters:

Name	Type	Description
min	number	滑动条最小值

Returns:

void

setPadding(padding) → {void}

设置滑动条内边距

Parameters:

Name	Type	Description
padding	number	滑动条内边距

Returns:

void

setStep(step) → {void}

设置滑动条步进

Parameters:

Name	Type	Description
step	number	滑动条步进

Returns:

void

setThickness(thickness) → {void}

设置滑动条厚度

Parameters:

Name	Type	Description
thickness	number	滑动条厚度

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	number

Returns:

void

setWidth(width) → {void}

设置布局宽度

Parameters:

Name	Type	Description
width	number	宽度值

Returns:

void

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