Methods

addItem(item, index) → {void}

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

Parameters:

Name	Type	Attributes	Description
item	any		监听器函数
index	number	<optional>	监听器函数域

Returns:

void

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

disableToolTip() → {void}

关闭ToolTip功能

Returns:

void

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

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

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
item	Object	元素
x	number	x坐标
height	number	绘制的高度

Returns:

number -

宽度值

enableToolTip() → {void}

启用ToolTip

Returns:

void

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

派发改变事件

Parameters:

Name	Type	Description
property	string	属性
oldValue	any	旧值
newValue	any	新值

Returns:

void

See:

• fp

fireViewEvent(kind) → {void}

Parameters:

Name	Type	Description
kind	string

Returns:

void

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

派发改变事件

Parameters:

Name	Type	Description
property	string	属性
oldValue	any	旧值
newValue	any	新值

Returns:

void

See:

• firePropertyChange

getClass() → {function}

获取类声明(构造函数)

Returns:

function -

类声明(构造函数)

getClassName() → {string}

获取类全名

Returns:

string -

类全名

getCurrentItem() → {Object}

获取当前选中toolItem

Returns:

Object

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:

HTMLElement -

被禁用组件的div

getHeight() → {number}

获取布局高度

Returns:

number -

布局高度

getItemById(id) → {any}

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

Parameters:

Name	Type	Description
id	Object

Returns:

any -

菜单项对象

getItemGap() → {number}

获取元素之间的间距

Returns:

number -

元素之间的间距

getItemInfos() → {Array.<Object>}

获取toolBar的所有item的信息

Returns:

Array.<Object> -

toolBar的所有item的信息

getItems() → {Array.<Object>}

获取工具条元素数组

Returns:

Array.<Object>

getLabelColor(item) → {string}

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

Parameters:

Name	Type	Description
item	Object

Returns:

string -

标题文字颜色

getLabelFont() → {string}

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

Returns:

string -

标题文本字体

getLabelSelectColor() → {string}

获取文本选中颜色

Returns:

string

getLogicalPoint(e) → {Object}

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

Parameters:

Name	Type	Description
e	Event

Returns:

Object

See:

• lp

getSelectBackground() → {string}

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

Returns:

string

getSeparatorColor() → {string}

获取分割线的颜色

Returns:

string -

分割线的颜色

getSumWidth() → {number}

Returns:

number

getSuperClass() → {function}

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

Returns:

function -

父类声明(构造函数)

getToolTip(e) → {string}

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

Parameters:

Name	Type	Description
e	Event	鼠标或Touch事件对象

Returns:

string -

toolTip文字，默认取出鼠标下的图元，然后返回其getToolTip()

getTranslateX() → {number}

获取水平平移值

Returns:

number -

水平平移值

See:

• tx

getValue(id) → {string}

根据id获取对应item元素值

Parameters:

Name	Type	Description
id	string	id值

Returns:

string -

对应item元素值

See:

• v

getView() → {HTMLElement}

获取组件的根层div

Returns:

HTMLElement -

组件的根层div

getWidth() → {number}

获取布局宽度

Returns:

number -

布局宽度

handleClick(fun) → {void}

点击事件回调，可重载自定义

Parameters:

Name	Type	Description
fun	function	回调函数，可返回点击选中的item，鼠标事件mouseEvent

Returns:

void

invalidate(delay) → {void}

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

Parameters:

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

Returns:

void

See:

• iv

isDisabled() → {boolean}

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

Returns:

boolean -

组件是否处于不可用状态

isScrollable() → {boolean}

获取工具条是否可滚动，默认值为fasle

Returns:

boolean -

工具条是否可滚动

isStickToRight() → {boolean}

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

Returns:

boolean -

是否向右对齐排布

iv(delay) → {void}

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

Parameters:

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

Returns:

void

See:

• invalidate

lp(event) → {Object}

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

Parameters:

Name	Type	Description
event	Object	数据模型

Returns:

Object -

组件中的逻辑坐标

See:

• getLogicalPoint

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

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

Parameters:

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

Returns:

void

See:

• addPropertyChangeListener

onPropertyChanged(event) → {void}

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

Parameters:

Name	Type	Description
event	Object	属性变化事件

Returns:

void

Example

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

redraw() → {void}

重绘组件

Returns:

void

removeItem(item) → {void}

删除指定元素

Parameters:

Name	Type	Description
item	Object

Returns:

void

removeItemById(id) → {void}

根据id删除指定元素

Parameters:

Name	Type	Description
id	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

setDisabled(value, iconUrl) → {void}

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

Parameters:

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

Returns:

void

setHeight(v) → {void}

设置布局高度

Parameters:

Name	Type	Description
v	number	高度值

Returns:

void

setItemGap(gap) → {void}

设置元素之间的间距

Parameters:

Name	Type	Description
gap	number

Returns:

void

setItems(items) → {void}

设置工具条元素数组

Parameters:

Name	Type	Description
items	Array.<Object>

Returns:

void

setLabelColor(Color) → {void}

设置文本颜色

Parameters:

Name	Type	Description
Color	string	颜色值

Returns:

void

setLabelFont(font) → {void}

设置文本字体

Parameters:

Name	Type	Description
font	string	字体

Returns:

void

setLabelSelectColor(color) → {void}

设置文本选中颜色

Parameters:

Name	Type	Description
color	string	文本选中颜色

Returns:

void

setSelectBackground(Color) → {void}

设置文本选中背景颜色

Parameters:

Name	Type	Description
Color	string	颜色值

Returns:

void

setSeparatorColor(Color) → {void}

设置分割线颜色

Parameters:

Name	Type	Description
Color	string	颜色值

Returns:

void

setStickToRight(v) → {void}

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

Parameters:

Name	Type	Description
v	boolean

Returns:

void

setTranslateX(x) → {void}

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

Parameters:

Name	Type	Description
x	number	水平平移(滚动)值

Returns:

void

setValue(id, value) → {void}

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

Parameters:

Name	Type	Description
id	string	元素id
value	any	值

Returns:

void

See:

• v

setWidth(width) → {void}

设置布局宽度

Parameters:

Name	Type	Description
width	number	宽度

Returns:

void

tx(value) → {void}

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

Parameters:

Name	Type	Description
value	number	平移(滚动)值

Returns:

void

ump(listener, scope) → {void}

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

Parameters:

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

Returns:

void

See:

• removePropertyChangeListener

v(id, value) → {any}

根据id获取或设置对应item元素值，比如input的值；一个参数时相当于getValue，有参数时相当于setValue

Parameters:

Name	Type	Attributes	Description
id	any	<optional>	元素id
value	any	<optional>	值

Returns:

any

validate() → {void}

立刻刷新组件

Returns:

void