Dezvoltarea machetelor de secţiuni personalizate cu API-uri

Puteţi dezvolta machete de secţiuni personalizate în Oracle Content Management cu API-ul Machetă de secţiuni, care include API-uri de randare şi API-uri de editare.

Pentru a vă familiariza cu fişierele starter, consultaţi Crearea unei machete de secţiuni. Fişierele starter pentru machetele de secţiuni includ comentarii cu detalii despre structura fişierelor machetelor de secţiuni.

API-urile de randare

API-urile de randare, încărcate din modulul render.js, sunt utilizate în Generatorul de site-uri şi la runtime.

API de randare Descriere Parametru (parametri) de intrare Rezultat returnat

API de randare	Descriere	Parametru (parametri) de intrare	Rezultat returnat
(Constructor)	Iniţializează modulul de randare pentru macheta de secţiuni.	Un obiect JavaScript care conţine următoarele proprietăţi: sectionlayoutData (obiect) : Datele machetei de secţiuni găsite în modelul paginii. componentId (şir): Valoarea `componentId` a machetei de secţiuni, în general, un identificator GUID. renderMode (şir, opţional): Modul de randare pentru operaţia de randare. customSettingsData (obiect): O copie a parametrului `customSettingsData` din secţiunea `sectionLayoutData.`	API-urile de randare pentru machetele de secţiuni sunt iniţializate.
render	Emite elemente DOM relevante pentru macheta de secţiuni către pagină, inclusiv DIV-urile containerului pentru componente fiu.	container (element) : Elementul DOM în care ar trebui randat marcajul machetei de secţiuni.	După returnarea acestei metode, componentele fiu vor fi randate. Puteţi să identificaţi componentele fiu căutând elementele fiu `div[id]`
addComponent	Se utilizează cu componente de tip listă de conţinut pentru a adăuga în mod dinamic componente fiu la o machetă de secţiuni. Această funcţie este opţională.	container (element): Elementul DOM în care ar trebui randată noua componentă. componentId (şir): ID-ul noii componente care se adaugă la macheta de secţiuni.	După returnarea acestei metode, elementul al cărui ID corespunde intrării `componentId` va fi randat.

(Constructor)

Iniţializează modulul de randare pentru macheta de secţiuni.

Un obiect JavaScript care conţine următoarele proprietăţi:

sectionlayoutData (obiect) : Datele machetei de secţiuni găsite în modelul paginii.
componentId (şir): Valoarea componentId a machetei de secţiuni, în general, un identificator GUID.
renderMode (şir, opţional): Modul de randare pentru operaţia de randare.
customSettingsData (obiect): O copie a parametrului customSettingsData din secţiunea sectionLayoutData.

API-urile de randare pentru machetele de secţiuni sunt iniţializate.

render

Emite elemente DOM relevante pentru macheta de secţiuni către pagină, inclusiv DIV-urile containerului pentru componente fiu.

container (element) : Elementul DOM în care ar trebui randat marcajul machetei de secţiuni.

După returnarea acestei metode, componentele fiu vor fi randate.

Puteţi să identificaţi componentele fiu căutând elementele fiu div[id]

addComponent

Se utilizează cu componente de tip listă de conţinut pentru a adăuga în mod dinamic componente fiu la o machetă de secţiuni.

Această funcţie este opţională.

container (element): Elementul DOM în care ar trebui randată noua componentă.

componentId (şir): ID-ul noii componente care se adaugă la macheta de secţiuni.

După returnarea acestei metode, elementul al cărui ID corespunde intrării componentId va fi randat.

API-uri de editare

Modulul edit.js este încărcat dacă proprietatea hasEditHandlers este setată la true în fişierul appinfo.json asociat cu macheta de secţiuni.

API-urile de editare sunt utilizate în Generatorul de site-uri.

Toate funcţiile din acest modul, în afară de Constructor, sunt opţionale.

API de editare	Descriere	Parametru (parametri) de intrare	Rezultat returnat
(Constructor)	Iniţializează modulul de editare a machetei de secţiuni.	Un obiect JavaScript care conţine următoarea proprietate: componentId (şir): Valoarea `componentId` a machetei de secţiuni, în general, un identificator GUID.	API-urile de editare pentru machetele de secţiuni sunt iniţializate.
getCapabilities	Returnează un obiect care descrie capacităţile de editare ale machetei de secţiuni.	Un obiect JavaScript care descrie capacităţile de editare ale machetei de secţiuni. După introducere, capacităţile prestabilite vor fi furnizate funcţiei. Funcţia poate modifica obiectul Capacităţi, dacă este necesar. Obiectul Capacităţi poate include următoarele capacităţi: title (şir): Titlul machetei de secţiuni care se afişează utilizatorului. settingsTitle (şir): Titlul care se afişează în dialogul panoului Setări. hasSettings (boolean): Indică dacă macheta de secţiuni acceptă un panou Setări. allowMove (boolean): Indică dacă macheta de secţiuni permite mutarea elementelor fiu. allowDelete (boolean): Indică dacă macheta de secţiuni permite ştergerea elementelor fiu. isHidden (boolean): Indică dacă macheta de secţiuni este ascunsă în prezent ca răspuns la opţiunile utilizatorului. dropTarget (boolean): Indică dacă macheta de secţiuni este destinaţia pentru operaţiile de tragere şi plasare. customMenuOptions (matrice): Opţiuni de meniu personalizate de adăugat la meniul contextual Machetă de secţiuni. Fiecare obiect aferent opţiunilor de meniu are următoarele proprietăţi: label (şir) : Textul afişat al elementului de meniu. action (funcţie): Funcţia de invocat atunci când se face clic pe elementul de meniu. disabled (boolean): Indică faptul că elementul de meniu ar trebui să se afişeze într-o stare dezactivată. icon (şir): URL-ul care se afişează alături de etichetă în elementul de meniu. (Această proprietate este rezervată pentru utilizare ulterioară.) checkmark (boolean): Indică faptul că ar trebui să apară o bifă alături de etichetă în elementul de meniu. subMenuItems (matrice): Opţiuni de meniu de afişat într-un submeniu.	(Obiect): Capacităţile pentru macheta de secţiuni.
getCaptionContent	Returnează numele afişat al machetei de secţiuni, care va apărea în elementele de interfaţă cu utilizatorul.	Niciunul.	(Şir): Numele afişat al machetei de secţiuni.
filterCapabilities	Permite machetei de secţiuni să modifice obiectul Capacităţi înainte ca meniurile să fie afişate utilizatorului. Puteţi utiliza acest API pentru a ajusta sau a elimina opţiunile de meniu. (Consultaţi şi getCapabilities.)	Un obiect JavaScript care descrie capacităţile de editare ale machetei de secţiuni. După introducere, capacităţile prestabilite vor fi furnizate funcţiei.	(Obiect) Capacităţile pentru macheta de secţiuni.
onDragOver	Se apelează în timpul unei operaţii de tragere şi plasare pentru a indica dacă elementul tras poate fi plasat pe macheta de secţiuni.	eventObject (obiect eveniment): un obiect de tip eveniment care conţine informaţii despre un eveniment de tragere. dataTransfer (obiect DataTransfer): Un obiect de tip `DataTransfer` care conţine informaţii despre elementul care este tras deasupra machetei de secţiuni.	(Boolean) O valoare care indică dacă elementul tras poate fi acceptat de macheta de secţiuni. Returnează adevărat dacă macheta de secţiuni poate accepta elementul tras, fals, în caz contrar.
onDrop	Se apelează în timpul acţiunii de plasare a unei operaţii de tragere şi plasare pentru a indica faptul că elementul tras ar trebui plasat în interiorul machetei de secţiuni.	eventObject (obiect eveniment) : Un obiect de tip eveniment care conţine informaţii despre evenimentul de plasare. dataTransfer (obiect DataTransfer) Un obiect de tip DataTransfer care conţine informaţii despre elementul care este plasat pe macheta de secţiuni.	(Boolean) O valoare care indică dacă operaţia de plasare a fost tratată de macheta de secţiuni. Dacă se returnează adevărat, este ocolită logica prestabilită.
onAddComponent	Înştiinţează macheta de secţiuni că o operaţie de glisare şi plasare a adăugat un element în macheta de secţiuni.	eventObject (obiect eveniment): un obiect de tip eveniment care conţine informaţii despre un eveniment de tragere. dataTransfer (obiect DataTransfer): Un obiect de tip DataTransfer care conţine informaţii despre elementul plasat pe macheta de secţiuni. componentId (şir): Valoarea `componentId` a elementului nou adăugat.	Înştiinţare pentru macheta de secţiuni.
onMoveComponent	Înştiinţează macheta de secţiuni că o operaţie de tragere şi plasare a mutat un element în macheta de secţiuni.	eventObject (obiect eveniment): un obiect de tip eveniment care conţine informaţii despre un eveniment de tragere. dataTransfer (obiect DataTransfer): Un obiect de tip DataTransfer care conţine informaţii despre elementul plasat pe macheta de secţiuni. componentId (şir): Valoarea `componentId` a elementului mutat.	Înştiinţare pentru macheta de secţiuni.
getSettingsData	Permite machetei de secţiuni să modifice datele setărilor înainte de a se afişa panoul Setări.	settingsData (obiect): Datele prestabilite ale setărilor, calculate pentru macheta de secţiuni	(Obiect) Datele setărilor pentru macheta de secţiuni.
updateSettings	Permite machetei de secţiuni să-şi modifice setările după închiderea panoului Setări. Acest API este apelat exact înainte ca setările să fie stocate în modelul paginii.	parameters (obiect): Obiectul aferent parametrilor de bază, returnat din panoul Setări. sectionLayoutData (obiect) : Datele machetei de secţiuni care vor fi stocate. Datele prestabilite vor fi generate din `parameters (obiect)` şi transferate funcţiei din acest parametru.	(Obiect) Datele machetei de secţiuni de stocat în modelul paginii.
dispose	Permite modulului de editare să elibereze memorie, să detaşeze evenimente şi să dezaloce resurse asociate cu rutinele de editare. Acest API este apelat atunci când macheta de secţiuni trebuie redesenată complet, ca în cazul unei operaţii de anulare/repetare.	Niciunul.	Redesenarea machetei de secţiuni este activată.