ToolboxCategory 类
用于工具箱中类别的类。
Signature:
export declare class ToolboxCategory extends ToolboxItem implements ISelectableToolboxItem
扩展:ToolboxItem
构造函数
构造函数 | 修饰符 | 说明 |
---|---|---|
(constructor)(categoryDef, parentToolbox, opt_parent) | 构造 ToolboxCategory 类的新实例 |
属性
属性 | 修饰符 | 类型 | 说明 |
---|---|---|---|
borderWidth | static |
number | 每个类别旁的色带的宽度(以像素为单位)。 |
colour_ | protected |
字符串 | 类别的颜色。 |
cssConfig_ | protected |
CssConfig | |
defaultBackgroundColour | static |
字符串 | 类别的默认颜色。此颜色将用作所选类别的背景颜色。 |
flyoutItems_ | protected |
字符串 | FlyoutItemInfoArray | 此类别的展开式菜单项。 |
htmlDiv_ | protected |
HTMLDivElement | null | 相应类别的 HTML 容器。 |
iconDom_ | protected |
元素 |null | 工具箱图标的 HTML 元素。 |
isDisabled_ | protected |
布尔值 | 如果此类别已停用,则为 true;否则为 false。 |
isHidden_ | protected |
布尔值 | 如果要隐藏类别,则为 true,否则为 false。 |
labelDom_ | protected |
元素 |null | 工具箱标签的 HTML 元素。 |
name_ | protected |
字符串 | 将在该类别中显示的名称。 |
nestedPadding | static |
number | 在每个嵌套级别上移动类别的像素数。 |
registrationName | static |
字符串 | 用于注册工具箱类别的名称。 |
rowContents_ | protected |
HTMLDivElement | null | 包含类别行子元素的 HTML 元素。 |
rowDiv_ | protected |
HTMLDivElement | null | 类别行的 HTML 元素。 |
toolboxItemDef_ | CategoryInfo |
方法
方法 | 修饰符 | 说明 |
---|---|---|
addColourBorder_(colour) | protected |
为工具箱类别添加颜色条。 |
allAncestorsExpanded_() | protected |
类别的所有祖先(父级和父级的父级等)是否处于展开状态。 |
closeIcon_(iconDiv) | protected |
添加了适当的类来显示已关闭的图标。 |
createContainer_() | protected |
创建包含该行及其任何子类别的容器。 |
createDom_() | protected |
为类别创建 DOM。 |
createIconDom_() | protected |
创建包含类别图标的 span。 |
createLabelDom_(name) | protected |
创建用于包含类别标签的 span。此元素应具有 ID,以便实现无障碍功能。 |
createRowContainer_() | protected |
创建内容容器的父级。所有点击都发生在此 div 上。 |
createRowContentsContainer_() | protected |
为标签和图标创建容器。这样做是为了让我们能够将所有子类别指针事件都设为“无”。 |
dispose() | ||
getClickTarget() | 获取可点击的 HTML 元素。父级工具箱元素会收到点击。父级工具箱将向此元素添加一个 ID,以便将 onClick 事件传递给正确的 toolboxItem。 | |
getColour_(categoryDef) | protected |
获取类别的颜色或样式。 |
getContents() | 获取相应类别的内容。这些项目旨在显示在浮出控件中。 | |
getDiv() | ||
getName() | 获取类别的名称。用于发送事件。 | |
getParent() | ||
hide() | 隐藏相应类别。 | |
init() | 初始化工具箱项。这包括创建 DOM 并根据 info 对象更新任何项的状态。应在构建 Toolbox 项后立即调用 init,以确保正确解析类别内容。 | |
isSelectable() | ||
isVisible() | 类别是否可见。仅当某个类别的所有祖先均处于展开状态且 isHidden_ 为 false 时,该类别才可见。 | |
makeDefaultCssConfig_() | protected |
创建一个对象,其中包含某个类别的默认类。 |
onClick(_e) | 处理点击工具箱项的时间。 | |
openIcon_(iconDiv) | protected |
添加了适当的类以显示打开图标。 |
parseCategoryDef_(categoryDef) | protected |
解析类别 def 的非内容部分。 |
parseContents_(categoryDef) | protected |
根据类别是动态类别还是其内容应显示在弹出式菜单中,解析内容数组。 |
refreshTheme() | 更新此类别的颜色。 | |
setDisabled(isDisabled) | 设置类别是否已停用。 | |
setSelected(isSelected) | 将当前类别设为已选。 | |
setVisible_(isVisible) | 设置类别是否可见。若要显示某个类别,其父类别也必须展开。 | |
show() | 显示类别。仅当其父类别也已展开时,才会显示此类别。 | |
updateFlyoutContents(contents) | 更新要在浮出控件中显示的内容。如果在更新内容时展开式菜单处于打开状态,则还必须调用工具箱上的 refreshSelection。 |