Développement de présentations de section personnalisées avec des API

Vous pouvez développer des présentations de section personnalisées dans Oracle Content Management avec l'API de présentation de section, qui comprend des API d'affichage et de modification.

Pour en savoir plus sur les fichiers de départ à consulter, reportez-vous à Création d'une présentation de section. Les fichiers de départ des présentations de section comprennent des commentaires qui donnent des informations sur la structure des fichiers de présentation de section.

API d'affichage

Chargées à partir du module render.js, les API d'affichage sont utilisées dans le générateur de site et lors de l'exécution.

API d'affichage Description Paramètres d'entrée Résultat renvoyé

API d'affichage	Description	Paramètres d'entrée	Résultat renvoyé
(Constructeur)	Initialise le module d'affichage de présentation de section.	Objet JavaScript qui contient les propriétés suivantes : sectionlayoutData (objet) : données de présentation de section trouvées dans le modèle de page. componentId (chaîne) : valeur `componentId` de la présentation de section, généralement un GUID. renderMode (chaîne, facultatif) : mode d'affichage de l'opération d'affichage. customSettingsData (objet) : copie de l'objet `customSettingsData` trouvé dans `sectionLayoutData`.	Les API d'affichage de présentation de section sont initialisées.
render	Emet des éléments DOM appropriés pour la présentation de section vers la page, y compris des éléments DIV de conteneur pour les composants enfant.	container (élément) : élément DOM dans lequel le balisage de la présentation de section doit être affiché.	Les composants enfant seront affichés après le renvoi de cette méthode. Vous pouvez identifier les composants enfant en recherchant les éléments `div[id]` enfant.
addComponent	Fonction utilisée avec les composants de liste de contenu pour ajouter dynamiquement des composants enfant à une présentation de section. Elle est facultative.	container (élément) : élément DOM dans lequel le nouveau composant doit être affiché. componentId (chaîne) : ID du nouveau composant à ajouter à la présentation de section.	L'élément dont l'ID correspond à l'entrée `componentId` sera affiché après le renvoi de cette méthode.

(Constructeur)

Initialise le module d'affichage de présentation de section.

Objet JavaScript qui contient les propriétés suivantes :

sectionlayoutData (objet) : données de présentation de section trouvées dans le modèle de page.
componentId (chaîne) : valeur componentId de la présentation de section, généralement un GUID.
renderMode (chaîne, facultatif) : mode d'affichage de l'opération d'affichage.
customSettingsData (objet) : copie de l'objet customSettingsData trouvé dans sectionLayoutData.

Les API d'affichage de présentation de section sont initialisées.

render

Emet des éléments DOM appropriés pour la présentation de section vers la page, y compris des éléments DIV de conteneur pour les composants enfant.

container (élément) : élément DOM dans lequel le balisage de la présentation de section doit être affiché.

Les composants enfant seront affichés après le renvoi de cette méthode.

Vous pouvez identifier les composants enfant en recherchant les éléments div[id] enfant.

addComponent

Fonction utilisée avec les composants de liste de contenu pour ajouter dynamiquement des composants enfant à une présentation de section.

Elle est facultative.

container (élément) : élément DOM dans lequel le nouveau composant doit être affiché.

componentId (chaîne) : ID du nouveau composant à ajouter à la présentation de section.

L'élément dont l'ID correspond à l'entrée componentId sera affiché après le renvoi de cette méthode.

API de modification

Le module edit.js est chargé si la propriété hasEditHandlers est définie sur true dans le fichier appinfo.json associé à la présentation de section.

Les API de modification sont utilisées dans le générateur de site.

A l'exception du constructeur, toutes les fonctions de ce module sont facultatives.

API de modification	Description	Paramètres d'entrée	Résultat renvoyé
(Constructeur)	Initialise le module de modification de présentation de section.	Objet JavaScript qui contient la propriété suivante : componentId (chaîne) : valeur `componentId` de la présentation de section, généralement un GUID.	Les API de modification de présentation de section sont initialisées.
getCapabilities	Renvoie un objet décrivant les fonctionnalités de modification de la présentation de section.	Objet JavaScript qui décrit les fonctionnalités de modification de la présentation de section. Lors de l'entrée, les fonctionnalités par défaut seront fournies à la fonction. La fonction peut modifier l'objet de fonctionnalités si besoin. L'objet de fonctionnalités peut inclure les fonctionnalités suivantes : title (chaîne) : titre de la présentation de section à afficher pour l'utilisateur. settingsTitle (chaîne) : titre à afficher dans la boîte de dialogue du panneau des paramètres. hasSettings (booléen) : indique si la présentation de section prend en charge un panneau de paramètres. allowMove (booléen) : indique si la présentation de section autorise le déplacement des éléments enfant. allowDelete (booléen) : indique si la présentation de section autorise la suppression des éléments enfant. isHidden (booléen) : indique si la présentation de section est actuellement masquée en réponse aux options utilisateur. dropTarget (booléen) : indique si la présentation de section est la cible des opérations glisser-déplacer. customMenuOptions (tableau) : options de menu personnalisées à ajouter au menu contextuel de la présentation de section. Chaque objet d'option de menu contient les propriétés suivantes : label (chaîne) : texte d'affichage de l'élément de menu. action (fonction) : fonction à appeler lorsque l'utilisateur clique sur l'élément de menu. disabled (booléen) : indique que l'élément de menu doit être affiché à l'état désactivé. icon (chaîne) : URL à afficher avec l'étiquette dans l'élément de menu. (Cette propriété est réservée en vue d'une utilisation ultérieure.) checkmark (booléen) : indique qu'une case à cocher doit apparaître avec l'étiquette dans l'élément de menu. subMenuItems (tableau) : options de menu à afficher dans un sous-menu.	(Objet) : fonctionnalités de la présentation de section.
getCaptionContent	Renvoie le nom d'affichage de la présentation de section, qui apparaîtra dans les éléments de l'interface utilisateur.	Aucun.	(Chaîne) : nom d'affichage de la présentation de section.
filterCapabilities	Permet à la présentation de section de modifier l'objet de fonctionnalités avant d'afficher les menus pour les utilisateurs. Vous pouvez utiliser cette API pour ajuster ou enlever des options de menu. (Reportez-vous également à getCapabilities.)	Objet JavaScript qui décrit les fonctionnalités de modification de la présentation de section. Lors de l'entrée, les fonctionnalités par défaut seront fournies à la fonction.	(Objet) Fonctionnalités de la présentation de section.
onDragOver	API appelée lors d'une opération glisser-déplacer pour indiquer si l'élément glissé peut être déplacé vers la section de présentation.	eventObject (objet d'événement) : objet d'événement qui contient les informations sur l'événement de glissement. dataTransfer (objet DataTransfer) : objet `DataTransfer` qui contient les informations concernant l'élément glissé vers la section de présentation.	(Booléen) Valeur indiquant si l'élément glissé peut être accepté par la présentation de section. Renvoie true si la présentation de section peut accepter l'élément glissé, sinon renvoie false.
onDrop	API appelée lors de la partie déplacement d'une opération glisser-déplacer pour indiquer que l'élément glissé doit être placé dans la section de présentation.	eventObject (objet d'événement) : objet d'événement qui contient les informations sur l'événement de déplacement. dataTransfer (objet DataTransfer) : objet DataTransfer qui contient les informations concernant l'élément déplacé vers la section de présentation.	(Booléen) Valeur indiquant si l'opération de déplacement a été gérée par la présentation de section. Si la valeur true est renvoyée, la logique par défaut est ignorée.
onAddComponent	Informe la présentation de section qu'une opération de glisser-déplacer a ajouté un élément dans la présentation de section.	eventObject (objet d'événement) : objet d'événement qui contient les informations sur l'événement de glissement. dataTransfer (objet DataTransfer) : objet DataTransfer qui contient les informations concernant l'élément déplacé vers la section de présentation. componentId (chaîne) : valeur `componentId` du nouvel élément ajouté.	Notification de présentation de section.
onMoveComponent	Informe la présentation de section qu'une opération glisser-déplacer a déplacé un élément dans la présentation de section.	eventObject (objet d'événement) : objet d'événement qui contient les informations sur l'événement de glissement. dataTransfer (objet DataTransfer) : objet DataTransfer qui contient les informations concernant l'élément déplacé vers la section de présentation. componentId (chaîne) : valeur `componentId` de l'élément déplacé.	Notification de présentation de section.
getSettingsData	Permet à la présentation de section de modifier les données de paramètres avant l'affichage du panneau des paramètres.	settingsData (objet) : données de paramètres par défaut calculées pour la présentation de section	(Objet) Données de paramètres de la présentation de section.
updateSettings	Permet à la présentation de section de modifier ses paramètres après la fermeture du panneau des paramètres. Cette API est appelée juste avant le stockage des paramètres dans le modèle de page.	parameters (objet) : objet de paramètres bruts renvoyé à partir du panneau des paramètres. sectionLayoutData (objet) : données de présentation de section qui seront stockées. Les données par défaut seront générées à partir de `parameters (objet)` et transmises à la fonction de ce paramètre.	(Objet) Données de présentation de section à stocker dans le modèle de page.
dispose	Permet au module de modification de libérer de la mémoire, de détacher des événements et d'annuler l'allocation des ressources associées aux gestionnaires de modification. Cette API est appelée lorsque la présentation de section doit être entièrement redéfinie, par exemple dans le cas d'une opération annuler/rétablir.	Aucun.	La redéfinition de la présentation de section est activée.