HT for web Class: ContextMenu

new ContextMenu(properties)

右键菜单组件

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

事件名	事件对象	描述
`beforeShow`	{ kind: 'beforeShow', // 事件类型 nativeEvent: e, // 鼠标事件 source: contextMenu // 事件源 }	菜单显示之前派发
`afterShow`	{ kind: 'afterShow', // 事件类型 nativeEvent: e, // 鼠标事件 source: contextMenu // 事件源 }	菜单显示之后派发
`beforeHide`	{ kind: 'beforeHide', // 事件类型 item: item, // 隐藏时点击的菜单项 source: contextMenu // 事件源 }	菜单隐藏之前派发
`afterHide`	{ kind: 'afterHide', // 事件类型 item: item, // 隐藏时点击的菜单项 source: contextMenu // 事件源 }	菜单隐藏之后派发
`action`	{ kind: 'action', // 事件类型 nativeEvent: e, // 鼠标事件 item: item, // 点击的菜单项 source: contextMenu // 事件源 }	点击菜单项时派发

样式属性(全部)： padding, border, background, backgroundDrawable, zIndex, rowHeight, gapLeft, gapRight, hoverRowBackground, hoverRowBackgroundDrawable, bottomMargin, separatorColor, separatorSize, prefixWidth, prefixGapRight, iconWidth, iconGapRight, labelFont, labelColor, disabledLabelColor, hoverLabelColor, labelGapRight, labelLeftAligned, suffixGapRight, indicatorIcon, indicatorWidth, indicatorColor, hoverIndicatorColor, radioOnIcon, radioOffIcon, checkIcon, uncheckIcon, radioOnIconDrawable, radioOffIconDrawable, checkIconDrawable, uncheckIconDrawable, scrollUpIndicator, scrollUpIndicatorDrawable, scrollDownIndicator, scrollDownIndicatorDrawable, disabledScrollUpIndicator, disabledScrollUpIndicatorDrawable, disabledScrollDownIndicator, disabledScrollDownIndicatorDrawable, scrollIndicatorHeight boxShadow, borderRadius

Parameters:

Name	Type	Argument	Description
`properties`	Object	<optional>	属性配置对象

Example

contextMenu = new ht.ui.ContextMenu();
contextMenu.setItems([
    {
        label: 'Edit',
        suffix: 'Custom Suffix', // 在 Label 右侧显示一段文字
        items: [
            {
                label: 'Edit in this window'
            },
            {
               label: 'Edit in new window'
            }
        ]
    },
    {
        label: 'Cut',
        disabled: true
    },
    {
        label: 'Copy',
        icon: 'res/copy.png',
        disabled: function(item) { // disabled 属性可以绑定函数
        		return false;
        }
    },
    {
        label: 'Paste'
    },
    {
        label: 'Delete'
    },
    {
        type: '-', // 分割线
    },
    {
        label: 'Quit',
        items: [
            {
                label: 'Normal',
                type: 'radio',
                groupId: 1
            },
            {
               label: 'Force',
                type: 'radio',
                groupId: 1
            }
        ]
    }
]);
contextMenu.addToDOM(document.body);

Extends

ht.ui.View

Methods

addPropertyChangeListener(listener, scope, ahead)

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

Parameters:

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

Inherited From:

ht.ui.View#addPropertyChangeListener

addStyleProperty(property)

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

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#addStyleProperty

addToDOM(dom, rect)

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

Parameters:

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

Inherited From:

ht.ui.View#addToDOM

addViewListener(listener, scope, ahead)

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

Parameters:

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

Inherited From:

ht.ui.View#addViewListener

disableToolTip()

禁用工具提示，同 setToolTipEnabled

Inherited From:

ht.ui.View#disableToolTip

See:

setToolTipEnabled

dispose()

彻底销毁菜单，包括删除 DOM 对象、注销全局键盘事件监听、全局鼠标事件监听等

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

绘制背景

Parameters:

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

Inherited From:

ht.ui.View#drawBackground

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

绘制边框

Parameters:

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

Inherited From:

ht.ui.View#drawBorder

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

绘制菜单项的图标

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	绘制对象
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`item`	Object	菜单项
`canvas`	HTMLCanvasElement	画布

drawIndicatorIcon(drawable, x, y, width, height, item, canvas)

绘制子菜单指示符图标

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	绘制对象
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`item`	Object	菜单项
`canvas`	HTMLCanvasElement	画布

drawLabel(g, label, font, color, x, y, width, height, align, vAlign, item)

绘制菜单项的文本

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`label`	String	文本
`font`	String	字体
`color`	color	颜色
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`align`	String	文本的水平对齐方式
`vAlign`	String	文本的垂直对齐方式
`item`	Object	菜单项

drawPrefix(drawable, x, y, width, height, item, canvas)

绘制菜单项的前缀

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	绘制对象
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`item`	Object	菜单项
`canvas`	HTMLCanvasElement	画布

drawRowBackground(drawable, x, y, width, height, item, canvas)

绘制菜单项的背景

Parameters:

Name	Type	Description
`drawable`	ht.ui.drawable.Drawable	绘制对象
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`item`	Object	菜单项
`canvas`	HTMLCanvasElement	画布

drawSeparator(g, color, x, y, width, height, item)

绘制分隔条

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`color`	color	颜色值
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`item`	Object	菜单项

drawSuffix(g, text, font, color, x, y, width, height, align, vAlign, item)

绘制菜单项的后缀文字

Parameters:

Name	Type	Description
`g`	CanvasRenderingContext2D	画笔对象
`text`	String	后缀文本
`font`	String	字体
`color`	color	颜色
`x`	Number	绘制范围 x 坐标
`y`	Number	绘制范围 y 坐标
`width`	Number	绘制范围的宽度
`height`	Number	绘制范围的高度
`align`	String	文本的水平对齐方式
`vAlign`	String	文本的垂直对齐方式
`item`	Object	菜单项

enableToolTip()

启用工具提示，同 setToolTipEnabled

Inherited From:

ht.ui.View#enableToolTip

See:

setToolTipEnabled

figureMaxSize() → {Object}

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

Inherited From:

ht.ui.View#figureMaxSize

Returns:

maxSize

Type: Object

figureMinSize() → {Object}

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

Inherited From:

ht.ui.View#figureMinSize

Returns:

minSize

Type: Object

figurePreferredSize() → {Object}

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

Inherited From:

ht.ui.View#figurePreferredSize

Returns:

preferredSize

Type: Object

findItemByLabel(label) → {Object}

根据文本内容查找菜单项

Parameters:

Name	Type	Description
`label`	String	文本内容

Returns:

菜单项

Type: Object

fireViewEvent(event)

派发 View 事件

Parameters:

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

Inherited From:

ht.ui.View#fireViewEvent

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

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

Parameters:

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

Inherited From:

ht.ui.View#fp

Returns:

事件是否派发成功

Type: Boolean

getBackground() → {Object}

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

Inherited From:

ht.ui.View#getBackground

See:

getBackgroundDrawable

Returns:

组件背景

Type: Object

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

获取组件背景的 Drawable 对象

Inherited From:

ht.ui.View#getBackgroundDrawable

Returns:

组件背景

Type: ht.ui.drawable.Drawable

getBorder() → {ht.border.Border}

获取组件的边框

Inherited From:

ht.ui.View#getBorder

Returns:

组件边框

Type: ht.border.Border

getBorderBottom() → {Number}

获取组件边框的底部高度

Inherited From:

ht.ui.View#getBorderBottom

Returns:

组件边框底部高度

Type: Number

getBorderLeft() → {Number}

获取组件边框的左侧宽度

Inherited From:

ht.ui.View#getBorderLeft

Returns:

组件边框左侧宽度

Type: Number

getBorderRadius() → {Number|Array}

获取 CSS 边框圆角

Inherited From:

ht.ui.View#getBorderRadius

Returns:

边框圆角

Type: Number | Array

getBorderRight() → {Number}

获取组件边框的右侧宽度

Inherited From:

ht.ui.View#getBorderRight

Returns:

组件边框右侧宽度

Type: Number

getBorderTop() → {Number}

获取组件边框的顶部高度

Inherited From:

ht.ui.View#getBorderTop

Returns:

组件边框顶部高度

Type: Number

getBottomMargin() → {Number}

获取菜单底部到页面底部的最小距离

Returns:

距离值

Type: Number

getBoxShadow() → {String}

获取 CSS 阴影值

Inherited From:

ht.ui.View#getBoxShadow

Returns:

阴影值

Type: String

getCheckIcon() → {Object}

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

See:

getCheckIconDrawable

Returns:

图标

Type: Object

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

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

Returns:

图标

Type: ht.ui.drawable.Drawable

getContentBottom() → {Number}

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

Inherited From:

ht.ui.View#getContentBottom

Returns:

内容底部距离

Type: Number

getContentDiv() → {HTMLElement}

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

Inherited From:

ht.ui.View#getContentDiv

Returns:

内容 div

Type: HTMLElement

getContentHeight() → {Number}

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

Inherited From:

ht.ui.View#getContentHeight

Returns:

内容高度

Type: Number

getContentLeft() → {Number}

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

Inherited From:

ht.ui.View#getContentLeft

Returns:

内容左侧距离

Type: Number

getContentPoint(event) → {Object}

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

Parameters:

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

Inherited From:

ht.ui.View#getContentPoint

Returns:

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

Type: Object

getContentRight() → {Number}

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

Inherited From:

ht.ui.View#getContentRight

Returns:

内容右侧距离

Type: Number

getContentTop() → {Number}

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

Inherited From:

ht.ui.View#getContentTop

Returns:

内容顶部距离

Type: Number

getContentWidth() → {Number}

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

Inherited From:

ht.ui.View#getContentWidth

Returns:

内容宽度

Type: Number

getContextMenu() → {ht.ui.ContextMenu}

获取绑定的右键菜单

Inherited From:

ht.ui.View#getContextMenu

Returns:

右键菜单

Type: ht.ui.ContextMenu

getCursor() → {String}

获取鼠标样式(CSS 格式)

Inherited From:

ht.ui.View#getCursor

Returns:

鼠标样式

Type: String

getDisabledBackground() → {String}

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

Inherited From:

ht.ui.View#getDisabledBackground

Returns:

遮罩背景

Type: String

getDisabledColor() → {color}

获取被禁用菜单项的文字颜色

Returns:

颜色

Type: color

getDisabledScrollDownIndicator() → {Object}

获取不可用状态的向下滚动指示图标

See:

getDisabledScrollDownIndicatorDrawable

Returns:

图标

Type: Object

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

获取不可用状态的向下滚动指示图标的 Drawable 对象

Returns:

drawable 图标

Type: ht.ui.drawable.Drawable

getDisabledScrollUpIndicator() → {Object}

获取不可用状态的向上滚动指示图标

See:

getDisabledScrollUpIndicatorDrawable

Returns:

图标

Type: Object

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

获取不可用状态的向上滚动指示图标的 Drawable 对象

Returns:

drawable 图标

Type: ht.ui.drawable.Drawable

getDOMProperties() → {Object}

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

Inherited From:

ht.ui.View#getDOMProperties

Returns:

DOM 属性映射表

Type: Object

getErrorMessage() → {String}

获取错误信息

Inherited From:

ht.ui.View#getErrorMessage

Returns:

错误信息

Type: String

getGapLeft() → {Number}

获取菜单内容到左侧边缘的间距；注意与 padding 的区别：padding 会影响 hover 背景宽度，而 gapLeft 不会

Returns:

间距值

Type: Number

getGapRight() → {Number}

获取菜单内容到右侧边缘的间距；注意与 padding 的区别：padding 会影响 hover 背景宽度，而 gapRight 不会

Returns:

间距值

Type: Number

getHeight() → {Number}

获取组件的高度

Inherited From:

ht.ui.View#getHeight

Returns:

组件高度

Type: Number

getHoverIndicatorColor() → {color}

获取 hover 状态下子菜单指示符图标的颜色

Returns:

颜色值

Type: color

getHoverLabelColor() → {color}

获取 hover 状态菜单项的文字颜色

Returns:

颜色

Type: color

getHoverMenuItem() → {Object}

获取处于 hover 状态的菜单项

Returns:

菜单项

Type: Object

getHoverRowBackground() → {Object}

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

See:

getHoverRowBackgroundDrawable

Returns:

背景

Type: Object

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

获取 hover 状态下的菜单项背景的 Drawable 对象

Returns:

背景

Type: ht.ui.drawable.Drawable

getIconGapRight() → {Number}

获取菜单项中图标右侧的预留空白区域的宽度

Returns:

宽度值

Type: Number

getIconWidth() → {Number}

获取菜单项中图标的宽度

Returns:

宽度值

Type: Number

getId() → {Object}

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

Inherited From:

ht.ui.View#getId

Returns:

唯一标识

Type: Object

getIndicatorColor() → {color}

获取子菜单指示符图标的颜色

Returns:

颜色值

Type: color

getIndicatorIcon() → {Object}

获取子菜单指示符图标，可以是颜色或者图片等

See:

getIndicatorIconDrawable

Returns:

图标

Type: Object

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

获取子菜单指示符图标的 Drawable 对象

Returns:

图标

Type: ht.ui.drawable.Drawable

getIndicatorWidth() → {Number}

获取子菜单指示符图标的宽度

Returns:

宽度值

Type: Number

getInteractorClasses() → {Array}

获取交互器类名数组

Inherited From:

ht.ui.View#getInteractorClasses

Returns:

交互器类名数组

Type: Array

getInvoker() → {ht.ui.View}

获取菜单调用者

Returns:

菜单调用者

Type: ht.ui.View

getItems() → {Array}

获取菜单配置 json

Returns:

json

Type: Array

getLabelColor() → {color}

获取菜单项中文字颜色

Returns:

颜色

Type: color

getLabelFont() → {String}

获取菜单项中文字字体

Returns:

字体

Type: String

getLabelGapRight() → {Number}

获取菜单项中文字右侧的预留空白区域的宽度

Returns:

宽度值

Type: Number

getLayoutParams(key) → {Object}

获取布局参数

Parameters:

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

Inherited From:

ht.ui.View#getLayoutParams

Returns:

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

Type: Object

getMargin() → {Number|Array}

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

Inherited From:

ht.ui.View#getMargin

Returns:

外边距

Type: Number | Array

getMarginBottom() → {Number}

获取组件底部外边距高度

Inherited From:

ht.ui.View#getMarginBottom

Returns:

底部外边距高度

Type: Number

getMarginRight() → {Number}

获取组件右侧外边距宽度

Inherited From:

ht.ui.View#getMarginRight

Returns:

右侧外边距宽度

Type: Number

getMarginTop() → {Number}

获取组件顶部外边距高度

Inherited From:

ht.ui.View#getMarginTop

Returns:

顶部外边距高度

Type: Number

getMarignLeft() → {Number}

获取组件左侧外边距宽度

Inherited From:

ht.ui.View#getMarignLeft

Returns:

左侧外边距宽度

Type: Number

getMatchedStyles() → {Object}

获取组件匹配到的样式

Inherited From:

ht.ui.View#getMatchedStyles

Returns:

Type: Object

getMaxSize() → {Object}

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

Inherited From:

ht.ui.View#getMaxSize

Returns:

maxSize

Type: Object

getMaxSizeProperties() → {Object}

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

Inherited From:

ht.ui.View#getMaxSizeProperties

Returns:

maxSize 属性映射表

Type: Object

getMinSize() → {Object}

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

Inherited From:

ht.ui.View#getMinSize

Returns:

minSize

Type: Object

getMinSizeProperties() → {Object}

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

Inherited From:

ht.ui.View#getMinSizeProperties

Returns:

minSize 属性映射表

Type: Object

getPadding() → {Number|Array}

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

Inherited From:

ht.ui.View#getPadding

Returns:

内边距

Type: Number | Array

getPaddingBottom() → {Number}

获取组件底部内边距高度

Inherited From:

ht.ui.View#getPaddingBottom

Returns:

底部内边距高度

Type: Number

getPaddingLeft() → {Number}

获取组件左侧内边距宽度

Inherited From:

ht.ui.View#getPaddingLeft

Returns:

左侧内边距宽度

Type: Number

getPaddingRight() → {Number}

获取组件右侧内边距宽度

Inherited From:

ht.ui.View#getPaddingRight

Returns:

右侧内边距宽度

Type: Number

getPaddingTop() → {Number}

获取组件顶部内边距高度

Inherited From:

ht.ui.View#getPaddingTop

Returns:

顶部内边距高度

Type: Number

getParent() → {ht.ui.ViewGroup}

获取父容器

Inherited From:

ht.ui.View#getParent

Returns:

父容器

Type: ht.ui.ViewGroup

getPopover() → {ht.ui.Popover}

获取弹框组件

Inherited From:

ht.ui.View#getPopover

Returns:

弹框组件

Type: ht.ui.Popover

getPopoverPlacements() → {Array}

获取弹框组件的弹出位置

Inherited From:

ht.ui.View#getPopoverPlacements

Returns:

弹出位置

Type: Array

getPopoverTrigger() → {String}

获取弹框触发器

Inherited From:

ht.ui.View#getPopoverTrigger

Returns:

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

Type: String

getPreferredSize() → {Object}

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

Inherited From:

ht.ui.View#getPreferredSize

Returns:

preferredSize

Type: Object

getPreferredSizeProperties() → {Object}

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

Inherited From:

ht.ui.View#getPreferredSizeProperties

Returns:

preferredSize 属性映射表

Type: Object

getPrefixGapRight() → {Number}

获取菜单项前缀右侧的预留空白区域宽度

Returns:

宽度值

Type: Number

getPrefixWidth() → {Number}

获取菜单项前缀的宽度；前缀用来显示复选框、单选框

Returns:

宽度值

Type: Number

getPropertyValue(name) → {Object}

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

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

Parameters:

Name	Type	Description
`name`	String	属性名

Inherited From:

ht.ui.View#getPropertyValue

Returns:

属性值

Type: Object

Example

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

getRadioOffIcon() → {Object}

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

See:

getRadioOffIconDrawable

Returns:

图标

Type: Object

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

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

Returns:

图标

Type: ht.ui.drawable.Drawable

getRadioOnIcon() → {Object}

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

See:

getRadioOnIconDrawable

Returns:

图标

Type: Object

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

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

Returns:

图标

Type: ht.ui.drawable.Drawable

getRootCanvas() → {HTMLCanvasElement}

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

Inherited From:

ht.ui.View#getRootCanvas

Returns:

Canvas DOM 对象

Type: HTMLCanvasElement

getRootContext(dom) → {CanvasRenderingContext2D}

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

Parameters:

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

Inherited From:

ht.ui.View#getRootContext

Returns:

画笔对象

Type: CanvasRenderingContext2D

getRowHeight(item) → {Number}

获取菜单项行高

Parameters:

Name	Type	Description
`item`	Object	菜单项

Returns:

高度

Type: Number

getScrollDownIndicator() → {Object}

获取向下滚动指示图标

See:

getScrollDownIndicatorDrawable

Returns:

图标

Type: Object

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

获取向下滚动指示图标的 Drawable 对象

Returns:

drawable 图标

Type: ht.ui.drawable.Drawable

getScrollIndicatorHeight() → {Number}

获取滚动指示条的高度

Returns:

高度值

Type: Number

getScrollUpIndicator() → {Object}

获取向上滚动指示图标

See:

getScrollUpIndicatorDrawable

Returns:

图标

Type: Object

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

获取向上滚动指示图标的 Drawable 对象

Returns:

drawable 图标

Type: ht.ui.drawable.Drawable

getSeparatorColor() → {color}

获取分割线颜色

Returns:

颜色值

Type: color

getSeparatorSize() → {Number}

获取分割线高度

Returns:

高度值

Type: Number

getStyle() → {String}

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

Inherited From:

ht.ui.View#getStyle

Returns:

样式名

Type: String

getStyleProperties() → {Object}

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

Inherited From:

ht.ui.View#getStyleProperties

Returns:

样式属性映射表

Type: Object

getStyleValue(property) → {Object}

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

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#getStyleValue

Returns:

样式值

Type: Object

getSuffixGapRight() → {Number}

获取菜单项后缀右侧预留空白区域的宽度；后缀用来在 Label 右侧显示一段文字，如快捷键提示

Returns:

宽度值

Type: Number

getToolTip() → {String}

获取工具提示文本内容

Inherited From:

ht.ui.View#getToolTip

Returns:

工具提示文本内容

Type: String

getUncheckIcon() → {Object}

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

See:

getUncheckIconDrawable

Returns:

图标

Type: Object

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

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

Returns:

图标

Type: ht.ui.drawable.Drawable

getView() → {HTMLElement}

获取组件最根层的 div

Inherited From:

ht.ui.View#getView

Returns:

组件 div

Type: HTMLElement

getViewPoint(event) → {Object}

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

Parameters:

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

Inherited From:

ht.ui.View#getViewPoint

Returns:

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

Type: Object

getVisibleFunc() → {function}

获取可见过滤器函数；此函数用于过滤菜单项是否可见

Returns:

过滤器函数

Type: function

getWidth() → {Number}

获取组件的宽度

Inherited From:

ht.ui.View#getWidth

Returns:

组件宽度

Type: Number

getX() → {Number}

获取组件的 x 坐标

Inherited From:

ht.ui.View#getX

Returns:

x 坐标

Type: Number

getY() → {Number}

获取组件的 y 坐标

Inherited From:

ht.ui.View#getY

Returns:

y 坐标

Type: Number

getZIndex() → {Number}

获取组件的堆叠顺序

Inherited From:

ht.ui.View#getZIndex

Returns:

堆叠顺序

Type: Number

getZoom() → {Number}

获取缩放值

Inherited From:

ht.ui.View#getZoom

Returns:

缩放值

Type: Number

getZoomAnchor() → {Array}

获取缩放锚点

Inherited From:

ht.ui.View#getZoomAnchor

Returns:

锚点数组

Type: Array

hasContentCanvas() → {Boolean}

判断组件是否有私有 canvas

Inherited From:

ht.ui.View#hasContentCanvas

Returns:

组件是否有私有 canvas

Type: Boolean

hasFocus() → {Boolean}

判断焦点是否在组件上

Inherited From:

ht.ui.View#hasFocus

Returns:

焦点是否在组件上

Type: Boolean

hide()

隐藏菜单

hidePopover()

隐藏弹框组件

Inherited From:

ht.ui.View#hidePopover

initView(canvas)

初始化组件的 DOM 结构

Parameters:

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

Inherited From:

ht.ui.View#initView

invalidate(forceLayoutChildren)

使组件无效化

Parameters:

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

Inherited From:

ht.ui.View#invalidate

See:

invalidateDOM()

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

Inherited From:

ht.ui.View#invalidateDOM

isDescendantOf(viewGroup) → {Boolean}

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

Parameters:

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

Inherited From:

ht.ui.View#isDescendantOf

Returns:

Type: Boolean

isDisabled() → {Boolean}

组件是否被禁用

Inherited From:

ht.ui.View#isDisabled

Returns:

是否被禁用

Type: Boolean

isFocusable() → {Boolean}

组件是否可以获取焦点

Inherited From:

ht.ui.View#isFocusable

Returns:

是否可获取焦点

Type: Boolean

isInDOM() → {Boolean}

判断组件是否在 DOM 树中

Inherited From:

ht.ui.View#isInDOM

Returns:

组件是否在 DOM 树中

Type: Boolean

isLabelLeftAligned() → {Boolean}

菜单项中文字是否左侧对齐；如果为 true，即使菜单项没有图标，文字也会跳过图标区域，与其它菜单项的文字左对齐

Returns:

文字左侧是否对齐

Type: Boolean

isMaxSizeSet() → {Boolean}

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

Inherited From:

ht.ui.View#isMaxSizeSet

Returns:

maxSize 是否被设置

Type: Boolean

isMinSizeSet() → {Boolean}

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

Inherited From:

ht.ui.View#isMinSizeSet

Returns:

minSize 是否被设置

Type: Boolean

isPreferredSizeSet() → {Boolean}

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

Inherited From:

ht.ui.View#isPreferredSizeSet

Returns:

preferredSize 是否被设置

Type: Boolean

isRedrawOnFocus() → {Boolean}

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

Inherited From:

ht.ui.View#isRedrawOnFocus

Returns:

是否重绘自身

Type: Boolean

isSelfViewEvent(event) → {Boolean}

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

Parameters:

Name	Type	Description
`event`	Event	事件对象

Inherited From:

ht.ui.View#isSelfViewEvent

Returns:

事件是否发生在自身 DOM 上

Type: Boolean

isShortcutEnabled() → {Boolean}

判断是否启用快捷键

Returns:

是否启用快捷键

Type: Boolean

isStyleProperty(property) → {Boolean}

判断属性是否是样式属性

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#isStyleProperty

Returns:

是否是样式属性

Type: Boolean

isToolTipEnabled() → {Boolean}

是否启用工具提示

Inherited From:

ht.ui.View#isToolTipEnabled

Returns:

是否启用工具提示

Type: Boolean

isVisible() → {Boolean}

判断菜单是否可见

Returns:

是否可见

Type: Boolean

iv(forceLayoutChildren)

使组件无效化

Parameters:

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

Inherited From:

ht.ui.View#iv

See:

invalidate

layoutDOM(x, y, width, height)

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

Parameters:

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

Inherited From:

ht.ui.View#layoutDOM

makeDisabled(disabled, disabledDiv)

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

Parameters:

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

Inherited From:

ht.ui.View#makeDisabled

mp(listener, scope, ahead)

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

Parameters:

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

Inherited From:

ht.ui.View#mp

off(name, function, scope, ahead)

删除事件监听

Parameters:

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

Inherited From:

ht.ui.View#off

on(name, function, scope, ahead)

增加事件监听

Parameters:

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

Inherited From:

ht.ui.View#on

onOnce(name, function, scope, ahead)

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

Parameters:

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

Inherited From:

ht.ui.View#onOnce

processValidate()

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

Inherited From:

ht.ui.View#processValidate

redraw(forceLayoutChildren)

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

Parameters:

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

Inherited From:

ht.ui.View#redraw

removeFromDOM()

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

Inherited From:

ht.ui.View#removeFromDOM

removePropertyChangeListener(listener, scope)

删除属性事件变化监听器

Parameters:

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

Inherited From:

ht.ui.View#removePropertyChangeListener

removeStyleProperty(property)

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

Parameters:

Name	Type	Description
`property`	String	属性名

Inherited From:

ht.ui.View#removeStyleProperty

removeViewListener(listener, scope)

删除 View 事件监听器

Parameters:

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

Inherited From:

ht.ui.View#removeViewListener

requestFocus()

请求获取焦点

Inherited From:

ht.ui.View#requestFocus

selectItem(item)

选中一个菜单项(针对单选或多选菜单项)

Parameters:

Name	Type	Description
`item`	Object	菜单项

set(properties)

批量设置组件属性

Parameters:

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

Inherited From:

ht.ui.View#set

setBackground(background)

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

Parameters:

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

Inherited From:

ht.ui.View#setBackground

See:

setBackgroundDrawable

setBackgroundDrawable(drawable)

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

Parameters:

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

Inherited From:

ht.ui.View#setBackgroundDrawable

setBorder(border)

设置组件的边框

Parameters:

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

Inherited From:

ht.ui.View#setBorder

setBorderRadius(radius)

设置 CSS 边框圆角

Parameters:

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

Inherited From:

ht.ui.View#setBorderRadius

setBottomMargin(margin)

设置菜单底部到页面底部的最小距离

Parameters:

Name	Type	Description
`margin`	Number	距离值

setBoxShadow(boxShadow)

设置 CSS 阴影值

Parameters:

Name	Type	Description
`boxShadow`	String	阴影值

Inherited From:

ht.ui.View#setBoxShadow

setCheckIcon(icon)

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

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setCheckIconDrawable

setCheckIconDrawable(drawable)

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

Parameters:

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

setContextMenu(contextMenu)

设置绑定的右键菜单

Parameters:

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

Inherited From:

ht.ui.View#setContextMenu

setCursor(cursor)

设置鼠标样式(CSS 格式)

Parameters:

Name	Type	Description
`cursor`	String	鼠标样式

Inherited From:

ht.ui.View#setCursor

setDisabled(disabled)

设置组件是否被禁用

Parameters:

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

Inherited From:

ht.ui.View#setDisabled

setDisabledBackground(background)

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

Parameters:

Name	Type	Description
`background`	String	遮罩背景

Inherited From:

ht.ui.View#setDisabledBackground

Example

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

setDisabledColor(color)

设置被禁用菜单项的文字颜色

Parameters:

Name	Type	Description
`color`	color	颜色

setDisabledScrollDownIndicator(icon)

设置不可用状态的向下滚动指示图标

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setDisabledScrollDownIndicatorDrawable

setDisabledScrollDownIndicatorDrawable(drawable)

设置不可用状态的向下滚动指示图标的 Drawable 对象

Parameters:

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

setDisabledScrollUpIndicator(icon)

设置不可用状态的向上滚动指示图标

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setDisabledScrollUpIndicatorDrawable

setDisabledScrollUpIndicatorDrawable(drawable)

设置不可用状态的向上滚动指示图标的 Drawable 对象

Parameters:

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

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

设置错误信息

Parameters:

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

Inherited From:

ht.ui.View#setErrorMessage

Returns:

错误提示组件

Type: ht.ui.ErrorMessagePopover

setFocusable(focusable)

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

Parameters:

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

Inherited From:

ht.ui.View#setFocusable

setGapLeft(gap)

设置菜单内容到左侧边缘的间距；注意与 padding 的区别：padding 会影响 hover 背景宽度，而 gapLeft 不会

Parameters:

Name	Type	Description
`gap`	Number	间距值

setGapRight(gap)

设置菜单内容到右侧边缘的间距；注意与 padding 的区别：padding 会影响 hover 背景宽度，而 gapRight 不会

Parameters:

Name	Type	Description
`gap`	Number	间距值

setHeight(height)

设置组件的高度

Parameters:

Name	Type	Description
`height`	Number	组件高度

Inherited From:

ht.ui.View#setHeight

setHoverIndicatorColor(color)

设置 hover 状态下子菜单指示符图标的颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setHoverLabelColor(color)

设置 hover 状态菜单项的文字颜色

Parameters:

Name	Type	Description
`color`	color	颜色

setHoverRowBackground(background)

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

Parameters:

Name	Type	Description
`background`	Object	背景

See:

setHoverRowBackgroundDrawable

setHoverRowBackgroundDrawable(drawable)

设置 hover 状态下的菜单项背景的 Drawable 对象

Parameters:

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

setIconGapRight(gap)

设置菜单项中图标右侧的预留空白区域的宽度

Parameters:

Name	Type	Description
`gap`	Number	宽度值

setIconWidth(width)

设置菜单项中图标的宽度

Parameters:

Name	Type	Description
`width`	Number	宽度值

setId(id)

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

Parameters:

Name	Type	Description
`id`	Object	唯一标识

Inherited From:

ht.ui.View#setId

setIndicatorColor(color)

设置子菜单指示符图标的颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setIndicatorIcon(icon)

设置子菜单指示符图标，可以是颜色或者图片等

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setIndicatorIconDrawable

setIndicatorIconDrawable(drawable)

设置子菜单指示符图标的 Drawable 对象

Parameters:

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

setIndicatorWidth(width)

设置子菜单指示符图标的宽度

Parameters:

Name	Type	Description
`width`	Number	宽度值

setItems(items)

设置菜单配置 json

Parameters:

Name	Type	Description
`items`	Array	配置json

setLabelColor(color)

设置菜单项中文字颜色

Parameters:

Name	Type	Description
`color`	color	颜色

setLabelFont(font)

设置菜单项中文字字体

Parameters:

Name	Type	Description
`font`	String	字体

setLabelGapRight(gap)

设置菜单项中文字右侧的预留空白区域的宽度

Parameters:

Name	Type	Description
`gap`	Number	宽度值

setLabelLeftAligned(leftAligned)

设置菜单项中文字是否左侧对齐；如果为 true，即使菜单项没有图标，文字也会跳过图标区域，与其它菜单项的文字左对齐

Parameters:

Name	Type	Description
`leftAligned`	Boolean	文字左侧是否对齐

setLayoutParams(layoutParams, value)

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

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

Parameters:

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

Inherited From:

ht.ui.View#setLayoutParams

setMargin(margin)

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

Parameters:

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

Inherited From:

ht.ui.View#setMargin

setMaxSize(width, height)

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

Parameters:

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

Inherited From:

ht.ui.View#setMaxSize

setMinSize(width, height)

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

Parameters:

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

Inherited From:

ht.ui.View#setMinSize

setPadding(padding)

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

Parameters:

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

Inherited From:

ht.ui.View#setPadding

setPopover(popover, trigger)

设置弹框组件

Parameters:

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

Inherited From:

ht.ui.View#setPopover

setPopoverPlacements(placements)

设置弹框组件的弹出位置

Parameters:

Name	Type	Description
`placements`	Array	位置数组

Inherited From:

ht.ui.View#setPopoverPlacements

setPopoverTrigger(trigger)

设置弹框触发器

Parameters:

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

Inherited From:

ht.ui.View#setPopoverTrigger

setPreferredSize(width, height)

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

Parameters:

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

Inherited From:

ht.ui.View#setPreferredSize

setPrefixGapRight(gap)

设置菜单项前缀右侧的预留空白区域宽度

Parameters:

Name	Type	Description
`gap`	Number	宽度值

setPrefixWidth(width)

设置菜单项前缀的宽度；前缀用来显示复选框、单选框

Parameters:

Name	Type	Description
`width`	Number	宽度值

setPropertyValue(name, value)

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

Parameters:

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

Inherited From:

ht.ui.View#setPropertyValue

setRadioOffIcon(icon)

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

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setRadioOffIconDrawable

setRadioOffIconDrawable(drawable)

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

Parameters:

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

setRadioOnIcon(icon)

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

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setRadioOnIconDrawable

setRadioOnIconDrawable(drawable)

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

Parameters:

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

setRedrawOnFocus(redrawOnFocus)

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

Parameters:

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

Inherited From:

ht.ui.View#setRedrawOnFocus

setRowHeight(height)

设置菜单项行高

Parameters:

Name	Type	Description
`height`	Number	行高

setScrollDownIndicator(icon)

设置向下滚动指示图标

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setScrollDownIndicatorDrawable

setScrollDownIndicatorDrawable(drawable)

设置向下滚动指示图标的 Drawable 对象

Parameters:

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

setScrollIndicatorHeight(height)

设置滚动指示条的高度

Parameters:

Name	Type	Description
`height`	Number	高度值

setScrollUpIndicator(icon)

设置向上滚动指示图标

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setScrollUpIndicatorDrawable

setScrollUpIndicatorDrawable(drawable)

设置向上滚动指示图标的 Drawable 对象

Parameters:

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

setSeparatorColor(color)

设置分割线颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

setSeparatorSize(size)

设置分割线高度

Parameters:

Name	Type	Description
`size`	Number	高度值

setShortcutEnabled(enabled)

设置是否启用快捷键

Parameters:

Name	Type	Description
`enabled`	Boolean	是否启用快捷键

setStyle(styleName)

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

Parameters:

Name	Type	Description
`styleName`	String	样式名

Inherited From:

ht.ui.View#setStyle

setSuffixGapRight(gap)

设置菜单项后缀右侧预留空白区域的宽度；后缀用来在 Label 右侧显示一段文字，如快捷键提示

Parameters:

Name	Type	Description
`gap`	Number	宽度值

setToolTipEnabled(enabled)

设置是否启用工具提示

Parameters:

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

Inherited From:

ht.ui.View#setToolTipEnabled

setUncheckIcon(icon)

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

Parameters:

Name	Type	Description
`icon`	Object	图标

See:

setUncheckIconDrawable

setUncheckIconDrawable(drawable)

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

Parameters:

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

setVisible(visible)

设置组件是否可见

Parameters:

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

Inherited From:

ht.ui.View#setVisible

setVisibleFunc(visibleFunc)

设置可见过滤器函数；此函数用于过滤菜单项是否可见

Parameters:

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

setWidth(width)

设置组件的宽度

Parameters:

Name	Type	Description
`width`	Number	组件宽度

Inherited From:

ht.ui.View#setWidth

setX(x)

设置组件的 x 坐标

Parameters:

Name	Type	Description
`x`	Number	x 坐标

Inherited From:

ht.ui.View#setX

setY(y)

设置组件的 y 坐标

Parameters:

Name	Type	Description
`y`	Number	y 坐标

Inherited From:

ht.ui.View#setY

setZIndex(zIndex)

设置组件的堆叠顺序

Parameters:

Name	Type	Description
`zIndex`	Number	堆叠顺序

Inherited From:

ht.ui.View#setZIndex

setZoom(zoom)

设置缩放

Parameters:

Name	Type	Description
`zoom`	Number	缩放值

Inherited From:

ht.ui.View#setZoom

setZoomAnchor(anchor)

设置缩放锚点

Parameters:

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

Inherited From:

ht.ui.View#setZoomAnchor

show(x, y)

显示菜单

Parameters:

Name	Type	Description
`x`	Number	菜单 x 坐标
`y`	Number	菜单 y 坐标

showPopover()

显示弹框组件

Inherited From:

ht.ui.View#showPopover

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