KToolWidget
kds-plugin-document / Exports / KToolWidget
Interface: KToolWidget
二级工具栏工具控件
Secondary tool widget
Hierarchy
↳
KToolWidget
Table of contents
Methods
- getClickListener
- getId
- getSubTools
- getToolKey
- getType
- getVisible
- remove
- setClickListener
- setSubTools
- setVisible
Methods
getClickListener
▸ getClickListener(): KClickListener
获取控件的点击监听器
Get the click listener of the widget
Returns
Inherited from
Defined in
api.d.ts:6886
getId
▸ getId(): string
获取控件的唯一标识符
Unique identifier for the widget
Returns
string
Inherited from
Defined in
api.d.ts:6871
getSubTools
▸ getSubTools(): KToolWidget[]
获取子工具项
Get sub-tools of the widget
Returns
当前的子工具项数组 (Current array of sub-tools)
Defined in
api.d.ts:5872
getToolKey
▸ getToolKey(): KSystemToolKey
获取工具标识
Get the tool key
Returns
Defined in
api.d.ts:5856
getType
▸ getType(): KWidgetIdentifier
获取控件的类型
Get the type of the widget
Returns
Inherited from
Defined in
api.d.ts:6863
getVisible
▸ getVisible(): boolean
获取是否可见
get visibility of the widget
Returns
boolean
Inherited from
Defined in
api.d.ts:6909
remove
▸ remove(): void
从界面中移除此控件
Remove this widget from the UI
Returns
void
Inherited from
Defined in
api.d.ts:6893
setClickListener
▸ setClickListener(listener?): void
设置点击监听器
Set the click listener for the widget
Parameters
| Name | Type | Description |
|---|---|---|
listener? | KClickListener | 可选的点击事件监听器 (Optional click event listener) |
Returns
void
Inherited from
Defined in
api.d.ts:6879
setSubTools
▸ setSubTools(subTools): Object
设置子工具项
Set sub-tools for the widget
Parameters
| Name | Type | Description |
|---|---|---|
subTools | KToolWidgetOption[] | 子工具项数组 (Array of sub-tools) |
Returns
Object
| Name | Type |
|---|---|
isSuccess | boolean |
Defined in
api.d.ts:5864
setVisible
▸ setVisible(visible): void
设置是否可见
Set the visibility of the widget
Parameters
| Name | Type |
|---|---|
visible | boolean |
Returns
void
Inherited from
Defined in
api.d.ts:6902