tinymce.editor.ui.Registry

TinyMCE UI 注册 API。

摘要

方法

方法

addAutocompleter()

addAutocompleter(name: String, obj: InlineContent.AutocompleterSpec)

注册一个新的自动补全器组件。当在内容中键入时匹配到配置的字符串模式，自动补全器将被触发。表情符号和字符映射表使用自动补全器。

有关创建自动补全器的信息，请参阅：UI 组件 - 自动补全器。

参数

• name (String) - 标识此自动补全配置的唯一名称。

• obj (InlineContent.AutocompleterSpec) - 自动补全配置对象。

addButton()

addButton(name: String, obj: Toolbar.ToolbarButtonSpec)

注册一个新的工具栏按钮，当点击或通过键盘导航控件激活时执行命令。

有关创建基本工具栏按钮的信息，请参阅：UI 组件 - 工具栏按钮的类型：基本按钮。

参数

• name (String) - 标识按钮的唯一名称，此按钮名称将在工具栏配置中用于引用该按钮。

• obj (Toolbar.ToolbarButtonSpec) - 按钮配置对象。

addContext()

addContext(name: String, pred: Function)

在注册表中注册一个新的上下文配置。注册表存储所有上下文配置。编辑器配置对象中的按钮可以包含一个上下文属性。这些按钮规范可以使用已注册的上下文来确定基于当前上下文启用或禁用按钮。

参数

• name (String) - 标识新上下文配置的唯一名称。

• pred (Function) - 一个用于确定上下文是否激活的谓词函数

addContextForm()

addContextForm(name: String, obj: Toolbar.ContextFormSpec)

注册一个新的上下文表单项。类似于上下文菜单项，上下文表单是在匹配内容谓词时出现的带有输入表单元素的项。上下文表单的一个例子是当使用配置{ link_context_toolbar: true }时的链接插件。当光标位于链接上时，会出现一个上下文输入表单，允许快速更改 url 字段。

有关创建上下文表单的信息，请参阅：UI 组件 - 上下文表单。

参数

• name (String) - 标识新上下文表单项的唯一名称。

• obj (Toolbar.ContextFormSpec) - 上下文表单配置对象。

addContextMenu()

addContextMenu(name: String, obj: Menu.ContextMenuSpec)

注册一个新的上下文菜单部分，只有当内容谓词匹配时才会出现，例如光标在表格内。

有关创建上下文菜单的信息，请参阅：UI 组件 - 上下文菜单。

参数

• name (String) - 标识新上下文菜单的唯一名称。

• obj (Menu.ContextMenuSpec) - 上下文菜单配置对象。

addContextToolbar()

addContextToolbar(name: String, obj: Toolbar.ContextToolbarSpec)

注册一个新的上下文工具栏，只有当内容谓词匹配时才会出现，例如光标在图像元素上。

有关创建上下文工具栏的信息，请参阅：UI 组件 - 上下文工具栏。

参数

• name (String) - 标识新上下文工具栏的唯一名称。

• obj (Toolbar.ContextToolbarSpec) - 上下文菜单配置对象。

addGroupToolbarButton()

addGroupToolbarButton(name: String, obj: Toolbar.GroupToolbarButtonSpec)

为工具栏注册一个新的分组工具栏按钮。渲染一个工具栏按钮，点击时会打开一个浮动工具栏。

注意： 分组工具栏按钮只能在使用浮动工具栏模式时使用。

有关创建分组工具栏按钮的信息，请参阅：UI 组件 - 工具栏按钮的类型：分组工具栏按钮。

参数

• name (String) - 用于标识新分组工具栏按钮的唯一名称。

• obj (Toolbar.GroupToolbarButtonSpec) - 分组工具栏按钮的配置对象。

addIcon()

addIcon(name: String, svgData: String)

注册一个新的SVG图标。图标名称引用可以由任何能够显示图标的TinyMCE UI组件配置。该图标仅对配置它的编辑器实例可用。

示例

// To add a simple triangle icon:
editor.ui.registry.addIcon('triangleUp', '<svg height="24" width="24"><path d="M12 0 L24 24 L0 24 Z" /></svg>');

参数

• name (String) - 用于标识新图标的唯一名称。

• svgData (String) - 浏览器将用于渲染SVG图标的SVG数据字符串。

addMenuButton()

addMenuButton(name: String, obj: Toolbar.ToolbarMenuButtonSpec)

注册一个新的菜单按钮。添加一个工具栏按钮，点击时会打开一个菜单。菜单可以通过由addMenuItem、addNestedMenuItem或addToggleMenuItem创建的项来填充。

有关创建工具栏菜单按钮的信息，请参阅：UI 组件 - 工具栏按钮的类型：菜单按钮。

参数

• name (String) - 用于标识新菜单按钮的唯一名称。

• obj (Toolbar.ToolbarMenuButtonSpec) - 菜单按钮的配置对象。

addMenuItem()

addMenuItem(name: String, obj: Menu.MenuItemSpec)

注册一个新的菜单项，当点击或通过键盘导航控件激活时执行命令。

有关创建基本菜单项的信息，请参阅：UI 组件 - 自定义菜单项：基本菜单项。

参数

• name (String) - 用于标识新菜单项的唯一名称。

• obj (Menu.MenuItemSpec) - 菜单项的配置对象。

addNestedMenuItem()

addNestedMenuItem(name: String, obj: Menu.NestedMenuItemSpec)

注册一个新的菜单项，当点击或通过键盘导航控件激活时会显示一个子菜单。子菜单可以通过由addMenuItem、addNestedMenuItem或addToggleMenuItem创建的项来填充。

有关创建嵌套菜单项的信息，请参阅：UI 组件 - 自定义菜单项：嵌套菜单项。

参数

• name (String) - 用于标识新嵌套菜单项的唯一名称。

• obj (Menu.NestedMenuItemSpec) - 嵌套菜单项的配置对象。

addSidebar()

addSidebar(name: String, obj: Sidebar.SidebarSpec)

注册一个新的侧边栏容器。这个侧边栏容器附加在编辑器的右侧，可以切换打开或关闭。注册时，会创建一个新的具有相同侧边栏名称的工具栏切换按钮。此外，还有一个ToggleSidebar命令和一个'ToggleSidebar'事件，可用于管理侧边栏的打开/关闭状态。TinyComments插件使用侧边栏来显示其UI组件。

有关创建自定义侧边栏的信息，请参阅：UI 组件 - 自定义侧边栏。

参数

• name (String) - 用于标识新侧边栏的唯一名称。

• obj (Sidebar.SidebarSpec) - 侧边栏的配置对象。

addSplitButton()

addSplitButton(name: String, obj: Toolbar.ToolbarSplitButtonSpec)

为工具栏注册一个新的拆分按钮。列表样式插件使用拆分按钮来简化其功能。

有关创建拆分工具栏按钮的信息，请参阅：UI 组件 - 工具栏按钮的类型：拆分按钮。

参数

• name (String) - 用于标识新拆分按钮的唯一名称。

• obj (Toolbar.ToolbarSplitButtonSpec) - 拆分按钮的配置对象。

addToggleButton()

addToggleButton(name: String, obj: Toolbar.ToolbarToggleButtonSpec)

为工具栏注册一个新的切换按钮。切换按钮的状态可以在配置中设置。

有关创建切换工具栏按钮的信息，请参阅：UI 组件 - 工具栏按钮的类型：切换按钮。

参数

• name (String) - 用于标识新拆分按钮的唯一名称。

• obj (Toolbar.ToolbarToggleButtonSpec) - 切换按钮的配置对象。

addToggleMenuItem()

addToggleMenuItem(name: String, obj: Menu.ToggleMenuItemSpec)

注册一个新的菜单项，该菜单项将作为切换按钮使用，会在菜单项中显示一个选中标记以表示状态。

有关创建切换菜单项的信息，请参阅：UI 组件 - 自定义菜单项：切换菜单项。

参数

• name (String) - 用于唯一标识新菜单项的名称。

• obj (Menu.ToggleMenuItemSpec) - 菜单项的配置对象。

addView()

addView(name: String, obj: View.ViewSpec)

注册一个新的视图容器。此视图容器默认是隐藏（关闭）的，并附加在主视图旁边。它可以被切换显示或隐藏。当它处于开启状态时，主编辑器视图会被隐藏，特定的视图会被显示。当它处于关闭状态时，特定的视图会被隐藏，主视图会被显示。此外还有一个 ToggleView 命令。该命令可以切换视图的可见性。还可以查询该命令的当前状态。

有关创建自定义视图的信息，请参阅：UI 组件 - 自定义视图。

参数

• name (String) - 用于唯一标识新视图的名称。

• obj (View.ViewSpec) - 视图的配置对象。