Implementácia lokálneho komponentu

Inštanciu komponentu vytvára objekt factory komponentu.

Záznam objektu factory komponentu v súbore registrácie komponentov je initData.componentFactory. Ide o odkaz na súbor JavaScript, ktorý nástroj RequireJS používa na načítanie objektu factory komponentu. Musí vrátiť objekt JavaScript, ktorý implementuje rozhranie componentFactory.

Objekt factory komponentu musí implementovať rozhranie API customComponentFactory.createComponent(argumenty), ktoré vytvára jednotlivé inštancie komponentu.

Sekcia argumenty obsahuje tieto nastavenia:

  • SitesSDK: Súprava Oracle Content Management Sites SDK.

  • id: Jednoznačné ID (GUID) komponentu pridaného na stránku.

  • viewMode: Aktuálny režim, v ktorom sa stránka vykresľuje. Pri úprave stránky sa používa režim úprav, zatiaľ čo pri zobrazení ukážky stránky sa používa režim navigácie. V čase behu (teda po publikovaní lokality) táto hodnota nie je definovaná. V závislosti od toho, aké funkcie majú byť dostupné v jednotlivých režimoch, môžete poskytnúť rôzne implementácie. Ak je napríklad stránka spustená v režime úprav, prepojenia by nemali byť aktívne.

Poznámka:

Pre komponent nie je potrebné používať skript JQuery ani model Knockout, ale ak chcete využívať rôzne funkcie služby Oracle Content Management, ako sú napríklad vnorené komponenty, musíte použiť verziu modelu Knockout poskytovanú službou Oracle Content Management. Táto verzia modelu Knockout obsahuje rozšírenú registráciu komponentov a obslužné programy, ktoré by ste inak nemali k dispozícii.

V prípade samotného komponentu sa súprava SDK odovzdáva pri inštancovaní komponentu, vďaka čomu môže komponent komunikovať so životným cyklom stránky. Funkcie životného cyklu stránky musia byť implementované komponentom a služba Oracle Content Management ich volaním vykresľuje komponent na stránke.

Na implementáciu komponentu sa poskytujú povinné a voliteľné rozhrania API.

Povinné rozhrania API

customComponent.render(container): Vyžaduje od komponentu, aby sa vložil do poskytnutého prvku kontajnera DOM.

  • container: Prvok kontajnera DOM pre kód HTML vlastného komponentu.

Voliteľné rozhrania API

customComponent.dispose(): Volá sa pri odstraňovaní komponentu zo stránky. Umožňuje komponentu odstrániť všetky prostriedky, ktoré už nie sú potrebné.