Groupe de navigation

Le Groupe de navigation organise des boutons de menu sous une entête repliable. Il permet de structurer un menu en sections. Il se situe obligatoirement à l’intérieur d’un Menu de navigation.

Sommaire

🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule

Propriétés

Avec en-têtes?

this.properties.isHeaderDisplayed · boolean · défaut true · modifie : Gabarit

Dépassement Horizontal

this.properties.overflowX · 'hidden' | 'visible' | 'scroll' | 'auto' · défaut 'hidden' · modifie : Taille

Comportement au dépassement horizontal.

Dépassement Vertical

this.properties.overflowY · 'hidden' | 'visible' | 'scroll' | 'auto' · défaut 'hidden' · modifie : Taille

Comportement au dépassement vertical.

Étendu?

this.properties.isOpen · boolean · défaut true · modifie : Gabarit

Contrôle l’état replié/déplié du groupe. Un clic sur l’entête inverse automatiquement cette valeur.

Icône titre

this.properties.icon · string · défaut ''

Permet d’afficher une icône ou une image dans l’entête. Si une image est définie, elle est prioritaire sur l’icône.

Image titre

this.properties.picture · any · défaut null

Position de l’image du titre

this.properties.iconPosition · 'left' | 'right' · défaut 'left'

Choix entre gauche et droite pour l’icône ou l’image.

Titre du menu

this.properties.content · string · défaut '' · {{jokerable}}

Texte affiché dans l’entête du groupe.

Couleur de fond du groupe

Couleur d’arrière‑plan spécifique à l’entête du groupe.

Informations

Accessibles par script, via this dans un script de l’acteur ou context.getActor('clé') depuis un autre acteur.

canAddActor

this.canAddActor · 🔒 lecture seule · boolean

Pour savoir s’il est possible d’ajouter un acteur.

canClearActors

this.canClearActors · 🔒 lecture seule · boolean

Pour savoir s’il est possible de retirer tous les acteurs.

canRemoveActor

this.canRemoveActor · 🔒 lecture seule · boolean

Pour savoir s’il est possible de retirer un acteur.

childActors

this.childActors · 🔒 lecture seule · Array<BaseActor

Obtiens la liste de tous les acteurs enfants.

completedContent

this.completedContent · 🔒 lecture seule · String

Le texte une fois complété.

Méthodes

addActor(…args)

this.addActor(...args)

Ajoute un acteur enfant, puis recalcule la hauteur du sous-menu.

addActors(…args)

this.addActors(...args)

Ajoute une collection d’acteurs enfants, puis recalcule la hauteur du sous-menu.

clearActors()

this.clearActors()

Retire tous les acteurs enfants.

getActor(key)

this.getActor(key) · renvoie Actor.BaseActor

Obtient un acteur enfant par sa clé.

  • key : Clé de l’acteur à trouver.

moveDownActor(key)

this.moveDownActor(key)

Déplace vers le bas un acteur enfant obtenu par sa clé.

  • key : Clé de l’acteur enfant à déplacer.

moveUpActor(key)

this.moveUpActor(key)

Déplace vers le haut un acteur enfant obtenu par sa clé.

  • key : Clé de l’acteur enfant à déplacer.

removeActor(…args)

this.removeActor(...args)

Retire un acteur enfant, puis recalcule la hauteur du sous-menu.

removeActors(…args)

this.removeActors(...args)

Retire les acteurs enfants, puis recalcule la hauteur du sous-menu.

Événements

Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.

onDidActorAdd

Se produit lorsque un acteur est ajouté.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
addedActor Actor.BaseActor Acteur ajouté.

onDidActorRemove

Se produit lorsque un acteur est retiré.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
removedActor Actor.BaseActor Acteur retiré.

onDidActorsAdd

Se produit lorsque une collection d’acteurs est ajoutée.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
addedActors Array.<Actor.BaseActor> Acteurs ajoutés.

onDidActorsClear

Se produit lorsque la collection d’acteurs est vidée.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
removedActors Array.<Actor.BaseActor> Acteurs retirés.

onDidActorsRemove

Se produit lorsque des acteurs sont retirés.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
removedActors Array.<Actor.BaseActor> Acteurs retirés.

Hérite de

Outre ce qui est décrit ici, l’acteur a tout ce que décrit l’acteur de base : propriétés communes (taille, disposition, aspect, texte, bordures, effets…), évènements communs (cycle de vie, souris, clavier…) et membres accessibles par script.

Il hérite aussi de :

  • JokerableContent (comportement) : Étend la classe pour permettre d’ajouter des jokers sur un contenu. Par défaut sur properties.content. Le valeur d’un joker est obtenue sur l’additionnelle de même clé.
  • LayoutBase : Base pour les acteurs de disposition.
  • Parenthood (comportement) : Étend la classe pour permettre d’avoir des acteurs enfants.

Fonctionnement

Le groupe calcule la hauteur de ses enfants (boutons de menu) afin d’animer l’ouverture et la fermeture. Lorsque l’entête est cliqué, la propriété Étendu? est inversée et les enfants sont affichés ou masqués.