Documentation AEM 6.4 Guide de développement

Composants AEM – Notions de base aem-components-the-basics

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Rubriques :
Developing

Créé pour :

Developer

CAUTION

AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

Lorsque vous commencez à développer de nouveaux composants, vous devez comprendre les principes de base de leur structure et de leur configuration.

Ce processus implique de lire la théorie et d’étudier le vaste éventail d’implémentations de composants possibles dans une instance AEM standard. Cette dernière approche est légèrement compliquée par le fait que, bien que AEM soit passée à une nouvelle interface utilisateur standard, moderne et tactile, elle continue de prendre en charge l’IU classique.

Présentation overview

Cette section décrit les concepts et les problèmes majeurs et sert d’introduction aux informations dont vous avez besoin pour développer vos propres composants.

Planification planning

Avant de commencer à configurer ou coder votre composant, vous devez vous poser la question suivante :

De quoi avez-vous besoin exactement pour le nouveau composant ?
- Un cahier des charges clair facilitera toutes les étapes de développement, de test et de transfert.
  
  Vos besoins peuvent évoluer au fil du temps, mais le cahier des charges peut être mis à jour (bien que les modifications doivent également être documentées).
Devez-vous créer votre composant de toutes pièces ou pouvez-vous hériter des bases d’un composant existant ?
- Inutile de réinventer la roue.
- Dans AEM, plusieurs mécanismes permettent d’hériter et d’étendre les détails d’une définition d’un autre composant, y compris le remplacement, le recouvrement et le module de fusion de ressources Sling (Sling Resource Merger).
Votre composant aura-t-il besoin d’une logique pour sélectionner/manipuler le contenu ?
- La logique doit rester distincte de la couche de l’interface utilisateur. HTL est conçu pour faciliter cette distinction.
Votre composant aura-t-il besoin d’une mise en forme CSS ?
- La mise en forme CSS doit rester distincte des définitions de composants. Définissez des conventions pour nommer vos éléments de HTML afin que vous puissiez les modifier via des fichiers CSS externes.
Quels aspects de sécurité dois-je prendre en compte ?
- Consultez Liste de contrôle de sécurité - Bonnes pratiques de développement pour plus de détails.

IU tactile ou classique touch-enabled-vs-classic-ui

Avant toute discussion sérieuse sur le développement de composants, vous devez savoir quelle interface utilisateur vos auteurs utiliseront :

Interface utilisateur optimisée pour les écrans tactiles
Interface utilisateur standard qui a été introduit dans AEM 5.6.0 en tant qu’aperçu et étendu dans la version 6.x. Elle repose sur l’expérience utilisateur unifiée de Adobe Marketing Cloud, qui utilise les technologies sous-jacentes de IU Coral et IU Granite.
IU classique
Interface utilisateur basée sur la technologie ExtJS introduite avec CQ 5.1.

Voir Recommendations de l’interface utilisateur pour les clients pour plus d’informations.

Les composants peuvent être implémentés de manière à prendre en charge l’IU tactile, l’IU classique ou les deux. Si vous étudiez une instance standard, vous pouvez également remarquer la présence de composants prêts à l’emploi qui ont été conçus à l’origine pour l’IU classique ou l’IU tactile, ou les deux.

Pour cette raison, nous allons aborder dans cette page les notions de base des deux interfaces et expliquer comment les reconnaître.

NOTE

Adobe recommande d’utiliser l’interface utilisateur tactile pour bénéficier des dernières technologies. Les Outils de modernisation d’AEM peuvent faciliter la migration.

Logique de contenu et balisage de rendu content-logic-and-rendering-markup

Il est recommandé de séparer le code responsable du balisage et du rendu du code qui contrôle la logique utilisée pour sélectionner le contenu du composant.

Cette approche est compatible avec HTL, un langage de modèle intentionnellement limité pour s’assurer qu’un vrai langage de programmation est utilisé afin de définir la logique métier sous-jacente. Cette logique (facultative) est appelée à partir de HTL avec une commande spécifique. Ce mécanisme met en évidence le code appelé pour une vue donnée et, si nécessaire, autorise une logique spécifique pour différentes vues du même composant.

HTL et JSP htl-vs-jsp

HTL est un langage de modèle HTML introduit avec AEM 6.0.

La discussion sur l’utilisation HTL ou JSP (Java Server Pages) lors du développement de vos propres composants doit être simple, car HTL est désormais le langage de script recommandé pour AEM.

HTL et JSP peuvent être utilisés pour développer des composants de l’IU classique et de l’IU tactile. Bien que la tendance laisse à supposer que HTL est réservé à l’IU tactile et JSP à l’IU classique, c’est une idée reçue que l’on attribue à une synchronisation fortuite. L’IU tactile et HTL ont été intégrés à AEM à peu près en même temps. Puisque HTL est aujourd’hui le langage recommandé, il est utilisé pour les nouveaux composants, qui sont plus souvent développés pour l’IU tactile.

NOTE

Les exceptions sont les champs de formulaire de base de l’IU Granite (utilisés dans les boîtes de dialogue). Ceux-ci nécessitent toujours l’utilisation de JSP.

Développer ses propres composants developing-your-own-components

Pour créer vos propres composants pour l’interface utilisateur appropriée, voir (après avoir lu cette page) :

Pour commencer rapidement, une méthode consiste à copier un élément existant, puis à effectuer les modifications de votre choix. Pour savoir comment créer vos propres composants et les ajouter au système de paragraphes, voir :

Développement de composants (axé sur l’interface utilisateur tactile)

Déplacement de composants vers l’instance de publication moving-components-to-the-publish-instance

Les composants de rendu de contenu doivent être déployés sur la même instance AEM que le contenu. Par conséquent, tous les composants utilisés pour la création et le rendu des pages sur l’instance d’auteur doivent être déployés sur l’instance de publication. Une fois déployés, les composants sont disponibles pour le rendu des pages activées.

Utilisez les outils suivants pour déplacer vos composants vers l’instance de publication :

Utilisez le gestionnaire de packages pour ajouter vos composants à un package et les déplacer vers une autre instance AEM.
Utilisation de l’outil de réplication Activer l’arborescence pour répliquer les composants.

NOTE

Ces mécanismes peuvent également être utilisés pour le transfert de votre composant entre d’autres instances, par exemple du développement vers votre instance de test.

Composants à connaître dès le début components-to-be-aware-of-from-the-start

Page :
- AEM comporte le composant page (cq:Page).
- Il s’agit d’un type spécifique de ressource important pour la gestion de contenu.
  - Une page correspond à une page web contenant du contenu pour votre site web.
Systèmes de paragraphes :
- Le système de paragraphe est un composeur majeur d’un site Web car il gère une liste de paragraphes. Il est utilisé pour contenir et structurer les composants individuels qui contiennent le contenu réel.
- Vous pouvez créer, déplacer, copier et supprimer des paragraphes dans le système de paragraphes.
- Vous pouvez également sélectionner les composants à utiliser dans un système de paragraphes spécifique.
- Il existe différents systèmes de paragraphes disponibles dans une instance standard (par exemple parsys, [responsivegrid](/docs/experience-manager-64/sites-authoring/responsive-layout.md)).

Structure structure

La structure d’un composant AEM est puissante et flexible. Les principales considérations sont les suivantes :

Type de ressource
Définition du composant
Propriétés et nœuds enfants d’un composant
Boîtes de dialogue
Boîtes de dialogue de conception
Disponibilité des composants
Composants et contenu qu’ils créent

Type de ressource resource-type

Le type de ressource est un élément clé de la structure.

La structure du contenu déclare les intentions.
Le type de ressource les implémente.

Il s’agit d’une abstraction qui permet de s’assurer que même lorsque l’apparence change au fil du temps, l’intention reste le temps.

Définition du composant component-definition

Notions de base des composants component-basics

La définition d’un composant peut être décomposée comme suit :

Les composants AEM sont basés sur Sling.
Les composants AEM se trouvent (généralement) sous :
- HTL : /libs/wcm/foundation/components
- JSP : /libs/foundation/components
Les composants spécifiques au projet/site sont (généralement) situés sous :
- /apps/<myApp>/components
Les composants standard d’AEM sont définis comme cq:Component et possèdent les éléments clés suivants :
- Propriétés jcr :
  
  Liste de propriétés jcr. Celles-ci sont variables et certaines peuvent être facultatives si la structure de base d’un nœud de composant, ses propriétés et ses sous-nœuds sont définis par la définition cq:Component.
- Ressources :
  
  Elles définissent les éléments statiques utilisés par le composant.
- Scripts :
Utilisés pour implémenter le comportement de l’instance résultante du composant.
Nœud racine :
- <mycomponent> (cq:Component) – Nœud de hiérarchie du composant.
Propriétés vitales :
- jcr:title - Titre du composant. Par exemple utilisé comme libellé lorsque le composant est répertorié dans le navigateur de composants ou le sidekick.
- jcr:description - Description du composant. Peut être utilisé comme indicateur de survol de la souris dans le navigateur de composants ou le sidekick.
- Interface utilisateur classique :
  - icon.png - Icône du composant.
  - thumbnail.png - Vignette affichée si le composant est listé dans le système de paragraphe.
- IU tactile
  - Voir la section Icône de composant dans l’interface utilisateur tactile pour plus d’informations.
Nœuds enfants essentiels :
- cq:editConfig (cq:EditConfig) - Définit les propriétés de modification du composant et permet au composant d’apparaître dans le navigateur de composants ou le sidekick.
  
  Remarque : si le composant possède une boîte de dialogue, elle apparaît automatiquement dans le navigateur de composants ou le sidekick, même si le cq:editConfig n’existe pas.
- cq:childEditConfig (cq:EditConfig) – Contrôle les aspects de l’IU de création pour les composants enfants qui ne définissent pas leur propre cq:editConfig.
- Interface utilisateur optimisée pour les écrans tactiles :
  - cq:dialog (nt:unstructured) - Boîte de dialogue pour ce composant. Définit l’interface permettant à l’utilisateur de configurer le composant et/ou de modifier le contenu.
  - cq:design_dialog (nt:unstructured) - Modification de la conception du composant.
- Interface utilisateur classique :
  - dialog (cq:Dialog) - Boîte de dialogue pour ce composant. Définit l’interface permettant à l’utilisateur de configurer le composant et/ou de modifier le contenu.
  - design_dialog (cq:Dialog) - Modification de la conception du composant.

Icône de composant dans l’IU tactile component-icon-in-touch-ui

L’icône ou l’abréviation du composant est définie via les propriétés JCR du composant lorsque le composant est créé par le développeur. Ces propriétés sont évaluées dans l’ordre suivant, la première propriété valide trouvée étant utilisée.

cq:icon – Propriété de chaîne pointant vers une icône standard dans la bibliothèque de l’IU Coral à afficher dans le navigateur de composants
- Utilisez la valeur de l’attribut HTML de l’icône Coral.
abbreviation – Propriété de chaîne servant à personnaliser l’abréviation du nom du composant dans le navigateur de composants
- L’abréviation devrait être limitée à deux caractères.
- La saisie d’une chaîne vide crée l’abréviation à partir des deux premiers caractères de la propriété jcr:title.
  - Par exemple, "Im" pour "Image"
  - Le titre localisé sera utilisé pour créer l’abréviation.
- L’abréviation n’est traduite que si le composant possède une propriété abbreviation_commentI18n, qui est ensuite utilisée comme indice de traduction.
cq:icon.png ou cq:icon.svg – Icône du composant, affichée dans le navigateur de composants
- 20 x 20 pixels représente la taille des icônes des composants standard.
  - Les icônes plus grandes seront réduites (côté client).
- La couleur recommandée est rgb(112, 112, 112) > # 707070
- L’arrière-plan des icônes de composants standard est transparent.
- Seuls les fichiers .png et .svg sont pris en charge.
- Si vous importez à partir du système de fichiers via le module externe Eclipse, les noms de fichiers doivent être configurés comme _cq_icon.png ou _cq_icon.svg, par exemple.
- .png est prioritaire sur .svg si les deux sont présents

Si aucune des propriétés ci-dessus (cq:icon.png, cq:icon, abbreviation ou cq:icon.svg) n’existe pour le composant :

Le système recherche les mêmes propriétés sur les super-composants selon la propriété sling:resourceSuperType.
Si aucune propriété n’est détectée, hormis une abréviation vide, au niveau du super composant, le système crée l’abréviation à partir des premières lettres de la propriété jcr:title du composant actif.

Pour annuler l’héritage des icônes à partir de super-composants, la définition d’une propriété abbreviation vide sur le composant rétablit le comportement par défaut.

La console des composants affiche la façon dont est définie l’icône d’un composant particulier.

Exemple d’icône SVG svg-icon-example

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink" x="0px" y="0px"
     width="20px" height="20px" viewBox="0 0 20 20" enable-background="new 0 0 20 20" xml:space="preserve">
    <ellipse cx="5" cy="5" rx="3" ry="3" fill="#707070"/>
    <ellipse cx="15" cy="5" rx="4" ry="4" fill="#707070"/>
    <ellipse cx="5" cy="15" rx="5" ry="5" fill="#707070"/>
    <ellipse cx="15" cy="15" rx="4" ry="4" fill="#707070"/>
</svg>

Propriétés et nœuds enfants d’un composant properties-and-child-nodes-of-a-component

La plupart des nœuds/propriétés nécessaires pour définir un composant sont communs aux deux interfaces utilisateur, les différences restant indépendantes pour que votre composant puisse fonctionner dans les deux environnements.

Un composant est un nœud de type cq:Component et possède les propriétés et les nœuds enfants suivants :

Nom

Type

Description

cq:Component

Composant actif. Un composant possède le type de nœud cq:Component.

componentGroup

String

Groupe sous lequel le composant peut être sélectionné dans le navigateur de composants (IU tactile) ou le sidekick (IU classique).
Une valeur .hidden est utilisée pour les composants qui ne sont pas sélectionnables dans l’IU, tels que les systèmes de paragraphes réels.

cq:isContainer

Boolean

Indique si le composant est un composant de type « container » qui peut donc contenir d’autres composants, tels qu’un système de paragraphes.

cq:dialog

nt:unstructured

Définition de la boîte de dialogue de modification pour l’IU tactile.

dialog

cq:Dialog

Définition de la boîte de dialogue de modification pour l’IU classique.

cq:design_dialog

nt:unstructured

Définition de la boîte de dialogue de conception pour l’IU tactile.

design_dialog

cq:Dialog

Définition de la boîte de dialogue de conception pour l’IU classique.

dialogPath

String

Chemin d’accès à une boîte de dialogue permettant de prendre en charge un cas où le composant n’aurait pas de nœud de boîte de dialogue.

cq:cellName

String

Si elle est définie, cette propriété sert d’ID de cellule. Pour plus d’informations, reportez-vous à l’article de la base de connaissances Comment les ID de cellule de conception sont-ils créés ?.

cq:childEditConfig

cq:EditConfig

Lorsque le composant est de type « container », par exemple un système de paragraphes, cela engendre la modification de la configuration des nœuds enfants.

cq:editConfig

cq:EditConfig

Modifier la configuration du composant.

cq:htmlTag

nt:unstructured

Renvoie des attributs de balise supplémentaires ajoutés à la balise html environnante. Active l’ajout d’attributs aux divs générés automatiquement.

cq:noDecoration

Boolean

Si la valeur est true, le composant n’est pas rendu avec les classes div et css générées automatiquement.

cq:template

nt:unstructured

S’il est détecté, ce nœud est utilisé comme modèle de contenu lorsque le composant est ajouté depuis le navigateur de composants ou le sidekick.

cq:templatePath

String

Chemin d’accès à un nœud à utiliser comme modèle de contenu lorsque le composant est ajouté depuis le navigateur de composants ou le sidekick. Il doit s’agir d’un chemin d’accès absolu, et non relatif au noeud de composant.
Sauf si vous souhaitez réutiliser du contenu déjà disponible ailleurs, cela n’est pas obligatoire, et cq:template est suffisant (voir ci-dessous).

jcr:created

Date

Date de création du composant.

jcr:description

String

Description du composant.

jcr:title

String

Titre du composant.

sling:resourceSuperType

String

Lorsqu’il est défini, le composant hérite de ce composant.

virtual

sling:Folder

Permet la création de composants virtuels. Pour voir un exemple, consultez le composant contact à l’adresse :
/libs/foundation/components/profile/form/contact

<breadcrumb.jsp>

nt:file

Fichier de script.

icon.png

nt:file

L’icône du composant apparaît à côté du titre dans le sidekick.

thumbnail.png

nt:file

Miniature facultative affichée lorsque le composant est déplacé à partir du sidekick.

Si nous regardons le Texte (l’une ou l’autre des versions), nous pouvons voir ces éléments :

HTL (/libs/wcm/foundation/components/text)
JSP (/libs/foundation/components/text)

Les propriétés d’intérêt particulier sont les suivantes :

jcr:title - Titre du composant. Il peut être utilisé pour identifier le composant, par exemple. Il est visible dans la liste du navigateur de composants dans le navigateur ou le sidekick.
jcr:description - Description du composant. Peut être utilisée comme indice de survol de la souris dans la liste des composants du sidekick.
sling:resourceSuperType - Indique le chemin de l’héritage lors de l’extension d’un composant (en remplaçant une définition).

Les nœuds d’enfant d’un intérêt particulier sont les suivants :

cq:editConfig (cq:EditConfig) - Contrôle les aspects visuels. Par exemple, il peut définir l’apparence d’une barre ou d’un widget, ou peut ajouter des contrôles personnalisés.
cq:childEditConfig (cq:EditConfig) - Contrôle les aspects visuels des composants enfants qui n’ont pas leurs propres définitions.
Interface utilisateur optimisée pour les écrans tactiles :
- cq:dialog (nt:unstructured) - Définit la boîte de dialogue de modification du contenu de ce composant.
- cq:design_dialog (nt:unstructured) - Spécifie les options de modification de conception pour le composant.
Interface utilisateur classique :
- dialog (cq:Dialog) - Définit la boîte de dialogue de modification du contenu du composant (spécifique à l’IU classique).
- design_dialog (cq:Dialog) - Spécifie les options de modification de conception pour le composant.
- icon.png - Fichier graphique à utiliser comme icône pour le composant dans le sidekick
- thumbnail.png - Fichier graphique à utiliser comme miniature pour le composant en le faisant glisser depuis le sidekick

Boîtes de dialogue dialogs

Les boîtes de dialogue sont un élément clé de votre composant, car elles fournissent une interface permettant aux auteurs de configurer et de fournir des informations sur ce composant.

Selon la complexité du composant, votre boîte de dialogue peut avoir besoin d’un ou de plusieurs onglets, afin de garder la boîte de dialogue courte et de trier les champs d’entrée.

Les définitions de boîte de dialogue sont spécifiques à l’interface utilisateur :

NOTE

À des fins de compatibilité, l’IU tactile peut utiliser la définition d’une boîte de dialogue d’IU classique lorsqu’aucune boîte de dialogue n’a été définie pour l’IU tactile.
Le Outils de modernisation d’AEM est également fourni pour vous aider à étendre/convertir les composants dont seules les boîtes de dialogue sont définies pour l’IU classique.

Interface utilisateur optimisée pour les écrans tactiles
- Les nœuds cq:dialog (nt:unstructured) :
  - définissent la boîte de dialogue pour la modification du contenu de ce composant ;
  - spécifique à l’IU tactile.
  - sont définis à l’aide des composants de l’IU Granite ;
  - ont une propriété sling:resourceType, comme structure de contenu Sling standard ;
  - peuvent avoir une propriété helpPath pour définir la ressource d’aide contextuelle (chemin absolu ou relatif) accessible lorsque l’icône d’aide (l’icône ? ) est sélectionnée.
    - Pour les composants prêts à l’emploi, il s’agit souvent d’une page dans la documentation.
    - Si aucun helpPath n’est spécifié, l’URL par défaut (page de présentation de la documentation) est affichée.
Dans la boîte de dialogue, chaque champ est défini :
Interface utilisateur classique
- Les nœuds dialog (cq:Dialog) :
  - définissent la boîte de dialogue pour la modification du contenu de ce composant ;
  - spécifique à l’IU classique
  - sont définis à l’aide des widgets ExtJS ;
  - possèdent une propriété xtype qui fait référence à ExtJS ;
  - peuvent avoir une propriété helpPath pour définir la ressource d’aide contextuelle (chemin absolu ou relatif) accessible lorsque le bouton Aide est sélectionné.
    - Pour les composants prêts à l’emploi, il s’agit souvent d’une page dans la documentation.
    - Si aucun helpPath n’est spécifié, l’URL par défaut (page de présentation de la documentation) est affichée.
Dans la boîte de dialogue, chaque champ est défini :

Dans une boîte de dialogue classique :
- vous pouvez créer une boîte de dialogue définie en tant que cq:Dialog qui fournira un seul onglet (comme dans le composant text). Si vous avez besoin de plusieurs onglets, comme dans le composant textimage, la boîte de dialogue peut être définie comme cq:TabPanel.
- un cq:WidgetCollection (items) sert de base pour les champs de saisie (cq:Widget) ou d’autres onglets (cq:Widget). Cette hiérarchie peut être étendue.

Boîtes de dialogue de conception design-dialogs

Les boîtes de dialogue de conception sont très similaires aux boîtes de dialogue utilisées pour modifier et configurer le contenu, mais elles fournissent l’interface permettant aux auteurs de configurer et de fournir des détails de conception pour ce composant.

Les boîtes de dialogue de conception sont disponibles en mode de conception, bien qu’elles ne soient pas nécessaires pour tous les composants, par exemple Titre et Image toutes deux comportent des boîtes de dialogue de conception, alors que Texte ne le fait pas.

La boîte de dialogue de conception pour le système de paragraphe (par exemple parsys) est un cas particulier. Elle permet à l’utilisateur de définir d’autres composants spécifiques à rendre sélectionnables (depuis le navigateur de composants ou le sidekick) sur la page.

Ajout de votre composant au système de paragraphes adding-your-component-to-the-paragraph-system

Une fois qu’un composant a été défini, il doit être disponible pour utilisation. Pour rendre un composant sélectionnable dans un système de paragraphes, vous pouvez :

ouvrir le mode Conception pour une page et activer le composant requis ;
ajouter le(s) composant(s) requis à la propriété components de votre définition de modèle sous :

/etc/designs/<*yourProject*>/jcr:content/<*yourTemplate*>/par

Pour obtenir un exemple, reportez-vous à :

/etc/designs/geometrixx/jcr:content/contentpage/par

Composants et contenu qu’ils créent components-and-the-content-they-create

Si nous créons et configurons une instance du composant Titre sur la page : <content-path>/Prototype.html

Interface utilisateur optimisée pour les écrans tactiles
Interface utilisateur classique

Ensuite, nous pouvons voir la structure du contenu créé dans le référentiel :

screen_shot_2012-02-13at61405pm

En particulier, si vous vous intéressez au texte actuel d’un composant Titre :

la définition (pour les deux interfaces utilisateur) possède la propriété name= ./jcr:title
- /libs/foundation/components/title/cq:dialog/content/items/column/items/title
- /libs/foundation/components/title/dialog/items/title
dans le contenu, ceci génère la propriété jcr:title qui stocke le contenu de l’auteur.

Les propriétés définies dépendent des définitions individuelles. Bien qu'elles puissent être plus complexes qu'auparavant, elles suivent toujours les mêmes principes de base.

Hiérarchie et héritage des composants component-hierarchy-and-inheritance

Les composants d’AEM sont soumis à 3 hiérarchies différentes :

Hiérarchie du type de ressource

Elle est utilisée pour étendre des composants à l’aide de la propriété sling:resourceSuperType. Cela permet au composant d’hériter d’attributs. Par exemple, un composant Text hérite de divers attributs du composant standard.
- scripts (résolus par Sling)
- boîtes de dialogue
- descriptions (y compris les images miniatures, les icônes, etc.)
Hiérarchie des conteneurs

Cette option permet de renseigner les paramètres de configuration du composant enfant. Elle est généralement utilisée dans un scénario parsys.

Par exemple, les paramètres de configuration des boutons de la barre de modification, la disposition de jeux de contrôles (barres de modification, survol), la disposition des boîtes de dialogue (ancrée, flottante) peuvent être définis sur le composant parent.

Les paramètres de configuration (liés à la fonctionnalité de modification) dans cq:editConfig et cq:childEditConfig sont propagés.
Hiérarchie d’inclusion

Paramètre imposé lors de l’exécution par la séquence d’inclusions.

Cette hiérarchie est utilisée par le concepteur, qui à son tour sert de base pour divers aspects de conception du rendu, notamment les informations de disposition, les informations css, les composants disponibles dans un parsys, etc.

Comportement de modification edit-behavior

Cette section explique comment configurer le comportement de modification d’un composant. Cela inclut les attributs tels que les actions disponibles pour le composant, les caractéristiques de l’éditeur statique et les écouteurs liés aux événements sur le composant.

La configuration est commune aux interfaces utilisateur tactile et classique, avec toutefois certaines différences spécifiques.

Le comportement de modification d’un composant est configuré en ajoutant un nœud cq:editConfig de type cq:EditConfig en dessous du nœud de composant (de type cq:Component) et en ajoutant des propriétés spécifiques et des nœuds enfants. Les propriétés et les nœuds enfants suivants sont disponibles :

Propriétés du nœud cq:editConfig :
- cq:actions (String array) : définit les actions pouvant être effectuées sur le composant.
- cq:layout (String) : définit la façon dont le composant est modifié dans l’IU classique.
- cq:dialogMode (String) : définit le mode d’ouverture de la boîte de dialogue des composants dans l’IU classique.
  - Dans l’IU tactile, les boîtes de dialogue flottent toujours en mode bureau et s’ouvrent automatiquement en mode plein écran sur mobile.
- cq:emptyText (String) : définit le texte qui est affiché quand aucun contenu visuel n’est présent.
- cq:inherit (Boolean) : définit si les valeurs manquantes sont héritées du composant.
- dialogLayout (chaîne) : définit le mode d’ouverture de la boîte de dialogue.
Nœuds enfants cq:editConfig :
- cq:dropTargets (type de nœud nt:unstructured) : définit une liste de cibles de dépôt pouvant accepter une ressource déposée à partir de l’outil de recherche de contenu.
  - Les cibles de dépôt multiples sont uniquement disponibles dans l’IU classique.
  - Dans l’IU tactile, une seule cible est autorisée.
- cq:actionConfigs (type de nœud nt:unstructured) : définit une liste de nouvelles actions ajoutées à la liste cq:actions.
- cq:formParameters (type de nœud nt:unstructured) : définit des paramètres supplémentaires qui sont ajoutés au formulaire de la boîte de dialogue.
- cq:inplaceEditing (type de nœud cq:InplaceEditingConfig) : définit une configuration de modification en place pour le composant.
- cq:listeners (type de nœud cq:EditListenersConfig) : définit ce qui se passe avant ou après une action sur le composant.

NOTE

Dans cette page, un nœud (propriétés et nœuds enfants) est représenté au format XML, comme indiqué dans l’exemple suivant.

<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    cq:actions="[edit]"
    cq:dialogMode="floating"
    cq:layout="editbar"
    jcr:primaryType="cq:EditConfig">
    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afteredit="REFRESH_PAGE"/>
</jcr:root>

Il existe de nombreuses configurations dans le référentiel. Vous pouvez facilement rechercher des propriétés spécifiques ou des noeuds enfants :

Pour rechercher une propriété du nœud cq:editConfig, par exemple cq:actions, vous pouvez utiliser l’outil de requête dans CRXDE Lite et faire une recherche avec la chaîne de requête XPath suivante :

//element(cq:editConfig, cq:EditConfig)[@cq:actions]
Pour rechercher un nœud enfant de cq:editConfig, par exemple, vous pouvez rechercher cq:dropTargets, qui est de type cq:DropTargetConfig, vous pouvez utiliser l’outil de requête dans CRXDE Lite et faire une recherche avec la chaîne de requête XPath suivante :

//element(cq:dropTargets, cq:DropTargetConfig)

Espaces réservés de composant component-placeholders

Les composants doivent toujours générer du code HTML visible par l’auteur, même si le composant ne comporte aucun contenu, sans quoi il pourrait disparaître visuellement de l’interface de l’éditeur, ce qui le rend techniquement présent, mais invisible sur la page et dans l’éditeur. Dans ce cas, les auteurs ne pourraient pas sélectionner ce composant vide ni interagir avec lui.

Pour cette raison, les composants doivent générer un espace réservé tant qu’ils n’affichent pas de sortie visible lorsque la page est rendue dans l’éditeur de page (lorsque le WCM est en mode edit ou preview).
L’annotation HTML type d’un espace réservé est la suivante :

<div class="cq-placeholder" data-emptytext="Component Name"></div>

Le script HTL type pour effectuer le rendu du code HTML d’espace réservé ci-dessus est le suivant :

<div class="cq-placeholder" data-emptytext="${component.properties.jcr:title}"
     data-sly-test="${(wcmmode.edit || wcmmode.preview) && isEmpty}"></div>

Dans l’exemple précédent, isEmpty est une variable vraie uniquement lorsque le composant n’a aucun contenu et est invisible pour l’auteur.

Pour éviter la répétition, Adobe recommande que les implémenteurs des composants utilisent un modèle HTL pour ces espaces réservés, comme celui fourni par les composants principaux.

L’utilisation du modèle dans le lien précédent se fait ensuite grâce à la ligne HTL suivante :

<sly data-sly-use.template="core/wcm/components/commons/v1/templates.html"
     data-sly-call="${template.placeholder @ isEmpty=!model.text}"></sly>

Dans l’exemple précédent, model.text est la variable qui est vraie uniquement lorsque le contenu comporte du contenu et est visible.

Vous trouverez un exemple d’utilisation de ce modèle dans les composants principaux, tels que dans le composant Titre.

Configuration avec les propriétés cq:EditConfig configuring-with-cq-editconfig-properties

cq:actions cq-actions

La propriété cq:actions (String array) définit une ou plusieurs actions pouvant être exécutées sur le composant. Les valeurs suivantes sont configurables :

Valeur de la propriété

Description

text:<some text>

Affiche la valeur de texte statique. <some text>
Visible uniquement dans l’IU classique. L’IU tactile n’affiche pas les actions dans un menu contextuel, donc ceci n’est pas applicable.

Ajoute un espacement.
Visible uniquement dans l’IU classique. L’IU tactile n’affiche pas les actions dans un menu contextuel, donc ceci n’est pas applicable.

edit

Ajoute un bouton pour modifier le composant.

editannotate

Ajoute un bouton permettant de modifier le composant et d’autoriser les annotations.

delete

Ajoute un bouton pour supprimer le composant.

insert

Ajoute un bouton permettant d’insérer un nouveau composant avant le composant actif.

copymove

Ajoute un bouton pour copier et couper le composant.

La configuration suivante ajoute un bouton de modification, un espacement, ainsi qu’un bouton de suppression et d’insertion à la barre de modification du composant :

<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    cq:actions="[edit,-,delete,insert]"
    cq:layout="editbar"
    jcr:primaryType="cq:EditConfig"/>

La configuration suivante ajoute le texte « Configurations héritées du framework de base » à la barre de modification des composants :

<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    cq:actions="[text:Inherited Configurations from Base Framework]"
    cq:layout="editbar"
    jcr:primaryType="cq:EditConfig"/>

cq:layout (IU classique uniquement) cq-layout-classic-ui-only

La propriété cq:layout (String) définit la façon dont le composant peut être modifié dans l’IU classique. Les valeurs suivantes sont disponibles :

Valeur de la propriété

Description

rollover

Valeur par défaut. La modification de composant est accessible par survol de la souris, via des clics et/ou un menu contextuel.
Pour une utilisation avancée, notez que l’objet côté client correspondant est : CQ.wcm.EditRollover

editbar

L’édition du composant est accessible par le biais d’une barre d’outils.
Pour une utilisation avancée, notez que l’objet côté client correspondant est : CQ.wcm.EditBar

auto

Le choix est laissé au code côté client.

NOTE

Les concepts de survol et de modification ne sont pas applicables dans l’IU tactile.

La configuration suivante ajoute un bouton de modification à la barre de modification du composant :

<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    cq:actions="[edit]"
    cq:layout="editbar"
    jcr:primaryType="cq:EditConfig">
</jcr:root>

cq:dialogMode (IU classique uniquement) cq-dialogmode-classic-ui-only

Le composant peut être lié à une boîte de dialogue de modification. La propriété cq:dialogMode (String) définit le mode d’ouverture de la boîte de dialogue du composant dans l’IU classique. Les valeurs suivantes sont disponibles :

Valeur de la propriété

Description

floating

La boîte de dialogue est flottante.

inline

(valeur par défaut). La boîte de dialogue est ancrée sur le composant.

auto

Si la largeur du composant est inférieure à celle du côté client CQ.themes.wcm.EditBase.INLINE_MINIMUM_WIDTH, la boîte de dialogue est flottante, sinon elle est insérée.

NOTE

Dans l’IU tactile, les boîtes de dialogue flottent toujours en mode bureau et s’ouvrent automatiquement en mode plein écran sur mobile.

La configuration suivante définit une barre de modification avec un bouton de modification et une boîte de dialogue flottante :

<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    cq:actions="[edit]"
    cq:dialogMode="floating"
    cq:layout="editbar"
    jcr:primaryType="cq:EditConfig">
</jcr:root>

cq:emptyText cq-emptytext

La propriété cq:emptyText (String) définit le texte qui est affiché quand aucun contenu visuel n’est présent. Cet attribut est défini, par défaut, sur : Drag components or assets here.

cq:inherit cq-inherit

La propriété cq:inherit (boolean) définit si les valeurs manquantes sont héritées du composant. Cet attribut est défini, par défaut, sur false.

dialogLayout dialoglayout

La propriété dialogLayout définit la façon dont une boîte de dialogue doit s’ouvrir par défaut.

Une valeur fullscreen ouvre la boîte de dialogue en plein écran.
Une valeur vide ou absente ouvre par défaut la boîte de dialogue normalement.
Notez que l’utilisateur peut toujours basculer en mode plein écran dans la boîte de dialogue.
Ne s’applique pas à l’IU classique.

Configuration avec des nœuds enfants cq:EditConfig configuring-with-cq-editconfig-child-nodes

cq:dropTargets cq-droptargets

Le nœud cq:dropTargets (type de nœud nt:unstructured) définit une liste de cibles de dépôt pouvant accepter une ressource déplacée à partir de l’outil de recherche de contenu. Il sert de collection de nœuds de type cq:DropTargetConfig.

NOTE

Les cibles de dépôt multiples sont uniquement disponibles dans l’IU classique.

Dans l’IU tactile, seule la première cible est utilisée.

Chaque nœud enfant de type cq:DropTargetConfig définit une cible de dépôt dans le composant. Le nom du nœud est important car il doit être utilisé dans JSP, comme suit, pour générer le nom de classe CSS affecté à l’élément DOM qui est la cible de dépôt réelle :

<drop target css class> = <drag and drop prefix> +
 <node name of the drop target in the edit configuration>

Le <*drag and drop prefix*> est défini par la propriété Java :

com.day.cq.wcm.api.components.DropTarget.CSS_CLASS_PREFIX.

Par exemple, le nom de classe est défini comme suit dans le JSP du composant Téléchargement.
( /libs/foundation/components/download/download.jsp), où file est le nom de noeud de la cible de dépôt dans la configuration d’édition du composant Téléchargement :

String ddClassName = DropTarget.CSS_CLASS_PREFIX + "file";

Le nœud de type cq:DropTargetConfig doit posséder les propriétés suivantes :

Nom de la propriété

Valeur de la propriété

accept

Expression régulière appliquée au type MIME de la ressource pour valider si le dépôt est autorisé.

groups

Tableau de groupes cibles de dépôt. Chaque groupe doit correspondre au type de groupe défini dans l’extension du Content Finder et associé aux ressources.

propertyName

Nom de la propriété qui sera mise à jour après un dépôt valide.

La configuration suivante est issue du composant Télécharger. Elle active n’importe quelle ressource (le type mime peut être n’importe quelle chaîne) à partir du groupe media à déposer à partir de l’outil de recherche de contenu dans le composant. Après le dépôt, la propriété de composant fileReference est mise à jour :

    <cq:dropTargets jcr:primaryType="nt:unstructured">
        <file
            jcr:primaryType="cq:DropTargetConfig"
            accept="[.*]"
            groups="[media]"
            propertyName="./fileReference"/>
    </cq:dropTargets>

cq:actionConfigs (IU classique uniquement) cq-actionconfigs-classic-ui-only

Le nœud cq:actionConfigs (type de nœud nt:unstructured) définit une liste de nouvelles actions ajoutées à la liste définie par la propriété cq:actions. Chaque nœud enfant de cq:actionConfigs définit une nouvelle action en définissant un widget.

L’exemple de configuration suivant définit un nouveau bouton (avec un séparateur pour l’IU classique) :

un séparateur, défini par le xtype tbseparator ;
- applicable uniquement dans l’IU classique.
- Cette définition est ignorée par l’IU tactile dans la mesure où les xtypes sont ignorés (et les séparateurs sont inutiles car la barre d’outils d’action est construite différemment dans l’IU tactile).
un bouton nommé Gérer les commentaires qui exécute la fonction de gestionnaire CQ_collab_forum_openCollabAdmin().

<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
    cq:actions="[EDIT,COPYMOVE,DELETE,INSERT]"
    jcr:primaryType="cq:EditConfig">
    <cq:actionConfigs jcr:primaryType="nt:unstructured">
        <separator0
            jcr:primaryType="nt:unstructured"
            xtype="tbseparator"/>
        <manage
            jcr:primaryType="nt:unstructured"
            handler="function(){CQ_collab_forum_openCollabAdmin();}"
            text="Manage comments"/>
    </cq:actionConfigs>
</jcr:root>

NOTE

Consultez Ajout d’une nouvelle action à une barre d’outils de composants à titre d’exemple pour l’IU tactile.

cq:formParameters cq-formparameters

Le nœud cq:formParameters (type de nœud nt:unstructured) définit des paramètres supplémentaires qui sont ajoutés au formulaire de la boîte de dialogue. Chaque propriété est mappée à un paramètre de formulaire.

La configuration suivante ajoute un paramètre appelé name, défini avec la valeur photos/primary dans le formulaire de boîte de dialogue :

    <cq:formParameters
        jcr:primaryType="nt:unstructured"
        name="photos/primary"/>

cq:inplaceEditing cq-inplaceediting

Le nœud cq:inplaceEditing (type de nœud cq:InplaceEditingConfig) définit une configuration de modification en place pour le composant. Il peut posséder les propriétés suivantes :

Nom de la propriété

Valeur de la propriété

active

(boolean) True pour activer la modification locale du composant.

configPath

(String) Chemin d’accès à l’éditeur de configuration. La configuration peut être spécifiée par un nœud de configuration.

editorType

(String) Type d’éditeur. Les types disponibles sont les suivants :

Plaintext : à utiliser pour le contenu non HTML.
title : éditeur de texte en clair amélioré qui convertit les titres graphiques en texte clair avant que l’édition ne commence. Utilisé par le composant title de Geometrixx.
text : à utiliser pour du contenu HTML (utilise l’éditeur de texte enrichi).

La configuration suivante active la modification locale du composant et définit plaintext comme type d’éditeur :

    <cq:inplaceEditing
        jcr:primaryType="cq:InplaceEditingConfig"
        active="{Boolean}true"
        editorType="plaintext"/>

cq:listeners cq-listeners

Le nœud cq:listeners (type de nœud cq:EditListenersConfig) définit ce qui se passe avant ou après une action sur le composant. Le tableau suivant définit ses propriétés possibles.

Nom de la propriété

Valeur de la propriété

Valeur par défaut

(IU classique uniquement)

beforedelete

Le gestionnaire est déclenché avant la suppression du composant.

beforeedit

Le gestionnaire est déclenché avant la modification du composant.

beforecopy

Le gestionnaire est déclenché avant la copie du composant.

beforemove

Le gestionnaire est déclenché avant le déplacement du composant.

beforeinsert

Le gestionnaire est déclenché avant l’insertion du composant.
Valide uniquement pour l’IU tactile.

beforechildinsert

Le gestionnaire est déclenché avant l’insertion du composant dans un autre composant (conteneurs uniquement).

afterdelete

Le gestionnaire est déclenché après la suppression du composant.

REFRESH_SELF

afteredit

Le gestionnaire est déclenché après la modification du composant.

REFRESH_SELF

aftercopy

Le gestionnaire est déclenché après la copie du composant.

REFRESH_SELF

afterinsert

Le gestionnaire est déclenché après l’insertion du composant.

REFRESH_INSERTED

aftermove

Le gestionnaire est déclenché après le déplacement du composant.

REFRESH_SELFMOVED

afterchildinsert

Le gestionnaire est déclenché après l’insertion du composant dans un autre composant (conteneurs uniquement).

NOTE

Les gestionnaires REFRESH_INSERTED et REFRESH_SELFMOVED sont uniquement disponibles dans l’IU classique.

NOTE

Les valeurs par défaut des écouteurs ne sont définies que dans l’IU classique.

NOTE

Dans le cas des composants imbriqués, certaines restrictions existent sur les actions définies en tant que propriétés sur le nœud cq:listeners :

Pour les composants imbriqués, les valeurs des propriétés doivent être REFRESH_PAGE :
- aftermove
- aftercopy

Le gestionnaire d’événements peut être mis en œuvre avec une implémentation personnalisée. Par exemple (où project.customerAction est une méthode statique) :

afteredit = "project.customerAction"

L’exemple suivant est équivalent à la configuration REFRESH_INSERTED :

afterinsert="function(path, definition) { this.refreshCreated(path, definition); }"

NOTE

En ce qui concerne l’IU classique, pour voir quels paramètres peuvent être utilisés dans les gestionnaires, reportez-vous aux sections des événements before<action> > et after<action> > de la documentation sur les widgets CQ.wcm.EditBar et CQ.wcm.EditRollover.

Avec la configuration suivante, la page est actualisée après la suppression, la modification, l’insertion ou le déplacement du composant :

    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afterdelete="REFRESH_PAGE"
        afteredit="REFRESH_PAGE"
        afterinsert="REFRESH_PAGE"
        afterMove="REFRESH_PAGE"/>

recommendation-more-help

2315f3f5-cb4a-4530-9999-30c8319c520e