ht.widget.Toolbar(items)

new Toolbar(items)

工具条组件,提供按钮等组件的水平摆放功能

Parameters:
Name Type Description
items Array

配置json,详细内容可以参考Toolbar手册

Methods

addItem(item, index)

在指定index位置插入新元素,index为空代表插入到最后

Parameters:
Name Type Attributes Description
item Object

监听器函数

index Number <optional>

监听器函数域

addPropertyChangeListener(listener, scope, ahead)

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

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

ahead Boolean <optional>

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

See:

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>

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

disableToolTip()

关闭ToolTip功能

drawItem(g, item, x, height) → {Number}

绘制元素,并返回该元素所占的宽度值

Parameters:
Name Type Description
g CanvasRenderingContext2D

画笔对象

item Object

元素

x Number

x坐标

height Number

绘制的高度

Returns:
Number -

宽度值

enableToolTip()

启用ToolTip

getHeight() → {Number}

获取布局高度

Returns:
Number

getItemById(id) → {Object}

获取指定id对应的元素,id值为item元素上的id属性定义

Parameters:
Name Type Description
id Object
Returns:
Object

getItemGap() → {Number}

获取元素之间的间距

Returns:
Number

getItems() → {Array}

获取工具条元素数组

Returns:
Array

getLabelColor(item) → {color}

获取文本颜色,可重载自定义

Parameters:
Name Type Description
item Object
Returns:
color

getLabelFont() → {String}

获取文本字体,可重载自定义

Returns:
String

getLabelSelectColor() → {color}

获取文本选中颜色

Returns:
color

getLogicalPoint(event) → {Object}

传入HTML事件对象,将事件坐标转换为组件中的逻辑坐标

Parameters:
Name Type Description
event Event

事件对象

Returns:
Object
See:

getSelectBackground() → {color}

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

Returns:
color

getSeparatorColor() → {color}

获取分割条颜色

Returns:
color

getToolTip(e) → {String}

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

Parameters:
Name Type Description
e Event

鼠标或Touch事件对象

Returns:
String -

toolTip文字,默认取出鼠标下的元素,然后返回其toolTip

getTranslateX() → {Number}

获取水平平移(滚动)值

Returns:
Number

getValue(id) → {Object}

根据id获取对应item元素值,比如input的值

Parameters:
Name Type Description
id Object

元素id

Returns:
Object
See:

getView() → {HTMLDivElement}

获取组件的根层div

Returns:
HTMLDivElement

getWidth() → {Number}

获取布局宽度

Returns:
Number

invalidate(delay)

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

Parameters:
Name Type Description
delay Number

延迟刷新的间隔事件(单位:ms)

See:

isDisabled() → {Boolean}

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

Returns:
Boolean

isStickToRight() → {Boolean}

获取是否向右对齐排布,默认为false

Returns:
Boolean

iv(delay)

无效组件,并调用延时刷新,invalidate的缩写

Parameters:
Name Type Description
delay Number

延迟刷新的间隔事件(单位:ms)

See:

lp(event) → {Object}

传入HTML事件对象,将事件坐标转换为组件中的逻辑坐标,getLogicalPoint的缩写

Parameters:
Name Type Description
event Event

事件对象

Returns:
Object
See:

mp(listener, scope, ahead)

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

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

ahead Boolean <optional>

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

See:

redraw()

重绘组件

removeItem(item)

删除指定元素

Parameters:
Name Type Description
item Object

removeItemById(id)

根据id删除指定元素

Parameters:
Name Type Description
id Object

removePropertyChangeListener(listener, scope)

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

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

removeViewListener(listener, scope)

删除视图事件监听器

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

setDisabled(value, iconUrl)

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

Parameters:
Name Type Attributes Description
value Boolean

是否禁用组件

iconUrl String <optional>

蒙板上显示的icon的路径

setHeight(height)

设置布局高度

Parameters:
Name Type Description
height Number

高度值

setItemGap(gap)

设置元素之间的间距

Parameters:
Name Type Description
gap Number

setItems(items)

设置工具条元素数组

Parameters:
Name Type Description
items Array

setLabelColor(v)

设置文本颜色

Parameters:
Name Type Description
v color

setLabelFont(v)

设置文本字体

Parameters:
Name Type Description
v String

setLabelSelectColor(v)

设置文本选中颜色

Parameters:
Name Type Description
v color

setSelectBackground(v)

设置选中元素的背景色,可重载自定义

Parameters:
Name Type Description
v color

setSeparatorColor(v)

设置分割条颜色

Parameters:
Name Type Description
v color

setStickToRight(v)

设置是否向右对齐排布,默认为false

Parameters:
Name Type Description
v Boolean

setTranslateX(x)

设置拓扑水平平移(滚动)值

Parameters:
Name Type Description
x Number

水平平移(滚动)值

setValue(id, value)

根据id设置对应item元素值,比如input的值

Parameters:
Name Type Description
id Object

元素id

value Object

See:

setWidth(width)

设置布局宽度

Parameters:
Name Type Description
width Number

宽度

tx(value)

获取或设置水平平移(滚动)值,没有参数时相当于getTranslateX,有参数时相当于setTranslateX

Parameters:
Name Type Description
value Number

平移(滚动)值

ump(listener, scope)

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

Parameters:
Name Type Attributes Description
listener function

监听器函数

scope Object <optional>

监听器函数域

See:

v(id, value) → {Object}

根据id获取或设置对应item元素值,比如input的值;没有参数时相当于getValue,有参数时相当于setValue

Parameters:
Name Type Attributes Description
id Object <optional>

元素id

value Object <optional>

Returns:
Object

validate()

立刻刷新组件