Vývoj vlastních rozvržení sekcí pomocí rozhraní API

Ve službě Oracle Content Management můžete vyvíjet vlastní rozvržení sekcí pomocí rozhraní API pro rozvržení sekcí, které zahrnuje rozhraní API pro generování a rozhraní API pro úpravy.

Úvodní soubory, na které se můžete podívat, naleznete v tématu Vytvoření rozvržení sekce. Úvodní soubory pro rozvržení sekcí obsahují komentáře s podrobnými informacemi o struktuře souborů rozvržení sekcí.

Rozhraní API pro generování

Rozhraní API pro generování načtená z modulu render.js se používají v nástroji Site Builder a za běhu.

Rozhraní API pro generování Popis Vstupní parametr(y) Vrácený výsledek

Rozhraní API pro generování	Popis	Vstupní parametr(y)	Vrácený výsledek
(Konstruktor)	Inicializuje modul pro generování rozvržení sekcí.	Objekt jazyka JavaScript, který obsahuje následující vlastnosti: sectionlayoutData (objekt): Data rozvržení sekce nalezená v modelu stránky. componentId (řetězec): Hodnota `componentId` rozvržení sekce, obvykle identifikátor GUID. renderMode (řetězec, nepovinný): Režim generování pro operaci generování. customSettingsData (objekt): Kopie parametru `customSettingsData` nalezeného v `sectionLayoutData`.	Rozhraní API pro generování rozvržení sekcí jsou inicializována.
render	Vytváří prvky DOM vhodné pro rozvržení sekce na stránce, včetně DIV kontejnerů pro podřízené komponenty.	container (prvek): Prvek DOM, do kterého by se měla generovat značka rozvržení sekce.	Po vrácení výsledku této metody budou generovány podřízené komponenty. Podřízené komponenty můžete identifikovat vyhledáním podřízených prvků `div[id]`.
addComponent	Používá se s komponentami seznamu obsahu k dynamickému přidávání podřízených komponent do rozvržení sekce. Tato funkce je nepovinná.	container (prvek): Prvek DOM, do kterého by měla být generována nová komponenta. componentId (řetězec): Identifikátor nové komponenty, která má být přidána do rozvržení sekce.	Po vrácení výsledku této metody bude generován prvek, jehož identifikátor odpovídá vstupnímu parametru `componentId`.

(Konstruktor)

Inicializuje modul pro generování rozvržení sekcí.

Objekt jazyka JavaScript, který obsahuje následující vlastnosti:

sectionlayoutData (objekt): Data rozvržení sekce nalezená v modelu stránky.
componentId (řetězec): Hodnota componentId rozvržení sekce, obvykle identifikátor GUID.
renderMode (řetězec, nepovinný): Režim generování pro operaci generování.
customSettingsData (objekt): Kopie parametru customSettingsData nalezeného v sectionLayoutData.

Rozhraní API pro generování rozvržení sekcí jsou inicializována.

render

Vytváří prvky DOM vhodné pro rozvržení sekce na stránce, včetně DIV kontejnerů pro podřízené komponenty.

container (prvek): Prvek DOM, do kterého by se měla generovat značka rozvržení sekce.

Po vrácení výsledku této metody budou generovány podřízené komponenty.

Podřízené komponenty můžete identifikovat vyhledáním podřízených prvků div[id].

addComponent

Používá se s komponentami seznamu obsahu k dynamickému přidávání podřízených komponent do rozvržení sekce.

Tato funkce je nepovinná.

container (prvek): Prvek DOM, do kterého by měla být generována nová komponenta.

componentId (řetězec): Identifikátor nové komponenty, která má být přidána do rozvržení sekce.

Po vrácení výsledku této metody bude generován prvek, jehož identifikátor odpovídá vstupnímu parametru componentId.

Rozhraní API pro úpravy

K načtení modulu edit.js dojde, pokud je v souboru appinfo.json přidruženém k rozvržení sekce nastavena vlastnost hasEditHandlers na hodnotu true.

Rozhraní API pro úpravy se používají v nástroji Site Builder.

Všechny funkce v tomto modulu jsou nepovinné, kromě funkce Konstruktor.

Rozhraní API pro úpravy	Popis	Vstupní parametr(y)	Vrácený výsledek
(Konstruktor)	Inicializuje modul pro úpravy rozvržení sekcí.	Objekt jazyka JavaScript, který obsahuje následující vlastnost: componentId (řetězec): Hodnota `componentId` rozvržení sekce, obvykle identifikátor GUID.	Rozhraní API pro úpravy rozvržení sekcí jsou inicializována.
getCapabilities	Vrací objekt popisující schopnosti úprav rozvržení sekce.	Objekt jazyka JavaScript, který popisuje schopnosti úprav rozvržení sekce. Po vstupu budou funkci poskytnuty výchozí schopnosti. Funkce může podle potřeby upravit objekt schopnosti. Objekt schopnosti může zahrnovat následující schopnosti: title (řetězec): Název rozvržení sekce, který se zobrazí uživateli. settingsTitle (řetězec): Název, který se zobrazí v dialogovém okně Panel nastavení. hasSettings (booleovská hodnota): Udává, zda rozvržení sekce podporuje panel nastavení. allowMove (booleovská hodnota): Udává, zda rozvržení sekce umožňuje přesouvat podřízené položky. allowDelete (booleovská hodnota): Udává, zda rozvržení sekce umožňuje odstraňovat podřízené položky. isHidden (booleovská hodnota): Udává, zda je rozvržení sekce aktuálně skryté v reakci na uživatelské volby. dropTarget (booleovská hodnota): Udává, zda je rozvržení sekce cílem operací přetahování. customMenuOptions (pole): Vlastní volby nabídky, které se doplní do místní nabídky Rozvržení sekce. Každý objekt volby nabídky má následující vlastnosti: label (řetězec): Zobrazovaný text položky nabídky. action (funkce): Funkce, která bude vyvolána po kliknutí na položku nabídky. disabled (booleovská hodnota): Udává, že by se položka nabídky měla zobrazovat jako deaktivovaná. icon (řetězec): Adresa URL, která se má zobrazit společně s popiskem v položce nabídky. (Tato vlastnost je vyhrazena pro budoucí použití.) checkmark (booleovská hodnota): Udává, že by se společně s popiskem v položce nabídky mělo zobrazit zatržítko. subMenuItems (pole): Volby nabídky, které se zobrazí v podnabídce.	(Objekt): Schopnosti pro rozvržení sekce.
getCaptionContent	Vrátí zobrazovaný název rozvržení sekce, který se zobrazí v prvcích uživatelského rozhraní.	Žádné.	(Řetězec): Zobrazovaný název rozvržení sekce.
filterCapabilities	Umožňuje, aby rozvržení sekce upravilo objekt Capabilities předtím, než se nabídky zobrazí uživateli. Pomocí tohoto rozhraní API můžete upravit nebo odebrat volby nabídky. (Viz také funkce getCapabilities.)	Objekt jazyka JavaScript, který popisuje schopnosti úprav rozvržení sekce. Při vstupu budou funkci poskytnuty výchozí schopnosti.	(Objekt): Schopnosti pro rozvržení sekce.
onDragOver	Tato funkce je volána během operace přetahování a určuje, zda lze přetahovanou položku umístit do rozvržení sekce.	eventObject (objekt třídy událost): Objekt třídy událost, který uchovává informace o události přetažení. dataTransfer (objekt třídy DataTransfer): Objekt třídy `DataTransfer`, který uchovává informace o položce, která je přetahována přes rozvržení sekce.	(Booleovská hodnota): Hodnota, která udává, zda rozvržení sekce může přijmout přetahovanou položku. Vrátí hodnotu true, pokud rozvržení sekce může přijmout přetahovanou položku. V opačném případě vrátí hodnotu false.
onDrop	Tato metoda je volána během fáze uvolnění při operaci přetažení a udává, že by přetahovaná položka měla být umístěna do rozvržení sekce.	eventObject (objekt třídy událost): Objekt třídy událost, který uchovává informace o události uvolnění. dataTransfer (objekt třídy DataTransfer): Objekt třídy DataTransfer, který uchovává informace o položce, která je uvolněna do rozvržení sekce.	(Booleovská hodnota): Hodnota, která udává, zda rozvržení sekce zpracovalo operaci přetažení. Vrácení hodnoty true obchází výchozí logiku.
onAddComponent	Uvědomí rozvržení sekce, že operace přetažení přidala položku do rozvržení sekce.	eventObject (objekt třídy událost): Objekt třídy událost, který uchovává informace o události přetažení. dataTransfer (objekt třídy DataTransfer): Objekt třídy DataTransfer, který uchovává informace o položce, která je uvolněna do rozvržení sekce. componentId (řetězec): Hodnota `componentId` nově přidané položky.	Upozornění rozvržení sekce.
onMoveComponent	Oznamuje rozvržení sekce, že operace přetažení přesunula položku do rozvržení sekce.	eventObject (objekt třídy událost): Objekt třídy událost, který uchovává informace o události přetažení. dataTransfer (objekt třídy DataTransfer): Objekt třídy DataTransfer, který uchovává informace o položce, která je uvolněna do rozvržení sekce. componentId (řetězec): Hodnota `componentId` přesunuté položky.	Upozornění rozvržení sekce.
getSettingsData	Umožňuje, aby rozvržení sekce změnilo data nastavení před zobrazením panelu nastavení.	settingsData (objekt): Výchozí data nastavení vypočítaná pro rozvržení sekce.	(Objekt): Data nastavení pro rozvržení sekce.
updateSettings	Umožňuje, aby rozvržení sekce změnilo nastavení po zavření panelu nastavení. Toto rozhraní API je voláno těsně před uložením nastavení do modelu stránky.	parameters (objekt): Objekt nezpracovaných parametrů vrácený z panelu nastavení. sectionLayoutData (objekt): Data rozvržení sekce, která budou uložena. Výchozí data budou generována z `parameters (objekt)` a předána funkci v tomto parametru.	(Objekt): Data rozvržení sekce, která mají být uložena do modelu stránky.
dispose	Umožňuje modulu úprav uvolnit paměť, odpojit události a zrušit přidělení zdrojů přidružených k obslužným programům pro úpravy. Toto rozhraní API je voláno, když je nutné znovu zcela vykreslit rozvržení sekce, jako v případě operace Zpět/Znovu.	Žádné.	Je povoleno opětovné vykreslení rozvržení sekce.