列表框ui/listBox

显示项列表供用户选择。

基本用法
样式: 基本样式; 状态
API: List 类; ListItem 类; ListBox 类

基本用法

❐import { VNode, render } from "ui/control";
import ListBox, { ListItem } from "ui/listBox";

render(
    __root__,
    <ListBox onChange={console.log} value="B">
        <ListItem key="A">A</ListItem>
        <ListItem key="B">B</ListItem>
        <ListItem key="C">C</ListItem>
        <ListItem key="D">D</ListItem>
    </ListBox>
);

样式

基本样式

❐<ul class="x-listbox">
    <li data-key="A"><a href="javascript:;">A</a></li>
    <li data-key="B" class="x-listbox-selected"><a href="javascript:;">B</a></li>
    <li data-key="C"><a href="javascript:;">C</a></li>
    <li data-key="D"><a href="javascript:;">D</a></li>
</ul>

状态

❐<ul class="x-listbox x-listbox-readonly">
    <li data-key="A"><a href="javascript:;">A</a></li>
    <li data-key="B" class="x-listbox-selected"><a href="javascript:;">B</a></li>
    <li data-key="C"><a href="javascript:;">C</a></li>
    <li data-key="D"><a href="javascript:;">D</a></li>
</ul>
<ul class="x-listbox x-listbox-disabled">
    <li data-key="A"><a href="javascript:;">A</a></li>
    <li data-key="B" class="x-listbox-selected"><a href="javascript:;">B</a></li>
    <li data-key="C"><a href="javascript:;">C</a></li>
    <li data-key="D"><a href="javascript:;">D</a></li>
</ul>

API

List 类

继承自：Input

表示一个列表框基类。

字段	类型	描述	继承自
⮞ `items` : `ListItem[]` 所有项。	`ListItem[]`	所有项。	—
⮞ `selectedItem` : `ListItem` 选中的第一项。	`ListItem`	选中的第一项。	—
⮞ `selectedIndex` : `number` 选中的第一项的索引。	`number`	选中的第一项的索引。	—
⮞ `readOnly` : `boolean` (已覆盖)是否只读。继承自 `Input`	`boolean`	(已覆盖)是否只读。	`Input`
⮞ `disabled` : `boolean` (已覆盖)是否禁用。继承自 `Input`	`boolean`	(已覆盖)是否禁用。	`Input`
⮞ `body` : `HTMLElement` (已覆盖)(只读)获取用于包含子控件和节点的根元素。继承自 `Input`	`HTMLElement`	(已覆盖)(只读)获取用于包含子控件和节点的根元素。	`Input`
⮞ `input` : `HTMLInputElement` (只读)内部关联的输入框元素。继承自 `Input`	`HTMLInputElement`	(只读)内部关联的输入框元素。	`Input`
⮞ `name` : `string` 名字。继承自 `Input`	`string`	名字。	`Input`
⮞ `value` : `any` 值。继承自 `Input`	`any`	值。	`Input`
⮞ `defaultValue` : `any` 默认值。继承自 `Input`	`any`	默认值。	`Input`
⮞ `type` : `string` 输入框的类型。继承自 `Input`	`string`	输入框的类型。	`Input`
⮞ `placeholder` : `string` 未输入内容时的占位符。继承自 `Input`	`string`	未输入内容时的占位符。	`Input`
⮞ `tabIndex` : `number` TAB 键切换顺序。继承自 `Input`	`number`	TAB 键切换顺序。	`Input`
⮞ `tabStop` : `boolean` 是否允许 TAB 键停靠。继承自 `Input`	`boolean`	是否允许 TAB 键停靠。	`Input`
⮞ `onCopy` : `(e: ClipboardEvent, sender: List) => void` 复制事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oncopy 继承自 `Input`	`function`	复制事件。	`Input`
⮞ `onCut` : `(e: ClipboardEvent, sender: List) => void` 剪切事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oncut 继承自 `Input`	`function`	剪切事件。	`Input`
⮞ `onPaste` : `(e: ClipboardEvent, sender: List) => void` 粘贴事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpaste 继承自 `Input`	`function`	粘贴事件。	`Input`
⮞ `onBeforeCopy` : `(e: ClipboardEvent, sender: List) => void` 即将复制事件。参考 https://msdn.microsoft.com/zh-cn/library/aa769320.ASPX 继承自 `Input`	`function`	即将复制事件。	`Input`
⮞ `onBeforeCut` : `(e: ClipboardEvent, sender: List) => void` 即将剪切事件。参考 https://msdn.microsoft.com/zh-cn/library/aa769321.aspx 继承自 `Input`	`function`	即将剪切事件。	`Input`
⮞ `onBeforePaste` : `(e: ClipboardEvent, sender: List) => void` 即将粘贴事件。参考 https://msdn.microsoft.com/zh-cn/library/aa769324.aspx 继承自 `Input`	`function`	即将粘贴事件。	`Input`
⮞ `onFocus` : `(e: FocusEvent, sender: List) => void` 获取焦点事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/nfocus 继承自 `Input`	`function`	获取焦点事件。	`Input`
⮞ `onBlur` : `(e: FocusEvent, sender: List) => void` 失去焦点事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onblur 继承自 `Input`	`function`	失去焦点事件。	`Input`
⮞ `onFocusIn` : `(e: FocusEvent, sender: List) => void` 当前元素和子元素获取焦点事件。参考 https://msdn.microsoft.com/zh-CN/library/ms536935(VS.85).aspx 继承自 `Input`	`function`	当前元素和子元素获取焦点事件。	`Input`
⮞ `onFocusOut` : `(e: FocusEvent, sender: List) => void` 当前元素和子元素失去焦点事件。参考 https://msdn.microsoft.com/zh-CN/library/ms536936(VS.85).aspx 继承自 `Input`	`function`	当前元素和子元素失去焦点事件。	`Input`
⮞ `onInput` : `(e: Event, sender: List) => void` 输入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oninput 继承自 `Input`	`function`	输入事件。	`Input`
⮞ `onChange` : `(e: Event, sender: List) => void` 更改事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlersonchange 继承自 `Input`	`function`	更改事件。	`Input`
⮞ `onKeyDown` : `(e: KeyboardEvent, sender: List) => void` 键盘按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onkeydown 继承自 `Input`	`function`	键盘按下事件。	`Input`
⮞ `onKeyPress` : `(e: KeyboardEvent, sender: List) => void` 键盘点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onkeypress 继承自 `Input`	`function`	键盘点击事件。	`Input`
⮞ `onKeyUp` : `(e: KeyboardEvent, sender: List) => void` 键盘按上事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onkeyup 继承自 `Input`	`function`	键盘按上事件。	`Input`
⮞ `onEnter` : `(e: KeyboardEvent, sender: List) => void` 回车事件。继承自 `Input`	`function`	回车事件。	`Input`
⮞ `status` : `Status` 控件状态。继承自 `Input`	`Status`	控件状态。	`Input`
⮞ `statusClassPrefix` : `string` 控件状态前缀。继承自 `Input`	`string`	控件状态前缀。	`Input`
⮞ `hideSuccess` : `boolean` 是否隐藏验证成功状态。继承自 `Input`	`boolean`	是否隐藏验证成功状态。	`Input`
⮞ `noValidate` : `boolean` 是否禁用验证。继承自 `Input`	`boolean`	是否禁用验证。	`Input`
⮞ `validateEvent` : `string` 触发验证的事件。继承自 `Input`	`string`	触发验证的事件。	`Input`
⮞ `required` : `boolean` 字段是否必填。继承自 `Input`	`boolean`	字段是否必填。	`Input`
⮞ `requiredMessage` : `string` 字段不满足必填时的提示文案。继承自 `Input`	`string`	字段不满足必填时的提示文案。	`Input`
⮞ `maxLength` : `number` 最大长度。-1 表示不限制。继承自 `Input`	`number`	最大长度。-1 表示不限制。	`Input`
⮞ `maxLengthMessage` : `string` 字段不满足最大长度时的提示文案。继承自 `Input`	`string`	字段不满足最大长度时的提示文案。	`Input`
⮞ `minLength` : `number` 最小长度。-1 表示不限制。继承自 `Input`	`number`	最小长度。-1 表示不限制。	`Input`
⮞ `minLengthMessage` : `string` 字段不满足最小长度时的提示文案。继承自 `Input`	`string`	字段不满足最小长度时的提示文案。	`Input`
⮞ `max` : `any` 最大值。继承自 `Input`	`any`	最大值。	`Input`
⮞ `maxMessage` : `string` 字段不满足最大值时的提示文案。继承自 `Input`	`string`	字段不满足最大值时的提示文案。	`Input`
⮞ `min` : `any` 最小值。继承自 `Input`	`any`	最小值。	`Input`
⮞ `minMessage` : `string` 字段不满足最小值时的提示文案。继承自 `Input`	`string`	字段不满足最小值时的提示文案。	`Input`
⮞ `pattern` : `RegExp` 匹配格式的正则表达式。继承自 `Input`	`RegExp`	匹配格式的正则表达式。	`Input`
⮞ `patternMessage` : `string` 字段不满足格式时的提示文案。继承自 `Input`	`string`	字段不满足格式时的提示文案。	`Input`
⮞ `validateErrorMessage` : `string` 验证失败的提示文案。继承自 `Input`	`string`	验证失败的提示文案。	`Input`
⮞ `validateStartMessage` : `string` 开始异步验证的提示文案。继承自 `Input`	`string`	开始异步验证的提示文案。	`Input`
⮞ `validateStartMessagePrefix` : `string` 开始异步验证的提示文案前缀。继承自 `Input`	`string`	开始异步验证的提示文案前缀。	`Input`
⮞ `validateInfoMessagePrefix` : `string` 验证信息状态的提示文案前缀。继承自 `Input`	`string`	验证信息状态的提示文案前缀。	`Input`
⮞ `validateErrorMessagePrefix` : `string` 验证失败状态的提示文案前缀。继承自 `Input`	`string`	验证失败状态的提示文案前缀。	`Input`
⮞ `validateWarningMessagePrefix` : `string` 验证警告状态的提示文案前缀。继承自 `Input`	`string`	验证警告状态的提示文案前缀。	`Input`
⮞ `validateSuccessMessagePrefix` : `string` 验证成功状态的提示文案前缀。继承自 `Input`	`string`	验证成功状态的提示文案前缀。	`Input`
⮞ `willValidate` : `boolean` (只读)判断当前输入域是否需要验证。继承自 `Input`	`boolean`	(只读)判断当前输入域是否需要验证。	`Input`
⮞ `validateDelay` : `number` 验证事件触发后延时验证的毫秒数。继承自 `Input`	`number`	验证事件触发后延时验证的毫秒数。	`Input`
⮞ `revalidateDelay` : `number` 重新验证事件触发后延时验证的毫秒数。继承自 `Input`	`number`	重新验证事件触发后延时验证的毫秒数。	`Input`
⮞ `onValidate` : `(value: any, sender: List) => ValidityResult` 验证事件。继承自 `Input`	`function`	验证事件。	`Input`
⮞ `onReportValidity` : `(validityResult: NormalizedValidityResult, sender: List) => boolean \| void` 报告验证结果事件。继承自 `Input`	`function`	报告验证结果事件。	`Input`
⮞ `validityToolTipOptions` : `Partial<ToolTip>` 验证工具提示的选项。继承自 `Input`	`Partial<ToolTip>`	验证工具提示的选项。	`Input`
⮞ `readyState` : `ControlState` 获取当前控件的渲染状态。继承自 `Control`	`ControlState`	获取当前控件的渲染状态。	`Control`
⮞ `elem` : `HTMLElement` 关联的元素。继承自 `Control`	`HTMLElement`	关联的元素。	`Control`
⮞ `vNode` : `VNode` (保护的)获取当前控件关联的虚拟节点。继承自 `Control`	`VNode`	(保护的)获取当前控件关联的虚拟节点。	`Control`
⮞ `sourceVNode` : `VNode` 获取创建该控件使用的源虚拟节点。继承自 `Control`	`VNode`	获取创建该控件使用的源虚拟节点。	`Control`
⮞ `alwaysUpdate` : `boolean` 控件是否使用主动更新模式。继承自 `Control`	`boolean`	控件是否使用主动更新模式。	`Control`
⮞ `duration` : `number` = `200` 渐变的持续毫秒数。如果为 0 则不使用渐变。继承自 `Control`	`number`	渐变的持续毫秒数。如果为 0 则不使用渐变。	`Control`
⮞ `class` : `string` CSS 类名。继承自 `Control`	`string`	CSS 类名。	`Control`
⮞ `hidden` : `boolean` 是否隐藏。继承自 `Control`	`boolean`	是否隐藏。	`Control`
⮞ `style` : `string \| { [key: string]: string \| number; }` 控件样式。继承自 `Control`	`string \| object`	控件样式。	`Control`
⮞ `id` : `string` 控件序号。继承自 `Control`	`string`	控件序号。	`Control`
⮞ `content` : `NodeLike` 控件内容。继承自 `Control`	`NodeLike`	控件内容。	`Control`
⮞ `onSelectStart` : `(e: Event, sender: List) => void` 选择开始事件。参考 https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onselectstart 继承自 `Control`	`function`	选择开始事件。	`Control`
⮞ `onClick` : `(e: MouseEvent, sender: List) => void` 点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onclick 继承自 `Control`	`function`	点击事件。	`Control`
⮞ `onAuxClick` : `(e: MouseEvent, sender: List) => void` 中键点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onauxclick 继承自 `Control`	`function`	中键点击事件。	`Control`
⮞ `onDblClick` : `(e: MouseEvent, sender: List) => void` 双击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ondblclick 继承自 `Control`	`function`	双击事件。	`Control`
⮞ `onContextMenu` : `(e: PointerEvent, sender: List) => void` 右键菜单事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oncontextmenu 继承自 `Control`	`function`	右键菜单事件。	`Control`
⮞ `onMouseDown` : `(e: MouseEvent, sender: List) => void` 鼠标按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmousedown 继承自 `Control`	`function`	鼠标按下事件。	`Control`
⮞ `onMouseUp` : `(e: MouseEvent, sender: List) => void` 鼠标按上事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseup 继承自 `Control`	`function`	鼠标按上事件。	`Control`
⮞ `onMouseOver` : `(e: MouseEvent, sender: List) => void` 鼠标移入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseover 继承自 `Control`	`function`	鼠标移入事件。	`Control`
⮞ `onMouseOut` : `(e: MouseEvent, sender: List) => void` 鼠标移开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseout 继承自 `Control`	`function`	鼠标移开事件。	`Control`
⮞ `onMouseEnter` : `(e: MouseEvent, sender: List) => void` 鼠标进入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseenter 继承自 `Control`	`function`	鼠标进入事件。	`Control`
⮞ `onMouseLeave` : `(e: MouseEvent, sender: List) => void` 鼠标离开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseleave 继承自 `Control`	`function`	鼠标离开事件。	`Control`
⮞ `onMouseMove` : `(e: MouseEvent, sender: List) => void` 鼠标移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmousemove 继承自 `Control`	`function`	鼠标移动事件。	`Control`
⮞ `onWheel` : `(e: WheelEvent, sender: List) => void` 鼠标滚轮事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/Events/wheel 继承自 `Control`	`function`	鼠标滚轮事件。	`Control`
⮞ `onScroll` : `(e: UIEvent, sender: List) => void` 滚动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onscroll 继承自 `Control`	`function`	滚动事件。	`Control`
⮞ `onTouchStart` : `(e: TouchEvent, sender: List) => void` 触摸开始事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchstart 继承自 `Control`	`function`	触摸开始事件。	`Control`
⮞ `onTouchMove` : `(e: TouchEvent, sender: List) => void` 触摸移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchmove 继承自 `Control`	`function`	触摸移动事件。	`Control`
⮞ `onTouchEnd` : `(e: TouchEvent, sender: List) => void` 触摸结束事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchend 继承自 `Control`	`function`	触摸结束事件。	`Control`
⮞ `onTouchCancel` : `(e: TouchEvent, sender: List) => void` 触摸撤销事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchcancel 继承自 `Control`	`function`	触摸撤销事件。	`Control`
⮞ `onPointerEnter` : `(e: PointerEvent, sender: List) => void` 指针进入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerenter 继承自 `Control`	`function`	指针进入事件。	`Control`
⮞ `onPointerLeave` : `(e: PointerEvent, sender: List) => void` 指针离开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerleave 继承自 `Control`	`function`	指针离开事件。	`Control`
⮞ `onPointerOver` : `(e: PointerEvent, sender: List) => void` 指针移入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerover 继承自 `Control`	`function`	指针移入事件。	`Control`
⮞ `onPointerOut` : `(e: PointerEvent, sender: List) => void` 指针移开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerout 继承自 `Control`	`function`	指针移开事件。	`Control`
⮞ `onPointerDown` : `(e: PointerEvent, sender: List) => void` 指针按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerdown 继承自 `Control`	`function`	指针按下事件。	`Control`
⮞ `onPointerMove` : `(e: PointerEvent, sender: List) => void` 指针移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointermove 继承自 `Control`	`function`	指针移动事件。	`Control`
⮞ `onPointerUp` : `(e: PointerEvent, sender: List) => void` 指针松开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerup 继承自 `Control`	`function`	指针松开事件。	`Control`
⮞ `onPointerCancel` : `(e: PointerEvent, sender: List) => void` 指针取消事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointercancel 继承自 `Control`	`function`	指针取消事件。	`Control`
⮞ `onGotPointerCapture` : `(e: PointerEvent, sender: List) => void` 指针开始捕获事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ongotpointercapture 继承自 `Control`	`function`	指针开始捕获事件。	`Control`
⮞ `onLostPointerCapture` : `(e: PointerEvent, sender: List) => void` 指针停止捕获事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onlostpointercapture 继承自 `Control`	`function`	指针停止捕获事件。	`Control`

方法描述继承自

⮞ findItemByKey(key)(key:string):ListItem

获取指定键对应的项。

参数	类型	描述	默认值
`key*`	`string`		—

返回值

类型：ListItem

返回匹配的第一个项。如果不存在则返回 undefined。

获取指定键对应的项。

—

⮞ findItemByContent(content)(content:string):ListItem

获取指定内容对应的项。

参数	类型	描述	默认值
`content*`	`string`		—

返回值

类型：ListItem

返回匹配的第一个项。如果不存在则返回 undefined。

获取指定内容对应的项。

—

⮞ render()():VNode

(保护的)

返回值

类型：VNode

继承自

Input

(保护的)(已覆盖)当被子类重写时负责返回当前控件的虚拟节点。

Input

⮞ isHidden()():boolean

判断输入域样式是否被隐藏。

返回值

类型：boolean

如果控件或其父元素被隐藏则返回 true，否则返回 false。

继承自

Input

判断输入域样式是否被隐藏。

Input

⮞ init()():void

(保护的)

返回值

类型：void

继承自

Control

(保护的)当被子类重写时负责在关联元素后初始化当前控件。

Control

⮞ handleValidateEvent()():void

(保护的)处理验证事件。

返回值

类型：void

继承自

Input

(保护的)处理验证事件。

Input

⮞ checkValidity()():NormalizedValidityResult | Promise<NormalizedValidityResult>

验证当前输入域。

返回值

类型：NormalizedValidityResult | Promise<NormalizedValidityResult>

返回验证结果。如果正在执行异步验证则返回一个确认对象。

继承自

Input

验证当前输入域。

Input

⮞ validate(value)(value:this["value"]):ValidityResult

(保护的)当被子类重写时负责验证指定的值。

参数	类型	描述	默认值
`value*`	`this["value"]`		—

返回值

类型：ValidityResult

返回验证结果。如果正在执行异步验证则返回一个确认对象。

继承自

Input

(保护的)当被子类重写时负责验证指定的值。

Input

⮞ normlizeValidityResult(r)(r:ValidityResult):NormalizedValidityResult | Promise<NormalizedValidityResult>

(保护的)规范化验证结果对象。

参数	类型	描述	默认值
`r*`	`ValidityResult`		—

返回值

类型：NormalizedValidityResult | Promise<NormalizedValidityResult>

继承自

Input

(保护的)规范化验证结果对象。

Input

⮞ reportValidity()():NormalizedValidityResult | Promise<NormalizedValidityResult>

向用户报告验证结果。

返回值

类型：NormalizedValidityResult | Promise<NormalizedValidityResult>

返回验证结果。如果正在执行异步验证则返回一个确认对象。

继承自

Input

向用户报告验证结果。

Input

⮞ setCustomValidity(validityResult)(validityResult:string | boolean | Partial<NormalizedValidityResult>):void

设置自定义的验证消息。

参数	类型	描述	默认值
`validityResult*`	`string \| boolean \| Partial<NormalizedValidityResult>`		—

返回值

类型：void

继承自

Input

设置自定义的验证消息。

Input

⮞ createValidityToolTip()():ToolTip

(保护的)当被子类重写时负责创建当前输入框的默认验证提示。

返回值

类型：ToolTip

继承自

Input

(保护的)当被子类重写时负责创建当前输入框的默认验证提示。

Input

⮞ reset()():void

重置当前输入域。

返回值

类型：void

继承自

Input

重置当前输入域。

Input

⮞ focus()():void

令当前控件获得焦点。

返回值

类型：void

继承自

Input

令当前控件获得焦点。

Input

⮞ blur()():void

令当前控件失去焦点。

返回值

类型：void

继承自

Input

令当前控件失去焦点。

Input

⮞ layout(changes)(changes:Changes):void

参数	类型	描述	默认值
`changes*`	`Changes`		—

返回值

类型：void

继承自

Control

重新布局当前控件。

Control

⮞ uninit()():void

(保护的)当被子类重写时负责在元素被取消关联前取消初始化当前控件。

返回值

类型：void

继承自

Control

(保护的)当被子类重写时负责在元素被取消关联前取消初始化当前控件。

Control

⮞ update()():void

重新渲染当前控件。

返回值

类型：void

继承自

Control

重新渲染当前控件。

Control

⮞ invalidate()():void

使当前控件无效并在下一帧重新渲染。

返回值

类型：void

继承自

Control

使当前控件无效并在下一帧重新渲染。

Control

⮞ renderTo(parent, ...)(parent:Control | Node, refChild?:Control | Node):void

将当前控件渲染到指定的父控件或节点。

参数	类型	描述	默认值
`parent*`	`Control \| Node`		—
`refChild`	`Control \| Node`		—

返回值

类型：void

继承自

Control

将当前控件渲染到指定的父控件或节点。

Control

⮞ find(selector)(selector:string):Control | HTMLElement

在当前控件查找指定的子控件或节点。

参数	类型	描述	默认值
`selector*`	`string`		—

返回值

类型：Control | HTMLElement

返回子控件或节点。如果找不到则返回 null。

继承自

Control

在当前控件查找指定的子控件或节点。

Control

⮞ query(selector)(selector:string):(Control | HTMLElement)[]

在当前控件查找匹配的所有子控件或节点。

参数	类型	描述	默认值
`selector*`	`string`		—

返回值

类型：(Control | HTMLElement)[]

返回子控件或节点列表。

继承自

Control

在当前控件查找匹配的所有子控件或节点。

Control

ListItem 类

继承自：Control

表示一个列表项。

字段	类型	描述	继承自
⮞ `key` : `any` 键。	`any`	键。	—
⮞ `selected` : `boolean` 是否选中。	`boolean`	是否选中。	—
⮞ `body` : `HTMLElement` (已覆盖)(只读)获取用于包含子控件和节点的根元素。继承自 `Control`	`HTMLElement`	(已覆盖)(只读)获取用于包含子控件和节点的根元素。	`Control`
⮞ `content` : `string` (已覆盖)内容。继承自 `Control`	`string`	(已覆盖)内容。	`Control`
⮞ `readyState` : `ControlState` 获取当前控件的渲染状态。继承自 `Control`	`ControlState`	获取当前控件的渲染状态。	`Control`
⮞ `elem` : `HTMLElement` 关联的元素。继承自 `Control`	`HTMLElement`	关联的元素。	`Control`
⮞ `vNode` : `VNode` (保护的)获取当前控件关联的虚拟节点。继承自 `Control`	`VNode`	(保护的)获取当前控件关联的虚拟节点。	`Control`
⮞ `sourceVNode` : `VNode` 获取创建该控件使用的源虚拟节点。继承自 `Control`	`VNode`	获取创建该控件使用的源虚拟节点。	`Control`
⮞ `alwaysUpdate` : `boolean` 控件是否使用主动更新模式。继承自 `Control`	`boolean`	控件是否使用主动更新模式。	`Control`
⮞ `duration` : `number` = `200` 渐变的持续毫秒数。如果为 0 则不使用渐变。继承自 `Control`	`number`	渐变的持续毫秒数。如果为 0 则不使用渐变。	`Control`
⮞ `class` : `string` CSS 类名。继承自 `Control`	`string`	CSS 类名。	`Control`
⮞ `hidden` : `boolean` 是否隐藏。继承自 `Control`	`boolean`	是否隐藏。	`Control`
⮞ `style` : `string \| { [key: string]: string \| number; }` 控件样式。继承自 `Control`	`string \| object`	控件样式。	`Control`
⮞ `id` : `string` 控件序号。继承自 `Control`	`string`	控件序号。	`Control`
⮞ `onSelectStart` : `(e: Event, sender: ListItem) => void` 选择开始事件。参考 https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onselectstart 继承自 `Control`	`function`	选择开始事件。	`Control`
⮞ `onClick` : `(e: MouseEvent, sender: ListItem) => void` 点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onclick 继承自 `Control`	`function`	点击事件。	`Control`
⮞ `onAuxClick` : `(e: MouseEvent, sender: ListItem) => void` 中键点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onauxclick 继承自 `Control`	`function`	中键点击事件。	`Control`
⮞ `onDblClick` : `(e: MouseEvent, sender: ListItem) => void` 双击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ondblclick 继承自 `Control`	`function`	双击事件。	`Control`
⮞ `onContextMenu` : `(e: PointerEvent, sender: ListItem) => void` 右键菜单事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oncontextmenu 继承自 `Control`	`function`	右键菜单事件。	`Control`
⮞ `onMouseDown` : `(e: MouseEvent, sender: ListItem) => void` 鼠标按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmousedown 继承自 `Control`	`function`	鼠标按下事件。	`Control`
⮞ `onMouseUp` : `(e: MouseEvent, sender: ListItem) => void` 鼠标按上事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseup 继承自 `Control`	`function`	鼠标按上事件。	`Control`
⮞ `onMouseOver` : `(e: MouseEvent, sender: ListItem) => void` 鼠标移入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseover 继承自 `Control`	`function`	鼠标移入事件。	`Control`
⮞ `onMouseOut` : `(e: MouseEvent, sender: ListItem) => void` 鼠标移开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseout 继承自 `Control`	`function`	鼠标移开事件。	`Control`
⮞ `onMouseEnter` : `(e: MouseEvent, sender: ListItem) => void` 鼠标进入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseenter 继承自 `Control`	`function`	鼠标进入事件。	`Control`
⮞ `onMouseLeave` : `(e: MouseEvent, sender: ListItem) => void` 鼠标离开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseleave 继承自 `Control`	`function`	鼠标离开事件。	`Control`
⮞ `onMouseMove` : `(e: MouseEvent, sender: ListItem) => void` 鼠标移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmousemove 继承自 `Control`	`function`	鼠标移动事件。	`Control`
⮞ `onWheel` : `(e: WheelEvent, sender: ListItem) => void` 鼠标滚轮事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/Events/wheel 继承自 `Control`	`function`	鼠标滚轮事件。	`Control`
⮞ `onScroll` : `(e: UIEvent, sender: ListItem) => void` 滚动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onscroll 继承自 `Control`	`function`	滚动事件。	`Control`
⮞ `onTouchStart` : `(e: TouchEvent, sender: ListItem) => void` 触摸开始事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchstart 继承自 `Control`	`function`	触摸开始事件。	`Control`
⮞ `onTouchMove` : `(e: TouchEvent, sender: ListItem) => void` 触摸移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchmove 继承自 `Control`	`function`	触摸移动事件。	`Control`
⮞ `onTouchEnd` : `(e: TouchEvent, sender: ListItem) => void` 触摸结束事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchend 继承自 `Control`	`function`	触摸结束事件。	`Control`
⮞ `onTouchCancel` : `(e: TouchEvent, sender: ListItem) => void` 触摸撤销事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchcancel 继承自 `Control`	`function`	触摸撤销事件。	`Control`
⮞ `onPointerEnter` : `(e: PointerEvent, sender: ListItem) => void` 指针进入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerenter 继承自 `Control`	`function`	指针进入事件。	`Control`
⮞ `onPointerLeave` : `(e: PointerEvent, sender: ListItem) => void` 指针离开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerleave 继承自 `Control`	`function`	指针离开事件。	`Control`
⮞ `onPointerOver` : `(e: PointerEvent, sender: ListItem) => void` 指针移入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerover 继承自 `Control`	`function`	指针移入事件。	`Control`
⮞ `onPointerOut` : `(e: PointerEvent, sender: ListItem) => void` 指针移开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerout 继承自 `Control`	`function`	指针移开事件。	`Control`
⮞ `onPointerDown` : `(e: PointerEvent, sender: ListItem) => void` 指针按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerdown 继承自 `Control`	`function`	指针按下事件。	`Control`
⮞ `onPointerMove` : `(e: PointerEvent, sender: ListItem) => void` 指针移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointermove 继承自 `Control`	`function`	指针移动事件。	`Control`
⮞ `onPointerUp` : `(e: PointerEvent, sender: ListItem) => void` 指针松开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerup 继承自 `Control`	`function`	指针松开事件。	`Control`
⮞ `onPointerCancel` : `(e: PointerEvent, sender: ListItem) => void` 指针取消事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointercancel 继承自 `Control`	`function`	指针取消事件。	`Control`
⮞ `onGotPointerCapture` : `(e: PointerEvent, sender: ListItem) => void` 指针开始捕获事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ongotpointercapture 继承自 `Control`	`function`	指针开始捕获事件。	`Control`
⮞ `onLostPointerCapture` : `(e: PointerEvent, sender: ListItem) => void` 指针停止捕获事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onlostpointercapture 继承自 `Control`	`function`	指针停止捕获事件。	`Control`

方法描述继承自

⮞ render()():VNode

(保护的)

返回值

类型：VNode

继承自

Control

(保护的)(已覆盖)当被子类重写时负责返回当前控件的虚拟节点。

Control

⮞ init()():void

(保护的)当被子类重写时负责在关联元素后初始化当前控件。

返回值

类型：void

继承自

Control

(保护的)当被子类重写时负责在关联元素后初始化当前控件。

Control

⮞ uninit()():void

(保护的)当被子类重写时负责在元素被取消关联前取消初始化当前控件。

返回值

类型：void

继承自

Control

(保护的)当被子类重写时负责在元素被取消关联前取消初始化当前控件。

Control

⮞ update()():void

重新渲染当前控件。

返回值

类型：void

继承自

Control

重新渲染当前控件。

Control

⮞ layout(changes)(changes:Changes):void

重新布局当前控件。

参数	类型	描述	默认值
`changes*`	`Changes`		—

返回值

类型：void

继承自

Control

重新布局当前控件。

Control

⮞ invalidate()():void

使当前控件无效并在下一帧重新渲染。

返回值

类型：void

继承自

Control

使当前控件无效并在下一帧重新渲染。

Control

⮞ renderTo(parent, ...)(parent:Control | Node, refChild?:Control | Node):void

将当前控件渲染到指定的父控件或节点。

参数	类型	描述	默认值
`parent*`	`Control \| Node`		—
`refChild`	`Control \| Node`		—

返回值

类型：void

继承自

Control

将当前控件渲染到指定的父控件或节点。

Control

⮞ find(selector)(selector:string):Control | HTMLElement

在当前控件查找指定的子控件或节点。

参数	类型	描述	默认值
`selector*`	`string`		—

返回值

类型：Control | HTMLElement

返回子控件或节点。如果找不到则返回 null。

继承自

Control

在当前控件查找指定的子控件或节点。

Control

⮞ query(selector)(selector:string):(Control | HTMLElement)[]

在当前控件查找匹配的所有子控件或节点。

参数	类型	描述	默认值
`selector*`	`string`		—

返回值

类型：(Control | HTMLElement)[]

返回子控件或节点列表。

继承自

Control

在当前控件查找匹配的所有子控件或节点。

Control

ListBox 类

继承自：List

表示一个列表框。

字段	类型	描述	继承自
⮞ `onSelect` : `(item: ListItem, e: UIEvent, sender: ListBox) => boolean \| void` 即将选中事件。	`function`	即将选中事件。	—
⮞ `keyMappings` : `KeyPressOptions` (只读)获取键盘绑定。	`KeyPressOptions`	(只读)获取键盘绑定。	—
⮞ `value` : `any` (已覆盖)值。继承自 `List`	`any`	(已覆盖)值。	`List`
⮞ `readOnly` : `boolean` (已覆盖)是否只读。继承自 `Input`	`boolean`	(已覆盖)是否只读。	`Input`
⮞ `disabled` : `boolean` (已覆盖)是否禁用。继承自 `Input`	`boolean`	(已覆盖)是否禁用。	`Input`
⮞ `body` : `HTMLElement` (已覆盖)(只读)获取用于包含子控件和节点的根元素。继承自 `Input`	`HTMLElement`	(已覆盖)(只读)获取用于包含子控件和节点的根元素。	`Input`
⮞ `items` : `ListItem[]` 所有项。继承自 `List`	`ListItem[]`	所有项。	`List`
⮞ `selectedItem` : `ListItem` 选中的第一项。继承自 `List`	`ListItem`	选中的第一项。	`List`
⮞ `selectedIndex` : `number` 选中的第一项的索引。继承自 `List`	`number`	选中的第一项的索引。	`List`
⮞ `input` : `HTMLInputElement` (只读)内部关联的输入框元素。继承自 `Input`	`HTMLInputElement`	(只读)内部关联的输入框元素。	`Input`
⮞ `name` : `string` 名字。继承自 `Input`	`string`	名字。	`Input`
⮞ `defaultValue` : `any` 默认值。继承自 `Input`	`any`	默认值。	`Input`
⮞ `type` : `string` 输入框的类型。继承自 `Input`	`string`	输入框的类型。	`Input`
⮞ `placeholder` : `string` 未输入内容时的占位符。继承自 `Input`	`string`	未输入内容时的占位符。	`Input`
⮞ `tabIndex` : `number` TAB 键切换顺序。继承自 `Input`	`number`	TAB 键切换顺序。	`Input`
⮞ `tabStop` : `boolean` 是否允许 TAB 键停靠。继承自 `Input`	`boolean`	是否允许 TAB 键停靠。	`Input`
⮞ `onCopy` : `(e: ClipboardEvent, sender: ListBox) => void` 复制事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oncopy 继承自 `Input`	`function`	复制事件。	`Input`
⮞ `onCut` : `(e: ClipboardEvent, sender: ListBox) => void` 剪切事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oncut 继承自 `Input`	`function`	剪切事件。	`Input`
⮞ `onPaste` : `(e: ClipboardEvent, sender: ListBox) => void` 粘贴事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpaste 继承自 `Input`	`function`	粘贴事件。	`Input`
⮞ `onBeforeCopy` : `(e: ClipboardEvent, sender: ListBox) => void` 即将复制事件。参考 https://msdn.microsoft.com/zh-cn/library/aa769320.ASPX 继承自 `Input`	`function`	即将复制事件。	`Input`
⮞ `onBeforeCut` : `(e: ClipboardEvent, sender: ListBox) => void` 即将剪切事件。参考 https://msdn.microsoft.com/zh-cn/library/aa769321.aspx 继承自 `Input`	`function`	即将剪切事件。	`Input`
⮞ `onBeforePaste` : `(e: ClipboardEvent, sender: ListBox) => void` 即将粘贴事件。参考 https://msdn.microsoft.com/zh-cn/library/aa769324.aspx 继承自 `Input`	`function`	即将粘贴事件。	`Input`
⮞ `onFocus` : `(e: FocusEvent, sender: ListBox) => void` 获取焦点事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/nfocus 继承自 `Input`	`function`	获取焦点事件。	`Input`
⮞ `onBlur` : `(e: FocusEvent, sender: ListBox) => void` 失去焦点事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onblur 继承自 `Input`	`function`	失去焦点事件。	`Input`
⮞ `onFocusIn` : `(e: FocusEvent, sender: ListBox) => void` 当前元素和子元素获取焦点事件。参考 https://msdn.microsoft.com/zh-CN/library/ms536935(VS.85).aspx 继承自 `Input`	`function`	当前元素和子元素获取焦点事件。	`Input`
⮞ `onFocusOut` : `(e: FocusEvent, sender: ListBox) => void` 当前元素和子元素失去焦点事件。参考 https://msdn.microsoft.com/zh-CN/library/ms536936(VS.85).aspx 继承自 `Input`	`function`	当前元素和子元素失去焦点事件。	`Input`
⮞ `onInput` : `(e: Event, sender: ListBox) => void` 输入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oninput 继承自 `Input`	`function`	输入事件。	`Input`
⮞ `onChange` : `(e: Event, sender: ListBox) => void` 更改事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlersonchange 继承自 `Input`	`function`	更改事件。	`Input`
⮞ `onKeyDown` : `(e: KeyboardEvent, sender: ListBox) => void` 键盘按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onkeydown 继承自 `Input`	`function`	键盘按下事件。	`Input`
⮞ `onKeyPress` : `(e: KeyboardEvent, sender: ListBox) => void` 键盘点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onkeypress 继承自 `Input`	`function`	键盘点击事件。	`Input`
⮞ `onKeyUp` : `(e: KeyboardEvent, sender: ListBox) => void` 键盘按上事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onkeyup 继承自 `Input`	`function`	键盘按上事件。	`Input`
⮞ `onEnter` : `(e: KeyboardEvent, sender: ListBox) => void` 回车事件。继承自 `Input`	`function`	回车事件。	`Input`
⮞ `status` : `Status` 控件状态。继承自 `Input`	`Status`	控件状态。	`Input`
⮞ `statusClassPrefix` : `string` 控件状态前缀。继承自 `Input`	`string`	控件状态前缀。	`Input`
⮞ `hideSuccess` : `boolean` 是否隐藏验证成功状态。继承自 `Input`	`boolean`	是否隐藏验证成功状态。	`Input`
⮞ `noValidate` : `boolean` 是否禁用验证。继承自 `Input`	`boolean`	是否禁用验证。	`Input`
⮞ `validateEvent` : `string` 触发验证的事件。继承自 `Input`	`string`	触发验证的事件。	`Input`
⮞ `required` : `boolean` 字段是否必填。继承自 `Input`	`boolean`	字段是否必填。	`Input`
⮞ `requiredMessage` : `string` 字段不满足必填时的提示文案。继承自 `Input`	`string`	字段不满足必填时的提示文案。	`Input`
⮞ `maxLength` : `number` 最大长度。-1 表示不限制。继承自 `Input`	`number`	最大长度。-1 表示不限制。	`Input`
⮞ `maxLengthMessage` : `string` 字段不满足最大长度时的提示文案。继承自 `Input`	`string`	字段不满足最大长度时的提示文案。	`Input`
⮞ `minLength` : `number` 最小长度。-1 表示不限制。继承自 `Input`	`number`	最小长度。-1 表示不限制。	`Input`
⮞ `minLengthMessage` : `string` 字段不满足最小长度时的提示文案。继承自 `Input`	`string`	字段不满足最小长度时的提示文案。	`Input`
⮞ `max` : `any` 最大值。继承自 `Input`	`any`	最大值。	`Input`
⮞ `maxMessage` : `string` 字段不满足最大值时的提示文案。继承自 `Input`	`string`	字段不满足最大值时的提示文案。	`Input`
⮞ `min` : `any` 最小值。继承自 `Input`	`any`	最小值。	`Input`
⮞ `minMessage` : `string` 字段不满足最小值时的提示文案。继承自 `Input`	`string`	字段不满足最小值时的提示文案。	`Input`
⮞ `pattern` : `RegExp` 匹配格式的正则表达式。继承自 `Input`	`RegExp`	匹配格式的正则表达式。	`Input`
⮞ `patternMessage` : `string` 字段不满足格式时的提示文案。继承自 `Input`	`string`	字段不满足格式时的提示文案。	`Input`
⮞ `validateErrorMessage` : `string` 验证失败的提示文案。继承自 `Input`	`string`	验证失败的提示文案。	`Input`
⮞ `validateStartMessage` : `string` 开始异步验证的提示文案。继承自 `Input`	`string`	开始异步验证的提示文案。	`Input`
⮞ `validateStartMessagePrefix` : `string` 开始异步验证的提示文案前缀。继承自 `Input`	`string`	开始异步验证的提示文案前缀。	`Input`
⮞ `validateInfoMessagePrefix` : `string` 验证信息状态的提示文案前缀。继承自 `Input`	`string`	验证信息状态的提示文案前缀。	`Input`
⮞ `validateErrorMessagePrefix` : `string` 验证失败状态的提示文案前缀。继承自 `Input`	`string`	验证失败状态的提示文案前缀。	`Input`
⮞ `validateWarningMessagePrefix` : `string` 验证警告状态的提示文案前缀。继承自 `Input`	`string`	验证警告状态的提示文案前缀。	`Input`
⮞ `validateSuccessMessagePrefix` : `string` 验证成功状态的提示文案前缀。继承自 `Input`	`string`	验证成功状态的提示文案前缀。	`Input`
⮞ `willValidate` : `boolean` (只读)判断当前输入域是否需要验证。继承自 `Input`	`boolean`	(只读)判断当前输入域是否需要验证。	`Input`
⮞ `validateDelay` : `number` 验证事件触发后延时验证的毫秒数。继承自 `Input`	`number`	验证事件触发后延时验证的毫秒数。	`Input`
⮞ `revalidateDelay` : `number` 重新验证事件触发后延时验证的毫秒数。继承自 `Input`	`number`	重新验证事件触发后延时验证的毫秒数。	`Input`
⮞ `onValidate` : `(value: any, sender: ListBox) => ValidityResult` 验证事件。继承自 `Input`	`function`	验证事件。	`Input`
⮞ `onReportValidity` : `(validityResult: NormalizedValidityResult, sender: ListBox) => boolean \| void` 报告验证结果事件。继承自 `Input`	`function`	报告验证结果事件。	`Input`
⮞ `validityToolTipOptions` : `Partial<ToolTip>` 验证工具提示的选项。继承自 `Input`	`Partial<ToolTip>`	验证工具提示的选项。	`Input`
⮞ `readyState` : `ControlState` 获取当前控件的渲染状态。继承自 `Control`	`ControlState`	获取当前控件的渲染状态。	`Control`
⮞ `elem` : `HTMLElement` 关联的元素。继承自 `Control`	`HTMLElement`	关联的元素。	`Control`
⮞ `vNode` : `VNode` (保护的)获取当前控件关联的虚拟节点。继承自 `Control`	`VNode`	(保护的)获取当前控件关联的虚拟节点。	`Control`
⮞ `sourceVNode` : `VNode` 获取创建该控件使用的源虚拟节点。继承自 `Control`	`VNode`	获取创建该控件使用的源虚拟节点。	`Control`
⮞ `alwaysUpdate` : `boolean` 控件是否使用主动更新模式。继承自 `Control`	`boolean`	控件是否使用主动更新模式。	`Control`
⮞ `duration` : `number` = `200` 渐变的持续毫秒数。如果为 0 则不使用渐变。继承自 `Control`	`number`	渐变的持续毫秒数。如果为 0 则不使用渐变。	`Control`
⮞ `class` : `string` CSS 类名。继承自 `Control`	`string`	CSS 类名。	`Control`
⮞ `hidden` : `boolean` 是否隐藏。继承自 `Control`	`boolean`	是否隐藏。	`Control`
⮞ `style` : `string \| { [key: string]: string \| number; }` 控件样式。继承自 `Control`	`string \| object`	控件样式。	`Control`
⮞ `id` : `string` 控件序号。继承自 `Control`	`string`	控件序号。	`Control`
⮞ `content` : `NodeLike` 控件内容。继承自 `Control`	`NodeLike`	控件内容。	`Control`
⮞ `onSelectStart` : `(e: Event, sender: ListBox) => void` 选择开始事件。参考 https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onselectstart 继承自 `Control`	`function`	选择开始事件。	`Control`
⮞ `onClick` : `(e: MouseEvent, sender: ListBox) => void` 点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onclick 继承自 `Control`	`function`	点击事件。	`Control`
⮞ `onAuxClick` : `(e: MouseEvent, sender: ListBox) => void` 中键点击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onauxclick 继承自 `Control`	`function`	中键点击事件。	`Control`
⮞ `onDblClick` : `(e: MouseEvent, sender: ListBox) => void` 双击事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ondblclick 继承自 `Control`	`function`	双击事件。	`Control`
⮞ `onContextMenu` : `(e: PointerEvent, sender: ListBox) => void` 右键菜单事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/oncontextmenu 继承自 `Control`	`function`	右键菜单事件。	`Control`
⮞ `onMouseDown` : `(e: MouseEvent, sender: ListBox) => void` 鼠标按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmousedown 继承自 `Control`	`function`	鼠标按下事件。	`Control`
⮞ `onMouseUp` : `(e: MouseEvent, sender: ListBox) => void` 鼠标按上事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseup 继承自 `Control`	`function`	鼠标按上事件。	`Control`
⮞ `onMouseOver` : `(e: MouseEvent, sender: ListBox) => void` 鼠标移入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseover 继承自 `Control`	`function`	鼠标移入事件。	`Control`
⮞ `onMouseOut` : `(e: MouseEvent, sender: ListBox) => void` 鼠标移开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseout 继承自 `Control`	`function`	鼠标移开事件。	`Control`
⮞ `onMouseEnter` : `(e: MouseEvent, sender: ListBox) => void` 鼠标进入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseenter 继承自 `Control`	`function`	鼠标进入事件。	`Control`
⮞ `onMouseLeave` : `(e: MouseEvent, sender: ListBox) => void` 鼠标离开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmouseleave 继承自 `Control`	`function`	鼠标离开事件。	`Control`
⮞ `onMouseMove` : `(e: MouseEvent, sender: ListBox) => void` 鼠标移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onmousemove 继承自 `Control`	`function`	鼠标移动事件。	`Control`
⮞ `onWheel` : `(e: WheelEvent, sender: ListBox) => void` 鼠标滚轮事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/Events/wheel 继承自 `Control`	`function`	鼠标滚轮事件。	`Control`
⮞ `onScroll` : `(e: UIEvent, sender: ListBox) => void` 滚动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onscroll 继承自 `Control`	`function`	滚动事件。	`Control`
⮞ `onTouchStart` : `(e: TouchEvent, sender: ListBox) => void` 触摸开始事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchstart 继承自 `Control`	`function`	触摸开始事件。	`Control`
⮞ `onTouchMove` : `(e: TouchEvent, sender: ListBox) => void` 触摸移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchmove 继承自 `Control`	`function`	触摸移动事件。	`Control`
⮞ `onTouchEnd` : `(e: TouchEvent, sender: ListBox) => void` 触摸结束事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchend 继承自 `Control`	`function`	触摸结束事件。	`Control`
⮞ `onTouchCancel` : `(e: TouchEvent, sender: ListBox) => void` 触摸撤销事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ontouchcancel 继承自 `Control`	`function`	触摸撤销事件。	`Control`
⮞ `onPointerEnter` : `(e: PointerEvent, sender: ListBox) => void` 指针进入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerenter 继承自 `Control`	`function`	指针进入事件。	`Control`
⮞ `onPointerLeave` : `(e: PointerEvent, sender: ListBox) => void` 指针离开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerleave 继承自 `Control`	`function`	指针离开事件。	`Control`
⮞ `onPointerOver` : `(e: PointerEvent, sender: ListBox) => void` 指针移入事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerover 继承自 `Control`	`function`	指针移入事件。	`Control`
⮞ `onPointerOut` : `(e: PointerEvent, sender: ListBox) => void` 指针移开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerout 继承自 `Control`	`function`	指针移开事件。	`Control`
⮞ `onPointerDown` : `(e: PointerEvent, sender: ListBox) => void` 指针按下事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerdown 继承自 `Control`	`function`	指针按下事件。	`Control`
⮞ `onPointerMove` : `(e: PointerEvent, sender: ListBox) => void` 指针移动事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointermove 继承自 `Control`	`function`	指针移动事件。	`Control`
⮞ `onPointerUp` : `(e: PointerEvent, sender: ListBox) => void` 指针松开事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointerup 继承自 `Control`	`function`	指针松开事件。	`Control`
⮞ `onPointerCancel` : `(e: PointerEvent, sender: ListBox) => void` 指针取消事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onpointercancel 继承自 `Control`	`function`	指针取消事件。	`Control`
⮞ `onGotPointerCapture` : `(e: PointerEvent, sender: ListBox) => void` 指针开始捕获事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/ongotpointercapture 继承自 `Control`	`function`	指针开始捕获事件。	`Control`
⮞ `onLostPointerCapture` : `(e: PointerEvent, sender: ListBox) => void` 指针停止捕获事件。参考 https://developer.mozilla.org/zh-CN/docs/Web/API/GlobalEventHandlers/onlostpointercapture 继承自 `Control`	`function`	指针停止捕获事件。	`Control`

方法描述继承自

⮞ handleItemClick(e, item)(e:MouseEvent, item:HTMLElement):void

(保护的)处理项点击事件。

参数	类型	描述	默认值
`e*`	`MouseEvent`		—
`item*`	`HTMLElement`		—

返回值

类型：void

(保护的)处理项点击事件。

—

⮞ select(item, ...)(item:string | Control | VNode | Node | ListItem, e?:UIEvent):void

选中项。

参数	类型	描述	默认值
`item*`	`string \| Control \| VNode \| Node \| ListItem`		—
`e`	`UIEvent`		—

返回值

类型：void

选中项。

—

⮞ init()():void

(保护的)

返回值

类型：void

继承自

List

(保护的)(已覆盖)当被子类重写时负责在关联元素后初始化当前控件。

List

⮞ render()():VNode

(保护的)

返回值

类型：VNode

继承自

Control

(保护的)当被子类重写时负责返回当前控件的虚拟节点。

Control

⮞ findItemByKey(key)(key:string):ListItem

获取指定键对应的项。

参数	类型	描述	默认值
`key*`	`string`		—

返回值

类型：ListItem

返回匹配的第一个项。如果不存在则返回 undefined。

继承自

List

获取指定键对应的项。

List

⮞ findItemByContent(content)(content:string):ListItem

获取指定内容对应的项。

参数	类型	描述	默认值
`content*`	`string`		—

返回值

类型：ListItem

返回匹配的第一个项。如果不存在则返回 undefined。

继承自

List

获取指定内容对应的项。

List

⮞ isHidden()():boolean

判断输入域样式是否被隐藏。

返回值

类型：boolean

如果控件或其父元素被隐藏则返回 true，否则返回 false。

继承自

Input

判断输入域样式是否被隐藏。

Input

⮞ handleValidateEvent()():void

(保护的)处理验证事件。

返回值

类型：void

继承自

Input

(保护的)处理验证事件。

Input

⮞ checkValidity()():NormalizedValidityResult | Promise<NormalizedValidityResult>

验证当前输入域。

返回值

类型：NormalizedValidityResult | Promise<NormalizedValidityResult>

返回验证结果。如果正在执行异步验证则返回一个确认对象。

继承自

Input

验证当前输入域。

Input

⮞ validate(value)(value:this["value"]):ValidityResult

(保护的)当被子类重写时负责验证指定的值。

参数	类型	描述	默认值
`value*`	`this["value"]`		—

返回值

类型：ValidityResult

返回验证结果。如果正在执行异步验证则返回一个确认对象。

继承自

Input

(保护的)当被子类重写时负责验证指定的值。

Input

⮞ normlizeValidityResult(r)(r:ValidityResult):NormalizedValidityResult | Promise<NormalizedValidityResult>

(保护的)规范化验证结果对象。

参数	类型	描述	默认值
`r*`	`ValidityResult`		—

返回值

类型：NormalizedValidityResult | Promise<NormalizedValidityResult>

继承自

Input

(保护的)规范化验证结果对象。

Input

⮞ reportValidity()():NormalizedValidityResult | Promise<NormalizedValidityResult>

向用户报告验证结果。

返回值

类型：NormalizedValidityResult | Promise<NormalizedValidityResult>

返回验证结果。如果正在执行异步验证则返回一个确认对象。

继承自

Input

向用户报告验证结果。

Input

⮞ setCustomValidity(validityResult)(validityResult:string | boolean | Partial<NormalizedValidityResult>):void

设置自定义的验证消息。

参数	类型	描述	默认值
`validityResult*`	`string \| boolean \| Partial<NormalizedValidityResult>`		—

返回值

类型：void

继承自

Input

设置自定义的验证消息。

Input

⮞ createValidityToolTip()():ToolTip

(保护的)当被子类重写时负责创建当前输入框的默认验证提示。

返回值

类型：ToolTip

继承自

Input

(保护的)当被子类重写时负责创建当前输入框的默认验证提示。

Input

⮞ reset()():void

重置当前输入域。

返回值

类型：void

继承自

Input

重置当前输入域。

Input

⮞ focus()():void

令当前控件获得焦点。

返回值

类型：void

继承自

Input

令当前控件获得焦点。

Input

⮞ blur()():void

令当前控件失去焦点。

返回值

类型：void

继承自

Input

令当前控件失去焦点。

Input

⮞ layout(changes)(changes:Changes):void

参数	类型	描述	默认值
`changes*`	`Changes`		—

返回值

类型：void

继承自

Control

重新布局当前控件。

Control

⮞ uninit()():void

(保护的)当被子类重写时负责在元素被取消关联前取消初始化当前控件。

返回值

类型：void

继承自

Control

(保护的)当被子类重写时负责在元素被取消关联前取消初始化当前控件。

Control

⮞ update()():void

重新渲染当前控件。

返回值

类型：void

继承自

Control

重新渲染当前控件。

Control

⮞ invalidate()():void

使当前控件无效并在下一帧重新渲染。

返回值

类型：void

继承自

Control

使当前控件无效并在下一帧重新渲染。

Control

⮞ renderTo(parent, ...)(parent:Control | Node, refChild?:Control | Node):void

将当前控件渲染到指定的父控件或节点。

参数	类型	描述	默认值
`parent*`	`Control \| Node`		—
`refChild`	`Control \| Node`		—

返回值

类型：void

继承自

Control

将当前控件渲染到指定的父控件或节点。

Control

⮞ find(selector)(selector:string):Control | HTMLElement

在当前控件查找指定的子控件或节点。

参数	类型	描述	默认值
`selector*`	`string`		—

返回值

类型：Control | HTMLElement

返回子控件或节点。如果找不到则返回 null。

继承自

Control

在当前控件查找指定的子控件或节点。

Control

⮞ query(selector)(selector:string):(Control | HTMLElement)[]

在当前控件查找匹配的所有子控件或节点。

参数	类型	描述	默认值
`selector*`	`string`		—

返回值

类型：(Control | HTMLElement)[]

返回子控件或节点列表。

继承自

Control

在当前控件查找匹配的所有子控件或节点。

Control

☍列表框ui/listBox

☍基本用法

☍样式

☍基本样式

☍状态

☍API

☍⅏List 类

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

参考

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

继承自

列表框ui/listBox

基本用法

样式

基本样式

状态

API

List 类