Methods

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

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

Parameters:

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

Returns:

void

addToDOM(parentNode) → {void}

将视图插入到 dom 中

Parameters:

Name	Type	Attributes	Description
parentNode	HTMLDivElement	<optional>	父DOM

Returns:

void

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

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

Parameters:

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

Returns:

void

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

绘制列头，可重载自定义

Parameters:

Name	Type	Description
g	CanvasRenderingContext2D	画笔对象
column	ht.Column	列信息
x	number	左上角x坐标
y	number	左上角y坐标
width	number	绘制的宽度
height	number	绘制的高度

Returns:

void

getCheckIcon(data) → {string}

返回data对象对应的check图标，可重载自定义check图标，该函数在checkMode模式下有效

Parameters:

Name	Type	Description
data	ht.Data	数据元素

Returns:

string

getColumnLineColor() → {string}

获取列线颜色

Returns:

string

getHeight() → {number}

获取布局高度

Returns:

number

getIndent() → {number}

获取缩进，一般当作列头图标的宽度

Returns:

number

getInsertColor() → {string}

获取移动列时可插入位置的提示颜色

Returns:

string

getLabel(column) → {string}

获取列头文字信息，默认返回column.toLabel()，可重载自定义

Parameters:

Name	Type	Description
column	ht.Column	数据元素

Returns:

string

getLabelAlign(column) → {string}

获取列头文字水平对齐方式，默认会考虑column.getAlign()值，可重载自定义

Parameters:

Name	Type	Description
column	ht.Column

Returns:

string

getLabelColor(column) → {string}

获取列头文字颜色，默认会返回column.getColor()||tableHeader.getLabelColor();

Parameters:

Name	Type	Description
column	ht.Column

Returns:

string

getLabelFont(column) → {string}

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

Parameters:

Name	Type	Description
column	ht.Column

Returns:

string

getLogicalPoint(event) → {Object}

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

Parameters:

Name	Type	Description
event	Event	事件对象

Returns:

Object

getMoveBackground() → {string}

获取移动列时的列头背景色

Returns:

string

getSortAscIcon() → {string}

获取表头列升序图标

Returns:

string

getSortDescIcon() → {string}

获取表头列降序图标

Returns:

string

getTableView() → {ht.widget.TableView|ht.widget.TreeTableView}

获取绑定的表格组件

Returns:

ht.widget.TableView | ht.widget.TreeTableView

getView() → {HTMLDivElement}

获取组件的根层div

Returns:

HTMLDivElement

getWidth() → {number}

获取布局宽度

Returns:

number

invalidate(delay) → {void}

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

Parameters:

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

Returns:

void

isColumnLineVisible() → {boolean}

获取列线是否可见，默认为true

Returns:

boolean

isDisabled() → {boolean}

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

Returns:

boolean

isMovable() → {boolean}

获取列顺序是否允许移动改变，默认为true

Returns:

boolean

isResizable() → {boolean}

获取列宽是否允许改变，默认为true

Returns:

boolean

iv(delay) → {void}

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

Parameters:

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

Returns:

void

lp(event) → {Object}

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

Parameters:

Name	Type	Description
event	Event	事件对象

Returns:

Object

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

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

Parameters:

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

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

setCheckIcon(icon) → {void}

设置check图标

Parameters:

Name	Type	Description
icon	string

Returns:

void

setColumnLineColor(color) → {void}

设置列线颜色

Parameters:

Name	Type	Description
color	string

Returns:

void

setColumnLineVisible(v) → {void}

设置列线是否可见

Parameters:

Name	Type	Description
v	boolean

Returns:

void

setDisabled(value, iconUrl) → {void}

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

Parameters:

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

Returns:

void

setHeight(v) → {void}

设置布局高度

Parameters:

Name	Type	Description
v	number	高度值

Returns:

void

setIndent(v) → {void}

设置缩进，一般当作列头图标的宽度

Parameters:

Name	Type	Description
v	number

Returns:

void

setInsertColor(color) → {void}

设置移动列时可插入位置的提示颜色

Parameters:

Name	Type	Description
color	string

Returns:

void

setLabelColor(v) → {void}

设置列头文本颜色

Parameters:

Name	Type	Description
v	string

Returns:

void

setLabelFont(v) → {void}

设置列头文本字体

Parameters:

Name	Type	Description
v	string

Returns:

void

setMovable(movable) → {void}

设置列顺序是否允许移动改变，默认为true

Parameters:

Name	Type	Description
movable	boolean

Returns:

void

setMoveBackground(color) → {string}

设置移动列时的列头背景色

Parameters:

Name	Type	Description
color	string

Returns:

string

setResizable(v) → {void}

设置列宽是否允许改变，默认为true

Parameters:

Name	Type	Description
v	boolean

Returns:

void

setSortAscIcon(icon) → {void}

设置表头列升序图标

Parameters:

Name	Type	Description
icon	string

Returns:

void

setSortDescIcon(icon) → {void}

设置表头列降序图标

Parameters:

Name	Type	Description
icon	string

Returns:

void

setWidth(v) → {void}

设置布局宽度

Parameters:

Name	Type	Description
v	number	宽度值

Returns:

void

ump(listener, scope) → {void}

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

Parameters:

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

Returns:

void

validate() → {void}

立刻刷新组件

Returns:

void