ToolboxCategory 類別
工具箱中類別的類別。
Signature:
export declare class ToolboxCategory extends ToolboxItem implements ISelectableToolboxItem
擴充: ToolboxItem
建構函式
建構函式 | 修飾符 | 說明 |
---|---|---|
(constructor)(categoryDef, parentToolbox, opt_parent) | 建構 ToolboxCategory 類別的新例項 |
屬性
屬性 | 修飾符 | 類型 | 說明 |
---|---|---|---|
borderWidth | static |
數字 | 每個類別旁的色條寬度 (以像素為單位)。 |
colour_ | protected |
字串 | 類別的顏色。 |
cssConfig_ | protected |
CssConfig | |
defaultBackgroundColour | static |
字串 | 類別的預設顏色。這會在選取該類別時用來當做該類別的背景顏色。 |
flyoutItems_ | protected |
字串 |FlyoutItemInfoArray | 這個類別的飛船項目。 |
htmlDiv_ | protected |
HTMLDivElement |null | 類別的 HTML 容器。 |
iconDom_ | protected |
元素 | 空值 | 工具箱圖示的 HTML 元素。 |
isDisabled_ | protected |
布林值 | 如果這個類別已停用,則傳回「是」;否則傳回「否」。 |
isHidden_ | protected |
布林值 | 如果要隱藏類別,則傳回「是」;否則傳回「否」。 |
labelDom_ | protected |
元素 | 空值 | 工具箱標籤的 HTML 元素。 |
name_ | protected |
字串 | 顯示在類別中的名稱。 |
nestedPadding | static |
數字 | 在每個巢狀層級中,移動類別的像素數量。 |
registrationName | static |
字串 | 用於註冊工具箱類別的名稱。 |
rowContents_ | protected |
HTMLDivElement | 空值 | 這個 HTML 元素會保留類別資料列的子項元素。 |
rowDiv_ | protected |
HTMLDivElement |null | 類別列的 HTML 元素。 |
toolboxItemDef_ | CategoryInfo |
方法
方法 | 修飾符 | 說明 |
---|---|---|
addColourBorder_(colour) | protected |
將顏色條紋新增至工具箱類別。 |
allAncestorsExpanded_() | protected |
是否展開類別的所有祖系 (父項和父項的父項等)。 |
closeIcon_(iconDiv) | protected |
新增適當的類別,以便顯示關閉圖示。 |
createContainer_() | protected |
建立包含該列和所有子類別的容器。 |
createDom_() | protected |
為類別建立 DOM。 |
createIconDom_() | protected |
建立容納類別圖示的區段。 |
createLabelDom_(name) | protected |
建立包含類別標籤的時距。這項資訊應包含 ID,以利無障礙功能。 |
createRowContainer_() | protected |
建立內容容器的父項。所有點擊都會發生在這個 div 上。 |
createRowContentsContainer_() | protected |
建立標籤和圖示的容器。此為必要操作,才能將所有子類別指標事件設為「無」。 |
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 |
剖析類別定義的非內容部分。 |
parseContents_(categoryDef) | protected |
根據類別是否為動態類別,或其內容是否應顯示在彈出式視窗中,剖析內容陣列。 |
refreshTheme() | 更新這個類別的顏色。 | |
setDisabled(isDisabled) | 設定類別是否已停用。 | |
setSelected(isSelected) | 將目前的類別設為已選取。 | |
setVisible_(isVisible) | 設定類別是否可見。如要顯示某個類別,其父項類別也必須展開。 | |
show() | 顯示類別。只有在父項類別展開時,系統才會顯示類別。 | |
updateFlyoutContents(contents) | 更新要顯示在彈出式視窗中的內容。如果在內容更新時開啟彈出式視窗,則必須呼叫工具箱上的 refreshSelection。 |