主题
BrowserContextMenu 继承自:Service, BaseControl
控制 Web 平台上浏览器的上下文菜单。
上下文菜单是指例如在浏览器中右键单击或选中文本时弹出的菜单。
在 Web 平台上,默认情况下浏览器上下文菜单是启用的,而 Flet 的上下文菜单是隐藏的。
在所有非 Web 平台上,本服务不执行任何操作。
示例
python
#
# Run this example as a web app using the command:
#
# flet run --web main.py
#
import flet as ft
async def main(page: ft.Page):
bcm = ft.BrowserContextMenu()
async def disable_context_menu():
await bcm.disable()
async def enable_context_menu():
await bcm.enable()
page.add(
ft.SafeArea(
content=ft.Column(
controls=[
ft.Button(
"Disable browser context menu",
on_click=disable_context_menu,
),
ft.Button(
"Enable browser context menu",
on_click=enable_context_menu,
),
],
),
)
)
if __name__ == "__main__":
ft.run(main)属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
data | Any | skip_ | 任意类型的自定义数据。 |
key | Optional['KeyValue'] | None | 用于在更新之间保持控件标识稳定的键。 |
只读属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
disabled | — | — | 当前是否已请求禁用浏览器上下文菜单。 此标志由本服务实例维护:- 初始化为 False;- 调用 disable 后设为 True;- 调用 enable 后设为 False。 注意: 在非 Web 平台上,浏览器上下文菜单控制并不适用,但此属性仍会反映最近一次请求的状态。 |
parent | Optional['BaseControl'] | — | 此控件的直接祖先(父级)。 默认为 None,只有在此控件被挂载(加入页面树)后才有值。 Page 控件(页面树的根)是个例外 —— 它的 parent 始终为 None。 |
page | 'Page' | — | 此控件所属的页面。 |
方法
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
enable | — | — | 启用浏览器的上下文菜单。 默认情况下,应用启动时浏览器的上下文菜单已经是启用的。 |
disable | — | — | 禁用浏览器的上下文菜单。 默认情况下,应用启动时浏览器的上下文菜单已经是启用的。 |
init | — | — | — |
is_isolated | — | — | 返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外,并需要自行管理更新边界。 |
build | — | — | 在控件初始化期间调用一次,用于定义其子控件。在此方法中 page 属性可用。 |
before_update | — | — | 每当此控件被更新时都会调用此方法。 注意: 务必不要在此处调用或请求 update()。 |
before_event | — | — | 在事件处理器执行之前拦截事件。 返回 False 可取消分发。返回 True 或 None 则继续正常的事件处理。 |
did_mount | — | — | 在控件挂载到页面树之后调用。 重写此方法以启动需要已挂载页面的资源,例如订阅、定时器或服务监听器。 |
will_unmount | — | — | 在控件从页面树移除之前调用。 重写此方法以释放 did_mount() 中创建的资源,例如订阅、定时器或外部句柄。 |
get_data_channel | — | — | 解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式: on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel,因此重复调用会返回同一实例。没有错误路径:该 id 始终来自框架触发的事件,所以当此方法运行时,通道在两端都已存在。 |
update | None | — | 为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。 |