Helyi összetevő megvalósítása

Az összetevőpéldányt az összetevő-szolgáltatói objektum hozza létre.

Az összetevő-szolgáltatói objektum bejegyzése az összetevő-regisztrációs fájlban: initData.componentFactory. Ez egy olyan JavaScript-fájlra mutató hivatkozás, amelyet a RequireJS használ az összetevő-szolgáltató betöltéséhez. Olyan JavaScript-objektumot kell visszaadnia, amely megvalósítja a componentFactory felületét

Az összetevő-szolgáltatónak meg kell valósítania a customComponentFactory.createComponent(args) API-t, amely az összetevő egyes példányait hozza létre.

Az args a következő beállításokat tartalmazza:

  • SitesSDK: Az Oracle Content Management Sites SDK.

  • id: Az oldalhoz adott összetevő egyedi azonosítója (GUID).

  • viewMode: Az oldal aktuális megjelenítési módja. Amikor az oldalt szerkesztik, akkor a mód értéke "Szerkesztés". Amikor az oldalt előzetesen megtekintik, akkor a mód értéke "Navigálás". Futásidőben, vagyis a webhely közzétételekor az érték meghatározatlan. Különböző megvalósításokat adhat meg az egyes módok esetében megjelenítendő funkciók alapján. Például a hivatkozások nem lehetnek aktívak, amikor az oldal Szerkesztés módban fut.

Megjegyzés:

A JQuery vagy a Knockout használata az összetevőhöz, viszont ha az Oracle Content Management funkcióit, például a beágyazott összetevőket szeretné alkalmazni, akkor az Oracle Content Managemente által biztosított Knockout-verziót kell használnia. Ez a Knockout-verzió olyan kibővített összetevő-regisztrációt és -kezelőket használ, amelyeket Ön másként nem érhet el.

Ami magát az összetevőt illeti, az SDK az összetevő példányának létrehozásakor akkor adódik át, s ezáltal az összetevő képes kommunikálni az oldal életciklusával. Az oldal életciklusának függvényeit az összetevőnek meg kell valósítania, és az Oracle Content Management szolgáltatásnak meg kell hívnia ahhoz, hogy az összetevő megjelenjen az oldalon.

A rendszer kötelező és opcionális API-kat biztosít az összetevő megvalósításához.

Kötelező API-k

customComponent.render(container): Megkéri az összetevőt, hogy szúrja be magát a biztosított DOM tárolóelembe.

  • container: Az egyéni összetevő HTML-fájljának DOM tárolóeleme.

Opcionális API-k

customComponent.dispose(): A rendszer akkor hívja meg, amikor az összetevőt eltávolítja az oldalról. Lehetőséget biztosít az összetevő számára, hogy eltávolítson minden olyan erőforrást, amelyre már nincs szüksége.