Utvikle egendefinerte deloppsett med API-er

Du kan utvikle egendefinerte deloppsett i Oracle Content Management med API-et for deloppsett, som inkluderer API-er for gjengivelse og API-er for redigering.

Hvis du vil ha opplysninger om startfiler, se Opprette et deloppsett. Startfilene for deloppsett inneholder kommentarer med detaljer om strukturen for deloppsettfiler.

API-er for gjengivelse

API-ene for gjengivelse, som lastes fra modulen render.js, brukes i områdebyggeren og under kjøring.

API for gjengivelse Beskrivelse Inndataparametre Returresultater

API for gjengivelse	Beskrivelse	Inndataparametre	Returresultater
(Konstruktør)	Initialiserer gjengivelsesmodulen for deloppsett.	Et JavaScript-objekt som inneholder følgende egenskaper: sectionlayoutData (objekt) : Deloppsettdataene som blir funnet i sidemodellen. componentId (streng): Verdien for `componentId` for deloppsettet, vanligvis en GUID. renderMode (streng, valgfri): Gjengivelsesmodusen for gjengivelsesoperasjonen. customSettingsData (objekt): En kopi av `customSettingsData` som blir funnet i `sectionLayoutData.`	API-ene for gjengivelse for deloppsett initialiseres.
render	Sender DOM-elementer passende for deloppsettet til siden, inkludert beholder-DIV-er for underordnede komponenter.	container (element) : DOM-elementet som koden for deloppsettet skal gjengis i.	Når denne metoden har returnert, gjengis underordnede komponenter. Du kan identifisere underordnede komponenter ved å finne underordnede `div[id]`-elementer.
addComponent	Brukes med innholdslistekomponenter for å legge til underordnede komponenter dynamisk i et deloppsett. Denne funksjonen er valgfri.	container (element) : DOM-elementet som den nye komponenten skal gjengis i. componentId (streng): ID-en for den nye komponenten som skal legges til i deloppsettet.	Når denne metoden har returnert, gjengis elementet med ID-en som samsvarer med inndataene for `componentId`.

(Konstruktør)

Initialiserer gjengivelsesmodulen for deloppsett.

Et JavaScript-objekt som inneholder følgende egenskaper:

sectionlayoutData (objekt) : Deloppsettdataene som blir funnet i sidemodellen.
componentId (streng): Verdien for componentId for deloppsettet, vanligvis en GUID.
renderMode (streng, valgfri): Gjengivelsesmodusen for gjengivelsesoperasjonen.
customSettingsData (objekt): En kopi av customSettingsData som blir funnet i sectionLayoutData.

API-ene for gjengivelse for deloppsett initialiseres.

render

Sender DOM-elementer passende for deloppsettet til siden, inkludert beholder-DIV-er for underordnede komponenter.

container (element) : DOM-elementet som koden for deloppsettet skal gjengis i.

Når denne metoden har returnert, gjengis underordnede komponenter.

Du kan identifisere underordnede komponenter ved å finne underordnede div[id]-elementer.

addComponent

Brukes med innholdslistekomponenter for å legge til underordnede komponenter dynamisk i et deloppsett.

Denne funksjonen er valgfri.

container (element) : DOM-elementet som den nye komponenten skal gjengis i.

componentId (streng): ID-en for den nye komponenten som skal legges til i deloppsettet.

Når denne metoden har returnert, gjengis elementet med ID-en som samsvarer med inndataene for componentId.

API-er for redigering

Modulen edit.js lastes hvis egenskapen hasEditHandlers er angitt som true i filen appinfo.json tilknyttet deloppsettet.

API-ene for redigering brukes i områdebyggeren.

Alle funksjonene i denne modulen unntatt konstruktøren er valgfrie.

API for redigering	Beskrivelse	Inndataparametre	Returresultater
(Konstruktør)	Initialiserer redigeringsmodulen for deloppsett.	Et JavaScript-objekt som inneholder følgende egenskap: componentId (streng): Verdien for `componentId` for deloppsettet, vanligvis en GUID.	API-ene for redigering for deloppsett initialiseres.
getCapabilities	Returnerer et objekt som beskriver redigeringsfunksjonene for deloppsettet.	Et JavaScript-objekt som beskriver redigeringsfunksjonene for deloppsettet. Standardfunksjonene angis for funksjonen ved registrering. Funksjonen kan endre funksjonsobjektet etter behov. Funksjonsobjektet kan omfatte følgende funksjoner: title (streng): Tittelen for deloppsettet som skal vises til brukeren. settingsTitle (streng): Tittelen som skal vises i ruten Innstillinger. hasSettings (boolsk): Angir om deloppsettet støtter ruten Innstillinger. allowMove (boolsk): Angir om deloppsettet tillater flytting av underordnede elementer. allowDelete (boolsk): Angir om deloppsettet tillater sletting av underordnede elementer. isHidden (boolsk): Angir om deloppsettet for øyeblikket er skjult som svar på brukervalg. dropTarget (boolsk): Angir om deloppsettet er målet for dra-og-slipp-operasjoner. customMenuOptions (matrise): Egendefinerte menyvalg som kan legges til på hurtigmenyen for deloppsettet. Hvert menyvalgobjekt har følgende egenskaper: label (streng) : Visningsteksten for menyelementet. action (funksjon): Funksjonen som skal aktiveres når det blir klikket på menyelementet. disabled (boolsk): Angir at menyelementet skal vises i en deaktivert tilstand. icon (streng): URL-adressen som skal vises sammen med etiketten i menyelementet. (Denne egenskapen er reservert for fremtidig bruk.) checkmark (boolsk): Angir at et merke skal vises sammen med etiketten i menyelementet. subMenuItems (matrise): Menyvalg som skal vises i en undermeny.	(Objekt): Funksjonene for deloppsettet.
getCaptionContent	Returnerer visningsnavnet for deloppsettet, som skal vises i brukergrensesnittelementer.	Ingen.	(Streng): Visningsnavnet for deloppsettet.
filterCapabilities	Tillater at deloppsettet kan endre funksjonsobjektet før menyer vises til brukeren. Du kan bruke dette API-et til å justere eller fjerne menyvalg. (Se også getCapabilities.)	Et JavaScript-objekt som beskriver redigeringsfunksjonene for deloppsettet. Standardfunksjonene angis for funksjonen ved registrering.	(Objekt): Funksjonene for deloppsettet.
onDragOver	Kalles under en dra-og-slipp-operasjon for å angi om elementet som dras, kan slippes på deloppsettet.	eventObject (hendelsesobjekt): Et hendelsesobjekt som inneholder opplysninger om dra-hendelsen. dataTransfer (DataTransfer-objekt): Et `DataTransfer`-objekt som inneholder opplysninger om elementet som dras over deloppsettet.	(Boolsk): En verdi som angir om elementet som dras, kan godtas av deloppsettet. Returnerer true hvis deloppsettet kan godta elementet som dras. Hvis ikke returneres false.
onDrop	Kalles under slipp-delen i en dra-og-slipp-operasjon for å angi at elementet som dras, skal plasseres i deloppsettet.	eventObject (hendelsesobjekt): Et hendelsesobjekt som inneholder opplysninger om slipp-hendelsen. dataTransfer (DataTransfer-objekt): Et DataTransfer-objekt som inneholder opplysninger om elementet som slippes på deloppsettet.	(Boolsk): En verdi som angir om dra-operasjonen ble behandlet av deloppsettet. Hvis true returneres, omgås standardlogikken.
onAddComponent	Varsler deloppsettet om at en dra-og-slipp-operasjon har lagt til et element i deloppsettet.	eventObject (hendelsesobjekt): Et hendelsesobjekt som inneholder opplysninger om dra-hendelsen. dataTransfer (DataTransfer-objekt) : Et DataTransfer-objekt som inneholder opplysninger om elementet som slippes på deloppsettet. componentId (streng): Verdien for `componentId` for elementet som nylig er lagt til.	Varsling for deloppsett.
onMoveComponent	Varsler deloppsettet om at en dra-og-slipp-operasjon har flyttet et element i deloppsettet.	eventObject (hendelsesobjekt): Et hendelsesobjekt som inneholder opplysninger om dra-hendelsen. dataTransfer (DataTransfer-objekt) : Et DataTransfer-objekt som inneholder opplysninger om elementet som slippes på deloppsettet. componentId (streng): Verdien for `componentId` for det flyttede elementet.	Varsling for deloppsett.
getSettingsData	Tillater at deloppsettet kan endre innstillingsdataene før ruten Innstillinger vises.	settingsData (objekt): Standardinnstillingsdataene som beregnes for deloppsettet.	(Objekt): Innstillingsdataene for deloppsettet.
updateSettings	Tillater at deloppsettet kan endre innstillingene når ruten Innstillinger er blitt lukket. Dette API-et kalles like før innstillingene lagres i sidemodellen.	parameters (objekt): Objektet for RAW-parametrene som returneres fra ruten Innstillinger. sectionLayoutData (objekt) : Deloppsettdataene som blir lagret. Standarddata genereres fra `parameters (objekt)` og sendes til funksjonen i denne parameteren.	(Objekt): Deloppsettdataene som skal lagres i sidemodellen.
dispose	Tillater at redigeringsmodulen kan frigjøre minne, koble fra hendelser og oppheve tildeling av ressurser knyttet til redigeringsbehandlerne. Dette API-et kalles når deloppsettet må tegnes på nytt fullstendig, for eksempel i en Angre / Gjør om-operasjon.	Ingen.	Tegning av oppsettet på nytt er aktivert.