ToolboxCategory 类
用于工具箱中的类别的类。
Signature:
export declare class ToolboxCategory extends ToolboxItem implements ISelectableToolboxItem
扩展:ToolboxItem
构造函数
构造函数 | 修饰符 | 说明 |
---|---|---|
(constructor)(categoryDef, parentToolbox, opt_parent) | 构造 ToolboxCategory 类的新实例 |
属性
媒体资源 | 修饰符 | 类型 | 说明 |
---|---|---|---|
borderWidth | static |
number | 每个类别旁边的彩色条带的宽度(以像素为单位)。 |
colour_ | protected |
string | 类别的颜色。 |
cssConfig_ | protected |
CssConfig | |
defaultBackgroundColour | static |
string | 类别的默认颜色。这将用作类别在被选中时的背景颜色。 |
flyoutItems_ | protected |
字符串 | FlyoutItemInfoArray | 此类别的浮出项目。 |
htmlDiv_ | protected |
HTMLDivElement | null | 类别的 HTML 容器。 |
iconDom_ | protected |
元素 | null | 工具箱图标的 HTML 元素。 |
isDisabled_ | protected |
boolean | 如果此类别已停用,则为 true,否则为 false。 |
isHidden_ | protected |
boolean | 如果要隐藏类别,则为 true,否则为 false。 |
labelDom_ | protected |
元素 | null | 工具箱标签的 HTML 元素。 |
name_ | protected |
string | 将在类别上显示的名称。 |
nestedPadding | static |
number | 在每个嵌套级别上将类别移动的像素数。 |
registrationName | static |
string | 用于注册工具箱类别的名称。 |
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 |
为标签和图标创建容器。这是必要的,以便我们可以将所有子类别指针事件设置为 none。 |
dispose() | ||
getClickTarget() | 获取可点击的 HTML 元素。父工具箱元素会获得点击次数。父工具箱会向此元素添加一个 ID,以便其将 onClick 事件传递给正确的 toolboxItem。 | |
getColour_(categoryDef) | protected |
获取类别的颜色或样式。 |
getContents() | 获取类别的内容。这些项是要显示在弹出框内的内容。 | |
getDiv() | ||
getName() | 获取类别名称。用于发出事件。 | |
getParent() | ||
hide() | 隐藏类别。 | |
init() | 初始化工具箱项。这包括创建 DOM 并根据 info 对象更新任何项的状态。您应在构建工具箱项后立即调用 Init,以确保正确解析类别内容。 | |
isSelectable() | ||
isVisible() | 类别是否可见。仅当类别的所有祖先都处于展开状态且 isHidden_ 为 false 时,类别才会显示。 | |
makeDefaultCssConfig_() | protected |
创建一个对象,其中包含某个类别的默认类。 |
onClick(_e) | 在工具箱项被点击时处理。 | |
openIcon_(iconDiv) | protected |
添加适当的类以显示打开的图标。 |
parseCategoryDef_(categoryDef) | protected |
解析 category def 的非内容部分。 |
parseContents_(categoryDef) | protected |
根据类别是否为动态类别,或者其内容是否将要显示在弹出项中,解析内容数组。 |
refreshTheme() | 更新该类别的颜色。 | |
setDisabled(isDisabled) | 设置是否停用类别。 | |
setSelected(isSelected) | 将当前类别设置为选中状态。 | |
setVisible_(isVisible) | 设置类别是否可见。要让类别显示,其父类别也必须展开。 | |
show() | 显示类别。类别只有在其父类别也处于展开状态时才会显示。 | |
updateFlyoutContents(contents) | 更新要在浮出控件中显示的内容。如果在内容更新时浮出控件处于打开状态,还必须调用工具箱上的 refreshSelection。 |