Utveckla anpassade sektionslayouter med API-gränssnitt

Du kan utveckla anpassade sektionslayouter i Oracle Content Management med API-gränssnittet Sektionslayout, som inkluderar API-gränssnitt för återgivning och API-gränssnitt för redigering.

Startfiler att titta på finns i Skapa en sektionslayout. Startfilerna för sektionslayouter inkluderar kommentarer med detaljer om sektionslayoutfilernas struktur.

Återgivnings-API:er

Återgivnings-API:erna, som laddas från modulen render.js, används i webbplatsverktyget och vid exekvering.

Återgivnings-API Beskrivning Indataparametrar Returresultat

Återgivnings-API	Beskrivning	Indataparametrar	Returresultat
(konstruktor)	Initierar återgivningsmodulen för sektionslayouter.	Ett JavaScript-objekt som innehåller följande egenskaper: sectionlayoutData (objekt) : De sektionslayoutdata som finns i sidmodellen. componentId (sträng): Sektionslayoutens värde för `componentId`, vanligtvis ett GUID. renderMode (sträng, valfri): Återgivningsläget för återgivningsåtgärden. customSettingsData (objekt): En kopia av `customSettingsData` som finns i `sectionLayoutData.`	Återgivnings-API:erna för sektionslayouter initieras.
render	Genererar DOM-element som är lämpliga för sektionslayouten till sidan, inklusive container-DIV:er för underordnade komponenter.	container (element) : Det DOM-element i vilket sektionslayoutens uppmärkning ska återges.	När den här metoden har returnerat återges underordnade komponenter. Du kan identifiera underordnade komponenter genom att söka efter underordnade `div[id]`-element
addComponent	Används med innehållslistkomponenter för att dynamiskt lägga till underordnade komponenter i en sektionslayout. Den här funktionen är valfri.	container (element): Det DOM-element i vilket den nya komponenten ska återges. componentId (sträng): Id:t för den nya komponent som ska läggas till i sektionslayouten.	När den här metoden har returnerat återges det element vars id matchar indata för `componentId`.

(konstruktor)

Initierar återgivningsmodulen för sektionslayouter.

Ett JavaScript-objekt som innehåller följande egenskaper:

sectionlayoutData (objekt) : De sektionslayoutdata som finns i sidmodellen.
componentId (sträng): Sektionslayoutens värde för componentId, vanligtvis ett GUID.
renderMode (sträng, valfri): Återgivningsläget för återgivningsåtgärden.
customSettingsData (objekt): En kopia av customSettingsData som finns i sectionLayoutData.

Återgivnings-API:erna för sektionslayouter initieras.

render

Genererar DOM-element som är lämpliga för sektionslayouten till sidan, inklusive container-DIV:er för underordnade komponenter.

container (element) : Det DOM-element i vilket sektionslayoutens uppmärkning ska återges.

När den här metoden har returnerat återges underordnade komponenter.

Du kan identifiera underordnade komponenter genom att söka efter underordnade div[id]-element

addComponent

Används med innehållslistkomponenter för att dynamiskt lägga till underordnade komponenter i en sektionslayout.

Den här funktionen är valfri.

container (element): Det DOM-element i vilket den nya komponenten ska återges.

componentId (sträng): Id:t för den nya komponent som ska läggas till i sektionslayouten.

När den här metoden har returnerat återges det element vars id matchar indata för componentId.

Redigerings-API:er

Modulen edit.js laddas om true har angetts för egenskapen hasEditHandlers i den appinfo.json-fil som är associerad med sektionslayouten.

Redigerings-API:erna används i webbplatsverktyget.

Alla funktioner i den här modulen utom konstruktorn är valfria.

Redigerings-API	Beskrivning	Indataparametrar	Returresultat
(konstruktor)	Initierar redigeringsmodulen för sektionslayouter.	Ett JavaScript-objekt som innehåller följande egenskap: componentId (sträng): Sektionslayoutens värde för `componentId`, vanligtvis ett GUID.	Redigerings-API:erna för sektionslayouter initieras.
getCapabilities	Returnerar ett objekt som beskriver sektionslayoutens redigeringskapaciteter.	Ett JavaScript-objekt som beskriver sektionslayoutens redigeringskapaciteter. Vid inmatning tillhandahålls standardkapaciteterna till funktionen. Funktionen kan ändra kapacitetsobjektet efter behov. Kapacitetsobjektet kan inkludera följande kapaciteter: title (sträng): Den titel på sektionslayouten som ska visas för användaren. settingsTitle (sträng): Den titel som ska visas i dialogrutan Inställningspanel. hasSettings (boolesk): Anger om sektionslayouten stöder en inställningspanel. allowMove (boolesk): Anger om sektionslayouten tillåter att underordnade objekt flyttas. allowDelete (boolesk): Anger om sektionslayouten tillåter att underordnade objekt tas bort. isHidden (boolesk): Anger om sektionslayouten för närvarande är dold som svar på användaralternativ. dropTarget (boolesk): Anger om sektionslayouten är mål för dra och släpp-åtgärder. customMenuOptions (uppställning): Anpassade menyalternativ som ska läggas till på snabbmenyn för sektionslayouten. Varje menyalternativobjekt har följande egenskaper: label (sträng) : Menyalternativets visningstext. action (funktion): Den funktion som ska anropas när användaren klickar på menyalternativet. disabled (boolesk): Anger att menyalternativet ska visas i avaktiverat tillstånd. icon (sträng): Den URL som ska visas tillsammans med etiketten i menyalternativet. (Den här egenskapen är reserverad för framtida bruk.) checkmark (boolesk): Anger att en bockmarkering ska visas tillsammans med etiketten i menyalternativet. subMenuItems (uppställning): Menyalternativ som ska visas på en undermeny.	(objekt): Kapaciteter för sektionslayouten.
getCaptionContent	Returnerar sektionslayoutens visningsnamn, som visas i element i användargränssnittet.	Inga.	(sträng): Sektionslayoutens visningsnamn.
filterCapabilities	Tillåter att sektionslayouten ändrar kapacitetsobjektet innan menyer visas för användaren. Du kan använda detta API-gränssnitt för att justera eller ta bort menyalternativ. (Se även getCapabilities.)	Ett JavaScript-objekt som beskriver sektionslayoutens redigeringskapaciteter. Vid inmatning tillhandahålls standardkapaciteterna till funktionen.	(objekt) Kapaciteter för sektionslayouten.
onDragOver	Anropas under en dra och släpp-åtgärd för att ange om det dragna objektet kan släppas på sektionslayouten.	eventObject (händelseobjekt): Ett händelseobjekt som innehåller information om dra-händelsen. dataTransfer (DataTransfer-objekt): Ett `DataTransfer`-objekt som innehåller information om det objekt som dras över sektionslayouten.	(boolesk) Ett värde som anger om det dragna objektet kan accepteras av sektionslayouten. Returnerar sant om sektionslayouten kan acceptera det dragna objektet, falskt i annat fall.
onDrop	Anropas under släpp-delen av en dra och släpp-åtgärd för att ange att det dragna objektet ska placeras i sektionslayouten.	eventObject (händelseobjekt) : Ett händelseobjekt som innehåller information om släpp-händelsen. dataTransfer (DataTransfer-objekt) Ett DataTransfer-objekt som innehåller information om det objekt som släpps på sektionslayouten.	(boolesk) Ett värde som anger om släpp-åtgärden hanterades av sektionslayouten. Om sant returneras kringgås standardlogiken.
onAddComponent	Meddelar sektionslayouten att en dra och släpp-åtgärd har flyttat ett objekt i sektionslayouten.	eventObject (händelseobjekt): Ett händelseobjekt som innehåller information om dra-händelsen. dataTransfer (DataTransfer-objekt): Ett DataTransfer-objekt som innehåller information om det objekt som släpps på sektionslayouten. componentId (sträng): Det nyligen tillagda objektets värde för `componentId`.	Meddelande till sektionslayouten.
onMoveComponent	Meddelar sektionslayouten att en dra och släpp-åtgärd har flyttat ett objekt i sektionslayouten.	eventObject (händelseobjekt): Ett händelseobjekt som innehåller information om dra-händelsen. dataTransfer (DataTransfer-objekt): Ett DataTransfer-objekt som innehåller information om det objekt som släpps på sektionslayouten. componentId (sträng): Det flyttade objektets värde för `componentId`.	Meddelande till sektionslayouten.
getSettingsData	Tillåter att sektionslayouten ändrar inställningsdata innan inställningspanelen visas.	settingsData (objekt): De standardinställningsdata som beräknas för sektionslayouten	(objekt) Inställningsdata för sektionslayouten.
updateSettings	Tillåter att sektionslayouten ändrar sina inställningar efter att inställningspanelen har stängts. Detta API-gränssnitt anropas precis innan inställningarna lagras i sidmodellen.	parameters (objekt): Det radparameterobjekt som returneras från inställningspanelen. sectionLayoutData (objekt) : De sektionslayoutdata som ska lagras. Standarddata genereras från `parameters (objekt)` och överförs till funktionen i den här parametern.	(objekt) De sektionslayoutdata som ska lagras i sidmodellen.
dispose	Tillåter redigeringsmodulen att frigöra minne, ta bort händelser och ta bort tilldelning av resurser som är associerade med redigeringshanterarna. Detta API-gränssnitt anropas när sektionslayouten behöver rita om fullständigt, som vid en ångra/gör om-åtgärd.	Inga.	Omritning av sektionslayouten är aktiv.