HT for web Class: TreeTableView

new TreeTableView(dataModel)

树表组件，以树和表格的组合方式呈现 DataModel 中数据元素属性及父子关系

组件在交互过程中经常派发出一些事件，可以通过 addViewListener 监听，常见事件如下(不含从父类继承)：

事件名	事件对象	描述
`expandAll`	{ kind: 'expandAll', // 事件类型 source: treeTableView // 事件源 }	调用 expandAll 展开所有节点时派发
`collapseAll`	{ kind: 'collapseAll', // 事件类型 source: treeTableView // 事件源 }	调用 collapseAll 合并所有节点时派发
`expand`	{ kind: 'expand', // 事件类型 data: data, // 被展开的数据元素 source: treeTableView // 事件源 }	调用 expand 展开单个节点时派发
`collapse`	{ kind: 'collapse', // 事件类型 data: data, // 被合并的数据元素 source: treeTableView // 事件源 }	调用 collapse 合并单个节点时派发
`clickData`	{ kind: 'clickData', data: data, nativeEvent: e }	单击节点时派发
`doubleClickData`	{ kind: 'doubleClickData', data: data, nativeEvent: e }	双击节点时派发
`beginEdit`	{ kind: 'beginEdit' }	开始编辑时派发
`endEdit`	{ kind: 'endEdit', valueChanged: valueChanged }	结束编辑时派发
`invalidateModel`	{ kind: 'invalidateModel' }	无效模型时派发
`checkData`	{ kind: 'checkData', data: data }	check 模式下，鼠标点击节点复选框选中时派发的事件
`uncheckData`	{ kind: 'checkData', data: data }	check 模式下，鼠标点击节点复选框取消选中时派发的事件

样式属性(不含从父类继承)：labelColor, selectLabelColor, hoverLabelColor, labelFont, sortMode, batchEditable, indent, checkMode, rootVisible, sortFunc, visibleFunc, autoMakeVisible, rowLineColor, rowHeight, rowLineVisible, columnLineVisible, columnLineColor, rowBackground, rowBackgroundDrawable, selectRowBackground, selectRowBackgroundDrawable expandIcon, expandIconDrawable, collapseIcon, collapseIconDrawable, hoverExpandIcon, hoverExpandIconDrawable, hoverCollapseIcon, hoverCollapseIconDrawable, selectExpandIcon, selectExpandIconDrawable, selectCollapseIcon, selectCollapseIconDrawable, rowHeightFunc, hoverRowBackground, hoverRowBackgroundDrawable, focusRowBackground, focusRowBackgroundDrawable, iconWidth, iconHeight, iconGap, checkIcon, checkIconDrawable, uncheckIcon, uncheckIconDrawable, indeterminateIcon, indeterminateIconDrawable, radioOnIcon, radioOnIconDrawable, radioOffIcon, radioOffIconDrawable, preferredSizeRowCountLimit, scrollBarColor, scrollBarSize, scrollBarTimeout, scrollBarMinLength, scrollBarActiveSize, scrollBarMode, dragEnabled, dropEnabled, dropLineColor, fixedShadow, editorValidator

Parameters:

Name	Type	Description
`dataModel`	ht.DataModel \| Object	绑定的数据模型或是属性配置对象

Extends

ht.ui.View

Methods

acceptDrop(e)

接受拖拽数据；可重写此函数，根据拖拽事件加业务判断是否接受拖拽数据

Parameters:

Name	Type	Description
`e`	Event	拖拽事件，格式为：{source: source, target: target, data: data, kind: 'dragEnter', nativeEvent: event}

addBottomPainter(painter)

增加底层绘制器
开发者可以使用 Canvas 的画笔对象自由绘制任意形状，底层绘制器绘制在组件最下面

Parameters:

Name	Type	Description
`painter`	function	绘制器函数

Example

 // 示例：
treeTableView.addBottomPainter(function(g) {
     g.save();
     // draw...
     g.restore();
});

addColumns(columns)

以 json 的方式配置表格中的列(新增)

Parameters:

Name	Type	Description
`columns`	Array	json 列

Example

 // 示例：
tableView.addColumns([{
	name: 'id',
	displayName: '序号'
},
{
	name: 'background',
	accessType: 'style'
}
]);

addPropertyChangeListener(listener, scope, ahead)

增加属性事件变化监听函数

Parameters:

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

Inherited From:

ht.ui.View#addPropertyChangeListener

addStyleProperty(property)

追加样式属性，将参数属性加入到样式属性列表中

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#addStyleProperty

addToDOM(dom, rect)

将组件加到页面的 DOM 树中；如果没有任何参数，或者只指定第一个参数并且第一个参数为 window，则组件会填满整个浏览器窗口，并且浏览器窗口大小变化时也会自动刷新组件

Parameters:

Name	Type	Argument	Description
`dom`	HTMLElement	<optional>	指定组件的父亲 DOM，如果为空，则加到 body 中
`rect`	Object	<optional>	组件的范围，格式为 {x: x, y: y, width: width, height: height}；如果为空，则填满父亲 DOM

Inherited From:

ht.ui.View#addToDOM

addTopPainter(painter)

增加顶层绘制器
开发者可以使用 Canvas 的画笔对象自由绘制任意形状，顶层绘制器绘制在组件最上面

Parameters:

Name	Type	Description
`painter`	function	绘制器函数

Example

 // 示例：
treeTableView.addTopPainter(function(g) {
     g.save();
     // draw...
     g.restore();
});

addViewListener(listener, scope, ahead)

增加 View 事件监听器，如 invalidate(无效事件)、beginValidate 等事件

Parameters:

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

Inherited From:

ht.ui.View#addViewListener

adjustTranslateX(value) → {Number}

调用 setTranslateX 之前调用此函数确保滚动值是合理范围内，如果滚动值不合理，将会被调整并返回

Parameters:

Name	Type	Description
`value`	Number	调整之前的滚动值

Returns:

调整后的滚动值

Type: Number

adjustTranslateY(value) → {Number}

调用 setTranslateY 之前调用此函数确保滚动值是合理范围内，如果滚动值不合理，将会被调整并返回

Parameters:

Name	Type	Description
`value`	Number	调整之前的滚动值

Returns:

调整后的滚动值

Type: Number

beginEdit(data, 事件对象或, editor)

开始编辑数据，可以调用这个函数手动启动编辑

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素
`事件对象或`	Event \| ht.ui.Column	Column 实例
`editor`	String \| Class \| ht.ui.editor.Editor	编辑器类或类名或实例

checkData(data)

模拟鼠标点击勾选一个节点

Parameters:

Name	Type	Description
`data`	ht.Data	节点

checkDatas(datas)

模拟鼠标点击勾选一批节点

Parameters:

Name	Type	Description
`datas`	Array	节点数组

checkHitTest(e, data) → {Boolean}

判断在 check 模式下，是否点击中了 check 区域

Parameters:

Name	Type	Argument	Description
`e`	Event		事件对象
`data`	Event	<optional>	数据元素

Returns:

是否点击中 check 区域

Type: Boolean

collapse(data)

合并数据元素(如果数据元素有子元素并处于展开状态)

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

collapseAll()

合并所有数据元素

createDragImage(data, selection) → {HTMLCanvasElement|HTMLImageElement|HTVector|String}

生成拖拽图片

Parameters:

Name	Type	Description
`data`	ht.Data	开始拖拽的节点
`selection`	ht.List	开始拖拽时选中的节点列表

Returns:

图片，可以是 Canvas 对象、Image 对象、矢量对象或注册的图片名称

Type: HTMLCanvasElement | HTMLImageElement | HTVector | String

disableToolTip()

禁用工具提示，同 setToolTipEnabled

See:

setToolTipEnabled

dm(dataModel) → {ht.DataModel}

获取或设置数据模型，没有参数时相当于 getDataModel，有参数时相当于 setDataModel

Parameters:

Name	Type	Argument	Description
`dataModel`	ht.DataModel	<optional>	数据模型

Returns:

dataModel

Type: ht.DataModel

drawBackground(background, x, y, width, height, dom)

绘制背景

Parameters:

Name	Type	Argument	Description
`background`	ht.ui.drawable.Drawable		背景 Drawable
`x`	Number	<optional>	起点 x 坐标
`y`	Number	<optional>	起点 y 坐标
`width`	Number	<optional>	宽度
`height`	Number	<optional>	高度
`dom`	HTMLElement	<optional>	指定绘制的目标 DOM

Inherited From:

ht.ui.View#drawBackground

drawBorder(border, x, y, width, height, dom)

绘制边框

Parameters:

Name	Type	Argument	Description
`border`	ht.border.Border		边框对象
`x`	Number	<optional>	起点 x 坐标
`y`	Number	<optional>	起点 y 坐标
`width`	Number	<optional>	宽度
`height`	Number	<optional>	高度
`dom`	HTMLElement	<optional>	指定绘制的目标 DOM

Inherited From:

ht.ui.View#drawBorder

drawCell(g, data, selected, column, x, y, width, height) → {HTMLElement}

绘制单元格，可重写自定义单元格渲染，如果返回值为 DOM 对象，则使用该 DOM 元素作为渲染器

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`data`	ht.Data	数据元素
`selected`	Boolean	数据元素是否选中
`column`	ht.ui.Column	列
`x`	Number	左上角 x 坐标
`y`	Number	左上角 y 坐标
`width`	Number	绘制的宽度
`height`	Number	绘制的高度

Returns:

DOM 渲染器

Type: HTMLElement

drawIcon(g, data, x, y, width, height)

绘制数据元素的图标

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`data`	ht.Data	数据元素
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度

drawLabel(g, data, x, y, height)

绘制数据元素的文本；注意：label 没有 width 参数限制

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`data`	ht.Data	数据元素
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`height`	Number	绘制范围的高度

drawRowBackground(drawable, x, y, width, height, data)

绘制行背景，默认仅在选中行时填充选中背景以及 hover 时填充 hover 背景，可重写自定义

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	Drawable 对象
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`data`	ht.Data	数据元素

enableToolTip()

启用工具提示，同 setToolTipEnabled

See:

setToolTipEnabled

endEdit(setValue)

结束编辑数据，可以调用这个函数手动结束编辑

Parameters:

Name	Type	Description
`setValue`	Boolean	是否将 Editor 中的值同步到模型中，如果为 false，Editor 中的值被丢弃

endEditImpl(value, saveValue, data, column)

结束编辑数据，可以调用这个函数手动结束编辑，重写此函数可以实现编辑数据验证

Parameters:

Name	Type	Description
`value`	Object	单元格的值
`saveValue`	Boolean	是否保存值
`data`	ht.Data	正在编辑的数据行
`column`	ht.ui.Column	正在编辑的数列

Example

var oldEndEditImpl = tableView.endEditImpl;
tableView.endEditImpl = function(value, saveValue, data, column) {
if (column.getName() === 'name') {
     if (value === '1') {
         // 数据不合法，保持编辑状态
         return;
     }
     else if (value === '2') {
         // 数据不合法，丢掉编辑值，同时结束编辑
         oldEndEditImpl.call(this, value, false, data, column);
         return;
     }
 }
 // 数据正常，结束编辑
 oldEndEditImpl.call(this, value, saveValue, data, column);
 
}

expand(data)

展开数据元素(如果数据元素有子元素并且处于合并状态)

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

expandAll({data})

展开所有数据元素

Parameters:

Name	Type	Description
`{data}`	ht.Data	如果指定此参数，则只展开此节点以及此节点下的所有子孙节点；否则展开所有数据元素

figureMaxSize() → {Object}

计算 maxSize，maxSize 表示组件的最大尺寸，布局器布局时会考虑此尺寸；

Inherited From:

ht.ui.View#figureMaxSize

Returns:

maxSize

Type: Object

figureMinSize() → {Object}

计算 minSize，minSize 表示组件的最小尺寸，布局器布局时会考虑此尺寸；

Inherited From:

ht.ui.View#figureMinSize

Returns:

minSize

Type: Object

figurePreferredSize() → {Object}

计算 preferredSize，preferredSize 表示组件自身最合适的尺寸，布局器布局时会考虑此尺寸；如果自定义组件一般需要重写此函数

Inherited From:

ht.ui.View#figurePreferredSize

Returns:

preferredSize

Type: Object

fireViewEvent(event)

派发 View 事件

Parameters:

Name	Type	Description
`event`	Object \| String	事件对象；如果是字符串，表示事件类型，函数内自动组装一个事件对象并派发示例：view.fireViewEvent('myevent') 等同于 view.fireViewEvent({kind: 'myevent'})

Inherited From:

ht.ui.View#fireViewEvent

fp(property, oldValue, newValue, compareFunc) → {Boolean}

派发属性变化事件，firePropertyChange 的缩写

Parameters:

Name	Type	Argument	Description
`property`	String		属性名
`oldValue`	Object		属性变化之前的值
`newValue`	Object		属性变化之后的值
`compareFunc`	function	<optional>	比较函数，用于比较新值和旧值是否一致，如果一致则不会派发事件

Inherited From:

ht.ui.View#fp

Returns:

事件是否派发成功

Type: Boolean

getAllRowDatas() → {ht.List}

获取所有可显示的数据元素集合，该集合已被排序和过滤(与 rowDatas 相比，此属性包含被折叠暂时不显示的数据元素)

Returns:

Type: ht.List

getBackground() → {Object}

获取组件的背景，可以是颜色或者图片等

Inherited From:

ht.ui.View#getBackground

See:

getBackgroundDrawable

Returns:

组件背景

Type: Object

getBackgroundDrawable() → {ht.ui.drawable.Drawable}

获取组件背景的 Drawable 对象

Inherited From:

ht.ui.View#getBackgroundDrawable

Returns:

组件背景

Type: ht.ui.drawable.Drawable

getBodyColor(data) → {color}

获取数据元素图标的染色，可重写自定义

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

颜色值，默认返回 data.s('body.color')

Type: color

getBorder() → {ht.border.Border}

获取组件的边框

Inherited From:

ht.ui.View#getBorder

Returns:

组件边框

Type: ht.border.Border

getBorderBottom() → {Number}

获取组件边框的底部高度

Inherited From:

ht.ui.View#getBorderBottom

Returns:

组件边框底部高度

Type: Number

getBorderColor(data) → {color}

获取数据元素图标的边框色，可重写自定义

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

颜色值，默认返回 data.s('border.color')

Type: color

getBorderLeft() → {Number}

获取组件边框的左侧宽度

Inherited From:

ht.ui.View#getBorderLeft

Returns:

组件边框左侧宽度

Type: Number

getBorderRadius() → {Number|Array}

获取 CSS 边框圆角

Inherited From:

ht.ui.View#getBorderRadius

Returns:

边框圆角

Type: Number | Array

getBorderRight() → {Number}

获取组件边框的右侧宽度

Inherited From:

ht.ui.View#getBorderRight

Returns:

组件边框右侧宽度

Type: Number

getBorderTop() → {Number}

获取组件边框的顶部高度

Inherited From:

ht.ui.View#getBorderTop

Returns:

组件边框顶部高度

Type: Number

getBoxShadow() → {String}

获取 CSS 阴影值

Inherited From:

ht.ui.View#getBoxShadow

Returns:

阴影值

Type: String

getCheckIcon() → {Object}

获取选中状态的多选图标，可以是颜色或者图片等

See:

getCheckIconDrawable

Returns:

图标

Type: Object

getCheckIconDrawable(数据行, 数据列) → {ht.ui.drawable.Drawable}

获取选中状态的多选图标的 Drawable 对象

Parameters:

Name	Type	Description
`数据行`	ht.Data
`数据列`	ht.ui.Column

Returns:

图标

Type: ht.ui.drawable.Drawable

getCheckMode() → {String}

获取 check 模式

null：默认值，不启用 check 选择模式
default：check 模式的默认选择方式，即单击选中或取消选中，只影响当前点击中的数据元素
children：该 check 模式将同时影响点击中的数据元素及其孩子元素
descendant：该 check 模式将同时影响点击中的数据元素及其所有子孙元素
all：该 check 模式将同时影响点击中的数据元素及其所有父辈和子孙元素

Returns:

check 模式

Type: String

getCollapseIcon() → {Object}

获取合并图标，可以是颜色或者图片等

See:

getCollapseIconDrawable

Returns:

图标

Type: Object

getCollapseIconDrawable() → {ht.ui.drawable.Drawable}

获取合并图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getColumnAt(e) → {ht.ui.Column}

获取交互事件所在的列

Parameters:

Name	Type	Description
`e`	Event	鼠标或 Touch 事件

Returns:

Type: ht.ui.Column

getColumnLineColor() → {color}

获取列线颜色

Returns:

颜色值

Type: color

getColumnModel() → {ht.DataModel}

获取列模型，列模型用于存储 Column 列对象信息

Returns:

列模型

Type: ht.DataModel

getContentBottom() → {Number}

获取内容底部距离，即底部边框高度加底部内边距高度

Inherited From:

ht.ui.View#getContentBottom

Returns:

内容底部距离

Type: Number

getContentDiv() → {HTMLElement}

获取内容 div；对于普通组件，contentDiv 里放置了 canvas 画布；对于容器组件，contentDiv 里除了画布，还有所有的子组件

Inherited From:

ht.ui.View#getContentDiv

Returns:

内容 div

Type: HTMLElement

getContentHeight() → {Number}

获取内容高度，即组件高度减去边框高度和上下内边距高度

Inherited From:

ht.ui.View#getContentHeight

Returns:

内容高度

Type: Number

getContentLeft() → {Number}

获取内容左侧距离，即左侧边框宽度加左侧内边距宽度

Inherited From:

ht.ui.View#getContentLeft

Returns:

内容左侧距离

Type: Number

getContentPoint(event) → {Object}

获取内容坐标点；此坐标与内边距和边框无关，是从内容区域左上角开始计算

Parameters:

Name	Type	Description
`event`	Event	交互事件对象(如鼠标事件对象)

Inherited From:

ht.ui.View#getContentPoint

Returns:

内容坐标点，包含 x、y 坐标

Type: Object

getContentRight() → {Number}

获取内容右侧距离，即右侧边框宽度加右侧内边距宽度

Inherited From:

ht.ui.View#getContentRight

Returns:

内容右侧距离

Type: Number

getContentTop() → {Number}

获取内容顶部距离，即顶部边框高度加顶部内边距高度

Inherited From:

ht.ui.View#getContentTop

Returns:

内容顶部距离

Type: Number

getContentWidth() → {Number}

获取内容宽度，即组件宽度减去边框宽度和左右内边距宽度

Inherited From:

ht.ui.View#getContentWidth

Returns:

内容宽度

Type: Number

getContextMenu() → {ht.ui.ContextMenu}

获取绑定的右键菜单

Inherited From:

ht.ui.View#getContextMenu

Returns:

右键菜单

Type: ht.ui.ContextMenu

getCurrentLabelColor(data) → {color}

获取数据元素的文本颜色，默认实现根据选中状态返回 labelColor 或 hoverLabelColor 或 selectLabelColor，可重写自定义

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

颜色值

Type: color

getCurrentSortFunc() → {function}

默认返回 sortFunc 函数，当 sortColumn 不为空时将返回其对应的排序函数

Returns:

排序函数

Type: function

getCursor() → {String}

获取鼠标样式(CSS 格式)

Inherited From:

ht.ui.View#getCursor

Returns:

鼠标样式

Type: String

getDataAt(pointOrEvent) → {ht.Data}

传入逻辑坐标点或者交互事件对象，返回坐标下的数据元素

Parameters:

Name	Type	Description
`pointOrEvent`	Object \| Event	逻辑坐标点或交互事件对象(如鼠标事件对象)

Returns:

坐标下的数据元素

Type: ht.Data

getDataModel() → {ht.DataModel}

获取绑定的数据模型

Returns:

数据模型

Type: ht.DataModel

getDisabledBackground() → {String}

组件被禁用时，遮罩的背景；这个值被设置到遮罩 div 的 background 样式上，因此可以使用所有 CSS 支持的 background 类型

Inherited From:

ht.ui.View#getDisabledBackground

Returns:

遮罩背景

Type: String

getDOMProperties() → {Object}

获取 DOM 属性映射表，格式为：{'width': true ...}；这些属性发生变化才会更新 DOM 结构，否则只需要绘制内容即可

Inherited From:

ht.ui.View#getDOMProperties

Returns:

DOM 属性映射表

Type: Object

getDropLineColor() → {color}

获取拖拽提示线颜色

Returns:

颜色值

Type: color

getEditor() → {ht.ui.editor.Editor}

获取编辑器

Returns:

编辑器实例

Type: ht.ui.editor.Editor

getEditorClass(data) → {String|function}

获取编辑器，可重写根据不同的数据元素返回不同的编辑器

Parameters:

Name	Type	Argument	Description
`data`	ht.Data	<optional>	数据元素

Returns:

编辑器类或类名

Type: String | function

getEditorValidator() → {function}

获取编辑器验证函数

Returns:

数据验证函数

Type: function

getEditorViewProperties(数据元素, 列)

获取编辑组件的属性，默认返回 column.s('editorViewProperties')

Parameters:

Name	Type	Description
`数据元素`	ht.Data
`列`	ht.ui.Column

getEndRowIndex() → {Number}

获取当前可见区域的结束行索引

Returns:

索引

Type: Number

getErrorMessage() → {String}

获取错误信息

Inherited From:

ht.ui.View#getErrorMessage

Returns:

错误信息

Type: String

getExpandIcon() → {Object}

获取展开图标，可以是颜色或者图片等

See:

getExpandIconDrawable

Returns:

图标

Type: Object

getExpandIconDrawable() → {ht.ui.drawable.Drawable}

获取展开图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getFixedShadow() → {color}

获取锁定列的阴影颜色

Returns:

颜色值

Type: color

getFocusData() → {ht.Data}

在 check 模式下，点击一个数据元素使其背景变化但并不选中它，此时它处于 focus 状态
此函数获取 focus 状态数据元素

Returns:

数据元素

Type: ht.Data

getFocusRowBackground() → {Object}

获取 check 模式下，点击行的背景；可以是颜色或者图片等

See:

getFocusRowBackgroundDrawable

Returns:

背景

Type: Object

getFocusRowBackgroundDrawable() → {ht.ui.drawable.Drawable}

获取 check 模式下，点击行背景的 Drawable 对象

Returns:

背景

Type: ht.ui.drawable.Drawable

getHeight() → {Number}

获取组件的高度

Inherited From:

ht.ui.View#getHeight

Returns:

组件高度

Type: Number

getHoverCollapseIcon() → {Object}

获取 hover 状态的合并图标，可以是颜色或者图片等

See:

getHoverCollapseIconDrawable

Returns:

图标

Type: Object

getHoverCollapseIconDrawable() → {ht.ui.drawable.Drawable}

获取 hover 状态的合并图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getHoverData() → {ht.Data}

获取 hover 状态的数据元素

Returns:

数据元素

Type: ht.Data

getHoverExpandIcon() → {Object}

获取 hover 状态的展开图标，可以是颜色或者图片等

See:

getHoverExpandIconDrawable

Returns:

图标

Type: Object

getHoverExpandIconDrawable() → {ht.ui.drawable.Drawable}

获取 hover 状态的展开图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getHoverLabelColor(data) → {color}

获取 hover 状态下文本的颜色

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

颜色值

Type: color

getHoverRowBackground() → {Object}

获取 hover 状态下的行背景；可以是颜色或者图片等

See:

getHoverRowBackgroundDrawable

Returns:

背景

Type: Object

getHoverRowBackgroundDrawable() → {ht.ui.drawable.Drawable}

获取 hover 状态下行选中背景的 Drawable 对象

Returns:

背景

Type: ht.ui.drawable.Drawable

getIcon(data) → {String}

获取数据元素对应的图标，默认返回 data.getIcon()，可重写自定义

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

图标

Type: String

getIconGap() → {Number}

返回图标之间的距离

Returns:

距离值

Type: Number

getIconHeight(data) → {Number}

返回数据元素的图标高度

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

高度值

Type: Number

getIconWidth(data) → {Number}

返回数据元素的图标宽度

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

宽度值

Type: Number

getId() → {Object}

获取唯一标识，根据标识可快速查找到组件

Inherited From:

ht.ui.View#getId

Returns:

唯一标识

Type: Object

getIndent() → {Number}

返回不同层次之间的缩进值

Returns:

缩进值

Type: Number

getIndeterminateIcon() → {Object}

获取半选中状态的图标，可以是颜色或者图片等

See:

getIndeterminateIconDrawable

Returns:

图标

Type: Object

getIndeterminateIconDrawable() → {ht.ui.drawable.Drawable}

获取半选中状态的图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getInteractorClasses() → {Array}

获取交互器类名数组

Inherited From:

ht.ui.View#getInteractorClasses

Returns:

交互器类名数组

Type: Array

getLabel(data) → {String}

获取数据元素显示的文本，默认返回 data.toLabel()，可重写自定义

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

文本内容

Type: String

getLabelColor(data) → {color}

获取数据元素的文本颜色

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

颜色值

Type: color

getLabelFont(data) → {String}

获取数据元素的文本字体，可重写自定义

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

文本字体

Type: String

getLayoutParams(key) → {Object}

获取布局参数

Parameters:

Name	Type	Argument	Description
`key`	String	<optional>	布局参数中的 key

Inherited From:

ht.ui.View#getLayoutParams

Returns:

如果指定 key 参数返回布局参数中 key 对应的值，否则返回整个布局参数对象

Type: Object

getLevel(data) → {Number}

获取数据元素的缩减层次，一般结合 indent 参数用于绘制

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

层次

Type: Number

getLoader() → {Object}

获取延迟加载器

Returns:

Type: Object

getMargin() → {Number|Array}

获取组件外边距，如果是数字，说明四边使用相同的外边距；如果是数组，则格式为：[上边距, 右边距, 下边距, 左边距]

Inherited From:

ht.ui.View#getMargin

Returns:

外边距

Type: Number | Array

getMarginBottom() → {Number}

获取组件底部外边距高度

Inherited From:

ht.ui.View#getMarginBottom

Returns:

底部外边距高度

Type: Number

getMarginRight() → {Number}

获取组件右侧外边距宽度

Inherited From:

ht.ui.View#getMarginRight

Returns:

右侧外边距宽度

Type: Number

getMarginTop() → {Number}

获取组件顶部外边距高度

Inherited From:

ht.ui.View#getMarginTop

Returns:

顶部外边距高度

Type: Number

getMarignLeft() → {Number}

获取组件左侧外边距宽度

Inherited From:

ht.ui.View#getMarignLeft

Returns:

左侧外边距宽度

Type: Number

getMatchedStyles() → {Object}

获取组件匹配到的样式

Inherited From:

ht.ui.View#getMatchedStyles

Returns:

Type: Object

getMaxSize() → {Object}

获取 maxSize，maxSize 表示组件自身最合适的尺寸；如果用户没有设置，则调用 figureMaxSize 计算

Inherited From:

ht.ui.View#getMaxSize

Returns:

maxSize

Type: Object

getMaxSizeProperties() → {Object}

获取 maxSize 属性映射表，格式为：{'border': true ...}；这些属性变化会重新计算 maxSize

Inherited From:

ht.ui.View#getMaxSizeProperties

Returns:

maxSize 属性映射表

Type: Object

getMinSize() → {Object}

获取 minSize，minSize 表示组件的最小尺寸；如果用户没有设置，则调用 figureMinSize 计算

Inherited From:

ht.ui.View#getMinSize

Returns:

minSize

Type: Object

getMinSizeProperties() → {Object}

获取 minSize 属性映射表，格式为：{'border': true ...}；这些属性变化会重新计算 minSize

Inherited From:

ht.ui.View#getMinSizeProperties

Returns:

minSize 属性映射表

Type: Object

getPadding() → {Number|Array}

获取组件内边距，如果是数字，说明四边使用相同的内边距；如果是数组，则格式为：[上边距, 右边距, 下边距, 左边距]

Inherited From:

ht.ui.View#getPadding

Returns:

内边距

Type: Number | Array

getPaddingBottom() → {Number}

获取组件底部内边距高度

Inherited From:

ht.ui.View#getPaddingBottom

Returns:

底部内边距高度

Type: Number

getPaddingLeft() → {Number}

获取组件左侧内边距宽度

Inherited From:

ht.ui.View#getPaddingLeft

Returns:

左侧内边距宽度

Type: Number

getPaddingRight() → {Number}

获取组件右侧内边距宽度

Inherited From:

ht.ui.View#getPaddingRight

Returns:

右侧内边距宽度

Type: Number

getPaddingTop() → {Number}

获取组件顶部内边距高度

Inherited From:

ht.ui.View#getPaddingTop

Returns:

顶部内边距高度

Type: Number

getParent() → {ht.ui.ViewGroup}

获取父容器

Inherited From:

ht.ui.View#getParent

Returns:

父容器

Type: ht.ui.ViewGroup

getPopover() → {ht.ui.Popover}

获取弹框组件

Inherited From:

ht.ui.View#getPopover

Returns:

弹框组件

Type: ht.ui.Popover

getPopoverPlacements() → {Array}

获取弹框组件的弹出位置

Inherited From:

ht.ui.View#getPopoverPlacements

Returns:

弹出位置

Type: Array

getPopoverTrigger() → {String}

获取弹框触发器

Inherited From:

ht.ui.View#getPopoverTrigger

Returns:

弹框触发器，值为：click|hover

Type: String

getPreferredSize() → {Object}

获取 preferredSize，preferredSize 表示组件自身最合适的尺寸，布局器布局时会考虑此尺寸；如果用户没有设置，则调用 figurePreferredSize 计算

Inherited From:

ht.ui.View#getPreferredSize

Returns:

preferredSize

Type: Object

getPreferredSizeProperties() → {Object}

获取 preferredSize 属性映射表，格式为：{'border': true ...}；这些属性变化会重新计算 preferredSize

Inherited From:

ht.ui.View#getPreferredSizeProperties

Returns:

preferredSize 属性映射表

Type: Object

getPreferredSizeRowCountLimit() → {Number}

获取计算 preferredSize 时要限制的数据行数

Returns:

限制行数

Type: Number

getPropertyValue(name) → {Object}

取组件的某个属性的原始值；不要直接去取私有变量，例如 padding，不要直接取 _padding 私有变量，而是应该使用此函数取值；此函数取值顺序：

先取 _padding 私有变量
如果为 undefind，再去取样式表中取值
如果为 undefied，再取 __padding 私有变量

Parameters:

Name	Type	Description
`name`	String	属性名

Inherited From:

ht.ui.View#getPropertyValue

Returns:

属性值

Type: Object

Example

// 这段代码演示了覆盖 getPadding 函数，先取出旧的 padding，再 +2 并返回
button.getPadding = function() {
	var oldPadding = this.getPropertyValue('padding');
	oldPadding += 2;
	return oldPadding;
}

getRadioOffIcon() → {Object}

获取非选中状态的单选图标，可以是颜色或者图片等

See:

getRadioOffIconDrawable

Returns:

图标

Type: Object

getRadioOffIconDrawable() → {ht.ui.drawable.Drawable}

获取非选中状态的单选图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getRadioOnIcon() → {Object}

获取选中状态的单选图标，可以是颜色或者图片等

See:

getRadioOnIconDrawable

Returns:

图标

Type: Object

getRadioOnIconDrawable() → {ht.ui.drawable.Drawable}

获取选中状态的单选图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getRootCanvas() → {HTMLCanvasElement}

获取根 Canvas，这个 Canvas 用来绘制背景、边框、内容等

Inherited From:

ht.ui.View#getRootCanvas

Returns:

Canvas DOM 对象

Type: HTMLCanvasElement

getRootContext(dom) → {CanvasRenderingContext2D}

获取默认的 canvas 画布的画笔对象，或者获取参数 DOM 对象的画笔；此函数在绘制背景、边框和自定义组件的情况下经常使用

Parameters:

Name	Type	Argument	Description
`dom`	HTMLElement	<optional>	指定目标 DOM，通常是个 canvas 类型的 DOM 对象

Inherited From:

ht.ui.View#getRootContext

Returns:

画笔对象

Type: CanvasRenderingContext2D

getRootData() → {ht.Data}

获取根节点，默认为空，从DataModel#getRoots() 的对象开始展示

Returns:

根节点

Type: ht.Data

getRowBackground() → {Object}

获取行背景；可以是颜色或者图片等

See:

getRowBackgroundDrawable

Returns:

背景

Type: Object

getRowBackgroundDrawable() → {ht.ui.drawable.Drawable}

获取行背景的 Drawable 对象

Returns:

背景

Type: ht.ui.drawable.Drawable

getRowDatas() → {ht.List}

获取当前显示的数据元素集合，该集合已被排序和过滤

Returns:

Type: ht.List

getRowHeight() → {Number}

获取行高

Returns:

行高

Type: Number

getRowHeightFunc() → {function}

获取行高函数，函数内可以根据不同的数据元素返回不同的高度值

Returns:

行高函数

Type: function

getRowIndex(data) → {Number}

获取数据元素的索引

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

索引值

Type: Number

getRowLineColor() → {color}

获取行线颜色

Returns:

颜色值

Type: color

getRowSize() → {Number}

返回总行数

Returns:

行数

Type: Number

getScrollBarActiveSize() → {Number}

获取滚动条感应区域的大小

Returns:

滚动条感应区域的大小

Type: Number

getScrollBarColor() → {color}

获取滚动条颜色

Returns:

颜色值

Type: color

getScrollBarMinLength() → {Number}

获取滚动条最小长度

Returns:

滚动条最小长度

Type: Number

getScrollBarMode() → {String}

获取滚动条模式，支持 'on'|'off'|'auto'

Returns:

滚动条模式

Type: String

getScrollBarSize() → {Number}

获取滚动条大小(横向滚动条的高度，纵向滚动条的宽度)

Returns:

滚动条大小

Type: Number

getScrollBarTimeout() → {Number}

获取滚动条显示时间，超过时间后滚动条将隐藏

Returns:

滚动条显示时间

Type: Number

getScrollRect() → {Object}

获取滚动范围，即内容区域

Returns:

内容区域，格式为：{x: x, y: y, width: width, height: height}

Type: Object

getSelectableFunc() → {function}

获取选择过滤器函数

Returns:

选择过滤器函数

Type: function

getSelectCollapseIcon() → {Object}

获取 select 状态的合并图标，可以是颜色或者图片等

See:

getSelectCollapseIconDrawable

Returns:

图标

Type: Object

getSelectCollapseIconDrawable() → {ht.ui.drawable.Drawable}

获取 select 状态的合并图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getSelectExpandIcon() → {Object}

获取 select 状态的展开图标，可以是颜色或者图片等

See:

getSelectExpandIconDrawable

Returns:

图标

Type: Object

getSelectExpandIconDrawable() → {ht.ui.drawable.Drawable}

获取 select 状态的展开图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getSelectionModel() → {ht.SelectionModel}

获取选中模型

See:

Returns:

Type: ht.SelectionModel

getSelectLabelColor(data) → {color}

获取选中状态下文本的颜色

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

颜色值

Type: color

getSelectRowBackground() → {Object}

获取行选中背景；可以是颜色或者图片等

See:

getSelectRowBackgroundDrawable

Returns:

背景

Type: Object

getSelectRowBackgroundDrawable() → {ht.ui.drawable.Drawable}

获取行选中背景的 Drawable 对象

Returns:

背景

Type: ht.ui.drawable.Drawable

getSortColumn() → {ht.ui.Column}

获取当前排序列

Returns:

排序列

Type: ht.ui.Column

getSortFunc() → {function}

获取排序函数

Returns:

排序函数

Type: function

getSortMode() → {String}

获取排序方式

none: 不允许排序
bistate: 点击表头时正序和倒序两种方式之间切换
tristate: 点击表头时正序、倒序、不排序三种方式之间切换

Returns:

排序方式

Type: String

getStartRowIndex() → {Number}

获取当前可见区域的起始行索引

Returns:

索引值

Type: Number

getStyle() → {String}

获取组件的样式名；如果有多个样式名，以空格分开，如：'header title'；注意此样式是指 HT 的样式，而非 CSS 样式

Inherited From:

ht.ui.View#getStyle

Returns:

样式名

Type: String

getStyleProperties() → {Object}

获取样式属性映射表，格式为：{'padding': true, 'border': true ...}

Inherited From:

ht.ui.View#getStyleProperties

Returns:

样式属性映射表

Type: Object

getStyleValue(property) → {Object}

获取样式属性对应的样式值

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#getStyleValue

Returns:

样式值

Type: Object

getToolTip(e) → {String}

获取工具提示文本内容，默认取出鼠标下的数据元素 data，然后返回 data.getToolTip()

Parameters:

Name	Type	Description
`e`	Event	事件对象

Returns:

工具提示文本内容

Type: String

getTranslateX() → {Number}

获取水平滚动值

Returns:

水平滚动值

Type: Number

getTranslateY() → {Number}

获取垂直滚动值

Returns:

垂直滚动值

Type: Number

getTreeColumn() → {ht.ui.Column}

返回树表组件默认插入的树列，该列显示树层次结构

Returns:

Type: ht.ui.Column

getUncheckIcon() → {Object}

获取非选中状态的多选图标，可以是颜色或者图片等

See:

getUncheckIconDrawable

Returns:

图标

Type: Object

getUncheckIconDrawable(数据行, 数据列) → {ht.ui.drawable.Drawable}

获取非选中状态的多选图标的 Drawable 对象

Parameters:

Name	Type	Description
`数据行`	ht.Data
`数据列`	ht.ui.Column

Returns:

图标

Type: ht.ui.drawable.Drawable

getView() → {HTMLElement}

获取组件最根层的 div

Inherited From:

ht.ui.View#getView

Returns:

组件 div

Type: HTMLElement

getViewPoint(event) → {Object}

获取组件坐标点；从组件的左上角开始计算

Parameters:

Name	Type	Description
`event`	Event	交互事件对象(如鼠标事件对象)

Inherited From:

ht.ui.View#getViewPoint

Returns:

组件坐标点，包含 x、y 坐标

Type: Object

getViewRect() → {Object}

获取视窗范围，即可视区域

Returns:

可见区域，格式为：{x: x, y: y, width: width, height: height}

Type: Object

getVisibleFunc() → {function}

获取可见过滤器函数

Returns:

可见过滤器函数

Type: function

getWidth() → {Number}

获取组件的宽度

Inherited From:

ht.ui.View#getWidth

Returns:

组件宽度

Type: Number

getX() → {Number}

获取组件的 x 坐标

Inherited From:

ht.ui.View#getX

Returns:

x 坐标

Type: Number

getY() → {Number}

获取组件的 y 坐标

Inherited From:

ht.ui.View#getY

Returns:

y 坐标

Type: Number

getZIndex() → {Number}

获取组件的堆叠顺序

Inherited From:

ht.ui.View#getZIndex

Returns:

堆叠顺序

Type: Number

getZoom() → {Number}

获取缩放值

Inherited From:

ht.ui.View#getZoom

Returns:

缩放值

Type: Number

getZoomAnchor() → {Array}

获取缩放锚点

Inherited From:

ht.ui.View#getZoomAnchor

Returns:

锚点数组

Type: Array

handleDrop(e, datas, refType, refData)

处理拖拽数据

如果数据来自自身，则调整节点顺序

如果数据来自其它列表了类组件，则将节点移动到本组件中（其它列表中删除）

如果来自其它类型的组件，需要重写此函数处理

Parameters:

Name	Type	Description
`e`	Event	拖拽事件对象，格式为：{source: source, target: target, data: data, kind: 'dragCompleted', nativeEvent: event}
`datas`	Object	节点列表或拖拽数据
`refType`	String	拖拽目标相对在 refData 的位置(up、down、append)，一般无需关心此参数
`refData`	ht.Data	拖拽目标相对定位的节点，一般无需关心此参数

handleSelect(e, data)

当用户点击鼠标时，会调用此函数将数据行选中；可重写此函数实现选中过滤功能，比如点击在某些区域不要选中

Parameters:

Name	Type	Description
`e`	Event	鼠标事件对象
`data`	ht.Data	要选中的数据行

hasContentCanvas() → {Boolean}

判断组件是否有私有 canvas

Inherited From:

ht.ui.View#hasContentCanvas

Returns:

组件是否有私有 canvas

Type: Boolean

hasFocus() → {Boolean}

判断焦点是否在组件上

Inherited From:

ht.ui.View#hasFocus

Returns:

焦点是否在组件上

Type: Boolean

hidePopover()

隐藏弹框组件

Inherited From:

ht.ui.View#hidePopover

initView(canvas)

初始化组件的 DOM 结构

Parameters:

Name	Type	Argument	Description
`canvas`	Boolean	<optional>	是否创建一个私有的 canvas 用来绘制私有内容，一般情况下在默认的 canvas 中绘制就可以，不需要此参数

Inherited From:

ht.ui.View#initView

invalidate(forceLayoutChildren)

使组件无效化

Parameters:

Name	Type	Argument	Description
`forceLayoutChildren`	Boolean	<optional>	是否强制刷新子组件(即使子组件没有无效标记)

Inherited From:

ht.ui.View#invalidate

See:

invalidateDOM()

设置重新布局 DOM 标记并调用 invalidate, 组件下次刷新时会强制更新 DOM

Inherited From:

ht.ui.View#invalidateDOM

invalidateModel()

无效模型，下次刷新时会重新构建 rowDatas

See:

isAutoMakeVisible() → {Boolean}

选中数据元素时，是否自动平移组件以确保该元素出现在可见区域内

Returns:

Type: Boolean

isBatchEditable() → {Boolean}

是否启用批量编辑

Returns:

是否批量编辑

Type: Boolean

isChildrenSortable(parent) → {Boolean}

判断是否允许对数据元素的子元素排序，默认返回 true，可重写屏蔽孩子排序

Parameters:

Name	Type	Description
`parent`	ht.Data	数据元素

Returns:

是否允许排序

Type: Boolean

isCloseToHScrollBar(e)

事件的坐标是否接近水平滚动条(接近的范围由 scrollBarActiveSize 决定)

Parameters:

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

isCloseToVScrollBar(e)

事件的坐标是否接近垂直滚动条(接近的范围由 scrollBarActiveSize 决定)

Parameters:

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

isColumnLineVisible() → {Boolean}

判断列线是否可见

Returns:

列线是否可见

Type: Boolean

isDataEditable(e, data) → {Boolean}

判断数据元素是否可编辑

Parameters:

Name	Type	Argument	Description
`e`	Event		交互事件
`data`	ht.Data	<optional>	数据元素

Returns:

是否可编辑

Type: Boolean

isDescendantOf(viewGroup) → {Boolean}

判断当前组件是否是参数容器的子孙组件

Parameters:

Name	Type	Description
`viewGroup`	ht.ui.ViewGroup	容器

Inherited From:

ht.ui.View#isDescendantOf

Returns:

Type: Boolean

isDisabled() → {Boolean}

组件是否被禁用

Inherited From:

ht.ui.View#isDisabled

Returns:

是否被禁用

Type: Boolean

isDragEnabled() → {Boolean}

是否启用拖拽

Returns:

是否启用拖拽

Type: Boolean

isDraggable(data, selection, e) → {Boolean}

判断行是否可以拖动；默认返回 true(即所有的行都可以拖动)，可重写将某些行设为不可拖动

Parameters:

Name	Type	Description
`data`	ht.Data	要拖动的行
`selection`	ht.List	当前选中的行
`e`	Event	DOM 事件对象

Returns:

行是否可以拖动

Type: Boolean

isDropEnabled() → {Boolean}

是否接受拖拽

Returns:

是否接受拖拽

Type: Boolean

isEditing() → {Boolean}

是否正在编辑数据

Returns:

正在编辑数据

Type: Boolean

isExpanded(data) → {Boolean}

判断数据元素是否展开

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

是否展开

Type: Boolean

isFixedShadowVisible(scrollBarIndent, translateX)

锁定列的阴影是否可见，可重写实现自定义的阴影是否可见逻辑

Parameters:

Name	Type	Description
`scrollBarIndent`	Number	滚动条缩进
`translateX`	Number	水平滚动值

Example

// 阴影始终可见
treeTableView.isFixedShadowVisible = function(indent, translateX) {
     if (!isNaN(indent)) return true;
}

isFocusable() → {Boolean}

组件是否可以获取焦点

Inherited From:

ht.ui.View#isFocusable

Returns:

是否可获取焦点

Type: Boolean

isHScrollable() → {Boolean}

判断组件是否可以水平滚动(即 scrollRect.width > viewRect.width)

Returns:

是否可以水平滚动

Type: Boolean

isIndeterminateSelected(data) → {Boolean}

判断数据元素是否处于半选中状态

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

是否被选中

Type: Boolean

isInDOM() → {Boolean}

判断组件是否在 DOM 树中

Inherited From:

ht.ui.View#isInDOM

Returns:

组件是否在 DOM 树中

Type: Boolean

isMaxSizeSet() → {Boolean}

判断 maxSize 是否被设置(如果为 true, 组件不再调用 figureMaxSize 自动计算)

Inherited From:

ht.ui.View#isMaxSizeSet

Returns:

maxSize 是否被设置

Type: Boolean

isMinSizeSet() → {Boolean}

判断 minSize 是否被设置(如果为 true, 组件不再调用 figureMinSize 自动计算)

Inherited From:

ht.ui.View#isMinSizeSet

Returns:

minSize 是否被设置

Type: Boolean

isPannable() → {Boolean}

是否允许拖拽平移

Returns:

是否允许拖拽平移

Type: Boolean

isPreferredSizeSet() → {Boolean}

判断 preferredSize 是否被设置(如果为 true, 组件不再调用 figurePreferredSize 自动计算)

Inherited From:

ht.ui.View#isPreferredSizeSet

Returns:

preferredSize 是否被设置

Type: Boolean

isRedrawOnFocus() → {Boolean}

判断组件获取或失去焦点时，是否重绘自身

Inherited From:

ht.ui.View#isRedrawOnFocus

Returns:

是否重绘自身

Type: Boolean

isRootVisible() → {Boolean}

判断根节点是否可见

Returns:

Type: Boolean

isRowLineVisible() → {Boolean}

判断行线是否可见，默认为 true

Returns:

行线是否可见

Type: Boolean

isSelectable(data) → {Boolean}

判断数据元素是否可被选中

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

是否可被选中

Type: Boolean

isSelected(data) → {Boolean}

判断数据元素是否被选中

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Returns:

是否被选中

Type: Boolean

isSelectedById(id) → {Boolean}

根据 id 判断数据元素是否被选中

Parameters:

Name	Type	Description
`id`	String \| Number	数据元素 id

Returns:

是否被选中

Type: Boolean

isSelectionModelShared() → {Boolean}

当前组件是否共享选中模型

Returns:

Type: Boolean

isSelfViewEvent(event) → {Boolean}

判断鼠标事件是否发生在组件自身上，例如容器的 div 上监听到一个原生的鼠标点击事件，此事件可能来自容器，也可能来自子组件的冒泡传播；如果自定义组件，并且改变了组件的 DOM 结构，需要重写此函数

Parameters:

Name	Type	Description
`event`	Event	事件对象

Inherited From:

ht.ui.View#isSelfViewEvent

Returns:

事件是否发生在自身 DOM 上

Type: Boolean

isStyleProperty(property) → {Boolean}

判断属性是否是样式属性

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#isStyleProperty

Returns:

是否是样式属性

Type: Boolean

isToolTipEnabled() → {Boolean}

是否启用工具提示

Returns:

是否启用工具提示

Type: Boolean

isVisible(data) → {Boolean}

判断数据元素是否可见；如果参数为空，表示当前组件是否可见

Parameters:

Name	Type	Argument	Description
`data`	ht.Data	<optional>	数据元素

Returns:

是否可见

Type: Boolean

isVScrollable() → {Boolean}

判断组件是否可以垂直滚动(即 scrollRect.height > viewRect.height)

Returns:

是否可以垂直滚动

Type: Boolean

iv(forceLayoutChildren)

使组件无效化

Parameters:

Name	Type	Argument	Description
`forceLayoutChildren`	Boolean	<optional>	是否强制刷新子组件(即使子组件没有无效标记)

Inherited From:

ht.ui.View#iv

See:

invalidate

ivm()

无效模型，下次刷新时会重新构建 rowDatas，invalidateModel 的缩写

See:

invalidateModel

layoutDOM(x, y, width, height)

重新调整组件的 DOM 结构布局，设置坐标、宽高以及内边距等

Parameters:

Name	Type	Description
`x`	Number	组件的 x 坐标
`y`	Number	组件的 y 坐标
`width`	Number	组件宽度
`height`	Number	组件高度

Inherited From:

ht.ui.View#layoutDOM

makeColumnVisible(column)

平移组件以确保数据列在可见区域内

Parameters:

Name	Type	Description
`column`	ht.ui.Column	列对象

makeDisabled(disabled, disabledDiv)

设置禁用组件样式，默认会将 disabedDiv 插入到组件内部

Parameters:

Name	Type	Description
`disabled`	disabled	是否禁用
`disabledDiv`	HTMLElement	遮罩 div

Inherited From:

ht.ui.View#makeDisabled

makeVisible(data)

平移组件以确保数据元素在可见区域内

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

mp(listener, scope, ahead)

增加属性事件变化监听函数，addPropertyChangeListener 的缩写

Parameters:

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

Inherited From:

ht.ui.View#mp

off(name, function, scope, ahead)

删除事件监听

Parameters:

Name	Type	Description
`name`	String	属性名，p: 开头(如 p:value)，表示监听属性变化事件；d: 开头(如 d:mousedown) 表示监听原生 DOM 事件；其它情况当作 viewEvent 处理
`function`	function	监听器函数
`scope`	Object	监听器函数域
`ahead`	Boolean	如果是 DOM 事件，表示 useCapture；否则表示是否将当前监听器插入到监听器列表开头

Inherited From:

ht.ui.View#off

on(name, function, scope, ahead)

增加事件监听

Parameters:

Name	Type	Description
`name`	String	属性名，p: 开头(如 p:value)，表示监听的是属性变化事件；d: 开头(如 d:mousedown) 表示监听原生 DOM 事件；其它情况当作 viewEvent 处理
`function`	function	监听器函数
`scope`	Object	监听器函数域
`ahead`	Boolean	如果是 DOM 事件，表示 useCapture；否则表示是否将当前监听器插入到监听器列表开头

Inherited From:

ht.ui.View#on

onCollapsed(data)

合并数据元素时调用，可重写做后续处理

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

onDataClicked(data, e)

数据元素被点击时回调，可重写做后续处理

Parameters:

Name	Type	Description
`data`	ht.Data	被点击的数据元素
`e`	Event	事件对象

onDataDoubleClicked(data, e)

数据元素被双击时回调，可重写做后续处理

Parameters:

Name	Type	Description
`data`	ht.Data	双击的数据元素
`e`	Event	事件对象

onExpanded(data)

展开数据元素时调用，可重写做后续处理

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

onOnce(name, function, scope, ahead)

增加一次性事件监听(监听器执行一次，然后马上被删除)

Parameters:

Name	Type	Description
`name`	String	属性名，p: 开头(如 p:value)，表示监听属性变化事件；d: 开头(如 d:mousedown) 表示监听原生 DOM 事件；其它情况当作 viewEvent 处理
`function`	function	监听器函数
`scope`	Object	监听器函数域
`ahead`	Boolean	如果是 DOM 事件，表示 useCapture；否则表示是否将当前监听器插入到监听器列表开头

Inherited From:

ht.ui.View#onOnce

processValidate()

绘制组件边框、背景及调用 validateImpl；此函数在 validate 中被调用

Inherited From:

ht.ui.View#processValidate

redraw(forceLayoutChildren)

设置所有的重绘标记包括重绘 canvas 标记、重绘 border 标记和重新布局 DOM 标记并调用 iv

Parameters:

Name	Type	Argument	Description
`forceLayoutChildren`	Boolean	<optional>	是否强制刷新子组件(即使子组件没有无效标记)

Inherited From:

ht.ui.View#redraw

removeBottomPainter(painter)

删除底层绘制器

Parameters:

Name	Type	Description
`painter`	function	绘制器函数

removeFromDOM()

将组件从页面的 DOM 树中删除；如果要删除通过 addToDOM 添加到页面的组件，应使用此函数，以免内存泄漏

Inherited From:

ht.ui.View#removeFromDOM

removePropertyChangeListener(listener, scope)

删除属性事件变化监听器

Parameters:

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

Inherited From:

ht.ui.View#removePropertyChangeListener

removeSelection()

删除所有选中的数据元素

removeStyleProperty(property)

删除样式属性，将参数属性从样式属性列表中移除

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#removeStyleProperty

removeTopPainter(painter)

删除顶层绘制器

Parameters:

Name	Type	Description
`painter`	function	绘制器函数

removeViewListener(listener, scope)

删除 View 事件监听器

Parameters:

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

Inherited From:

ht.ui.View#removeViewListener

requestFocus()

请求获取焦点

Inherited From:

ht.ui.View#requestFocus

scrollToIndex(index)

平移(滚动)组件至指定的行

Parameters:

Name	Type	Description
`index`	Number	行索引

selectAll()

选中所有数据元素

selectNext(data)

选中指定数据元素的后一个数据元素

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

selectPrevious(data)

选中指定数据元素的前一个数据元素

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

set(properties)

批量设置组件属性

Parameters:

Name	Type	Description
`properties`	Object	格式示范：{ background: 'red', border: new ht.ui.border.LineBorder(1, 'red'), padding: 20 }

Inherited From:

ht.ui.View#set

setAutoMakeVisible(v)

设置当选中数据元素，是否自动平移(滚动)组件以确保该数据元素出现在可见区域内

Parameters:

Name	Type	Description
`v`	Boolean	是否自动显示选中的数据元素

setBackground(background)

设置组件的背景，可以是颜色或者图片等；此值最终会被转换为 Drawable 对象

Parameters:

Name	Type	Description
`background`	Object	颜色值、图片名、图片路径、矢量对象等

Inherited From:

ht.ui.View#setBackground

See:

setBackgroundDrawable

setBackgroundDrawable(drawable)

设置组件的背景 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 background 转换

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	Drawable 对象

Inherited From:

ht.ui.View#setBackgroundDrawable

setBatchEditable(batchEditable)

设置是否启用批量编辑

Parameters:

Name	Type	Description
`batchEditable`	Boolean	是否启用批量编辑

setBorder(border)

设置组件的边框

Parameters:

Name	Type	Description
`border`	ht.border.Border	组件边框

Inherited From:

ht.ui.View#setBorder

setBorderRadius(radius)

设置 CSS 边框圆角

Parameters:

Name	Type	Description
`radius`	Number \| Array	边框圆角；如果是数组，则表示[左上角圆角、右上角圆角、右下角圆角、左下角圆角]

Inherited From:

ht.ui.View#setBorderRadius

setBoxShadow(boxShadow)

设置 CSS 阴影值

Parameters:

Name	Type	Description
`boxShadow`	String	阴影值

Inherited From:

ht.ui.View#setBoxShadow

setCheckIcon(icon)

设置选中状态的多选图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setCheckIconDrawable

setCheckIconDrawable(drawable)

设置选中状态的多选图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setCheckMode(checkMode)

设置 check 模式

Parameters:

Name	Type	Description
`checkMode`	String	null：默认值，不启用 check 选择模式 default：check 模式的默认选择方式，即单击选中或取消选中，只影响当前点击中的数据元素 children：该 check 模式将同时影响点击中的数据元素及其孩子元素 descendant：该 check 模式将同时影响点击中的数据元素及其所有子孙元素 all：该 check 模式将同时影响点击中的数据元素及其所有父辈和子孙元素

setCollapseIcon(icon)

设置合并图标图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setCollapseIconDrawable

setCollapseIconDrawable(drawable)

设置合并图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setColumnLineColor(color)

设置列线颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setColumnLineVisible(visible)

设置列线是否可见

Parameters:

Name	Type	Description
`visible`	Boolean	是否可见

setColumnModel(model)

设置列模型，列模型用于存储 Column 列对象信息

Parameters:

Name	Type	Description
`model`	ht.DataModel	列模型

setColumns(columns)

以 json 的方式配置表格中的列

Parameters:

Name	Type	Description
`columns`	Array	json 列

Example

 // 示例：
tableView.setColumns([{
	name: 'id',
	displayName: '序号'
},
{
	name: 'background',
	accessType: 'style'
}
]);

setContextMenu(contextMenu)

设置绑定的右键菜单

Parameters:

Name	Type	Description
`contextMenu`	ht.ui.ContextMenu	右键菜单

Inherited From:

ht.ui.View#setContextMenu

setCursor(cursor)

设置鼠标样式(CSS 格式)

Parameters:

Name	Type	Description
`cursor`	String	鼠标样式

Inherited From:

ht.ui.View#setCursor

setDatas(datas)

将参数 datas 转成 ht.Data 类型并添加到 dataModel 中

Parameters:

Name	Type	Description
`datas`	JSON	格式：[{name: 'data1'}, {name: 'data2'}] 或者 { name: 'Root', children: [ {name: 'Child1'} ]}

setDisabled(disabled)

设置组件是否被禁用

Parameters:

Name	Type	Description
`disabled`	Boolean \| String	是否被禁用；如果为字符串，组件除了被禁用，disabledDiv 还会被设置相应的 CSS 样式名

Inherited From:

ht.ui.View#setDisabled

setDisabledBackground(background)

设置组件被禁用时，遮罩的背景；这个值被设置到遮罩 div 的 background 样式上，因此可以使用所有 CSS 支持的 background 类型

Parameters:

Name	Type	Description
`background`	String	遮罩背景

Inherited From:

ht.ui.View#setDisabledBackground

Example

// 设置一个居中的 gif 图片 作为背景
view.setDisabledBackground('url(a.gif) no-repeat 50% 50%');

setDragEnabled(enabled)

设置是否启用拖拽

Parameters:

Name	Type	Description
`enabled`	Boolean	是否启用拖拽

setDropEnabled(enabled)

设置是否接受拖拽

Parameters:

Name	Type	Description
`enabled`	Boolean	是否接受拖拽

setDropLineColor(color)

设置拖拽提示线颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setEditable(editable)

设置是否可编辑

Parameters:

Name	Type	Description
`editable`	Boolean	是否可编辑

setEditorClass(clazz)

设置编辑器

Parameters:

Name	Type	Description
`clazz`	String \| function	编辑器类或类名

setEditorValidator(validator)

设置编辑器验证函数

Parameters:

Name	Type	Description
`validator`	function	数据验证函数，格式为：function(olodValue, newValue, data, [column], editor, editorView, endEdit) {} 其中最后一个参数 endEdit 表示是否要结束编辑，为 false 表示用户不打算结束编辑(比如假设 StringEditor 中文本框的 instant 为 true，每输入一个字符都会用 validator 验证且 endEdit 参数为 fale) 返回值为 true 表示 newValue 格式合法返回值为 false 表示 newValue 格式不合法，同时阻止默认的停止编辑行为(让用户继续编辑) 返回值为 end 表示 newValue 不合法，同时结束编辑(仅在 endEdit 为 true 时起作用)

setErrorMessage(message, params) → {ht.ui.ErrorMessagePopover}

设置错误信息

Parameters:

Name	Type	Description
`message`	String	错误信息
`params`	Object	ErrorMessagePopover 组件的属性配置，如 { placements: ['top'] } 将错误提示显示在上方

Inherited From:

ht.ui.View#setErrorMessage

Returns:

错误提示组件

Type: ht.ui.ErrorMessagePopover

setExpandIcon(icon)

设置展开图标图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setExpandIconDrawable

setExpandIconDrawable(drawable)

设置展开图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setFixedShadow(color)

设置锁定列的阴影颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setFocusable(focusable)

设置组件是否可以获取焦点

Parameters:

Name	Type	Description
`focusable`	Boolean	是否可获取焦点

Inherited From:

ht.ui.View#setFocusable

setFocusData(data)

在 check 模式下，点击一个数据元素使其背景变化但并不选中它，此时它处于 focus 状态
此函数设置 focus 状态数据元素

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

setFocusDataById(id)

根据 id 设置 focus 的数据元素

Parameters:

Name	Type	Description
`id`	String \| Number	数据元素的id

setFocusRowBackground(background)

设置 check 模式下，点击行的背景；可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	Object	背景

See:

setFocusRowBackgroundDrawable

setFocusRowBackgroundDrawable(drawable)

设置 check 模式下，点击行背景的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	背景

setHeight(height)

设置组件的高度

Parameters:

Name	Type	Description
`height`	Number	组件高度

Inherited From:

ht.ui.View#setHeight

setHoverCollapseIcon(icon)

设置 hover 状态的合并图标图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setHoverCollapseIconDrawable

setHoverCollapseIconDrawable(drawable)

设置 hover 状态的合并图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setHoverExpandIcon(icon)

设置 hover 状态的展开图标图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setHoverExpandIconDrawable

setHoverExpandIconDrawable(drawable)

设置 hover 状态的展开图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setHoverLabelColor(color)

设置 hover 状态下的文字颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setHoverRowBackground(background)

设置 hover 状态下的行背景；可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	Object	背景

See:

setHoverRowBackgroundDrawable

setHoverRowBackgroundDrawable(drawable)

设置 hover 状态下行选中背景的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	背景

setIconGap(gap)

设置图标之间的距离

Parameters:

Name	Type	Description
`gap`	Number	距离值

setIconHeight(height)

设置数据元素的图标高度

Parameters:

Name	Type	Description
`height`	Number	高度值

setIconWidth(width)

设置数据元素的图标宽度

Parameters:

Name	Type	Description
`width`	Number	宽度值

setId(id)

设置唯一标识，根据标识可快速查找到组件

Parameters:

Name	Type	Description
`id`	Object	唯一标识

Inherited From:

ht.ui.View#setId

setIndent(indent)

设置不同层次的缩进值

Parameters:

Name	Type	Description
`indent`	Number	缩进值

setIndeterminateIcon(icon)

设置半选中状态的图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setIndeterminateIconDrawable

setIndeterminateIconDrawable(drawable)

设置半选中状态的图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setLabelColor(color)

设置数据元素的文本颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setLabelFont(font)

设置数据元素的文字字体

Parameters:

Name	Type	Description
`font`	String	字体

setLayoutParams(layoutParams, value)

设置布局参数；这个函数有两种使用方式：

view.setLayoutParams({ marginLeft: 20, marginRight: 20 }) 指定布局参数对象
view.setLayoutParams('marginLeft', 20) 传入两个参数设置布局参数对象中的属性

Parameters:

Name	Type	Argument	Description
`layoutParams`	Object		布局参数对象或 key
`value`	Object	<optional>	布局参数值

Inherited From:

ht.ui.View#setLayoutParams

setLoader(loader)

设置延迟加载器

Parameters:

Name	Type	Description
`loader`	Object

Example

 // 示例：
treeView.setLoader({
	load: function(data) {
		// 展开此数据元素时回调，可用于加载子节点
	},
	isLoaded: function(data) {
		// 返回子结点是否已加载
	}
});

setMargin(margin)

设置组件外边距，如果是数字，说明四边使用相同的外边距；如果是数组，则格式为：[上边距, 右边距, 下边距, 左边距]

Parameters:

Name	Type	Description
`margin`	Number \| Array	外边距；父容器布局时，会动态将此参数填充到 layoutParams 中(优先级低于 layoutParams，如果 layoutParams 参数中没有指定相应的 margin 才会从组件上取值)

Inherited From:

ht.ui.View#setMargin

setMaxSize(width, height)

计算 maxSize，maxSize 表示组件的最大尺寸，布局器布局时会考虑此尺寸，尽量不让组件的布局宽高大于此尺寸；如果设置过 maxSize，就不会再调用 figureMaxSize 计算；如果要清空设置过的 maxSize，可以调用 setMaxSize(undefined, undefined);

Parameters:

Name	Type	Description
`width`	Number	最大宽度
`height`	Number	最大高度

Inherited From:

ht.ui.View#setMaxSize

setMinSize(width, height)

计算 minSize，minSize 表示组件的最小尺寸，布局器布局时会考虑此尺寸，尽量不让组件的布局宽高小于此尺寸；如果设置过 minSize，就不会再调用 figureMinSize 计算；如果要清空设置过的 minSize，可以调用 setMinSize(undefined, undefined);

Parameters:

Name	Type	Description
`width`	Number	最小宽度
`height`	Number	最小高度

Inherited From:

ht.ui.View#setMinSize

setPadding(padding)

设置组件内边距，如果是数字，说明四边使用相同的内边距；如果是数组，则格式为：[上边距, 右边距, 下边距, 左边距]

Parameters:

Name	Type	Description
`padding`	Number \| Array	内边距

Inherited From:

ht.ui.View#setPadding

setPannable(pannable)

设置是否允许拖拽平移

Parameters:

Name	Type	Description
`pannable`	Boolean	是否允许拖拽平移

setPopover(popover, trigger)

设置弹框组件

Parameters:

Name	Type	Argument	Description
`popover`	ht.ui.Popover \| String		弹框组件，如果参数是字符串，则用这段文本作为弹框内容(内部自动创建 Popover 和 HtmlView 组件)
`trigger`	String	<optional>	触发器，值为：click\|hover

Inherited From:

ht.ui.View#setPopover

setPopoverPlacements(placements)

设置弹框组件的弹出位置

Parameters:

Name	Type	Description
`placements`	Array	位置数组

Inherited From:

ht.ui.View#setPopoverPlacements

setPopoverTrigger(trigger)

设置弹框触发器

Parameters:

Name	Type	Description
`trigger`	String	弹框触发器，值为：click\|hover

Inherited From:

ht.ui.View#setPopoverTrigger

setPreferredSize(width, height)

设置 preferredSize，preferredSize 表示组件自身最合适的尺寸，布局器布局时会考虑此尺寸作为布局尺寸；如果设置过 preferredSize，就不会再调用 figurePreferredSize 计算；如果要清空设置过的 preferredSize，可以调用 setPreferredSize(undefined, undefined);

Parameters:

Name	Type	Description
`width`	Number	首选宽度
`height`	Number	首选高度

Inherited From:

ht.ui.View#setPreferredSize

setPreferredSizeRowCountLimit(limit)

设置计算 preferredSize 时要限制的数据行数；例如参数为 10，表示根据前 10 行数据的高度计算 preferredHeight

Parameters:

Name	Type	Description
`limit`	Number	限制行数

setPropertyValue(name, value)

设置属性值并派发事件，自定义 set 函数内部应该调用此函数设值

Parameters:

Name	Type	Description
`name`	String	属性名
`value`	Object	属性值

Inherited From:

ht.ui.View#setPropertyValue

setRadioOffIcon(icon)

设置非选中状态的单选图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setRadioOffIconDrawable

setRadioOffIconDrawable(drawable)

设置非选中状态的单选图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setRadioOnIcon(icon)

设置选中状态的单选图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setRadioOnIconDrawable

setRadioOnIconDrawable(drawable)

设置选中状态的单选图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setRedrawOnFocus(redrawOnFocus)

设置组件获取或失去焦点时，是否重绘自身

Parameters:

Name	Type	Description
`redrawOnFocus`	Boolean	是否重绘自身

Inherited From:

ht.ui.View#setRedrawOnFocus

setRootData(root)

指定根节点，默认为空，从 DataModel#getRoots() 的对象开始展示

Parameters:

Name	Type	Description
`root`	ht.Data	根节点

setRootVisible(visible)

设置根节点是否可见

Parameters:

Name	Type	Description
`visible`	Boolean	是否可见

setRowBackground(background)

设置行背景；可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	Object	背景

See:

setRowBackgroundDrawable

setRowBackgroundDrawable(drawable)

设置行背景的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	背景

setRowHeight(height)

设置行高

Parameters:

Name	Type	Description
`height`	Number	高度值

setRowHeightFunc(func)

设置行高函数，函数内可以根据不同的数据元素返回不同的高度值

Parameters:

Name	Type	Description
`func`	function	行高函数

Example

treeTableView.setRowHeightFunc(function(data) {
		if (data.getId() === 1) return 50;
		else return 24;
});

setRowLineColor(color)

设置行线颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setRowLineVisible(visible)

设置行线是否可见

Parameters:

Name	Type	Description
`visible`	Boolean	是否可见

setScrollBarActiveSize(activeSize)

设置滚动条感应区域的大小

Parameters:

Name	Type	Description
`activeSize`	Number	滚动条感应区域的大小

setScrollBarColor(color)

设置滚动条颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setScrollBarMinLength(length)

设置滚动条最小长度

Parameters:

Name	Type	Description
`length`	Number	滚动条最小长度

setScrollBarMode(mode)

设置滚动条模式

Parameters:

Name	Type	Description
`mode`	String	滚动条模式，可选值为：'on'\|'off'\|'auto'

setScrollBarSize(size)

设置滚动条大小(横向滚动条的高度，纵向滚动条的宽度)

Parameters:

Name	Type	Description
`size`	Number	滚动条大小

setScrollBarTimeout(timeout)

设置滚动条显示时间，超过时间后滚动条将隐藏

Parameters:

Name	Type	Description
`timeout`	Number	滚动条显示时间

setSelectableFunc(func)

设置选择过滤器函数

Parameters:

Name	Type	Description
`func`	function	过滤器函数

setSelectCollapseIcon(icon)

设置 select 状态的合并图标图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setSelectCollapseIconDrawable

setSelectCollapseIconDrawable(drawable)

设置 select 状态的合并图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setSelectExpandIcon(icon)

设置 select 状态的展开图标图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setSelectExpandIconDrawable

setSelectExpandIconDrawable(drawable)

设置 select 状态的展开图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setSelectionModelShared(v)

设置组件是否共享选中模型

Parameters:

Name	Type	Description
`v`	Boolean	是否共享选中模型

setSelectLabelColor(color)

设置选中状态下的文字颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setSelectLabelColor(color)

设置行label文字选中颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setSelectRowBackground(background)

设置行选中背景；可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	Object	背景

See:

setSelectRowBackgroundDrawable

setSelectRowBackgroundDrawable(drawable)

设置行选中背景的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	背景

setSortColumn(column)

设置排序列

Parameters:

Name	Type	Description
`column`	ht.ui.Column	排序列

setSortFunc(func)

设置排序函数

Parameters:

Name	Type	Description
`func`	function	排序函数

setSortMode(mode)

设置排序方式

Parameters:

Name	Type	Description
`mode`	String	none: 不允许排序 bistate: 点击表头时正序和倒序两种方式之间切换 tristate: 点击表头时正序、倒序、不排序三种方式之间切换

setStyle(styleName)

设置组件的样式名；如果有多个样式名，以空格分开，如：'header title'；注意此样式是指 HT 的样式，而非 CSS 样式

Parameters:

Name	Type	Description
`styleName`	String	样式名

Inherited From:

ht.ui.View#setStyle

setToolTipEnabled(enabled)

设置是否启用工具提示

Parameters:

Name	Type	Description
`enabled`	Boolean	是否启用工具提示

setTranslate(translateX, translateY, anim)

设置水平和垂直滚动值

Parameters:

Name	Type	Argument	Description
`translateX`	Number		水平滚动值
`translateY`	Number		垂直滚动值
`anim`	Boolean	<optional>	是否使用动画

setTranslateX(translateX)

设置水平滚动值

Parameters:

Name	Type	Description
`translateX`	Number	水平滚动值

setTranslateY(translateY)

设置垂直滚动值

Parameters:

Name	Type	Description
`translateY`	Number	垂直滚动值

setUncheckIcon(icon)

设置非选中状态的多选图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setUncheckIconDrawable

setUncheckIconDrawable(drawable)

设置非选中状态的多选图标的 Drawable 对象

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	图标

setVisible(visible)

设置组件是否可见

Parameters:

Name	Type	Description
`visible`	Boolean	组件是否可见

Inherited From:

ht.ui.View#setVisible

setVisibleFunc(func)

设置可见过滤器

Parameters:

Name	Type	Description
`func`	function	过滤器函数

setWidth(width)

设置组件的宽度

Parameters:

Name	Type	Description
`width`	Number	组件宽度

Inherited From:

ht.ui.View#setWidth

setX(x)

设置组件的 x 坐标

Parameters:

Name	Type	Description
`x`	Number	x 坐标

Inherited From:

ht.ui.View#setX

setY(y)

设置组件的 y 坐标

Parameters:

Name	Type	Description
`y`	Number	y 坐标

Inherited From:

ht.ui.View#setY

setZIndex(zIndex)

设置组件的堆叠顺序

Parameters:

Name	Type	Description
`zIndex`	Number	堆叠顺序

Inherited From:

ht.ui.View#setZIndex

setZoom(zoom)

设置缩放

Parameters:

Name	Type	Description
`zoom`	Number	缩放值

Inherited From:

ht.ui.View#setZoom

setZoomAnchor(anchor)

设置缩放锚点

Parameters:

Name	Type	Description
`anchor`	Array	横向和纵向锚点数组，如右上角为：[1, 0]

Inherited From:

ht.ui.View#setZoomAnchor

showHScrollBar()

显示水平滚动条

showPopover()

显示弹框组件

Inherited From:

ht.ui.View#showPopover

showScrollBar()

显示滚动条，内部会调用 showVScrollBar() 和 showHScrollBar()

showVScrollBar()

显示垂直滚动条

sm() → {ht.SelectionModel}

获取选中模型，getSelectionModel的缩写

See:

getSelectionModel

Returns:

Type: ht.SelectionModel

tearDownBorder(border, x, y, width, height, dom)

卸载边框；只有 CSS 类型的边框才需要此函数

Parameters:

Name	Type	Argument	Description
`border`	ht.border.Border		边框对象
`x`	Number	<optional>	起点 x 坐标
`y`	Number	<optional>	起点 y 坐标
`width`	Number	<optional>	宽度
`height`	Number	<optional>	高度
`dom`	HTMLElement	<optional>	指定绘制的目标 DOM

Inherited From:

ht.ui.View#tearDownBorder

toggle(data)

展开或合并数据元素

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

toggleHitTest(e, data) → {Boolean}

判断是否点击中了展开合并图标

Parameters:

Name	Type	Argument	Description
`e`	Event		事件对象
`data`	Event	<optional>	数据元素

Returns:

是否点击中展开合并图标

Type: Boolean

translate(x, y, anim)

水平滚动值增加 x，垂直滚动值增加 y

Parameters:

Name	Type	Argument	Description
`x`	Number		水平滚动值增量
`y`	Number		垂直滚动值增量
`anim`	Boolean	<optional>	是否使用动画

tx(value)

获取或设置水平滚动值

Parameters:

Name	Type	Argument	Description
`value`	Number	<optional>	如果为空，相当于 getTranslateX()；如果不为空，相当于 setTranslateX(value)

ty(value)

获取或设置垂直滚动值

Parameters:

Name	Type	Argument	Description
`value`	Number	<optional>	如果为空，相当于 getTranslateY()；如果不为空，相当于 setTranslateY(value)

ump(listener, scope)

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

Parameters:

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

Inherited From:

ht.ui.View#ump

validate()

重绘组件；此函数负责重新布局组件 DOM、设置层叠关系、加载需要的图片资源、派发 validate 事件等如果自定义组件，不要重写此函数，而是重写 validateImpl 函数

Inherited From:

ht.ui.View#validate

See:

validateImpl

validateImpl(x, y, width, height)

绘制组件内容；如果自定义组件，一般要重写此函数，通过 getRootContext() 获取画笔然后绘制

Parameters:

Name	Type	Description
`x`	Number	内容范围的 x 坐标
`y`	Number	内容范围的 y 坐标
`width`	Number	内容范围宽度
`height`	Number	内容范围高度

Inherited From:

ht.ui.View#validateImpl