Class: TabLayout | HT for Web

new TabLayout(properties)

标签页布局器；此布局器将子组件无条件的放在内容区域，不会考虑子组件的 minSize、maxSize、margin 等布局参数

Parameters:

Name	Type	Attributes	Description
`properties`	any	<optional>

Example

// 这个例子中，在布局器中创建了五个标签，并选中最后一个
tabLayout = new ht.ui.TabLayout();
for (var i = 0; i < 5; i++) {
    var button = new ht.ui.Button();
    button.setText('Button' + i);
    button.setLayoutParams({
        icon: 'node_image',
        title: 'Tab ' + i,
        closable: i === 0 ? true: false
    });
    tabLayout.addView(button);
  }
tabLayout.setActiveViewIndex(0);

Extends

ht.ui.ViewGroup

Methods

a(property, value) → {any}

Parameters:

Name	Type	Attributes	Description
`property`	any
`value`	any	<optional>

Returns:

any

Inherited From:

ht.ui.View#a

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

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#addPropertyChangeListener

addStyleProperty(property) → {void}

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

Parameters:

Name	Type	Description
`property`	string	属性名

Returns:

void

Inherited From:

ht.ui.View#addStyleProperty

addToDOM(dom, rect) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#addToDOM

addView(view, params, index) → {void}

将子组件加到容器中

Parameters:

Name	Type	Attributes	Description
`view`	ht.ui.View \| ht.ui.TableRow		子组件
`params`	any	<optional>	布局参数；可通过 childView.setLayoutPrams({...}) 提前设置并省略此参数
`index`	number	<optional>	在子组件列表中的插入位置

Returns:

void

Inherited From:

ht.ui.ViewGroup#addView

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

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#addViewListener

adjustChildHeight(child, height) → {number}

布局器计算出子组件的高度，传入此函数进行验证，确保其不会大于 maxSize.height 或小于 minSize.height
返回值会被用于布局子组件

Parameters:

Name	Type	Description
`child`	ht.ui.View	子组件
`height`	number	验证之前的高度

Returns:

number -

验证之后的高度

Inherited From:

ht.ui.ViewGroup#adjustChildHeight

adjustChildWidth(child, width) → {number}

布局器计算出子组件的宽度，传入此函数进行验证，确保其不会大于 maxSize.width 或小于 minSize.width；
返回值会被用于布局子组件

Parameters:

Name	Type	Description
`child`	ht.ui.View	子组件
`width`	number	验证之前的宽度

Returns:

number -

验证之后的宽度

Inherited From:

ht.ui.ViewGroup#adjustChildWidth

adjustTranslateX(value) → {number}

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

Parameters:

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

Returns:

number -

调整后的滚动值

Inherited From:

ht.ui.ViewGroup#adjustTranslateX

adjustTranslateY(value) → {number}

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

Parameters:

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

Returns:

number -

调整后的滚动值

Inherited From:

ht.ui.ViewGroup#adjustTranslateY

checkPreferredSize(property) → {void}

Parameters:

Name	Type	Description
`property`	string

Returns:

void

Inherited From:

ht.ui.View#checkPreferredSize

clear() → {void}

删除所有子组件

Returns:

void

Inherited From:

ht.ui.ViewGroup#clear

closeTab(view) → {void}

关闭标签页；将子组件从容器中删除并选中前一个子组件

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

void

containsEvent(e) → {boolean}

判断交互事件对象位置是否在组件区域

Parameters:

Name	Type	Description
`e`	UIEvent

Returns:

boolean

Inherited From:

ht.ui.View#containsEvent

disableToolTip() → {void}

禁用工具提示，同 setToolTipEnabled

Returns:

void

Inherited From:

ht.ui.View#disableToolTip

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

绘制背景

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#drawBackground

drawBorder(border, x, y, width, height, dom) → {void}

绘制边框

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#drawBorder

drawCloseIcon(drawable, x, y, w, h, child) → {void}

绘制关闭图标

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	Drawable 对象
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度
`child`	ht.ui.View	子组件

Returns:

void

drawInsertLine(drawable, x, y, w, h) → {void}

绘制插入提示线

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	Drawable 对象
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度

Returns:

void

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

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D
`tab`	any
`x`	number
`y`	number
`width`	number
`height`	number

Returns:

void

drawTabBackground(drawable, x, y, w, h, child) → {void}

绘制标签背景

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	Drawable 对象
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度
`child`	ht.ui.View	子组件

Returns:

void

drawTabHeaderBackground(drawable, x, y, w, h) → {void}

绘制标签行背景

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	Drawable 对象
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度

Returns:

void

drawTabIcon(drawable, x, y, w, h, child) → {void}

绘制标签图标

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	Drawable 对象
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度
`child`	ht.ui.View	子组件

Returns:

void

drawTabTitle(g, text, font, color, x, y, w, h, child) → {void}

绘制标签文本

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`text`	string	文本内容
`font`	string	文字字体
`color`	string	文字颜色
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度
`child`	ht.ui.View	子组件

Returns:

void

drawVerticalTabIcon(g, iconDrawable, x, y, w, h, iconWidth, iconHeight, startY, tabPosition, child) → {void}

绘制垂直标签(left-vertical|right-vertical)图标

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`iconDrawable`	ht.ui.drawable.Drawable	Drawable 对象
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度
`iconWidth`	number	图标宽度
`iconHeight`	number	图标高度
`startY`	number	图标起点 y 坐标
`tabPosition`	string	标签头位置
`child`	ht.ui.View	子组件

Returns:

void

drawVerticalTabTitle(g, text, font, color, x, y, w, h, textWidth, startY, tabPosition, child) → {void}

绘制垂直标签(left-vertical|right-vertical)文本

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`text`	string	文本内容
`font`	string	文字字体
`color`	string	文字颜色
`x`	number	绘制区域的 x 坐标
`y`	number	绘制区域的 y 坐标
`w`	number	绘制区域的宽度
`h`	number	绘制区域的高度
`textWidth`	number	文本宽度
`startY`	number	文字起点 y 坐标
`tabPosition`	string	标签头位置
`child`	ht.ui.View	子组件

Returns:

void

enableToolTip() → {void}

启用工具提示，同 setToolTipEnabled

Returns:

void

Inherited From:

ht.ui.View#enableToolTip

figureMaxSize() → {Object}

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

Returns:

Object -

maxSize

Inherited From:

ht.ui.View#figureMaxSize

figureMinSize() → {Object}

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

Returns:

Object -

minSize

Inherited From:

ht.ui.View#figureMinSize

figurePreferredSize() → {Object}

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

Returns:

Object -

preferredSize

Inherited From:

ht.ui.View#figurePreferredSize

findViewById(id, recursive, skip) → {ht.ui.View}

遍历子组件列表根据 id 查找匹配的子组件

Parameters:

Name	Type	Attributes	Description
`id`	string \| number		子组件 id
`recursive`	boolean	<optional>	是否递归查找
`skip`	boolean	<optional>	是否跳过 refviewgroup

Returns:

ht.ui.View -

匹配到的子组件

Inherited From:

ht.ui.ViewGroup#findViewById

fireViewEvent(event) → {void}

派发 View 事件

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#fireViewEvent

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

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

Parameters:

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

Returns:

boolean -

事件是否派发成功

Inherited From:

ht.ui.View#fp

getActiveCloseIcon() → {any}

获取 active 状态下的标签的关闭图标

Returns:

any -

关闭图标，可以是颜色或者图片等

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

获取 active 状态下的标签关闭图标的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

关闭图标

getActiveIconTint() → {string}

获取 active 状态下图标染色

Returns:

string -

颜色

getActiveScrollController() → {any}

获取 active 状态下滚动控制器图标

Returns:

any -

图标，可以是颜色或者图片等

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

获取 active 状态下滚动控制器图标的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

图标

getActiveTabBackground() → {any}

获取 Active 状态下的标签背景，可以是颜色或者图片等

Returns:

any -

标签背景

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

获取 Active 状态下标签背景的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

标签背景

getActiveTitleColor() → {string}

获取 Active 状态下标签文字的颜色

Returns:

string -

颜色值

getActiveToolTint() → {string}

获取 active 状态下工具图标染色

Returns:

string -

颜色

getActiveView() → {ht.ui.View}

获取选中的子组件

Returns:

ht.ui.View -

子组件

getActiveViewIndex() → {number}

获取选中的子组件的下标

Returns:

number -

子组件下标

getAttr(property) → {any}

Parameters:

Name	Type	Description
`property`	string

Returns:

any

Inherited From:

ht.ui.View#getAttr

getBackground() → {any}

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

Returns:

any -

组件背景

Inherited From:

ht.ui.View#getBackground

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

获取组件背景的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

组件背景

Inherited From:

ht.ui.View#getBackgroundDrawable

getBorder() → {ht.ui.border.Border}

获取组件的边框

Returns:

ht.ui.border.Border -

组件边框

Inherited From:

ht.ui.View#getBorder

getBorderBottom() → {number}

获取组件边框的底部高度

Returns:

number -

组件边框底部高度

Inherited From:

ht.ui.View#getBorderBottom

getBorderLeft() → {number}

获取组件边框的左侧宽度

Returns:

number -

组件边框左侧宽度

Inherited From:

ht.ui.View#getBorderLeft

getBorderRadius() → {number|Array.<number>}

获取 CSS 边框圆角

Returns:

number | Array.<number> -

边框圆角

Inherited From:

ht.ui.View#getBorderRadius

getBorderRight() → {number}

获取组件边框的右侧宽度

Returns:

number -

组件边框右侧宽度

Inherited From:

ht.ui.View#getBorderRight

getBorderTop() → {number}

获取组件边框的顶部高度

Returns:

number -

组件边框顶部高度

Inherited From:

ht.ui.View#getBorderTop

getBoxShadow() → {string}

获取 CSS 阴影值

Returns:

string -

阴影值

Inherited From:

ht.ui.View#getBoxShadow

getChildAt(event) → {ht.ui.View}

获取鼠标事件下的子组件

Parameters:

Name	Type	Description
`event`	number \| MouseEvent \| TouchEvent \| Object

Returns:

ht.ui.View -

子组件

Inherited From:

ht.ui.ViewGroup#getChildAt

getChildLayoutParams(child) → {any}

获取子组件的 layoutParams

Parameters:

Name	Type	Description
`child`	ht.ui.View

Returns:

any -

layoutParams

Inherited From:

ht.ui.ViewGroup#getChildLayoutParams

getChildren() → {ht.List}

获取子组件列表

Returns:

ht.List -

子组件列表

Inherited From:

ht.ui.ViewGroup#getChildren

getClassName() → {string}

获取类名

Returns:

string

Inherited From:

ht.ui.View#getClassName

getCloseIcon() → {any}

获取标签的关闭图标

Returns:

any -

关闭图标，可以是颜色或者图片等

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

获取标签关闭图标的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

关闭图标

getCloseIconMarginLeft() → {number}

获取关闭按钮图标左侧的空白距离(到标题文字的距离)

Returns:

number

getCloseIconSize() → {number}

获取标签关闭图标尺寸

Returns:

number -

关闭图标的尺寸

getCloseIconX() → {number}

获取关闭图标的水平中心坐标

Returns:

number -

水平中心坐标；如果小于 0，表示在右侧固定像素位置；如果大于 1，表示在左侧固定像素位置；如果在 0 - 1 之间，表示百分比

getCloseIconY() → {number}

获取关闭图标的垂直中心坐标

Returns:

number -

垂直中心坐标；如果小于 0，表示在底部固定像素位置；如果大于 1，表示在顶部固定像素位置；如果在 0 - 1 之间，表示百分比

getCloseRect(x, y, width, height, iconX, iconY, tabPosition, child) → {Object}

计算关闭图标的范围

Parameters:

Name	Type	Description
`x`	number	标签页绘制范围 x 坐标
`y`	number	标签页绘制范围 y 坐标
`width`	number	标签页绘制范围宽度
`height`	number	标签页绘制范围高度
`iconX`	number	图标中心 x 坐标
`iconY`	number	图标中心 y 坐标
`tabPosition`	string	标签头位置
`child`	ht.ui.View	子组件

Returns:

Object -

关闭图标的范围，格式为：{x: 中心点 x 坐标, y: 中心点 y 坐标, width: 宽度, height: 高度 }

getColorMode() → {string}

Returns:

string

Inherited From:

ht.ui.View#getColorMode

getContentBottom() → {number}

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

Returns:

number -

内容底部距离

Inherited From:

ht.ui.View#getContentBottom

getContentDiv() → {HTMLElement}

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

Returns:

HTMLElement -

内容 div

Inherited From:

ht.ui.View#getContentDiv

getContentHeight() → {number}

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

Returns:

number -

内容高度

Inherited From:

ht.ui.View#getContentHeight

getContentLeft() → {number}

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

Returns:

number -

内容左侧距离

Inherited From:

ht.ui.View#getContentLeft

getContentPoint(event) → {Object}

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

Parameters:

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

Returns:

Object -

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

Inherited From:

ht.ui.View#getContentPoint

getContentRight() → {number}

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

Returns:

number -

内容右侧距离

Inherited From:

ht.ui.View#getContentRight

getContentTop() → {number}

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

Returns:

number -

内容顶部距离

Inherited From:

ht.ui.View#getContentTop

getContentWidth() → {number}

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

Returns:

number -

内容宽度

Inherited From:

ht.ui.View#getContentWidth

getContextMenu() → {ht.ui.ContextMenu}

获取绑定的右键菜单

Returns:

ht.ui.ContextMenu -

右键菜单

Inherited From:

ht.ui.View#getContextMenu

getCurrentScrollController() → {string}

获取当前操作的控制器

Returns:

string -

控制器名称

getCurrentScrollControllerState() → {string}

获取当前操作的控制器状态

Returns:

string -

状态

getCurrentTabBackgroundDrawable(view) → {ht.ui.drawable.Drawable}

根据子组件的状态，获取相应的标签背景 Drawable 对象；可重写自定义

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

ht.ui.drawable.Drawable -

标签背景

getCurrentTitleColor(view) → {string}

根据参数子组件的状态(normal、hover、active、move)，获取标签文字颜色；可重写返回自定义的颜色

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

string -

颜色值

getCursor() → {string}

获取鼠标样式(CSS 格式)

Returns:

string -

鼠标样式

Inherited From:

ht.ui.View#getCursor

getDisabledBackground() → {any}

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

Returns:

any -

遮罩背景

Inherited From:

ht.ui.View#getDisabledBackground

getDisabledIconTint() → {string}

获取 disabled 状态下图标染色

Returns:

string -

颜色

getDisabledScrollController() → {any}

获取 disabled 状态下滚动控制器图标

Returns:

any -

图标，可以是颜色或者图片等

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

获取 disabled 状态下滚动控制器图标的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

图标

getDOMProperties() → {any}

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

Returns:

any -

DOM 属性映射表

Inherited From:

ht.ui.View#getDOMProperties

getErrorMessage() → {string}

获取错误信息

Returns:

string -

错误信息

Inherited From:

ht.ui.View#getErrorMessage

getHeight() → {number}

获取组件的高度

Returns:

number -

组件高度

Inherited From:

ht.ui.View#getHeight

getHoverCloseIcon() → {any}

获取 hover 状态下的标签的关闭图标

Returns:

any -

关闭图标，可以是颜色或者图片等

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

获取 hover 状态下的标签关闭图标的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

关闭图标

getHoverIconTint() → {string}

获取 hover 状态下图标染色

Returns:

string -

颜色

getHoverScrollController() → {any}

获取 hover 状态下滚动控制器图标

Returns:

any -

图标，可以是颜色或者图片等

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

获取 hover 状态下滚动控制器图标的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

图标

getHoverTabBackground() → {any}

获取 Hover 状态下的标签背景，可以是颜色或者图片等

Returns:

any -

标签背景

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

获取 Hover 状态下标签背景的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

标签背景

getHoverTitleColor() → {string}

获取 Hover 状态下标签文字的颜色

Returns:

string -

颜色值

getHoverToolTint() → {string}

获取 hover 状态下工具图标染色

Returns:

string -

颜色

getIconDrawable(view) → {ht.ui.drawable.Drawable}

返回子组件对应的标签图标 Drawable 对象；可重写自定义

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

ht.ui.drawable.Drawable -

标签图标

getIconHeight() → {number}

获取标签图标的高度，默认为 16

Returns:

number -

图标高度

getIconTint() → {string}

获取图标染色

Returns:

string -

颜色

getIconTitleGap() → {number}

获取标签图标和文字之间的距离，默认为 4

Returns:

number -

图标和文字之间的距离

getIconWidth() → {number}

获取标签图标的宽度，默认为 16

Returns:

number -

图标宽度

getId() → {any}

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

Returns:

any -

唯一标识

Inherited From:

ht.ui.View#getId

getInsertLine() → {any}

获取拖拽过程中插入提示线的背景，可以是颜色或者图片等

Returns:

any -

提示线背景

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

获取拖拽过程中插入提示线背景的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

提示线背景

getInteractorClasses() → {Array.<string>}

获取交互器类名数组

Returns:

Array.<string> -

交互器类名数组

Inherited From:

ht.ui.View#getInteractorClasses

getLayoutParams(key) → {any}

获取布局参数

Parameters:

Name	Type	Attributes	Description
`key`	string	<optional>	布局参数中的 key

Returns:

any -

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

Inherited From:

ht.ui.View#getLayoutParams

getMargin() → {number|Array.<number>}

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

Returns:

number | Array.<number> -

外边距

Inherited From:

ht.ui.View#getMargin

getMarginBottom() → {number}

获取组件底部外边距高度

Returns:

number -

底部外边距高度

Inherited From:

ht.ui.View#getMarginBottom

getMarginRight() → {number}

获取组件右侧外边距宽度

Returns:

number -

右侧外边距宽度

Inherited From:

ht.ui.View#getMarginRight

getMarginTop() → {number}

获取组件顶部外边距高度

Returns:

number -

顶部外边距高度

Inherited From:

ht.ui.View#getMarginTop

getMarignLeft() → {number}

获取组件左侧外边距宽度

Returns:

number -

左侧外边距宽度

Inherited From:

ht.ui.View#getMarignLeft

getMatchedStyles() → {any}

获取组件匹配到的样式

Returns:

any

Inherited From:

ht.ui.View#getMatchedStyles

getMaxSize() → {Object}

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

Returns:

Object -

maxSize

Inherited From:

ht.ui.View#getMaxSize

getMaxSizeProperties() → {any}

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

Returns:

any -

maxSize 属性映射表

Inherited From:

ht.ui.View#getMaxSizeProperties

getMinSize() → {Object}

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

Returns:

Object -

minSize

Inherited From:

ht.ui.View#getMinSize

getMinSizeProperties() → {any}

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

Returns:

any -

minSize 属性映射表

Inherited From:

ht.ui.View#getMinSizeProperties

getMoveIconTint() → {string}

获取 move 状态下图标染色

Returns:

string -

颜色

getMoveTabBackground() → {any}

获取拖拽状态的标签背景，可以是颜色或者图片等

Returns:

any -

标签背景

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

获取拖拽状态下标签背景的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

标签背景

getMoveTitleColor() → {string}

获取 Move 状态下标签文字的颜色

Returns:

string -

颜色值

getPadding() → {number|Array.<number>}

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

Returns:

number | Array.<number> -

内边距

Inherited From:

ht.ui.View#getPadding

getPaddingBottom() → {number}

获取组件底部内边距高度

Returns:

number -

底部内边距高度

Inherited From:

ht.ui.View#getPaddingBottom

getPaddingLeft() → {number}

获取组件左侧内边距宽度

Returns:

number -

左侧内边距宽度

Inherited From:

ht.ui.View#getPaddingLeft

getPaddingRight() → {number}

获取组件右侧内边距宽度

Returns:

number -

右侧内边距宽度

Inherited From:

ht.ui.View#getPaddingRight

getPaddingTop() → {number}

获取组件顶部内边距高度

Returns:

number -

顶部内边距高度

Inherited From:

ht.ui.View#getPaddingTop

getParent() → {ht.ui.ViewGroup}

获取父容器

Returns:

ht.ui.ViewGroup -

父容器

Inherited From:

ht.ui.View#getParent

getPopover() → {ht.ui.Popover}

获取弹框组件

Returns:

ht.ui.Popover -

弹框组件

Inherited From:

ht.ui.View#getPopover

getPopoverPlacements() → {Array.<string>}

获取弹框组件的弹出位置

Returns:

Array.<string> -

弹出位置

Inherited From:

ht.ui.View#getPopoverPlacements

getPopoverTrigger() → {string}

获取弹框触发器

Returns:

string -

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

Inherited From:

ht.ui.View#getPopoverTrigger

getPreferredSize() → {Object}

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

Returns:

Object -

preferredSize

Inherited From:

ht.ui.View#getPreferredSize

getPreferredSizeProperties() → {any}

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

Returns:

any -

preferredSize 属性映射表

Inherited From:

ht.ui.View#getPreferredSizeProperties

getPropertyValue(name) → {any}

取组件的某个属性的原始值；
不要直接去取私有变量，例如 padding，不要直接取 _padding 私有变量，而是应该使用此函数取值；
此函数取值顺序：
先取 _padding 私有变量
如果为 undefind，再去取样式表中取值
如果为 undefied，再取 __padding 私有变量

Parameters:

Name	Type	Description
`name`	string	属性名

Returns:

any -

属性值

Inherited From:

ht.ui.View#getPropertyValue

Example

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

getRootCanvas() → {HTMLCanvasElement}

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

Returns:

HTMLCanvasElement -

Canvas DOM 对象

Inherited From:

ht.ui.View#getRootCanvas

getRootContext(dom, ignoreCache) → {CanvasRenderingContext2D}

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

Parameters:

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

Returns:

CanvasRenderingContext2D -

画笔对象

Inherited From:

ht.ui.View#getRootContext

getScrollBarActiveSize() → {number}

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

Returns:

number -

滚动条感应区域的大小

Inherited From:

ht.ui.ViewGroup#getScrollBarActiveSize

getScrollBarColor() → {string}

获取滚动条颜色

Returns:

string -

颜色值

Inherited From:

ht.ui.ViewGroup#getScrollBarColor

getScrollBarMinLength() → {number}

获取滚动条最小长度

Returns:

number -

滚动条最小长度

Inherited From:

ht.ui.ViewGroup#getScrollBarMinLength

getScrollBarMode() → {string}

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

Returns:

string -

滚动条模式

Inherited From:

ht.ui.ViewGroup#getScrollBarMode

getScrollBarSize() → {number}

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

Returns:

number -

滚动条大小

Inherited From:

ht.ui.ViewGroup#getScrollBarSize

getScrollBarTimeout() → {number}

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

Returns:

number -

滚动条显示时间

Inherited From:

ht.ui.ViewGroup#getScrollBarTimeout

getScrollController() → {any}

获取滚动控制器图标

Returns:

any -

图标，可以是颜色或者图片等

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

获取滚动控制器图标的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

图标

getScrollControllerHeight() → {number}

获取控制器图标高度

Returns:

number -

图标高度

getScrollControllerWidth() → {number}

获取控制器图标宽度

Returns:

number -

图标宽度

getScrollRect() → {Object}

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

Returns:

Object -

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

Inherited From:

ht.ui.ViewGroup#getScrollRect

getStyle(property) → {any}

Parameters:

Name	Type	Description
`property`	string

Returns:

any

Inherited From:

ht.ui.View#getStyle

getStyleProperties() → {any}

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

Returns:

any -

样式属性映射表

Inherited From:

ht.ui.View#getStyleProperties

getStyleValue(property) → {any}

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

Parameters:

Name	Type	Description
`property`	string	属性名

Returns:

any -

样式值

Inherited From:

ht.ui.View#getStyleValue

getTabBackground() → {any}

获取标签背景，可以是颜色或者图片等

Returns:

any -

标签背景

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

获取标签背景的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

标签背景

getTabGap() → {number}

获取标签之间的距离

Returns:

number -

标签之间的距离

getTabGapTop() → {number}

获取标签顶部到 tabHeader(标签行) 顶部的空白距离

Returns:

number -

距离

getTabHeaderBackground() → {any}

获取标签行背景，可以是颜色或者图片等

Returns:

any -

标签行背景

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

获取标签行背景的 Drawable 对象

Returns:

ht.ui.drawable.Drawable -

标签行背景

getTabHeaderLineColor() → {string}

获取标签行分割线颜色

Returns:

string -

颜色值

getTabHeaderLineSize() → {number}

获取标签行分割线宽度

Returns:

number -

线宽

getTabHeight() → {number}

获取标签高度

Returns:

number -

标签高度

getTabInfoAt(event) → {Object}

获取鼠标事件下的标签信息

Parameters:

Name	Type	Description
`event`	MouseEvent \| TouchEvent	事件对象

Returns:

Object -

标签信息，格式为：{closeRect: closeRect, view: view, rect: rect};

getTabPadding() → {number}

获取标签文字左右两侧的间距

Returns:

number -

间距值

getTabPosition() → {string}

获取标签头的位置，默认为 'top'

Returns:

string -

getTabWidth(view) → {number}

获取统一的标签宽度

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

number -

宽度值

getTextWidth(text, child) → {number}

计算文本宽度，结果被用来计算标签页的尺寸

Parameters:

Name	Type	Description
`text`	string	文本内容
`child`	ht.ui.View	子组件

Returns:

number -

文本宽度

getTitle(view) → {string}

获取指定子组件的标签文本；可重写自定义标签文本

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

string -

标签文本

getTitleColor() → {string}

获取正常状态下标签文字的颜色

Returns:

string -

颜色值

getTitleFont() → {string}

获取标签文字字体

Returns:

string -

标签文字字体

getToolGap() → {number}

获取工具按钮图标之间的距离

Returns:

number

getToolHeight() → {number}

获取工具按钮图标的高度

Returns:

number

getToolMarginLeft() → {number}

获取工具按钮图标左侧的空白距离(到标题文字的距离)

Returns:

number

getToolTint() → {string}

获取工具图标染色

Returns:

string -

颜色

getToolTip(event) → {string}

获取工具提示文本内容

Parameters:

Name	Type	Attributes	Description
`event`	any	<optional>

Returns:

string -

工具提示文本内容

Inherited From:

ht.ui.View#getToolTip

getToolWidth() → {number}

获取工具按钮图标的宽度

Returns:

number

getTranslateX() → {number}

获取水平滚动值

Returns:

number -

水平滚动值

Inherited From:

ht.ui.ViewGroup#getTranslateX

getTranslateY() → {number}

获取垂直滚动值

Returns:

number -

垂直滚动值

Inherited From:

ht.ui.ViewGroup#getTranslateY

getView() → {HTMLElement}

获取组件最根层的 div

Returns:

HTMLElement -

组件 div

Inherited From:

ht.ui.View#getView

getViewPoint(event) → {Object}

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

Parameters:

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

Returns:

Object -

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

Inherited From:

ht.ui.View#getViewPoint

getViewRect() → {Object}

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

Returns:

Object -

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

Inherited From:

ht.ui.ViewGroup#getViewRect

getVisibleChildren() → {ht.List}

获取可见的子组件列表

Returns:

ht.List -

可见的子组件列表

Inherited From:

ht.ui.ViewGroup#getVisibleChildren

getWidth() → {number}

获取组件的宽度

Returns:

number -

组件宽度

Inherited From:

ht.ui.View#getWidth

getX() → {number}

获取组件的 x 坐标

Returns:

number -

x 坐标

Inherited From:

ht.ui.View#getX

getY() → {number}

获取组件的 y 坐标

Returns:

number -

y 坐标

Inherited From:

ht.ui.View#getY

getZIndex() → {number}

获取组件的堆叠顺序

Returns:

number -

堆叠顺序

Inherited From:

ht.ui.View#getZIndex

getZoom() → {number}

获取缩放值

Returns:

number -

缩放值

Inherited From:

ht.ui.View#getZoom

getZoomAnchor() → {Array.<number>}

获取缩放锚点

Returns:

Array.<number> -

锚点数组

Inherited From:

ht.ui.View#getZoomAnchor

hasContentCanvas() → {boolean}

判断组件是否有私有 canvas

Returns:

boolean -

组件是否有私有 canvas

Inherited From:

ht.ui.View#hasContentCanvas

hasFocus() → {boolean}

判断焦点是否在组件上

Returns:

boolean -

焦点是否在组件上

Inherited From:

ht.ui.View#hasFocus

hidePopover() → {void}

隐藏弹框组件

Returns:

void

Inherited From:

ht.ui.View#hidePopover

hideToolTip() → {void}

隐藏 toolTip

Returns:

void

Inherited From:

ht.ui.View#hideToolTip

hideView(view) → {void}

隐藏子组件

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件实例

Returns:

void

initView(canvas) → {void}

初始化组件的 DOM 结构

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#initView

invalidate(forceLayoutChildren) → {void}

使组件无效化

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#invalidate

invalidateDOM() → {void}

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

Returns:

void

Inherited From:

ht.ui.View#invalidateDOM

isAutoHideCloseIcon() → {boolean}

是否自动隐藏关闭按钮；如果为 true，只有鼠标移动到标签页上时才显示关闭按钮

Returns:

boolean -

是否自动隐藏关闭按钮

isAutoMakeVisible() → {boolean}

是否自动调整 translate 以显示选中的子组件标签

Returns:

boolean -

是否自动调整 translate 以显示选中的子组件标签

isClosable(view) → {boolean}

判断子组件是否可以被关闭

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

boolean -

是否可被关闭

isCloseToHScrollBar(e) → {void}

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

Parameters:

Name	Type	Description
`e`	MouseEvent \| TouchEvent	鼠标或 Touch 事件对象

Returns:

void

Inherited From:

ht.ui.ViewGroup#isCloseToHScrollBar

isCloseToVScrollBar(e) → {void}

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

Parameters:

Name	Type	Description
`e`	MouseEvent \| TouchEvent	鼠标或 Touch 事件对象

Returns:

void

Inherited From:

ht.ui.ViewGroup#isCloseToVScrollBar

isDescendantOf(viewGroup) → {boolean}

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

Parameters:

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

Returns:

boolean

Inherited From:

ht.ui.View#isDescendantOf

isDisabled() → {boolean}

组件是否被禁用

Returns:

boolean -

是否被禁用

Inherited From:

ht.ui.View#isDisabled

isFloatLayout() → {boolean}

Returns:

boolean

Inherited From:

ht.ui.View#isFloatLayout

isFocusable() → {boolean}

组件是否可以获取焦点

Returns:

boolean -

是否可获取焦点

Inherited From:

ht.ui.View#isFocusable

isHScrollable() → {boolean}

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

Returns:

boolean -

是否可以水平滚动

Inherited From:

ht.ui.ViewGroup#isHScrollable

isInDOM() → {boolean}

判断组件是否在 DOM 树中

Returns:

boolean -

组件是否在 DOM 树中

Inherited From:

ht.ui.View#isInDOM

isMaxSizeSet() → {boolean}

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

Returns:

boolean -

maxSize 是否被设置

Inherited From:

ht.ui.View#isMaxSizeSet

isMinSizeSet() → {boolean}

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

Returns:

boolean -

minSize 是否被设置

Inherited From:

ht.ui.View#isMinSizeSet

isMovable() → {boolean}

判断标签是否可拖拽调整位置，默认为 true

Returns:

boolean -

是否可拖拽调整位置

isPreferredSizeSet() → {boolean}

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

Returns:

boolean -

preferredSize 是否被设置

Inherited From:

ht.ui.View#isPreferredSizeSet

isRedrawOnFocus() → {boolean}

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

Returns:

boolean -

是否重绘自身

Inherited From:

ht.ui.View#isRedrawOnFocus

isScrollControllerVisible() → {boolean}

Returns:

boolean

isSelfViewEvent(event) → {boolean}

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

Parameters:

Name	Type	Description
`event`	any	事件对象

Returns:

boolean -

事件是否发生在自身 DOM 上

Inherited From:

ht.ui.View#isSelfViewEvent

isStyleProperty(property) → {boolean}

判断属性是否是样式属性

Parameters:

Name	Type	Description
`property`	string	属性名

Returns:

boolean -

是否是样式属性

Inherited From:

ht.ui.View#isStyleProperty

isToolTipEnabled() → {boolean}

是否启用工具提示

Returns:

boolean -

是否启用工具提示

Inherited From:

ht.ui.View#isToolTipEnabled

isVisible() → {boolean}

判断组件是否可见

Returns:

boolean -

组件是否可见

Inherited From:

ht.ui.View#isVisible

isVScrollable() → {boolean}

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

Returns:

boolean -

是否可以垂直滚动

Inherited From:

ht.ui.ViewGroup#isVScrollable

iv(forceLayoutChildren) → {void}

使组件无效化

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#iv

layoutChild(child, x, y, width, height) → {void}

布局子组件，设置组件的 x、y 坐标以及宽高并调用子组件的 validate；
如果自定义布局器，一般需要在 validateImpl 函数中调用此函数对子组件进行布局

Parameters:

Name	Type	Description
`child`	ht.ui.View	要布局的子组件
`x`	number	组件的 x 坐标
`y`	number	组件的 y 坐标
`width`	number	组件的宽度
`height`	number	组件的高度

Returns:

void

Inherited From:

ht.ui.ViewGroup#layoutChild

layoutDOM(x, y, width, height) → {void}

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

Parameters:

Name	Type	Attributes	Description
`x`	number		组件的 x 坐标
`y`	number	<optional>	组件的 y 坐标
`width`	number	<optional>	组件宽度
`height`	number	<optional>	组件高度

Returns:

void

Inherited From:

ht.ui.View#layoutDOM

makeDisabled(disabled, disabledDiv) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#makeDisabled

makeVisible(view) → {void}

调整 translate 以显示参数指定子组件标签

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

void

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

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#mp

off(name, listener, scope) → {void}

删除事件监听

Parameters:

Name	Type	Attributes	Description
`name`	string		属性名，p: 开头(如 p:value)，表示监听属性变化事件；d: 开头(如 d:mousedown) 表示监听原生 DOM 事件；其它情况当作 viewEvent 处理
`listener`	Object
`scope`	any	<optional>	监听器函数域

Returns:

void

Inherited From:

ht.ui.View#off

on(name, listener, scope, ahead) → {void}

增加事件监听

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#on

onOnce(name, listener, scope, ahead) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#onOnce

onPropertyChanged(e) → {void}

属性变化回调

Parameters:

Name	Type	Description
`e`	Object

Returns:

void

Inherited From:

ht.ui.View#onPropertyChanged

processValidate() → {void}

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

Returns:

void

Inherited From:

ht.ui.View#processValidate

redraw(forceLayoutChildren) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#redraw

removeFromDOM() → {void}

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

Returns:

void

Inherited From:

ht.ui.View#removeFromDOM

removePropertyChangeListener(listener, scope) → {void}

删除属性事件变化监听器

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#removePropertyChangeListener

removeStyleProperty(property) → {void}

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

Parameters:

Name	Type	Description
`property`	string	属性名

Returns:

void

Inherited From:

ht.ui.View#removeStyleProperty

removeView(view) → {void}

将子组件从容器中删除

Parameters:

Name	Type	Description
`view`	ht.ui.View	要删除的子组件

Returns:

void

Inherited From:

ht.ui.ViewGroup#removeView

removeViewAt(index) → {void}

删除容器子组件列表中对应下标为 index 的子组件

Parameters:

Name	Type	Description
`index`	number	子组件下标

Returns:

void

Inherited From:

ht.ui.ViewGroup#removeViewAt

removeViewListener(listener, scope) → {void}

删除 View 事件监听器

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#removeViewListener

requestFocus() → {void}

请求获取焦点

Returns:

void

Inherited From:

ht.ui.View#requestFocus

resetTranslate() → {any}

Returns:

any

Inherited From:

ht.ui.View#resetTranslate

selectNext(view) → {void}

选中指定子组件的下一个子组件

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

void

selectPrevious(view) → {void}

选中指定子组件的前一个子组件

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件

Returns:

void

set(properties) → {void}

批量设置组件属性

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#set

setActiveCloseIcon(icon) → {void}

设置 active 状态下的标签中的关闭图标

Parameters:

Name	Type	Description
`icon`	any	关闭图标，可以是颜色或者图片等

Returns:

void

setActiveCloseIconDrawable(drawable) → {void}

设置 active 状态下的标签中关闭图标的 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 activeCloseIcon 转换

Parameters:

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

Returns:

void

setActiveIconTint(color) → {void}

设置 active 状态下图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setActiveScrollController(icon) → {void}

设置 active 状态下滚动控制器图标

Parameters:

Name	Type	Description
`icon`	any	图标，可以是颜色或者图片等

Returns:

void

setActiveScrollControllerDrawable(drawable) → {void}

设置 active 状态下滚动控制器图标的 Drawable 对象

Parameters:

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

Returns:

void

setActiveTabBackground(background) → {void}

设置 Active 状态下的标签背景，可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	any	标签背景

Returns:

void

setActiveTabBackgroundDrawable(drawable) → {void}

设置 Active 状态下标签背景的 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 activeTabBackground 转换

Parameters:

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

Returns:

void

setActiveTitleColor(color) → {void}

设置 Active 状态下标签文字的颜色

Parameters:

Name	Type	Description
`color`	string	颜色值

Returns:

void

setActiveToolTint(color) → {void}

设置 active 状态下工具图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setActiveView(view) → {void}

设置选中的子组件

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件实例

Returns:

void

setActiveViewIndex(index) → {void}

根据下标设置选中的子组件

Parameters:

Name	Type	Description
`index`	number	子组件下标

Returns:

void

setAttr(property, value) → {void}

Parameters:

Name	Type	Description
`property`	string
`value`	any

Returns:

void

Inherited From:

ht.ui.View#setAttr

setAutoHideCloseIcon(autoHide) → {void}

设置是否自动隐藏关闭按钮

Parameters:

Name	Type	Description
`autoHide`	boolean	是否自动隐藏关闭按钮

Returns:

void

setAutoMakeVisible(autoMakeVisible) → {void}

设置自动调整 translate 以显示选中的子组件标签

Parameters:

Name	Type	Description
`autoMakeVisible`	boolean	是否自动调整 translate 以显示选中的子组件标签

Returns:

void

setBackground(background) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setBackground

setBackgroundDrawable(drawable) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setBackgroundDrawable

setBorder(border) → {void}

设置组件的边框

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setBorder

setBorderRadius(radius) → {void}

设置 CSS 边框圆角

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setBorderRadius

setBoxShadow(boxShadow) → {void}

设置 CSS 阴影值

Parameters:

Name	Type	Description
`boxShadow`	string	阴影值

Returns:

void

Inherited From:

ht.ui.View#setBoxShadow

setChildren(children) → {void}

设置子组件，会覆盖容器原有子组件

Parameters:

Name	Type	Description
`children`	Array.<any>	子组件集合

Returns:

void

Inherited From:

ht.ui.ViewGroup#setChildren

setCloseIcon(icon) → {void}

设置标签中的关闭图标

Parameters:

Name	Type	Description
`icon`	any	关闭图标，可以是颜色或者图片等

Returns:

void

setCloseIconDrawable(drawable) → {void}

设置标签中关闭图标的 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 closeIcon 转换

Parameters:

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

Returns:

void

setCloseIconMarginLeft(gap) → {void}

设置关闭按钮图标左侧的空白距离(到标题文字的距离)

Parameters:

Name	Type	Description
`gap`	number

Returns:

void

setCloseIconSize(size) → {void}

设置标签中关闭图标尺寸

Parameters:

Name	Type	Description
`size`	number	关闭图标的尺寸

Returns:

void

setCloseIconX(x) → {void}

设置关闭图标的水平中心坐标

Parameters:

Name	Type	Description
`x`	number	水平中心坐标；如果小于 0，表示在右侧固定像素位置；如果大于 1，表示在左侧固定像素位置；如果在 0 - 1 之间，表示百分比

Returns:

void

setCloseIconY(y) → {void}

设置关闭图标的垂直中心坐标

Parameters:

Name	Type	Description
`y`	number	垂直中心坐标；如果小于 0，表示在底部固定像素位置；如果大于 1，表示在顶部固定像素位置；如果在 0 - 1 之间，表示百分比

Returns:

void

setColorMode(mode) → {void}

Parameters:

Name	Type	Description
`mode`	string

Returns:

void

Inherited From:

ht.ui.View#setColorMode

setContextMenu(contextMenu) → {void}

设置绑定的右键菜单

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setContextMenu

setCurrentScrollController(name) → {void}

设置当前操作的控制器

Parameters:

Name	Type	Description
`name`	string	控制器名称

Returns:

void

setCurrentScrollControllerState(state) → {void}

设置当前操作的控制器状态

Parameters:

Name	Type	Description
`state`	string	状态

Returns:

void

setCursor(cursor) → {void}

设置鼠标样式(CSS 格式)

Parameters:

Name	Type	Description
`cursor`	string	鼠标样式

Returns:

void

Inherited From:

ht.ui.View#setCursor

setDisabled(disabled) → {void}

设置组件是否被禁用

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setDisabled

setDisabledBackground(background) → {void}

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

Parameters:

Name	Type	Description
`background`	string	遮罩背景

Returns:

void

Inherited From:

ht.ui.View#setDisabledBackground

Example

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

setDisabledIconTint(color) → {void}

设置 disabled 状态下图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setDisabledScrollController(icon) → {void}

设置 disabled 状态下滚动控制器图标

Parameters:

Name	Type	Description
`icon`	any	图标，可以是颜色或者图片等

Returns:

void

setDisabledScrollControllerDrawable(drawable) → {void}

设置 disabled 状态下滚动控制器图标的 Drawable 对象

Parameters:

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

Returns:

void

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

设置错误信息

Parameters:

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

Returns:

ht.ui.Popover -

错误提示组件

Inherited From:

ht.ui.View#setErrorMessage

setFloatLayout(floatLayout) → {void}

Parameters:

Name	Type	Description
`floatLayout`	boolean

Returns:

void

Inherited From:

ht.ui.View#setFloatLayout

setFocusable(focusable) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setFocusable

setFormDataName(name) → {any}

Parameters:

Name	Type	Description
`name`	string

Returns:

any

Inherited From:

ht.ui.View#setFormDataName

setHeight(height) → {void}

设置组件的高度

Parameters:

Name	Type	Description
`height`	number	组件高度

Returns:

void

Inherited From:

ht.ui.View#setHeight

setHoverCloseIcon(icon) → {void}

设置 hover 状态下的标签中的关闭图标

Parameters:

Name	Type	Description
`icon`	any	关闭图标，可以是颜色或者图片等

Returns:

void

setHoverCloseIconDrawable(drawable) → {void}

设置 hover 状态下的标签中关闭图标的 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 hoverCloseIcon 转换

Parameters:

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

Returns:

void

setHoverIconTint(color) → {void}

设置 hover 状态下图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setHoverScrollController(icon) → {void}

设置 hover 状态下滚动控制器图标

Parameters:

Name	Type	Description
`icon`	any	图标，可以是颜色或者图片等

Returns:

void

setHoverScrollControllerDrawable(drawable) → {void}

设置 hover 状态下滚动控制器图标的 Drawable 对象

Parameters:

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

Returns:

void

setHoverTabBackground(background) → {void}

设置 Hover 状态下的标签背景，可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	any	标签背景

Returns:

void

setHoverTabBackgroundDrawable(drawable) → {void}

设置 Hover 状态下标签背景的 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 hoverTabBackground 转换

Parameters:

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

Returns:

void

setHoverTitleColor(color) → {void}

设置 Hover 状态下标签文字的颜色

Parameters:

Name	Type	Description
`color`	string	颜色值

Returns:

void

setHoverToolTint(color) → {void}

设置 hover 状态下工具图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setIconHeight(height) → {void}

设置标签中图标的高度，默认为 16

Parameters:

Name	Type	Description
`height`	number	图标高度

Returns:

void

setIconTint(color) → {void}

设置图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setIconTitleGap(gap) → {void}

设置标签图标和文字之间的距离，默认为 4

Parameters:

Name	Type	Description
`gap`	number	图标和文字之间的距离

Returns:

void

setIconWidth(width) → {void}

设置标签中图标的宽度，默认为 16

Parameters:

Name	Type	Description
`width`	number	图标宽度

Returns:

void

setId(id) → {void}

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

Parameters:

Name	Type	Description
`id`	string \| number	唯一标识

Returns:

void

Inherited From:

ht.ui.View#setId

setInsertLine(insertLine) → {void}

设置拖拽过程中插入提示线的背景，可以是颜色或者图片等

Parameters:

Name	Type	Description
`insertLine`	any	提示线背景

Returns:

void

setInsertLineDrawable(drawable) → {void}

设置拖拽过程中插入提示线的 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 insertLine 转换

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	提示线背景

Returns:

void

setLayoutParams(layoutParams, value) → {void}

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

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setLayoutParams

setLazyValidate(lazyValidate) → {void}

Parameters:

Name	Type	Description
`lazyValidate`	boolean

Returns:

void

setLoading(arg0) → {void}

Parameters:

Name	Type	Description
`arg0`	boolean

Returns:

void

Inherited From:

ht.ui.View#setLoading

setMargin(margin) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setMargin

setMaxSize(width, height) → {void}

Parameters:

Name	Type	Attributes	Description
`width`	number	<optional>
`height`	number	<optional>

Returns:

void

Inherited From:

ht.ui.View#setMaxSize

setMemoryValidate(validate) → {void}

Parameters:

Name	Type	Description
`validate`	boolean

Returns:

void

Inherited From:

ht.ui.View#setMemoryValidate

setMinSize(width, height) → {void}

Parameters:

Name	Type	Attributes	Description
`width`	number	<optional>
`height`	number	<optional>

Returns:

void

Inherited From:

ht.ui.View#setMinSize

setMovable(movable) → {void}

设置标签是否可拖拽调整位置，默认为 true

Parameters:

Name	Type	Description
`movable`	boolean	是否可拖拽调整位置

Returns:

void

setMoveIconTint(color) → {void}

设置 move 状态下图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setMoveTabBackground(background) → {void}

设置拖拽状态的标签背景，可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	any	标签背景

Returns:

void

setMoveTabBackgroundDrawable(drawable) → {void}

设置拖拽状态下标签背景的 Drawable 对象；组件渲染时优先使用此 Drawable 对象，如果为空，再用 moveTabBackground 转换

Parameters:

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

Returns:

void

setMoveTitleColor(color) → {void}

设置 Move 状态下标签文字的颜色

Parameters:

Name	Type	Description
`color`	string	颜色值

Returns:

void

setOverflow(value) → {void}

Parameters:

Name	Type	Description
`value`	"auto" \| "clip" \| "hidden" \| "visible" \| "scroll"

Returns:

void

Inherited From:

ht.ui.ViewGroup#setOverflow

setPadding(padding) → {void}

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

Parameters:

Name	Type	Description
`padding`	number \| Array.<Number>	内边距

Returns:

void

Inherited From:

ht.ui.View#setPadding

setPopover(popover, trigger) → {void}

设置弹框组件

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setPopover

setPopoverPlacements(placements) → {void}

设置弹框组件的弹出位置

Parameters:

Name	Type	Description
`placements`	Array.<string>	位置数组

Returns:

void

Inherited From:

ht.ui.View#setPopoverPlacements

setPopoverTrigger(trigger) → {void}

设置弹框触发器

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setPopoverTrigger

setPreferredSize(width, height) → {void}

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

Parameters:

Name	Type	Attributes	Description
`width`	number \| Size2d	<optional>	首选宽度
`height`	number	<optional>	首选高度

Returns:

void

Inherited From:

ht.ui.View#setPreferredSize

setPropertyValue(name, value) → {void}

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

Parameters:

Name	Type	Description
`name`	string	属性名
`value`	any	属性值

Returns:

void

Inherited From:

ht.ui.View#setPropertyValue

setRedrawOnFocus(redrawOnFocus) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setRedrawOnFocus

setScrollBarActiveSize(activeSize) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#setScrollBarActiveSize

setScrollBarColor(color) → {void}

设置滚动条颜色

Parameters:

Name	Type	Description
`color`	string	颜色值

Returns:

void

Inherited From:

ht.ui.ViewGroup#setScrollBarColor

setScrollBarMinLength(length) → {void}

设置滚动条最小长度

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#setScrollBarMinLength

setScrollBarMode(mode) → {void}

设置滚动条模式

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#setScrollBarMode

setScrollBarSize(size) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#setScrollBarSize

setScrollBarTimeout(timeout) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#setScrollBarTimeout

setScrollController(icon) → {void}

设置滚动控制器图标

Parameters:

Name	Type	Description
`icon`	any	图标，可以是颜色或者图片等

Returns:

void

setScrollControllerDrawable(drawable) → {void}

设置滚动控制器图标的 Drawable 对象

Parameters:

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

Returns:

void

setScrollControllerHeight(height) → {void}

设置控制器图标高度

Parameters:

Name	Type	Description
`height`	number	图标高度

Returns:

void

setScrollControllerVisible(visible) → {void}

Parameters:

Name	Type	Description
`visible`	boolean

Returns:

void

setScrollControllerWidth(width) → {void}

设置控制器图标宽度

Parameters:

Name	Type	Description
`width`	number	图标宽度

Returns:

void

setStyle(property, value) → {void}

Parameters:

Name	Type	Description
`property`	string
`value`	any

Returns:

void

Inherited From:

ht.ui.View#setStyle

setTabBackground(background) → {void}

设置标签背景，可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	any	标签背景

Returns:

void

setTabBackgroundDrawable(drawable) → {void}

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

Parameters:

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

Returns:

void

setTabGap(gap) → {void}

设置标签之间的距离

Parameters:

Name	Type	Description
`gap`	number	标签之间的距离

Returns:

void

setTabGapTop(gap) → {void}

设置标签顶部到 tabHeader(标签行) 顶部的空白距离

Parameters:

Name	Type	Description
`gap`	number	距离值

Returns:

void

setTabHeaderBackground(background) → {void}

设置标签行背景，可以是颜色或者图片等

Parameters:

Name	Type	Description
`background`	any	标签行背景

Returns:

void

setTabHeaderBackgroundDrawable(drawable) → {void}

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

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	标签行背景

Returns:

void

setTabHeaderLineColor(color) → {void}

设置标签行分割线颜色

Parameters:

Name	Type	Description
`color`	string	颜色值

Returns:

void

setTabHeaderLineSize(size) → {void}

设置标签行分割线宽度

Parameters:

Name	Type	Description
`size`	number	线宽

Returns:

void

setTabHeight(height) → {void}

设置标签高度

Parameters:

Name	Type	Description
`height`	number	标签高度

Returns:

void

setTabPadding(padding) → {void}

设置标签文字左右两侧的间距

Parameters:

Name	Type	Description
`padding`	number	间距值

Returns:

void

setTabPosition(position) → {void}

设置标签的位置

Parameters:

Name	Type	Description
`position`	string	标签位置，可选值：'left'\|'right'\|'top'\|'bottom'\|'left-vertical'\|'right-vertical'，默认为 'top'

Returns:

void

setTabWidth(width) → {void}

设置统一的标签宽度

Parameters:

Name	Type	Description
`width`	number	宽度值

Returns:

void

setTitleColor(color) → {void}

设置正常状态下标签文字的颜色

Parameters:

Name	Type	Description
`color`	string	颜色值

Returns:

void

setTitleFont(font) → {void}

设置标签文字字体

Parameters:

Name	Type	Description
`font`	string	标签文字字体，如 '12px Arial'

Returns:

void

setToolGap(gap) → {void}

设置工具按钮图标之间的距离

Parameters:

Name	Type	Description
`gap`	number

Returns:

void

setToolHeight(height) → {void}

设置工具按钮图标的高度

Parameters:

Name	Type	Description
`height`	number

Returns:

void

setToolMarginLeft(gap) → {void}

设置工具按钮图标左侧的空白距离(到标题文字的距离)

Parameters:

Name	Type	Description
`gap`	number

Returns:

void

setToolTint(color) → {void}

设置工具图标染色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setToolTipEnabled(enabled) → {void}

设置是否启用工具提示

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setToolTipEnabled

setToolTipPlacements(placements) → {any}

Parameters:

Name	Type	Description
`placements`	Array.<string>

Returns:

any

Inherited From:

ht.ui.View#setToolTipPlacements

setToolWidth(width) → {void}

设置工具按钮图标的宽度

Parameters:

Name	Type	Description
`width`	number

Returns:

void

setTranslate(translateX, translateY, anim) → {void}

设置水平和垂直滚动值

Parameters:

Name	Type	Attributes	Description
`translateX`	number		水平滚动值
`translateY`	number	<optional>	垂直滚动值
`anim`	boolean	<optional>	是否使用动画

Returns:

void

Inherited From:

ht.ui.ViewGroup#setTranslate

setTranslateX(translateX) → {void}

设置水平滚动值

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#setTranslateX

setTranslateY(translateY) → {void}

设置垂直滚动值

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#setTranslateY

setVisible(visible) → {void}

设置组件是否可见

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setVisible

setWidth(width) → {void}

设置组件的宽度

Parameters:

Name	Type	Description
`width`	number	组件宽度

Returns:

void

Inherited From:

ht.ui.View#setWidth

setX(x) → {void}

设置组件的 x 坐标

Parameters:

Name	Type	Description
`x`	number	x 坐标

Returns:

void

Inherited From:

ht.ui.View#setX

setY(y) → {void}

设置组件的 y 坐标

Parameters:

Name	Type	Description
`y`	number	y 坐标

Returns:

void

Inherited From:

ht.ui.View#setY

setZIndex(zIndex) → {void}

设置组件的堆叠顺序

Parameters:

Name	Type	Description
`zIndex`	number	堆叠顺序

Returns:

void

Inherited From:

ht.ui.View#setZIndex

setZoom(zoom) → {void}

设置缩放

Parameters:

Name	Type	Description
`zoom`	number	缩放值

Returns:

void

Inherited From:

ht.ui.View#setZoom

setZoomAnchor(anchor) → {void}

设置缩放锚点

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#setZoomAnchor

showHScrollBar() → {void}

显示水平滚动条

Returns:

void

Inherited From:

ht.ui.ViewGroup#showHScrollBar

showPopover() → {void}

显示弹框组件

Returns:

void

Inherited From:

ht.ui.View#showPopover

showScrollBar() → {void}

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#showScrollBar

showToolTip(moveEvent) → {void}

显示 toolTip

Parameters:

Name	Type	Description
`moveEvent`	MouseEvent \| TouchEvent	鼠标事件对象

Returns:

void

Inherited From:

ht.ui.View#showToolTip

showView(view) → {void}

显示子组件

Parameters:

Name	Type	Description
`view`	ht.ui.View	子组件实例

Returns:

void

showVScrollBar() → {void}

显示垂直滚动条

Returns:

void

Inherited From:

ht.ui.ViewGroup#showVScrollBar

tearDownBorder(border, x, y, width, height, dom) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#tearDownBorder

translate(x, y, anim) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.ViewGroup#translate

tx(value) → {number|void}

获取或设置水平滚动值

Parameters:

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

Returns:

number | void

Inherited From:

ht.ui.ViewGroup#tx

ty(value) → {number|void}

获取或设置垂直滚动值

Parameters:

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

Returns:

number | void

Inherited From:

ht.ui.ViewGroup#ty

ump(listener, scope) → {void}

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

Parameters:

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

Returns:

void

Inherited From:

ht.ui.View#ump

updateScrollBar(width, height, scrollWidth, scrollHeight) → {void}

更新滚动条；如果布局器需要滚动条，应该在 validateImpl 函数的末尾调用此函数更新滚动条

Parameters:

Name	Type	Description
`width`	number	组件布局宽度
`height`	number	组件布局高度
`scrollWidth`	number	组件内容宽度
`scrollHeight`	number	组件内容高度

Returns:

void

Inherited From:

ht.ui.ViewGroup#updateScrollBar

validate() → {void}

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

Returns:

void

Inherited From:

ht.ui.View#validate

validateImpl(x, y, width, height) → {void}

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

Parameters:

Name	Type	Attributes	Description
`x`	number	<optional>	内容范围的 x 坐标
`y`	number	<optional>	内容范围的 y 坐标
`width`	number	<optional>	内容范围宽度
`height`	number	<optional>	内容范围高度

Returns:

void

Inherited From:

ht.ui.View#validateImpl