HT for web

Class: Dialog

ht.ui. Dialog

new Dialog(properties)

对话框组件
子组件可用的布局参数(layoutParams)：

  • marginLeft 指定组件左侧外边距

  • marginRight 指定组件右侧外边距

  • marginTop 指定组件顶部外边距

  • marginBottom 指定组件底部外边距
可以看到 layoutParams 中不支持设置 width 和 height 的参数，因为对话框布局时会把 contentView 填满自身(周围根据 margin 留空白空间)， 因此也不支持设置滚动条

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

事件名 事件对象 描述
clickButton 

{
      kind: 'clickButton', // 事件种类
      button: button, // 点击的按钮
      source: dialog, // 事件源
      buttonEvent: e // button 派发出来的点击事件对象
}
点击对话框底部按钮时派发
样式属性(不含从父类继承)：modal, resizable, maskBackground, resizeBorderColor, closeIcon, closeIconDrawable, hoverCloseIcon, hoverCloseIconDrawable, activeCloseIcon, activeCloseIconDrawable, closable, closeToolIndex, maximizable, maximized, maximizeToolIndex, maximizeIcon, maximizeIconDrawable, hoverMaximizeIcon, hoverMaximizeIconDrawable, activeMaximizeIcon, activeMaximizeIconDrawable, restoreIcon, restoreIconDrawable, hoverRestoreIcon, hoverRestoreIconDrawable, activeRestoreIcon, activeRestoreIconDrawable, footerHeight, footerBackground, footerBackgroundDrawable, buttonGap, buttonAlign, buttonVAlign, buttonPrefWidth, buttonPrefHeight, footerPaddingLeft, footerPaddingRight, fixToCenter

Parameters:
Name Type Argument Description
properties Object <optional>

属性配置对象
Example
var btn1 = new ht.ui.Button();
btn1.setText('button1');
var dialog = new ht.ui.Dialog();
dialog.setContentView(btn1, { marginTop: 10 });
dialog.setWidth(600);
dialog.setHeight(300);
var center = dialog.getCenterPosition();
dialog.show(center.x, center.y);

Extends

Methods

addButton(button, index)

增加底栏按钮

Parameters:
Name Type Argument Description
button Object

按钮配置 json
index Number <optional>

显示顺序

addPropertyChangeListener(listener, scope, ahead)

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

Parameters:
Name Type Argument Description
listener function

监听器函数
scope Object <optional>

函数域
ahead Boolean <optional>

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

addStyleProperty(property)

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

Parameters:
Name Type Description
property String

属性名
Inherited From:

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:

addTool(tool, index)

增加工具按钮

Parameters:
Name Type Argument Description
tool Object

工具按钮配置 json
index Number <optional>

显示顺序
Inherited From:

addView(view, params, index)

将子组件加到容器中

Parameters:
Name Type Argument Description
view ht.ui.View

子组件
params Object <optional>

布局参数；可通过 childView.setLayoutPrams({...}) 提前设置并省略此参数
index Number <optional>

在子组件列表中的插入位置
Inherited From:

addViewListener(listener, scope, ahead)

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

Parameters:
Name Type Argument Description
listener function

监听器函数
scope Object <optional>

监听器函数域
ahead Boolean <optional>

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

adjustChildHeight(child, height) → {Number}

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

Parameters:
Name Type Description
child ht.ui.View

子组件
height Number

验证之前的高度
Inherited From:
Returns:

验证之后的高度

Type
Number

adjustChildWidth(child, width) → {Number}

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

Parameters:
Name Type Description
child ht.ui.View

子组件
width Number

验证之前的宽度
Inherited From:
Returns:

验证之后的宽度

Type
Number

adjustTranslateX(value) → {Number}

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

Parameters:
Name Type Description
value Number

调整之前的滚动值
Inherited From:
Returns:

调整后的滚动值

Type
Number

adjustTranslateY(value) → {Number}

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

Parameters:
Name Type Description
value Number

调整之前的滚动值
Inherited From:
Returns:

调整后的滚动值

Type
Number

clear()

删除所有子组件

Inherited From:

disableToolTip()

禁用工具提示，同 setToolTipEnabled

Inherited From:
See:

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:

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:

drawFooterBackground(drawable, x, y, width, height)

绘制底栏背景

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

图标 Drawable 对象
x Number

绘制范围的 x 坐标
y Number

绘制范围的 y 坐标
width Number

绘制范围的宽度
height Number

绘制范围的高度

drawHeaderBackground(drawable, x, y, width, height)

绘制标题栏背景

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

图标 Drawable 对象
x Number

绘制范围的 x 坐标
y Number

绘制范围的 y 坐标
width Number

绘制范围的宽度
height Number

绘制范围的高度
Inherited From:

drawIcon(drawable, x, y, width, height)

绘制标题栏图标

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

图标 Drawable 对象
x Number

绘制范围的 x 坐标
y Number

绘制范围的 y 坐标
width Number

绘制范围的宽度
height Number

绘制范围的高度
Inherited From:

drawTitle(g, text, font, color, x, y, width, height)

绘制标题栏文字

Parameters:
Name Type Description
g CanvasRenderingContext2D

画笔对象
text String

文字内容
font String

文字字体
color color

文字颜色
x Number

绘制范围的 x 坐标
y Number

绘制范围的 y 坐标
width Number

绘制范围的宽度
height Number

绘制范围的高度
Inherited From:

drawTool(tool, toolIndex, x, y, width, height)

绘制工具按钮

Parameters:
Name Type Description
tool Object

按钮配置 json
toolIndex Number

按钮顺序
x Number

绘制范围的 x 坐标
y Number

绘制范围的 y 坐标
width Number

绘制范围的宽度
height Number

绘制范围的高度
Inherited From:

enableToolTip()

启用工具提示，同 setToolTipEnabled

Inherited From:
See:

figureMaxSize() → {Object}

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

Inherited From:
Returns:

maxSize

Type
Object

figureMinSize() → {Object}

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

Inherited From:
Returns:

minSize

Type
Object

figurePreferredSize() → {Object}

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

Inherited From:
Returns:

preferredSize

Type
Object

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

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

Parameters:
Name Type Description
id Object

子组件 id
recursive Boolean

是否递归查找
Inherited From:
Returns:

匹配到的子组件

Type
ht.ui.View

fireViewEvent(event)

派发 View 事件

Parameters:
Name Type Description
event Object | String

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

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

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

Parameters:
Name Type Argument Description
property String

属性名
oldValue Object

属性变化之前的值
newValue Object

属性变化之后的值
compareFunc function <optional>

比较函数，用于比较新值和旧值是否一致，如果一致则不会派发事件
Inherited From:
Returns:

事件是否派发成功

Type
Boolean

getActiveCloseIcon() → {Object}

获取 Active 状态下关闭图标，可以是颜色或者图片等

See:
Returns:

关闭图标

Type
Object

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

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

Returns:

关闭图标

Type
ht.ui.drawable.Drawable

getActiveCollapseIcon() → {Object}

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

Inherited From:
See:
Returns:

合并图标

Type
Object

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

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

Inherited From:
Returns:

合并图标

Type
ht.ui.drawable.Drawable

getActiveExpandIcon() → {Object}

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

Inherited From:
See:
Returns:

展开图标

Type
Object

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

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

Inherited From:
Returns:

展开图标

Type
ht.ui.drawable.Drawable

getActiveHeaderBackground() → {Object}

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

Inherited From:
See:
Returns:

标题栏背景

Type
Object

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

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

Inherited From:
Returns:

标题栏背景

Type
ht.ui.drawable.Drawable

getActiveMaximizeIcon() → {Object}

获取 Active 状态下最大化图标，可以是颜色或者图片等

See:
Returns:

最大化图标

Type
Object

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

获取 Active 状态下最大化图标的 Drawable 对象

Returns:

最大化图标

Type
ht.ui.drawable.Drawable

getActiveRestoreIcon() → {Object}

获取 Active 状态下恢复图标，可以是颜色或者图片等

See:
Returns:

恢复图标

Type
Object

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

获取 Active 状态下恢复图标的 Drawable 对象

Returns:

恢复图标

Type
ht.ui.drawable.Drawable

getActiveTitleColor() → {color}

获取 Active 状态下标题文本颜色

Inherited From:
Returns:

颜色值

Type
color

getBackground() → {Object}

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

Inherited From:
See:
Returns:

组件背景

Type
Object

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

获取组件背景的 Drawable 对象

Inherited From:
Returns:

组件背景

Type
ht.ui.drawable.Drawable

getBorder() → {ht.border.Border}

获取组件的边框

Inherited From:
Returns:

组件边框

Type
ht.border.Border

getBorderBottom() → {Number}

获取组件边框的底部高度

Inherited From:
Returns:

组件边框底部高度

Type
Number

getBorderLeft() → {Number}

获取组件边框的左侧宽度

Inherited From:
Returns:

组件边框左侧宽度

Type
Number

getBorderRadius() → {Number|Array}

获取 CSS 边框圆角

Inherited From:
Returns:

边框圆角

Type
Number | Array

getBorderRight() → {Number}

获取组件边框的右侧宽度

Inherited From:
Returns:

组件边框右侧宽度

Type
Number

getBorderTop() → {Number}

获取组件边框的顶部高度

Inherited From:
Returns:

组件边框顶部高度

Type
Number

getBoxShadow() → {String}

获取 CSS 阴影值

Inherited From:
Returns:

阴影值

Type
String

getButtonAlign() → {String}

获取底栏按钮的水平对齐方式

Returns:

对齐方式，值可能为：'left'|'center'|'right'

Type
String

getButtonGap() → {Number}

获取底栏按钮之间的距离

Returns:

间距值

Type
Number

getButtonHeight(button) → {Number}

获取底栏按钮的高度，默认返回 preferredSize.height，可重写自定义

Parameters:
Name Type Description
button ht.ui.Button

按钮对象
Returns:

高度值

Type
Number

getButtonPrefHeight() → {Number}

获取对话框底部按钮的首选高度

Returns:
Type
Number

getButtonPrefWidth() → {Number}

获取对话框底部按钮的首选宽度

Returns:
Type
Number

getButtons() → {Array}

获取底栏中的按钮数组

Returns:

按钮数组，格式为：[{icon: 'icon', onClick: function(e) {} }, {icon: 'icon1', onClick: function(e) {} }]

Type
Array

getButtonVAlign() → {String}

获取底栏按钮的垂直对齐方式

Returns:

对齐方式，值可能为：'top'|'middle'|'bottom'

Type
String

getButtonWidth(button) → {Number}

获取底栏按钮的宽度，默认返回 preferredSize.width，可重写自定义

Parameters:
Name Type Description
button ht.ui.Button

按钮对象
Returns:

宽度值

Type
Number

getCenterPosition() → {Object}

根据屏幕大小和对话框本身宽高计算出显示在中心时的坐标并返回

Returns:

坐标值

Type
Object

getChildAt(事件对象或逻辑坐标点) → {ht.View}

获取鼠标事件下的子组件

Parameters:
Name Type Description
事件对象或逻辑坐标点 Event | Point
Inherited From:
Returns:

子组件

Type
ht.View

getChildLayoutParams(子组件) → {Object}

获取子组件的 layoutParams

Parameters:
Name Type Description
子组件 ht.ui.View
Inherited From:
Returns:

layoutParams

Type
Object

getChildren() → {ht.List}

获取子组件列表

Inherited From:
Returns:

子组件列表

Type
ht.List

getCloseIcon() → {Object}

获取正常状态下关闭图标，可以是颜色或者图片等

See:
Returns:

关闭图标

Type
Object

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

获取正常状态下关闭图标的 Drawable 对象

Returns:

关闭图标

Type
ht.ui.drawable.Drawable

getCloseToolIndex() → {Number}

获取关闭按钮在工具按钮组中的显示顺序

Returns:

显示顺序

Type
Number

getCollapseIcon() → {Object}

获取正常状态下合并图标，可以是颜色或者图片等

Inherited From:
See:
Returns:

合并图标

Type
Object

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

获取正常状态下合并图标的 Drawable 对象

Inherited From:
Returns:

合并图标

Type
ht.ui.drawable.Drawable

getCollapseToolIndex() → {Number}

获取展开合并按钮在工具按钮组中的显示顺序

Inherited From:
Returns:

显示顺序

Type
Number

getContentBottom() → {Number}

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

Inherited From:
Returns:

内容底部距离

Type
Number

getContentDiv() → {HTMLElement}

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

Inherited From:
Returns:

内容 div

Type
HTMLElement

getContentHeight() → {Number}

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

Inherited From:
Returns:

内容高度

Type
Number

getContentLeft() → {Number}

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

Inherited From:
Returns:

内容左侧距离

Type
Number

getContentPadding() → {Number|Array}

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

Inherited From:
Returns:
Type
Number | Array

getContentPoint(event) → {Object}

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

Parameters:
Name Type Description
event Event

交互事件对象(如鼠标事件对象)
Inherited From:
Returns:

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

Type
Object

getContentRight() → {Number}

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

Inherited From:
Returns:

内容右侧距离

Type
Number

getContentTop() → {Number}

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

Inherited From:
Returns:

内容顶部距离

Type
Number

getContentView() → {ht.ui.View}

获取面板中的子组件

Inherited From:
Returns:

子组件

Type
ht.ui.View

getContentWidth() → {Number}

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

Inherited From:
Returns:

内容宽度

Type
Number

getContextMenu() → {ht.ui.ContextMenu}

获取绑定的右键菜单

Inherited From:
Returns:

右键菜单

Type
ht.ui.ContextMenu

getCurrentTitleColor(state) → {color}

根据标题栏状态，返回相应的颜色(normalTitleColor 或 hoverTitleColor 或 activeTitleColor)；可重写自定义

Parameters:
Name Type Argument Description
state String <optional>

状态，如果未指定，使用 panel.getHeaderState()
Inherited From:
Returns:

颜色值

Type
color

getCursor() → {String}

获取鼠标样式(CSS 格式)

Inherited From:
Returns:

鼠标样式

Type
String

getDisabledBackground() → {String}

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

Inherited From:
Returns:

遮罩背景

Type
String

getDOMProperties() → {Object}

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

Inherited From:
Returns:

DOM 属性映射表

Type
Object

getErrorMessage() → {String}

获取错误信息

Inherited From:
Returns:

错误信息

Type
String

getExpandIcon() → {Object}

获取正常状态下展开图标，可以是颜色或者图片等

Inherited From:
See:
Returns:

展开图标

Type
Object

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

获取正常状态下展开图标的 Drawable 对象

Inherited From:
Returns:

展开图标

Type
ht.ui.drawable.Drawable

getFooterBackground() → {Object}

获取底栏背景，可以是颜色或者图片等

See:
Returns:

背景

Type
Object

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

获取底栏背景的 Drawable 对象

Returns:

背景

Type
ht.ui.drawable.Drawable

getFooterHeight() → {Number}

获取底栏高度

Returns:

高度值

Type
Number

getFooterPaddingLeft() → {String}

获取底栏左侧内边距

Returns:

底栏左侧内边距

Type
String

getFooterPaddingRight() → {String}

获取底栏右侧内边距

Returns:

底栏右侧内边距

Type
String

getHeaderBackground() → {Object}

获取正常状态下标题栏背景，可以是颜色或者图片等

Inherited From:
See:
Returns:

标题栏背景

Type
Object

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

获取正常状态下标题栏背景的 Drawable 对象

Inherited From:
Returns:

标题栏背景

Type
ht.ui.drawable.Drawable

getHeaderHeight() → {Number}

获取标题栏高度

Inherited From:
Returns:

标题栏高度

Type
Number

getHeaderPaddingLeft() → {Number}

获取标题栏左侧内边距

Inherited From:
Returns:

左侧内边距

Type
Number

getHeaderPaddingRight() → {Number}

获取标题栏右侧内边距

Inherited From:
Returns:

右侧内边距

Type
Number

getHeaderState() → {String}

获取标题栏状态

Inherited From:
Returns:

标题栏状态，值可能为：'normal'|'hover'|'active'

Type
String

getHeight() → {Number}

获取组件的高度

Inherited From:
Returns:

组件高度

Type
Number

getHoverCloseIcon() → {Object}

获取 Hover 状态下关闭图标，可以是颜色或者图片等

See:
Returns:

关闭图标

Type
Object

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

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

Returns:

关闭图标

Type
ht.ui.drawable.Drawable

getHoverCollapseIcon() → {Object}

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

Inherited From:
See:
Returns:

合并图标

Type
Object

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

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

Inherited From:
Returns:

合并图标

Type
ht.ui.drawable.Drawable

getHoverExpandIcon() → {Object}

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

Inherited From:
See:
Returns:

展开图标

Type
Object

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

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

Inherited From:
Returns:

展开图标

Type
ht.ui.drawable.Drawable

getHoverHeaderBackground() → {Object}

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

Inherited From:
See:
Returns:

标题栏背景

Type
Object

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

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

Inherited From:
Returns:

标题栏背景

Type
ht.ui.drawable.Drawable

getHoverMaximizeIcon() → {Object}

获取 Hover 状态下最大化图标，可以是颜色或者图片等

See:
Returns:

最大化图标

Type
Object

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

获取 Hover 状态下最大化图标的 Drawable 对象

Returns:

最大化图标

Type
ht.ui.drawable.Drawable

getHoverRestoreIcon() → {Object}

获取 Hover 状态下恢复图标，可以是颜色或者图片等

See:
Returns:

恢复图标

Type
Object

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

获取 Hover 状态下恢复图标的 Drawable 对象

Returns:

恢复图标

Type
ht.ui.drawable.Drawable

getHoverTitleColor() → {color}

获取 Hover 状态下标题文本颜色

Inherited From:
Returns:

颜色值

Type
color

getIcon() → {Object}

获取标题栏图标，可以是颜色或者图片等

Inherited From:
See:
Returns:

图标

Type
Object

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

获取标题栏图标的 Drawable 对象

Inherited From:
Returns:

图标

Type
ht.ui.drawable.Drawable

getIconHeight() → {Number}

获取标题栏图标高度

Inherited From:
Returns:

图标高度

Type
Number

getIconTitleGap() → {Number}

获取标题栏图文字和图标之间的距离

Inherited From:
Returns:

间距值

Type
Number

getIconWidth() → {Number}

获取标题栏图标宽度

Inherited From:
Returns:

图标宽度

Type
Number

getId() → {Object}

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

Inherited From:
Returns:

唯一标识

Type
Object

getInteractorClasses() → {Array}

获取交互器类名数组

Inherited From:
Returns:

交互器类名数组

Type
Array

getLayoutParams(key) → {Object}

获取布局参数

Parameters:
Name Type Argument Description
key String <optional>

布局参数中的 key
Inherited From:
Returns:

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

Type
Object

getMargin() → {Number|Array}

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

Inherited From:
Returns:

外边距

Type
Number | Array

getMarginBottom() → {Number}

获取组件底部外边距高度

Inherited From:
Returns:

底部外边距高度

Type
Number

getMarginRight() → {Number}

获取组件右侧外边距宽度

Inherited From:
Returns:

右侧外边距宽度

Type
Number

getMarginTop() → {Number}

获取组件顶部外边距高度

Inherited From:
Returns:

顶部外边距高度

Type
Number

getMarignLeft() → {Number}

获取组件左侧外边距宽度

Inherited From:
Returns:

左侧外边距宽度

Type
Number

getMaskBackground() → {String}

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

Returns:

遮罩背景

Type
String

getMatchedStyles() → {Object}

获取组件匹配到的样式

Inherited From:
Returns:
Type
Object

getMaximizeIcon() → {Object}

获取正常状态下最大化图标，可以是颜色或者图片等

See:
Returns:

最大化图标

Type
Object

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

获取正常状态下最大化图标的 Drawable 对象

Returns:

最大化图标

Type
ht.ui.drawable.Drawable

getMaximizeToolIndex() → {Number}

获取最大化按钮在工具按钮组中的显示顺序

Returns:

显示顺序

Type
Number

getMaxSize() → {Object}

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

Inherited From:
Returns:

maxSize

Type
Object

getMaxSizeProperties() → {Object}

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

Inherited From:
Returns:

maxSize 属性映射表

Type
Object

getMinSize() → {Object}

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

Inherited From:
Returns:

minSize

Type
Object

getMinSizeProperties() → {Object}

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

Inherited From:
Returns:

minSize 属性映射表

Type
Object

getPadding() → {Number|Array}

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

Inherited From:
Returns:

内边距

Type
Number | Array

getPaddingBottom() → {Number}

获取组件底部内边距高度

Inherited From:
Returns:

底部内边距高度

Type
Number

getPaddingLeft() → {Number}

获取组件左侧内边距宽度

Inherited From:
Returns:

左侧内边距宽度

Type
Number

getPaddingRight() → {Number}

获取组件右侧内边距宽度

Inherited From:
Returns:

右侧内边距宽度

Type
Number

getPaddingTop() → {Number}

获取组件顶部内边距高度

Inherited From:
Returns:

顶部内边距高度

Type
Number

getParent() → {ht.ui.ViewGroup}

获取父容器

Inherited From:
Returns:

父容器

Type
ht.ui.ViewGroup

getPopover() → {ht.ui.Popover}

获取弹框组件

Inherited From:
Returns:

弹框组件

Type
ht.ui.Popover

getPopoverPlacements() → {Array}

获取弹框组件的弹出位置

Inherited From:
Returns:

弹出位置

Type
Array

getPopoverTrigger() → {String}

获取弹框触发器

Inherited From:
Returns:

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

Type
String

getPreferredSize() → {Object}

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

Inherited From:
Returns:

preferredSize

Type
Object

getPreferredSizeProperties() → {Object}

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

Inherited From:
Returns:

preferredSize 属性映射表

Type
Object

getPropertyValue(name) → {Object}

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

  • 先取 _padding 私有变量
  • 如果为 undefind，再去取样式表中取值
  • 如果为 undefied，再取 __padding 私有变量
Parameters:
Name Type Description
name String

属性名
Inherited From:
Returns:

属性值

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

getResizeBorderColor() → {color}

获取 resize 时提示边框颜色

Returns:

颜色值

Type
color

getResizeDivAt(e) → {String}

获取事件对象下的 resize 区域

Parameters:
Name Type Description
e Event

事件对象
Returns:

resize 区域名称，值可能为：'east'|'west'|'south'|'southwest'|'southeast'

Type
String

getRestoreIcon() → {Object}

获取正常状态下恢复图标，可以是颜色或者图片等

See:
Returns:

恢复图标

Type
Object

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

获取正常状态下恢复图标的 Drawable 对象

Returns:

恢复图标

Type
ht.ui.drawable.Drawable

getRootCanvas() → {HTMLCanvasElement}

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

Inherited From:
Returns:

Canvas DOM 对象

Type
HTMLCanvasElement

getRootContext(dom) → {CanvasRenderingContext2D}

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

Parameters:
Name Type Argument Description
dom HTMLElement <optional>

指定目标 DOM，通常是个 canvas 类型的 DOM 对象
Inherited From:
Returns:

画笔对象

Type
CanvasRenderingContext2D

getScrollBarActiveSize() → {Number}

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

Inherited From:
Returns:

滚动条感应区域的大小

Type
Number

getScrollBarColor() → {color}

获取滚动条颜色

Inherited From:
Returns:

颜色值

Type
color

getScrollBarMinLength() → {Number}

获取滚动条最小长度

Inherited From:
Returns:

滚动条最小长度

Type
Number

getScrollBarMode() → {String}

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

Inherited From:
Returns:

滚动条模式

Type
String

getScrollBarSize() → {Number}

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

Inherited From:
Returns:

滚动条大小

Type
Number

getScrollBarTimeout() → {Number}

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

Inherited From:
Returns:

滚动条显示时间

Type
Number

getScrollRect() → {Object}

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

Inherited From:
Returns:

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

Type
Object

getStyle() → {String}

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

Inherited From:
Returns:

样式名

Type
String

getStyleProperties() → {Object}

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

Inherited From:
Returns:

样式属性映射表

Type
Object

getStyleValue(property) → {Object}

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

Parameters:
Name Type Description
property String

属性名
Inherited From:
Returns:

样式值

Type
Object

getTitle() → {String}

获取标题文本

Inherited From:
Returns:

标题文本

Type
String

getTitleColor() → {color}

获取正常状态下标题文本颜色

Inherited From:
Returns:

颜色值

Type
color

getTitleFont() → {String}

获取标题文本字体

Inherited From:
Returns:

标题文本字体

Type
String

getToolAt(event) → {Object}

获取事件对象下的工具按钮

Parameters:
Name Type Description
event Event

事件对象
Inherited From:
Returns:

工具按钮配置 json

Type
Object

getToolGap() → {Number}

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

Inherited From:
Returns:

间距值

Type
Number

getToolHeight() → {Number}

获取标题栏工具按钮高度

Inherited From:
Returns:

高度值

Type
Number

getToolIndex(tool) → {Number}

获取工具按钮的顺序

Parameters:
Name Type Description
tool Object

工具按钮配置 json
Inherited From:
Returns:

显示顺序

Type
Number

getTools() → {Array}

获取标题栏的工具按钮

Inherited From:
Returns:

工具按钮数组，格式为：[{icon: 'icon', onClick: function(e) {} }, {icon: 'icon1', onClick: function(e) {} }]

Type
Array

getToolsPosition() → {String}

获取标题栏工具按钮的位置

Inherited From:
Returns:

工具按钮位置，值为 left|right

Type
String

getToolTip() → {String}

获取工具提示文本内容

Inherited From:
Returns:

工具提示文本内容

Type
String

getToolWidth() → {Number}

获取标题栏工具按钮宽度

Inherited From:
Returns:

宽度值

Type
Number

getTranslateX() → {Number}

获取水平滚动值

Inherited From:
Returns:

水平滚动值

Type
Number

getTranslateY() → {Number}

获取垂直滚动值

Inherited From:
Returns:

垂直滚动值

Type
Number

getView() → {HTMLElement}

获取组件最根层的 div

Inherited From:
Returns:

组件 div

Type
HTMLElement

getViewPoint(event) → {Object}

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

Parameters:
Name Type Description
event Event

交互事件对象(如鼠标事件对象)
Inherited From:
Returns:

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

Type
Object

getViewRect() → {Object}

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

Inherited From:
Returns:

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

Type
Object

getVisibleChildren() → {ht.List}

获取可见的子组件列表

Inherited From:
Returns:

可见的子组件列表

Type
ht.List

getWidth() → {Number}

获取组件的宽度

Inherited From:
Returns:

组件宽度

Type
Number

getX() → {Number}

获取组件的 x 坐标

Inherited From:
Returns:

x 坐标

Type
Number

getY() → {Number}

获取组件的 y 坐标

Inherited From:
Returns:

y 坐标

Type
Number

getZIndex() → {Number}

获取组件的堆叠顺序

Inherited From:
Returns:

堆叠顺序

Type
Number

getZoom() → {Number}

获取缩放值

Inherited From:
Returns:

缩放值

Type
Number

getZoomAnchor() → {Array}

获取缩放锚点

Inherited From:
Returns:

锚点数组

Type
Array

hasContentCanvas() → {Boolean}

判断组件是否有私有 canvas

Inherited From:
Returns:

组件是否有私有 canvas

Type
Boolean

hasFocus() → {Boolean}

判断焦点是否在组件上

Inherited From:
Returns:

焦点是否在组件上

Type
Boolean

headerHitTest(event) → {Boolean}

判断是否点击中标题栏

Parameters:
Name Type Description
event Event

事件对象
Inherited From:
Returns:

是否点击中分隔条

Type
Boolean

hide()

隐藏对话框

hidePopover()

隐藏弹框组件

Inherited From:

initView(canvas)

初始化组件的 DOM 结构

Parameters:
Name Type Argument Description
canvas Boolean <optional>

是否创建一个私有的 canvas 用来绘制私有内容，一般情况下在默认的 canvas 中绘制就可以，不需要此参数
Inherited From:

invalidate(forceLayoutChildren)

使组件无效化

Parameters:
Name Type Argument Description
forceLayoutChildren Boolean <optional>

是否强制刷新子组件(即使子组件没有无效标记)
Inherited From:
See:

invalidateDOM()

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

Inherited From:

isAutoResize() → {Boolean}

判断对话框是否会自动按照首选大小调整自身尺寸

Returns:
Type
Boolean

isClosable() → {Boolean}

判断面板是否可关闭；如果为 true，在工具按钮中显示关闭按钮

Returns:

是否可关闭

Type
Boolean

isCloseToHScrollBar(e)

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

Parameters:
Name Type Description
e Event

鼠标或 Touch 事件对象
Inherited From:

isCloseToVScrollBar(e)

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

Parameters:
Name Type Description
e Event

鼠标或 Touch 事件对象
Inherited From:

isCollapsable() → {Boolean}

判断面板是否可合并；如果为 true，在工具按钮中显示展开合并按钮

Inherited From:
Returns:

是否可展开合并

Type
Boolean

isDescendantOf(viewGroup) → {Boolean}

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

Parameters:
Name Type Description
viewGroup ht.ui.ViewGroup

容器
Inherited From:
Returns:
Type
Boolean

isDisabled() → {Boolean}

组件是否被禁用

Inherited From:
Returns:

是否被禁用

Type
Boolean

isExpanded() → {Boolean}

判断面板是否处于展开状态

Inherited From:
Returns:

面板是否展开

Type
Boolean

isFixToCenter() → {Boolean}

获取对话框是否固定在页面中心

Returns:
Type
Boolean

isFocusable() → {Boolean}

组件是否可以获取焦点

Inherited From:
Returns:

是否可获取焦点

Type
Boolean

isHeaderVisible() → {Boolean}

判断标题栏是否可见

Inherited From:
Returns:

是否可见

Type
Boolean

isHScrollable() → {Boolean}

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

Inherited From:
Returns:

是否可以水平滚动

Type
Boolean

isInDOM() → {Boolean}

判断组件是否在 DOM 树中

Inherited From:
Returns:

组件是否在 DOM 树中

Type
Boolean

isMaximizable() → {Boolean}

判断面板是否可最大化；如果为 true，在工具按钮中显示最大化按钮

Returns:

是否可最大化

Type
Boolean

isMaximized() → {Boolean}

判断面板是否处于最大化状态

Returns:

面板是否最大化

Type
Boolean

isMaxSizeSet() → {Boolean}

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

Inherited From:
Returns:

maxSize 是否被设置

Type
Boolean

isMinSizeSet() → {Boolean}

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

Inherited From:
Returns:

minSize 是否被设置

Type
Boolean

isModal() → {Boolean}

判断是否是模态对话框

Returns:

是否为模态对话框

Type
Boolean

isPreferredSizeSet() → {Boolean}

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

Inherited From:
Returns:

preferredSize 是否被设置

Type
Boolean

isRedrawOnFocus() → {Boolean}

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

Inherited From:
Returns:

是否重绘自身

Type
Boolean

isResizable() → {Boolean}

判断是否可拖拽边缘调整对话框尺寸

Returns:

是否为模态对话框

Type
Boolean

isSelfViewEvent(event) → {Boolean}

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

Parameters:
Name Type Description
event Event

事件对象
Inherited From:
Returns:

事件是否发生在自身 DOM 上

Type
Boolean

isStyleProperty(property) → {Boolean}

判断属性是否是样式属性

Parameters:
Name Type Description
property String

属性名
Inherited From:
Returns:

是否是样式属性

Type
Boolean

isToolTipEnabled() → {Boolean}

是否启用工具提示

Inherited From:
Returns:

是否启用工具提示

Type
Boolean

isVisible() → {Boolean}

判断对话框是否可见

Returns:

是否可见

Type
Boolean

isVScrollable() → {Boolean}

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

Inherited From:
Returns:

是否可以垂直滚动

Type
Boolean

iv(forceLayoutChildren)

使组件无效化

Parameters:
Name Type Argument Description
forceLayoutChildren Boolean <optional>

是否强制刷新子组件(即使子组件没有无效标记)
Inherited From:
See:

layoutChild(child, x, y, width, height)

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

Parameters:
Name Type Description
child ht.ui.View

要布局的子组件
x Number

组件的 x 坐标
y Number

组件的 y 坐标
width Number

组件的宽度
height Number

组件的高度
Inherited From:

layoutDOM(x, y, width, height)

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

Parameters:
Name Type Description
x Number

组件的 x 坐标
y Number

组件的 y 坐标
width Number

组件宽度
height Number

组件高度
Inherited From:

makeDisabled(disabled, disabledDiv)

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

Parameters:
Name Type Description
disabled disabled

是否禁用
disabledDiv HTMLElement

遮罩 div
Inherited From:

mp(listener, scope, ahead)

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

Parameters:
Name Type Argument Description
listener function

监听器函数
scope Object <optional>

函数域
ahead Boolean <optional>

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

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:

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:

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:

processValidate()

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

Inherited From:

redraw(forceLayoutChildren)

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

Parameters:
Name Type Argument Description
forceLayoutChildren Boolean <optional>

是否强制刷新子组件(即使子组件没有无效标记)
Inherited From:

removeButtonAt(index)

删除指定下标的底栏按钮

Parameters:
Name Type Description
index Number

底栏按钮的下标

removeFromDOM()

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

Inherited From:

removePropertyChangeListener(listener, scope)

删除属性事件变化监听器

Parameters:
Name Type Argument Description
listener function

监听器函数
scope Object <optional>

函数域
Inherited From:

removeStyleProperty(property)

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

Parameters:
Name Type Description
property String

属性名
Inherited From:

removeToolAt(index)

删除指定下标的工具按钮

Parameters:
Name Type Description
index Number

工具按钮的下标
Inherited From:

removeView(view)

将子组件从容器中删除

Parameters:
Name Type Description
view ht.ui.View

要删除的子组件
Inherited From:

removeViewAt(index)

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

Parameters:
Name Type Description
index Number

子组件下标
Inherited From:

removeViewListener(listener, scope)

删除 View 事件监听器

Parameters:
Name Type Argument Description
listener function

监听器函数
scope Object <optional>

监听器函数域
Inherited From:

requestFocus()

请求获取焦点

Inherited From:

set(properties)

批量设置组件属性

Parameters:
Name Type Description
properties Object

格式示范：{ background: 'red', border: new ht.ui.border.LineBorder(1, 'red'), padding: 20 }
Inherited From:

setActiveCloseIcon(icon)

设置 Active 状态下关闭图标

Parameters:
Name Type Description
icon Object

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

setActiveCloseIconDrawable(drawable)

设置 Active 状态下关闭图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

关闭图标

setActiveCollapseIcon(icon)

设置 Active 状态下合并图标

Parameters:
Name Type Description
icon Object

合并图标，可以是颜色或者图片等
Inherited From:
See:

setActiveCollapseIconDrawable(drawable)

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

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

合并图标
Inherited From:

setActiveExpandIcon(icon)

设置 Active 状态下展开图标

Parameters:
Name Type Description
icon Object

展开图标，可以是颜色或者图片等
Inherited From:
See:

setActiveExpandIconDrawable(drawable)

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

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

展开图标
Inherited From:

setActiveHeaderBackground(background)

设置 Active 状态下标题栏背景

Parameters:
Name Type Description
background Object

标题栏背景，可以是颜色或者图片等
Inherited From:
See:

setActiveHeaderBackgroundDrawable(drawable)

设置 Active 状态下标题栏背景的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

标题栏背景
Inherited From:

setActiveMaximizeIcon(icon)

设置 Active 状态下最大化图标

Parameters:
Name Type Description
icon Object

最大化图标，可以是颜色或者图片等
See:

setActiveMaximizeIconDrawable(drawable)

设置 Active 状态下最大化图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

最大化图标

setActiveRestoreIcon(icon)

设置 Active 状态下恢复图标，可以是颜色或者图片等

Parameters:
Name Type Description
icon Object

恢复图标
See:

setActiveRestoreIconDrawable(drawable)

设置 Active 状态下恢复图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

恢复图标

setActiveTitleColor(color)

设置 Active 状态下标题文本颜色

Parameters:
Name Type Description
color color

颜色值
Inherited From:

setAutoResize(autoResize)

设置对话框是否自动按照首选大小调整自身尺寸

Parameters:
Name Type Description
autoResize Boolean

setBackground(background)

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

Parameters:
Name Type Description
background Object

颜色值、图片名、图片路径、矢量对象等
Inherited From:
See:

setBackgroundDrawable(drawable)

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

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

Drawable 对象
Inherited From:

setBorder(border)

设置组件的边框

Parameters:
Name Type Description
border ht.border.Border

组件边框
Inherited From:

setBorderRadius(radius)

设置 CSS 边框圆角

Parameters:
Name Type Description
radius Number | Array

边框圆角；如果是数组，则表示[左上角圆角、右上角圆角、右下角圆角、左下角圆角]
Inherited From:

setBoxShadow(boxShadow)

设置 CSS 阴影值

Parameters:
Name Type Description
boxShadow String

阴影值
Inherited From:

setButtonAlign(align)

设置底栏按钮的水平对齐方式

Parameters:
Name Type Description
align String

对齐方式，可选值为：'left'|'center'|'right'

setButtonGap(gap)

设置底栏按钮之间的距离

Parameters:
Name Type Description
gap Number

间距值

setButtonPrefHeight(height)

设置对话框底部按钮的首选高度

Parameters:
Name Type Description
height Number

setButtonPrefWidth(width)

设置对话框底部按钮的首选宽度

Parameters:
Name Type Description
width Number

setButtons(buttons)

设置底栏中的按钮数组

Parameters:
Name Type Description
buttons Array

按钮数组
Example
dialog.setButtons([{
      // 这里可配置所有按钮属性，如 text、textColor 等
      icon: 'roundNormal',
      hoverIcon: 'roundHover',
      activeIcon: 'roundActive',
      onClick: function(event) {
          console.log('click tool', event);
      }
  }]);

setButtonVAlign(vAlign)

设置底栏按钮的垂直对齐方式

Parameters:
Name Type Description
vAlign String

对齐方式，可选值为：'top'|'middle'|'bottom'

setClosable(closable)

设置面板是否可关闭

Parameters:
Name Type Description
closable Boolean

是否可关闭；如果为 true，在工具按钮中显示关闭按钮

setCloseIcon(icon)

设置正常状态下关闭图标

Parameters:
Name Type Description
icon Object

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

setCloseIconDrawable(drawable)

设置正常状态下关闭图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

关闭图标

setCloseToolIndex(index)

设置关闭按钮在工具按钮组中的显示顺序

Parameters:
Name Type Description
index Number

显示顺序

setCollapsable(collapsable)

设置面板是否可合并

Parameters:
Name Type Description
collapsable Boolean

是否可展开合并；如果为 true，在工具按钮组中显示展开合并按钮
Inherited From:

setCollapseIcon(icon)

设置正常状态下合并图标

Parameters:
Name Type Description
icon Object

合并图标，可以是颜色或者图片等
Inherited From:
See:

setCollapseIconDrawable(drawable)

设置正常状态下合并图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

合并图标
Inherited From:

setCollapseToolIndex(index)

设置展开合并按钮在工具按钮组中的显示顺序

Parameters:
Name Type Description
index Number

显示顺序
Inherited From:

setContentPadding(contentPadding)

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

Parameters:
Name Type Description
contentPadding Number | Array
Inherited From:

setContentView(view, layoutParams)

设置面板中的子组件

Parameters:
Name Type Argument Description
view ht.ui.View

子组件
layoutParams Object <optional>

布局参数；可通过 childView.setLayoutPrams({...}) 提前设置并省略此参数
Inherited From:

setContextMenu(contextMenu)

设置绑定的右键菜单

Parameters:
Name Type Description
contextMenu ht.ui.ContextMenu

右键菜单
Inherited From:

setCursor(cursor)

设置鼠标样式(CSS 格式)

Parameters:
Name Type Description
cursor String

鼠标样式
Inherited From:

setDisabled(disabled)

设置组件是否被禁用

Parameters:
Name Type Description
disabled Boolean | String

是否被禁用；如果为字符串，组件除了被禁用，disabledDiv 还会被设置相应的 CSS 样式名
Inherited From:

setDisabledBackground(background)

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

Parameters:
Name Type Description
background String

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

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

设置错误信息

Parameters:
Name Type Description
message String

错误信息
params Object

ErrorMessagePopover 组件的属性配置，如 { placements: ['top'] } 将错误提示显示在上方
Inherited From:
Returns:

错误提示组件

Type
ht.ui.ErrorMessagePopover

setExpanded(expanded)

设置面板展开合并状态

Parameters:
Name Type Description
expanded Boolean

面板是否展开
Inherited From:

setExpandIcon(icon)

设置正常状态下展开图标

Parameters:
Name Type Description
icon Object

展开图标，可以是颜色或者图片等
Inherited From:
See:

setExpandIconDrawable(drawable)

设置正常状态下展开图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

展开图标
Inherited From:

setFixToCenter(fixToCenter)

设置对话框是否固定在页面中心

Parameters:
Name Type Description
fixToCenter Boolean

setFocusable(focusable)

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

Parameters:
Name Type Description
focusable Boolean

是否可获取焦点
Inherited From:

setFooterBackground(底栏背景，可以是颜色或者图片等)

设置底栏背景

Parameters:
Name Type Description
底栏背景，可以是颜色或者图片等 Object
See:

setFooterBackgroundDrawable(drawable)

设置底栏背景的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

底栏背景

setFooterHeight(height)

设置底栏高度

Parameters:
Name Type Description
height Number

高度值

setFooterPaddingLeft(paddingLeft)

设置底栏左侧内边距

Parameters:
Name Type Description
paddingLeft Number

底栏左侧内边距

setFooterPaddingRight(paddingRight)

设置底栏右侧内边距

Parameters:
Name Type Description
paddingRight Number

底栏右侧内边距

setHeaderBackground(background)

设置正常状态下标题栏背景

Parameters:
Name Type Description
background Object

标题栏背景，可以是颜色或者图片等
Inherited From:
See:

setHeaderBackgroundDrawable(drawable)

设置正常状态下标题栏背景的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

标题栏背景
Inherited From:

setHeaderHeight(height)

设置标题栏高度

Parameters:
Name Type Description
height Number

标题栏高度
Inherited From:

setHeaderPaddingLeft(paddingLeft)

设置标题栏左侧内边距

Parameters:
Name Type Description
paddingLeft Number

左侧内边距
Inherited From:

setHeaderPaddingRight(paddingRight)

设置标题栏右侧内边距

Parameters:
Name Type Description
paddingRight Number

右侧内边距
Inherited From:

setHeaderState(state)

设置标题栏状态

Parameters:
Name Type Description
state String

标题栏状态，可选值为：'normal'|'hover'|'active'
Inherited From:

setHeaderVisible(visible)

设置标题栏是否可见

Parameters:
Name Type Description
visible Boolean

是否可见
Inherited From:

setHeight(height)

设置组件的高度

Parameters:
Name Type Description
height Number

组件高度
Inherited From:

setHoverCloseIcon(icon)

设置 Hover 状态下关闭图标

Parameters:
Name Type Description
icon Object

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

setHoverCloseIconDrawable(drawable)

设置 Hover 状态下关闭图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

关闭图标

setHoverCollapseIcon(icon)

设置 Hover 状态下合并图标

Parameters:
Name Type Description
icon Object

合并图标，可以是颜色或者图片等
Inherited From:
See:

setHoverCollapseIconDrawable(drawable)

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

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

合并图标
Inherited From:

setHoverExpandIcon(icon)

设置 Hover 状态下展开图标

Parameters:
Name Type Description
icon Object

展开图标，可以是颜色或者图片等
Inherited From:
See:

setHoverExpandIconDrawable(drawable)

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

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

展开图标
Inherited From:

setHoverHeaderBackground(background)

设置 Hover 状态下标题栏背景

Parameters:
Name Type Description
background Object

标题栏背景，可以是颜色或者图片等
Inherited From:
See:

setHoverHeaderBackgroundDrawable(drawable)

设置 Hover 状态下标题栏背景的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

标题栏背景
Inherited From:

setHoverMaximizeIcon(icon)

设置 Hover 状态下最大化图标

Parameters:
Name Type Description
icon Object

最大化图标，可以是颜色或者图片等
See:

setHoverMaximizeIconDrawable(drawable)

设置 Hover 状态下最大化图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

最大化图标

setHoverRestoreIcon(icon)

设置 Hover 状态下恢复图标

Parameters:
Name Type Description
icon Object

恢复图标，可以是颜色或者图片等
See:

setHoverRestoreIconDrawable(drawable)

设置 Hover 状态下恢复图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

恢复图标

setHoverTitleColor(color)

设置 Hover 状态下标题文本颜色

Parameters:
Name Type Description
color color

颜色值
Inherited From:

setIcon(icon)

设置标题栏图标

Parameters:
Name Type Description
icon Object

图标，可以是颜色或者图片等
Inherited From:
See:

setIconDrawable(drawable)

设置标题栏图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

图标
Inherited From:

setIconHeight(height)

设置标题栏图标高度

Parameters:
Name Type Description
height Number

图标高度
Inherited From:

setIconTitleGap(gap)

设置标题栏图文字和图标之间的距离

Parameters:
Name Type Description
gap Number

间距值
Inherited From:

setIconWidth(width)

设置标题栏图标宽度

Parameters:
Name Type Description
width Number

图标宽度
Inherited From:

setId(id)

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

Parameters:
Name Type Description
id Object

唯一标识
Inherited From:

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:

setMargin(margin)

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

Parameters:
Name Type Description
margin Number | Array

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

setMaskBackground(background)

设置遮罩背景

Parameters:
Name Type Description
background String

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

setMaximizable(maximizable)

设置面板是否可最大化

Parameters:
Name Type Description
maximizable Boolean

是否可最大化；如果为 true，在工具按钮中显示最大化按钮

setMaximized(maximized)

设置面板是否处于最大化状态

Parameters:
Name Type Description
maximized Boolean

面板是否最大化

setMaximizeIcon(icon)

设置正常状态下最大化图标

Parameters:
Name Type Description
icon Object

最大化图标，可以是颜色或者图片等
See:

setMaximizeIconDrawable(drawable)

设置正常状态下最大化图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

最大化图标

setMaximizeToolIndex(index)

设置最大化按钮在工具按钮组中的显示顺序

Parameters:
Name Type Description
index Number

显示顺序

setMaxSize(width, height)

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

Parameters:
Name Type Description
width Number

最大宽度
height Number

最大高度
Inherited From:

setMinSize(width, height)

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

Parameters:
Name Type Description
width Number

最小宽度
height Number

最小高度
Inherited From:

setModal(modal)

设置是否是模态对话框

Parameters:
Name Type Description
modal Boolean

是否为模态对话框

setPadding(padding)

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

Parameters:
Name Type Description
padding Number | Array

内边距
Inherited From:

setPopover(popover, trigger)

设置弹框组件

Parameters:
Name Type Argument Description
popover ht.ui.Popover | String

弹框组件，如果参数是字符串，则用这段文本作为弹框内容(内部自动创建 Popover 和 HtmlView 组件)
trigger String <optional>

触发器，值为：click|hover
Inherited From:

setPopoverPlacements(placements)

设置弹框组件的弹出位置

Parameters:
Name Type Description
placements Array

位置数组
Inherited From:

setPopoverTrigger(trigger)

设置弹框触发器

Parameters:
Name Type Description
trigger String

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

setPreferredSize(width, height)

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

Parameters:
Name Type Description
width Number

首选宽度
height Number

首选高度
Inherited From:

setPropertyValue(name, value)

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

Parameters:
Name Type Description
name String

属性名
value Object

属性值
Inherited From:

setRedrawOnFocus(redrawOnFocus)

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

Parameters:
Name Type Description
redrawOnFocus Boolean

是否重绘自身
Inherited From:

setResizable(resizable)

设置是否可拖拽边缘调整对话框尺寸

Parameters:
Name Type Description
resizable Boolean

是否为模态对话框

setResizeBorderColor(color)

设置 resize 时提示边框颜色

Parameters:
Name Type Description
color color

颜色值

setRestoreIcon(icon)

设置正常状态下恢复图标

Parameters:
Name Type Description
icon Object

恢复图标，可以是颜色或者图片等
See:

setRestoreIconDrawable(drawable)

设置正常状态下恢复图标的 Drawable 对象

Parameters:
Name Type Description
drawable ht.ui.drawable.Drawable

恢复图标

setScrollBarActiveSize(activeSize)

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

Parameters:
Name Type Description
activeSize Number

滚动条感应区域的大小
Inherited From:

setScrollBarColor(color)

设置滚动条颜色

Parameters:
Name Type Description
color color

颜色值
Inherited From:

setScrollBarMinLength(length)

设置滚动条最小长度

Parameters:
Name Type Description
length Number

滚动条最小长度
Inherited From:

setScrollBarMode(mode)

设置滚动条模式

Parameters:
Name Type Description
mode String

滚动条模式，可选值为：'on'|'off'|'auto'|'hidden'
Inherited From:

setScrollBarSize(size)

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

Parameters:
Name Type Description
size Number

滚动条大小
Inherited From:

setScrollBarTimeout(timeout)

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

Parameters:
Name Type Description
timeout Number

滚动条显示时间
Inherited From:

setStyle(styleName)

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

Parameters:
Name Type Description
styleName String

样式名
Inherited From:

setTitle(title)

设置标题文本

Parameters:
Name Type Description
title String

标题文本
Inherited From:

setTitleColor(color)

设置正常状态下标题文本颜色

Parameters:
Name Type Description
color color

颜色值
Inherited From:

setTitleFont(font)

设置标题文本字体

Parameters:
Name Type Description
font String

标题文本字体，如 '12px Arial'
Inherited From:

setToolGap(gap)

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

Parameters:
Name Type Description
gap Number

间距值
Inherited From:

setToolHeight(height)

设置标题栏工具按钮高度

Parameters:
Name Type Description
height Number

高度值
Inherited From:

setTools(工具按钮数组)

设置标题栏的工具按钮

Parameters:
Name Type Description
工具按钮数组 Array
Inherited From:
Example
 panel.setTools([{
      icon: 'roundNormal',
      hoverIcon: 'roundHover',
      activeIcon: 'roundActive',
      onClick: function(event) {
          console.log('click tool', event);
      }
  }]);

setToolsPosition(position)

设置标题栏工具按钮的位置

Parameters:
Name Type Description
position String

工具按钮位置，值为：left|right
Inherited From:

setToolTipEnabled(enabled)

设置是否启用工具提示

Parameters:
Name Type Description
enabled Boolean

是否启用工具提示
Inherited From:

setToolWidth(width)

设置标题栏工具按钮宽度

Parameters:
Name Type Description
width Number

宽度值
Inherited From:

setTranslate(translateX, translateY, anim)

设置水平和垂直滚动值

Parameters:
Name Type Argument Description
translateX Number

水平滚动值
translateY Number

垂直滚动值
anim Boolean <optional>

是否使用动画
Inherited From:

setTranslateX(translateX)

设置水平滚动值

Parameters:
Name Type Description
translateX Number

水平滚动值
Inherited From:

setTranslateY(translateY)

设置垂直滚动值

Parameters:
Name Type Description
translateY Number

垂直滚动值
Inherited From:

setVisible(visible)

设置对话框是否可见；不要调用此函数，如果要显示对话框用 show 函数(但是可以通过监听 visible 属性变化来处理对话框显示和隐藏事件)

Parameters:
Name Type Description
visible Boolean

setWidth(width)

设置组件的宽度

Parameters:
Name Type Description
width Number

组件宽度
Inherited From:

setX(x)

设置组件的 x 坐标

Parameters:
Name Type Description
x Number

x 坐标
Inherited From:

setY(y)

设置组件的 y 坐标

Parameters:
Name Type Description
y Number

y 坐标
Inherited From:

setZIndex(zIndex)

设置组件的堆叠顺序

Parameters:
Name Type Description
zIndex Number

堆叠顺序
Inherited From:

setZoom(zoom)

设置缩放

Parameters:
Name Type Description
zoom Number

缩放值
Inherited From:

setZoomAnchor(anchor)

设置缩放锚点

Parameters:
Name Type Description
anchor Array

横向和纵向锚点数组，如右上角为：[1, 0]
Inherited From:

show(x, y)

显示对话框

Parameters:
Name Type Argument Description
x Number <optional>

x 坐标
y Number <optional>

y 坐标
Example
// 对话框显示在屏幕中心
dialog.setWidth(600);
dialog.setHeight(300);
var center = dialog.getCenterPosition();
dialog.show(center.x, center.y);

showHScrollBar()

显示水平滚动条

Inherited From:

showPopover()

显示弹框组件

Inherited From:

showScrollBar()

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

Inherited From:

showVScrollBar()

显示垂直滚动条

Inherited From:

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:

translate(x, y, anim)

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

Parameters:
Name Type Argument Description
x Number

水平滚动值增量
y Number

垂直滚动值增量
anim Boolean <optional>

是否使用动画
Inherited From:

tx(value)

获取或设置水平滚动值

Parameters:
Name Type Argument Description
value Number <optional>

如果为空，相当于 getTranslateX()；如果不为空，相当于 setTranslateX(value)
Inherited From:

ty(value)

获取或设置垂直滚动值

Parameters:
Name Type Argument Description
value Number <optional>

如果为空，相当于 getTranslateY()；如果不为空，相当于 setTranslateY(value)
Inherited From:

ump(listener, scope)

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

Parameters:
Name Type Argument Description
listener function

监听器函数
scope Object <optional>

函数域
Inherited From:

updateScrollBar(width, height, scrollWidth, scrollHeight)

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

Parameters:
Name Type Description
width Number

组件布局宽度
height Number

组件布局高度
scrollWidth Number

组件内容宽度
scrollHeight Number

组件内容高度
Inherited From:

validate()

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

Inherited From:
See:

validateImpl(x, y, width, height)

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

Parameters:
Name Type Description
x Number

内容范围的 x 坐标
y Number

内容范围的 y 坐标
width Number

内容范围宽度
height Number

内容范围高度
Inherited From:
© 2017 Hightopo Inc. All rights reserved. - Email: service@hightopo.com