Räätälöityjen osan asettelujen kehitys API-liittymien avulla

Voit kehittää mukautettuja osan asetteluja Oracle Content Management -palvelun Osan asettelu -API-liittymän avulla. Se sisältää muodostuksen ja muokkauksen API-liittymiä.

Jos haluat tutustua aloitustiedostoihin, katso kohta Osan asettelun luonti. Osan asettelujen aloitustiedostot sisältävät kommentteja, joissa on tietoja section-layout-tiedostojen rakenteesta.

Muodostuksen API-liittymät

render.js-moduulista ladattuja muodostuksen API-liittymiä käytetään sivustonluontiohjelmassa ja ajon aikana.

Muodostuksen API-liittymä Kuvaus Syöteparametrit Palautuksen tulos

Muodostuksen API-liittymä	Kuvaus	Syöteparametrit	Palautuksen tulos
(Muodostin)	Alustaa Osan asettelu -muodostusmoduulin.	JavaScript-objekti, joka sisältää seuraavat ominaisuudet: sectionlayoutData (objekti) : sivumallin sisältämät osan asettelun tiedot. componentId (merkkijono): osan asettelun `componentId`-arvo, joka on yleensä GUID-tunnus. renderMode (merkkijono, valinnainen): muodostustoiminnon muodostustila. customSettingsData (objekti): `sectionLayoutData`-objektin sisältämän `customSettingsData`-objektin kopio.	Osan asettelun muodostuksen API-liittymät alustetaan.
render	Tuottaa sivun osan asettelun mukaiset DOM-elementit mukaan lukien alikomponenttien DIV-säiliöelementit.	container (elementti) : DOM-elementti, johon osan asettelun koodaus muodostetaan.	Kun tästä menetelmästä on palattu, aliobjektit muodostetaan. Voit tunnistaa alikomponentit etsimällä `div[id]`-alielementtejä
addComponent	Tätä käytetään sisältölistakomponenttien kanssa. Se lisää alikomponentteja osan asetteluun dynaamisesti. Tämä funktio on valinnainen.	container (elementti) : DOM-elementti, johon uusi komponentti muodostetaan. componentId (merkkijono): osan asetteluun lisättävän uuden komponentin tunnus.	Kun tästä menetelmästä on palattu, muodostetaan elementti, jonka tunnus vastaa syötettyä `componentId`-arvoa.

(Muodostin)

Alustaa Osan asettelu -muodostusmoduulin.

JavaScript-objekti, joka sisältää seuraavat ominaisuudet:

sectionlayoutData (objekti) : sivumallin sisältämät osan asettelun tiedot.
componentId (merkkijono): osan asettelun componentId-arvo, joka on yleensä GUID-tunnus.
renderMode (merkkijono, valinnainen): muodostustoiminnon muodostustila.
customSettingsData (objekti): sectionLayoutData-objektin sisältämän customSettingsData-objektin kopio.

Osan asettelun muodostuksen API-liittymät alustetaan.

render

Tuottaa sivun osan asettelun mukaiset DOM-elementit mukaan lukien alikomponenttien DIV-säiliöelementit.

container (elementti) : DOM-elementti, johon osan asettelun koodaus muodostetaan.

Kun tästä menetelmästä on palattu, aliobjektit muodostetaan.

Voit tunnistaa alikomponentit etsimällä div[id]-alielementtejä

addComponent

Tätä käytetään sisältölistakomponenttien kanssa. Se lisää alikomponentteja osan asetteluun dynaamisesti.

Tämä funktio on valinnainen.

container (elementti) : DOM-elementti, johon uusi komponentti muodostetaan.

componentId (merkkijono): osan asetteluun lisättävän uuden komponentin tunnus.

Kun tästä menetelmästä on palattu, muodostetaan elementti, jonka tunnus vastaa syötettyä componentId-arvoa.

Muokkauksen API-liittymät

edit.js-moduuli ladataan, jos hasEditHandlers-ominaisuuden arvo on true osan asetteluun liittyvässä appinfo.json-tiedostossa.

Muokkauksen API-liittymiä käytetään sivustonluontiohjelmassa

Kaikki tämän moduulin funktiot ovat valinnaisia muodostinta lukuun ottamatta.

Muokkauksen API-liittymä	Kuvaus	Syöteparametrit	Palautuksen tulos
(Muodostin)	Alustaa Osan asettelu -muokkausmoduulin.	JavaScript-objekti, joka sisältää seuraavan ominaisuuden: componentId (merkkijono): osan asettelun `componentId`-arvo, joka on yleensä GUID-tunnus.	Osan asettelun muokkauksen API-liittymät alustetaan.
getCapabilities	Palauttaa objektin, joka kuvaa osan asettelun muokkausominaisuuksia.	JavaScript-objekti, joka kuvaa osan asettelun muokkausominaisuuksia. Syötteen yhteydessä funktiolle annetaan oletusominaisuudet. Funktio voi muokata Capabilities-objektia tarpeen mukaan. Capabilities-objekti voi sisältää seuraavat ominaisuudet: title (merkkijono): käyttäjälle näytettävä osan asettelun otsikko. settingsTitle (merkkijono): asetuspaneelin valintaikkunassa näytettävä otsikko. hasSettings (totuusarvo): ilmaisee, tukeeko osan asettelu asetuspaneelia. allowMove (totuusarvo): ilmaisee, salliiko osan asettelu alikohteiden siirron. allowDelete (totuusarvo): ilmaisee, salliiko osan asettelu alikohteiden poiston. isHidden (totuusarvo): ilmaisee, onko osan asettelu sillä hetkellä piilotettu käyttäjävalintojen seurauksena. dropTarget (totuusarvo): ilmaisee, onko osan asettelu vedä ja pudota -toimintojen kohteena. customMenuOptions (taulukko): Räätälöidyt valikkovaihtoehdot, jotka lisätään osan asettelun kontekstivalikkoon. Jokaisella menu-option-objektilla on seuraavat ominaisuudet: label (merkkijono): valikon vaihtoehdossa näytettävä teksti. action (funktio): funktio, jota kutsutaan, kun valikon vaihtoehtoa napsautetaan. disabled (totuusarvo): ilmaisee, näytetäänkö valikon vaihtoehto ei käytössä -tilassa. icon (merkkijono): URL-osoite, joka näytetään otsikon vieressä valikon vaihtoehdossa. (Tämä ominaisuus on varattu myöhempään käyttöön.) checkmark (totuusarvo): ilmaisee, näytetään otsikon vieressä valintamerkki valikon vaihtoehdossa. subMenuItems (taulukko): alivalikossa näytettävät valikon vaihtoehdot.	(Objekti): osan asettelun ominaisuudet.
getCaptionContent	Palauttaa osan asettelun näyttönimen, joka näytetään käyttöliittymäelementeissä.	Ei ole.	(Merkkijono): osan asettelun näyttönimi.
filterCapabilities	Tämän avulla osan asettelu voi muokata Capabilities-objektia, ennen kuin valikot näytetään käyttäjälle Tämän API-liittymän avulla voit säätää tai poistaa valikon vaihtoehtoja. (Katso myös getCapabilities.)	JavaScript-objekti, joka kuvaa osan asettelun muokkausominaisuuksia. Syötteen yhteydessä funktiolle annetaan oletusominaisuudet.	(Objekti) Osan asettelun ominaisuudet.
onDragOver	Tätä kutsutaan vedä ja pudota -toiminnon aikana. Se ilmaisee, voiko vedetyn kohteen pudottaa osan asetteluun.	eventObject (Event-objekti): tapahtumaobjekti, joka sisältää tietoja vetotapahtumasta. dataTransfer (DataTransfer-objekti): `DataTransfer`-objekti, joka sisältää tietoja osan asettelun päällä vedettävästä kohteesta.	(Totuusarvo) Arvo, joka ilmaisee, hyväksyykö osan asettelu vedetyn kohteen. Palauttaa true-arvon, jos osan asettelu voi hyväksyä vedetyn kohteen, ja muussa tapauksessa false-arvon.
onDrop	Tätä kutsutaan vedä ja pudota -toiminnon pudotusosan aikana. Se ilmaisee, että vedetty kohde on sijoitettava osan asetteluun.	eventObject (Event-objekti): tapahtumaobjekti, joka sisältää tietoja pudotustapahtumasta. dataTransfer (DataTransfer-objekti): DataTransfer-objekti, joka sisältää tietoja osan asetteluun pudotettavasta kohteesta.	(Totuusarvo) Arvo, joka ilmaisee, käsittelikö osan asettelu pudotustoiminnon. true-arvon palautus ohittaa oletuslogiikan.
onAddComponent	Ilmoittaa osan asettelulle, että vedä ja pudota -toiminto lisäsi kohteen osan asettelussa.	eventObject (Event-objekti): tapahtumaobjekti, joka sisältää tietoja vetotapahtumasta. dataTransfer (DataTransfer-objekti): DataTransfer-objekti, joka sisältää tietoja osan asetteluun pudotettavasta kohteesta. componentId (merkkijono): äsken lisätyn kohteen `componentId`-arvo, joka on yleensä GUID-tunnus.	Osan asettelun ilmoitus.
onMoveComponent	Ilmoittaa osan asettelulle, että vedä ja pudota -toiminto siirsi kohteen osan asettelussa.	eventObject (Event-objekti): tapahtumaobjekti, joka sisältää tietoja vetotapahtumasta. dataTransfer (DataTransfer-objekti): DataTransfer-objekti, joka sisältää tietoja osan asetteluun pudotettavasta kohteesta. componentId (merkkijono): siirretyn kohteen `componentId`-arvo, joka on yleensä GUID-tunnus.	Osan asettelun ilmoitus.
getSettingsData	Tämän avulla osan asettelu voi muuttaa asetustietoja ennen asetuspaneelin näyttöä.	settingsData (objekti): osan asettelulle lasketut oletusarvoiset asetustiedot	(Objekti) Osan asettelun asetustiedot.
updateSettings	Tämän avulla osan asettelu voi muuttaa asetuksiaan asetuspaneelin sulkemisen jälkeen. Tätä API-liittymää kutsutaan juuri ennen asetusten tallennusta sivumalliin.	parameters (objekti): asetuspaneelin palauttama käsittelemätön parametriobjekti. sectionLayoutData (objekti) : tallennettavat osan asettelun tiedot. Oletustiedot luodaan `parameters (objekti)` -kohteesta ja välitetään tämän parametrin funktiolle.	(Objekti) Sivumalliin tallennettavat osan asettelun tiedot.
dispose	Tämän avulla editointimoduuli voi vapauttaa muistia, irrottaa tapahtumia ja poistaa muokkausten käsittelijöihin liittyvien resurssien varauksia. Tätä API-liittymää kutsutaan, kun osan asettelu on piirrettävä kokonaan uudelleen esimerkiksi kumoamis- tai toistotoiminnon yhteydessä.	Ei ole.	Osan asettelun uudelleenpiirto on käytössä.