Metody v Modifier

Metody umístěné ve jmenném prostoru Modifier.

Metoda addEvent

Zaregistruje specifickou událost modifikátoru.

typ: method; celé jméno: COMEX.Class.Range.Modifier.addEvent;

Parametry:

• $eventType ● hodnota typu String typ události bez úvodního 'on' (submit, load, ...)

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda build

Vytvoření komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.build;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda connect

Vyvolá propojení komponent.

typ: method; celé jméno: COMEX.Class.Range.Modifier.connect;

Parametry:

• $connectionNode ● hodnota typu COMEX.XML.Node nod definující propojení

• $extraData ● hodnota typu mixed (výchozí: null) volitelná data události

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda customDescription

Vrátí uživatelsky definovaný popis komponenty pro daný jazyk, pokud existuje.

typ: method; celé jméno: COMEX.Class.Range.Modifier.customDescription;

Vrací:

• hodnota typu Stringpopis komponenty, pokud existuje, jinak null

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda customHeader

Vrátí uživatelsky definovaný nadpis komponenty pro daný jazyk, pokud existuje.

typ: method; celé jméno: COMEX.Class.Range.Modifier.customHeader;

Vrací:

• hodnota typu Stringnadpis komponenty, pokud existuje, jinak null

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda definition

Vrátí požadovanou definici.

typ: method; celé jméno: COMEX.Class.Range.Modifier.definition;

Parametry:

• $modifier ● hodnota typu String název modifikátoru bez názvu třídy i rozsahu

Vrací:

• hodnota typu COMEX.Definitiondefinice

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda error

Nastaví chybový stav komponenty, vyvolá chybovou událost a vyhodí výjimku.

typ: method; celé jméno: COMEX.Class.Range.Modifier.error;

Možné výjimky:

• COMEX.Exceptions.GeneralException

Parametry:

• $pageStatus ● hodnota typu String (výchozí: undefined) chybové hlášení pro status stránky

• $logData ● hodnota typu String (výchozí: undefined) data do logu

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda fireEvent

Spustí specifickou událost modifikátoru.

typ: method; celé jméno: COMEX.Class.Range.Modifier.fireEvent;

Parametry:

• $eventType ● hodnota typu String typ události bez úvodního 'on' (submit, load, ...)

• $extraData ● hodnota typu mixed (výchozí: null) extra data ke zpracování

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda getConnectionData

Vrátí data pro propojení komponent.

typ: method; celé jméno: COMEX.Class.Range.Modifier.getConnectionData;

Parametry:

• $foreignPageConnection ● hodnota typu Boolean (výchozí: false) true, pokud se jedná o propojení s komponentou na jiné stránce, jinak false.

Vrací:

• hodnota typu COMEX.Resultpředávaná data

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda hide

Skryje komponentu.

typ: method; celé jméno: COMEX.Class.Range.Modifier.hide;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda highlight

Nastaví příznak pro zvýraznění komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.highlight;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda init

Inicializace komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.init;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda load

Načtení zdrojů komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.load;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda loadCSS

Načte kaskádové styly pro daný modifikátor

typ: method; celé jméno: COMEX.Class.Range.Modifier.loadCSS;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda main

Hlavní výkonný skript modifikátoru.

typ: method; celé jméno: COMEX.Class.Range.Modifier.main;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda prepare

Příprava komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.prepare;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda receiveConnection

Přijme propojení a spustí specifickou funkcionalitu.

typ: method; celé jméno: COMEX.Class.Range.Modifier.receiveConnection;

Parametry:

• $connection ● hodnota typu COMEX.Connection data propojení

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda refresh

Obnoví data komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.refresh;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda remove

Odstraní komponentu.

typ: method; celé jméno: COMEX.Class.Range.Modifier.remove;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda setStatus

Nastaví status komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.setStatus;

Parametry:

• $status ● hodnota typu String status komponenty

• $pageStatus ● hodnota typu String (výchozí: undefined) status stránky

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda setup

Nastavení komponenty.

typ: method; celé jméno: COMEX.Class.Range.Modifier.setup;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )

Metoda show

Zobrazí komponentu.

typ: method; celé jméno: COMEX.Class.Range.Modifier.show;

Vrací:

• hodnota typu voidbez návratové hodnoty

( umístěno v souboru /comex/scripts/comex-page.js )