Classe ToolboxCategory
Classe para uma categoria em uma caixa de ferramentas.
Signature:
export declare class ToolboxCategory extends ToolboxItem implements ISelectableToolboxItem
Estende: ToolboxItem
Implementa: ISelectableToolboxItem
Construtores
| Construtor | Modificadores | Descrição |
|---|---|---|
| (construtor)(categoryDef, parentToolbox, opt_parent) | Cria uma nova instância da classe ToolboxCategory. |
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| borderWidth | static |
number | A largura, em pixels, da faixa colorida ao lado de cada categoria. |
| colour_ | protected |
string | A cor da categoria. |
| cssConfig_ | protected |
CssConfig | |
| defaultBackgroundColour | static |
string | A cor padrão da categoria. É usada como a cor de fundo da categoria quando ela é selecionada. |
| flyoutItems_ | protected |
string | FlyoutItemInfoArray | Os itens suspensos dessa categoria. |
| htmlDiv_ | protected |
HTMLDivElement | null | O contêiner HTML da categoria. |
| iconDom_ | protected |
Elemento | nulo | O elemento HTML do ícone da caixa de ferramentas. |
| isDisabled_ | protected |
booleano | Verdadeiro se a categoria estiver desativada. Caso contrário, será falso. |
| isHidden_ | protected |
booleano | Verdadeiro se a categoria for oculta, falso caso contrário. |
| labelDom_ | protected |
Elemento | null | O elemento HTML para o rótulo da caixa de ferramentas. |
| name_ | protected |
string | O nome que vai aparecer na categoria. |
| nestedPadding | static |
number | O número de pixels para mover a categoria em cada nível aninhado. |
| registrationName | static |
string | Nome usado para registrar uma categoria da caixa de ferramentas. |
| rowContents_ | protected |
HTMLDivElement | null | O elemento HTML que contém elementos filhos da linha de categoria. |
| rowDiv_ | protected |
HTMLDivElement | null | O elemento HTML da linha da categoria. |
| toolboxItemDef_ | CategoryInfo |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| addColourBorder_(colour) | protected |
Adicione a faixa de cor à categoria da caixa de ferramentas. |
| allAncestorsExpanded_() | protected |
Indica se todos os ancestrais de uma categoria (mãe e pai do pai etc.) são expandidos. |
| closeIcon_(iconDiv) | protected |
Adiciona classes adequadas para mostrar um ícone fechado. |
| createContainer_() | protected |
Cria o contêiner que contém a linha e todas as subcategorias. |
| createDom_() | protected |
Cria o DOM da categoria. |
| createIconDom_() | protected |
Cria o período que contém o ícone da categoria. |
| createLabelDom_(name) | protected |
Cria o período que contém o rótulo da categoria. Ele precisa ter um ID para fins de acessibilidade. |
| createRowContainer_() | protected |
Cria o pai do contêiner de conteúdo. Todos os cliques ocorrerão neste div. |
| createRowContentsContainer_() | protected |
Cria o contêiner para o rótulo e o ícone. Isso é necessário para que possamos definir todos os eventos de ponteiro da subcategoria como nenhum. |
| dispose() | ||
| getClickTarget() | Recupera o elemento HTML clicável. O elemento pai da caixa de ferramentas recebe cliques. A caixa de ferramentas mãe vai adicionar um ID a esse elemento para transmitir o evento onClick ao toolboxItem correto. | |
| getColour_(categoryDef) | protected |
Recebe a cor ou o estilo de uma categoria. |
| getContents() | Recebe o conteúdo da categoria. Esses são os itens que devem ser mostrados no menu suspenso. | |
| getDiv() | ||
| getName() | Recebe o nome da categoria. Usado para emitir eventos. | |
| getParent() | ||
| hide() | Ocultar a categoria. | |
| init() | Inicializa o item da caixa de ferramentas. Isso inclui a criação do DOM e a atualização do estado de todos os itens com base no objeto de informações. O init precisa ser chamado imediatamente após a construção do item da caixa de ferramentas para garantir que o conteúdo da categoria seja analisado corretamente. | |
| isSelectable() | ||
| isVisible() | Indica se a categoria está visível. Uma categoria só é visível quando todos os seus ancestrais são expandidos e isHidden_ é falso. | |
| makeDefaultCssConfig_() | protected |
Cria um objeto que contém as classes padrão de uma categoria. |
| onClick(_e) | Processa quando o item da caixa de ferramentas é clicado. | |
| openIcon_(iconDiv) | protected |
Adiciona classes adequadas para mostrar um ícone aberto. |
| parseCategoryDef_(categoryDef) | protected |
Analisa as partes sem conteúdo da definição da categoria. |
| parseContents_(categoryDef) | protected |
Analisa a matriz de conteúdo dependendo se a categoria é dinâmica ou se o conteúdo dela deve ser mostrado no menu suspenso. |
| refreshTheme() | Atualiza a cor dessa categoria. | |
| setDisabled(isDisabled) | Define se a categoria está desativada. | |
| setSelected(isSelected) | Define a categoria atual como selecionada. | |
| setVisible_(isVisible) | Define se a categoria é visível ou não. Para que uma categoria seja visível, a categoria principal dela também precisa ser expandida. | |
| show() | Mostre a categoria. A categoria só vai aparecer se a mãe dela também estiver aberta. | |
| updateFlyoutContents(contents) | Atualiza o conteúdo que será exibido no menu flutuante. Se o menu suspenso estiver aberto quando o conteúdo for atualizado, a função refreshSelection na caixa de ferramentas também precisará ser chamada. |