blockly > ToolboxCategory

Classe ToolboxCategory

Classe d'une catégorie dans une boîte à outils.

Signature :

export declare class ToolboxCategory extends ToolboxItem implements ISelectableToolboxItem

Extension:ToolboxItem

Implémentation: ISelectableToolboxItem

Constructeurs

Constructeur Les modificateurs Description
(constructor)(categoryDef, parentToolbox, opt_parent) Construit une instance de la classe ToolboxCategory.

Propriétés

Propriété Les modificateurs Type Description
borderWidth static number Largeur, en pixels, de la bande de couleur à côté de chaque catégorie.
colour_ protected chaîne Couleur de la catégorie.
cssConfig_ protected CssConfig
defaultBackgroundColour static chaîne Couleur par défaut de la catégorie. Elle est utilisée comme couleur d'arrière-plan de la catégorie lorsqu'elle est sélectionnée.
flyoutItems_ protected string | FlyoutItemInfoArray Éléments du menu déroulant pour cette catégorie.
htmlDiv_ protected HTMLDivElement | null Conteneur HTML de la catégorie.
iconDom_ protected Élément | null Élément HTML de l'icône de la boîte à outils.
isDisabled_ protected boolean "True" si cette catégorie est désactivée, "false" dans le cas contraire.
isHidden_ protected boolean "True" si la catégorie est destinée à être masquée, sinon "false".
labelDom_ protected Élément | null Élément HTML du libellé de la boîte à outils.
name_ protected chaîne Nom qui sera affiché dans la catégorie.
nestedPadding static number Nombre de pixels vers lesquels déplacer la catégorie à chaque niveau imbriqué.
registrationName static chaîne Nom utilisé pour enregistrer une catégorie de boîte à outils.
rowContents_ protected HTMLDivElement | null Élément HTML contenant les éléments enfants de la ligne de la catégorie.
rowDiv_ protected HTMLDivElement | null Élément HTML pour la ligne de la catégorie.
toolboxItemDef_ CategoryInfo

Méthodes

Méthode Les modificateurs Description
addColourBorder_(colour) protected Ajoutez la bande de couleur à la catégorie boîte à outils.
allAncestorsExpanded_() protected Indique si tous les ancêtres d'une catégorie (parent et parent du parent, etc.) sont développés.
closeIcon_(iconDiv) protected Ajout des classes appropriées pour afficher une icône fermée.
createContainer_() protected Crée le conteneur qui contient la ligne et ses éventuelles sous-catégories.
createDom_() protected Crée le DOM pour la catégorie.
createIconDom_() protected Crée le segment contenant l'icône de catégorie.
createLabelDom_(name) protected Crée le segment contenant le libellé de catégorie. Il doit avoir un identifiant pour des raisons d'accessibilité.
createRowContainer_() protected Crée le parent du conteneur de contenu. Tous les clics interviendront dans cet élément div.
createRowContentsContainer_() protected Crée le conteneur pour le libellé et l'icône. Cette opération est nécessaire pour définir tous les événements de pointeur de sous-catégorie sur "Aucun".
dispose()
getClickTarget() Récupère l'élément HTML cliquable. L'élément de la boîte à outils parent reçoit des clics. La boîte à outils parent ajoute un ID à cet élément afin qu'il puisse transmettre l'événement onClick à l'élément approprié.
getColour_(categoryDef) protected Récupère la couleur ou le style d'une catégorie.
getContents() Récupère le contenu de la catégorie. Il s'agit d'éléments qui sont destinés à être affichés dans le menu déroulant.
getDiv()
getName() Récupère le nom de la catégorie. Utilisé pour émettre des événements.
getParent()
masquer() Masquer la catégorie.
init() Initialise l'élément de la boîte à outils. Cela inclut la création du DOM et la mise à jour de l'état de tous les éléments en fonction de l'objet info. Init doit être appelé immédiatement après la construction de l'élément de la boîte à outils, pour garantir que le contenu de la catégorie est correctement analysé.
isSelectable()
isVisible() Indique si la catégorie est visible. Une catégorie n'est visible que si tous ses ancêtres sont développés et que isHidden_ est défini sur "false".
makeDefaultCssConfig_() protected Crée un objet contenant les classes par défaut d'une catégorie.
onClick(_e) Gère le clic sur l'élément de la boîte à outils.
openIcon_(iconDiv) protected Ajout des classes appropriées pour afficher une icône ouverte.
parseCategoryDef_(categoryDef) protected Analyse les parties sans contenu de la catégorie définie.
parseContents_(categoryDef) protected Analyse le tableau "content" selon que la catégorie est une catégorie dynamique ou si son contenu est destiné à être affiché dans le menu déroulant.
refreshTheme() Met à jour la couleur pour cette catégorie.
setDisabled(isDisabled) Détermine si la catégorie est désactivée.
setSelected(isSelected) Définit la catégorie actuelle comme étant sélectionnée.
setVisible_(isVisible) Détermine si la catégorie est visible ou non. Pour qu'une catégorie soit visible, sa catégorie parente doit également être développée.
show() Afficher la catégorie. La catégorie ne s'affiche que si sa catégorie parente est également développée.
updateFlyoutContents(contents) Met à jour le contenu à afficher dans le menu déroulant. Si le menu déroulant est ouvert lors de la mise à jour du contenu, vous devez également appeler l'option "refreshSelection" dans la boîte à outils.