Egyéni szakaszelrendezések fejlesztése API felületekkel

Egyéni szakaszelrendezéseket fejleszthet az Oracle Content Management szolgáltatásban a szakaszelrendezési API segítségével, amely a megjelenítési és szerkesztési API felületeket tartalmazza.

A kiinduló fájlokról a tudnivalókat lásd: Szakaszelrendezés létrehozása. A szakaszelrendezésekhez tartozó kiinduló fájlok megjegyzéseket és a szakaszelrendezési fájlok szerkezetére vonatkozó adatokat tartalmaznak.

Megjelenítési API felületek

A render.js modulból betöltött megjelenítési API felületek a Site Builder szolgáltatásban és futásidőben használatosak.

Megjelenítési API Leírás Bemeneti paraméter Visszatérési eredmény

Megjelenítési API	Leírás	Bemeneti paraméter	Visszatérési eredmény
(Konstruktor)	Inicializálja a szakaszelrendezés megjelenítési modulját.	JavaScript objektum, amely a következő tulajdonságokat tartalmazza: sectionlayoutData (objektum) : a szakaszelrendezés oldalmodellben található adatai. componentId (karakterlánc): a szakaszelrendezés `componentId` értéke, jellemzően GUID azonosító. renderMode (karakterlánc, választható): a megjelenítési művelet megjelenítési módja. customSettingsData (objektum): a `sectionLayoutData` tulajdonságban található `customSettingsData` másolata.	A szakaszelrendezés megjelenítési API felületei inicializálva vannak.
render	A szakaszelrendezésnek megfelelő DOM elemeket ad ki az oldalnak, beleértve a tároló DIV elemeit az alárendelt összetevőkhöz.	container (elem) : az a DOM elem, amelybe a szakaszelrendezés kódját meg kell jeleníteni.	A metódus visszatérése után az alárendelt összetevők meg lesznek jelenítve. Az alárendelt összetevőket az alárendelt `div[id]` elemek keresésével azonosíthatja
addComponent	A tartalomlista összetevőivel használatos alárendelt összetevők dinamikus hozzáadására szakaszelrendezéshez. Ez választható függvény.	container (elem) : az a DOM elem, amelybe az új összetevőt meg kell jeleníteni. componentId (karakterlánc): a szakaszelrendezéshez hozzáadni kívánt új összetevő azonosítója.	A metódus visszatérése után a `componentId` bemeneti paraméterrel megegyező azonosítójú elem meg lesz jelenítve.

(Konstruktor)

Inicializálja a szakaszelrendezés megjelenítési modulját.

JavaScript objektum, amely a következő tulajdonságokat tartalmazza:

sectionlayoutData (objektum) : a szakaszelrendezés oldalmodellben található adatai.
componentId (karakterlánc): a szakaszelrendezés componentId értéke, jellemzően GUID azonosító.
renderMode (karakterlánc, választható): a megjelenítési művelet megjelenítési módja.
customSettingsData (objektum): a sectionLayoutData tulajdonságban található customSettingsData másolata.

A szakaszelrendezés megjelenítési API felületei inicializálva vannak.

render

A szakaszelrendezésnek megfelelő DOM elemeket ad ki az oldalnak, beleértve a tároló DIV elemeit az alárendelt összetevőkhöz.

container (elem) : az a DOM elem, amelybe a szakaszelrendezés kódját meg kell jeleníteni.

A metódus visszatérése után az alárendelt összetevők meg lesznek jelenítve.

Az alárendelt összetevőket az alárendelt div[id] elemek keresésével azonosíthatja

addComponent

A tartalomlista összetevőivel használatos alárendelt összetevők dinamikus hozzáadására szakaszelrendezéshez.

Ez választható függvény.

container (elem) : az a DOM elem, amelybe az új összetevőt meg kell jeleníteni.

componentId (karakterlánc): a szakaszelrendezéshez hozzáadni kívánt új összetevő azonosítója.

A metódus visszatérése után a componentId bemeneti paraméterrel megegyező azonosítójú elem meg lesz jelenítve.

Szerkesztési API felületek

Az edit.js modul akkor töltődik be, ha a hasEditHandlers tulajdonság beállítása true a szakaszelrendezéshez társított appinfo.json fájlban.

A szerkesztési API felületek a Site Builder szolgáltatásban használatosak.

A Konstruktor kivételével a modul valamennyi függvénye választható.

Szerkesztési API	Leírás	Bemeneti paraméter	Visszatérési eredmény
(Konstruktor)	Inicializálja a szakaszelrendezés szerkesztési modulját.	JavaScript objektum, amely a következő tulajdonságot tartalmazza: componentId (karakterlánc): a szakaszelrendezés `componentId` értéke, jellemzően GUID azonosító.	A szakaszelrendezés szerkesztési API felületei inicializálva vannak.
getCapabilities	A szakaszelrendezés szerkesztési funkcióit leíró objektumot ad vissza.	JavaScript objektum, amely a szakaszelrendezés szerkesztési funkcióit írja le. A bevitelt követően az alapértelmezett funkciók állnak rendelkezésre. Szükség szerint módosíthatja a Capabilities objektumot. A Capabilities objektum a következő funkciókat tartalmazhatja: title (karakterlánc): a szakaszelrendezés felhasználónak megjeleníteni kívánt címe. settingsTitle (karakterlánc): a Beállítások párbeszédpanelen megjeleníteni kívánt cím. hasSettings (logikai érték): azt jelzi, hogy a szakaszelrendezés támogatja-e a Beállítások panelt. allowMove (logikai érték): azt jelzi, hogy a szakaszelrendezés lehetővé tesz-e alárendelt elemek áthelyezését. allowDelete (logikai érték): azt jelzi, hogy a szakaszelrendezés lehetővé teszi-e alárendelt elemek törlését. isHidden (logikai érték): azt jelzi, hogy a szakaszelrendezés elrejtett-e a felhasználói beállításokra válaszul. dropTarget (logikai érték): azt jelzi, hogy a szakaszelrendezés célterület-e áthúzási műveletek számára. customMenuOptions (tömb): a szakaszelrendezés helyi menüjére felvenni kívánt egyéni menüelemek. Az egyes menüelem objektumok a következő tulajdonságokkal rendelkeznek: label (karakterlánc) : a menüelem megjelenített szövege. action (függvény): a menüelemre kattintáskor hívott függvény. disabled (logikai érték): azt jelzi, hogy a menüelemet letiltott állapotban kell-e megjeleníteni. icon (karakterlánc): a menüelem felirata mellett megjeleníteni kívánt URL-cím. (Ez a tulajdonság későbbi használatra van fenntartva.) checkmark (logikai érték): azt jelzi, hogy meg kell-e jelennie pipajelnek a menüelem felirata mellett. subMenuItems (tömb): almenün megjeleníteni kívánt menüelemek.	(Objektum): a szakaszelrendezéshez tartozó funkciók.
getCaptionContent	A szakaszelrendezés megjelenítési nevét adja vissza, amely az UI-elemeken fog megjelenni.	Nincs.	(Karakterlánc): a szakaszelrendezés megjelenítési neve.
filterCapabilities	Lehetővé teszi a szakaszelrendezés számára a Capabilities objektum módosítását menük felhasználónak való megjelenítése előtt. Ezt az API felületet menüelemek módosítására vagy eltávolítására használhatja. (Lásd még: getCapabilities.)	JavaScript objektum, amely a szakaszelrendezés szerkesztési funkcióit írja le. A bevitelt követően az alapértelmezett funkciók állnak rendelkezésre.	(Objektum): a szakaszelrendezéshez tartozó funkciók.
onDragOver	Hívására áthúzási művelet során kerül sor annak jelzésére, hogy az áthúzott elem elhelyezhető-e a szakaszelrendezésen.	eventObject (esemény objektum): áthúzási eseményre vonatkozó adatokat tartalmazó esemény objektum. dataTransfer (DataTransfer objektum): a szakaszelrendezés fölé húzott elemre vonatkozó adatokat tartalmazó `DataTransfer` objektum.	(Logikai érték): azt jelzi, hogy az áthúzott elemet elfogadhatja-e a szakaszelrendezés. Visszatérési értéke true, ha a szakaszelrendezés elfogadhatja az áthúzott elemet, ellenkező esetben false.
onDrop	Hívására áthúzási művelet elhelyezési része során kerül sor annak jelzésére, hogy az áthúzott elemet el kell-e helyezni a szakaszelrendezésen belül.	eventObject (esemény objektum): elhelyezési eseményre vonatkozó adatokat tartalmazó esemény objektum. dataTransfer (DataTransfer objektum): a szakaszelrendezésen elhelyezni kívánt objektumra vonatkozó adatokat tartalmazó DataTransfer objektum.	(Logikai érték): azt jelzi, hogy az elhelyezési műveletet kezelte-e a szakaszelrendezés. A true visszatérési érték figyelmen kívül hagyja az alapértelmezett viselkedést.
onAddComponent	Arról értesíti a szakaszelrendezést, hogy egy áthúzási művelet elemet vett fel a szakaszelrendezésen.	eventObject (esemény objektum): áthúzási eseményre vonatkozó adatokat tartalmazó esemény objektum. dataTransfer (DataTransfer objektum): a szakaszelrendezésen elhelyezni kívánt objektumra vonatkozó adatokat tartalmazó DataTransfer objektum. componentId (karakterlánc): az újonnan felvett elem `componentId` értéke.	Szakaszelrendezés értesítése.
onMoveComponent	Arról értesíti a szakaszelrendezést, hogy egy áthúzási művelet elemet helyezett át a szakaszelrendezésen.	eventObject (esemény objektum): áthúzási eseményre vonatkozó adatokat tartalmazó esemény objektum. dataTransfer (DataTransfer objektum): a szakaszelrendezésen elhelyezni kívánt objektumra vonatkozó adatokat tartalmazó DataTransfer objektum. componentId (karakterlánc): az áthelyezett elem `componentId` értéke.	Szakaszelrendezés értesítése.
getSettingsData	Lehetővé teszi a szakaszelrendezés számára a Beállítások adatainak módosítását a Beállítások panel megjelenítése előtt.	settingsData (objektum): a szakaszelrendezés számára kiszámított alapértelmezett beállítási adatok.	(Objektum): a szakaszelrendezéshez tartozó beállítási adatok.
updateSettings	Lehetővé teszi a szakaszelrendezés számára beállításainak módosítását a Beállítások panel bezárása után. Az API hívására közvetlenül a beállítások oldalmodellben való tárolása előtt kerül sor.	parameters (objektum): a Beállítások panelről visszaadott nyers parameters objektum. sectionLayoutData (objektum) : a szakaszelrendezés tárolásra kerülő adatai. Az alapértelmezett adatok előállítása a `parameters (objektum)` paraméterből történik, és ezek lesznek átadva a függvénynek.	(Objektum): a szakaszelrendezés oldalmodellben tárolandó adatai.
dispose	Lehetővé teszi a szerkesztési modul számára memória felszabadítását, események leválasztását és a szerkesztéskezelőkhöz társított erőforrások kiosztásának megszüntetését. Az API hívására akkor kerül sor, amikor teljesen újra kell rajzolni a szakaszelrendezést, például visszavonás/ismételt végrehajtás műveletnél.	Nincs.	A szakaszelrendezés újrarajzolása engedélyezve van.