Metody v Modifier
Metody umístěné ve jmenném prostoru Modifier.
Metoda autosave
Automatické uložení draftu.
typ: method; celé jméno: COMEX.Document.Form.Modifier.autosave;
Vrací:
bez návratové hodnoty
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda close
Zavře dokument/draft.
typ: method; celé jméno: COMEX.Document.Form.Modifier.close;
Parametry:
$forced
● hodnota typu Boolean (výchozí: false)
true, pokud má být dokument zavřen bez detekce změn, jinak false
Vrací:
bez návratové hodnoty
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda getDataPath
Poskládá kompletní cestu k nodu v datech dokumentu.
typ: method; celé jméno: COMEX.Document.Form.Modifier.getDataPath;
Parametry:
$node
● hodnota typu COMEX.XML.Node
XML nod z definice
Vrací:
cesta k nodu v datech dokumentu
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda getDocDateSerial
Vrátí sériové číslo dne data určeného XPath.
typ: method; celé jméno: COMEX.Document.Form.Modifier.getDocDateSerial;
Parametry:
$arguments
● hodnota typu Object
strukturovaný objekt
(String) xpath: XPath pro výběr uzlu
(COMEX.XML.Node) node: datový nod
(Boolean) context: true, pokud se jedná o kontextový nod, jinak false
Vrací:
sériové číslo dne (1.1.1900 == 1)
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda getDocNode
Vrátí nodu určený XPath.
typ: method; celé jméno: COMEX.Document.Form.Modifier.getDocNode;
Parametry:
$arguments
● hodnota typu Object
strukturovaný objekt
(String) xpath: XPath pro výběr uzlu
(COMEX.XML.Node) node: datový nod
(Boolean) context: true, pokud se jedná o kontextový nod, jinak false
Vrací:
XML nod
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda getDocValue
Vrátí hodnotu nodu určeného XPath.
typ: method; celé jméno: COMEX.Document.Form.Modifier.getDocValue;
Parametry:
$arguments
● hodnota typu Object
strukturovaný objekt
(String) xpath: XPath pro výběr uzlu
(COMEX.XML.Node) node: datový nod
(Boolean) context: true, pokud se jedná o kontextový nod, jinak false
Vrací:
hodnota nodu
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda getLangPath
Poskládá kompletní cestu k nodu v jazykovém nastavení.
typ: method; celé jméno: COMEX.Document.Form.Modifier.getLangPath;
Parametry:
$node
● hodnota typu COMEX.XML.Node
XML nod z definice
Vrací:
cesta k nodu v jazykovém nastavení
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda getStructPath
Poskládá kompletní cestu k nodu ve struktuře dokumentu.
typ: method; celé jméno: COMEX.Document.Form.Modifier.getStructPath;
Parametry:
$node
● hodnota typu COMEX.XML.Node
XML nod z dat
Vrací:
cesta k nodu ve struktuře dokumentu
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda isChanged
Vrátí příznak, zda byla změněna data.
typ: method; celé jméno: COMEX.Document.Form.Modifier.isChanged;
Vrací:
true, pokud byla data změněna, jinak false
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda load
Načte dokument/draft dle klíče.
typ: method; celé jméno: COMEX.Document.Form.Modifier.load;
Vrací:
true, pokud se podařilo dokument načíst, jinak false
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda loadBlank
Načte nový dokument.
typ: method; celé jméno: COMEX.Document.Form.Modifier.loadBlank;
Vrací:
nový dokument
null, pokud se nepodařilo dokument načíst
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda loadDefinition
Načte definici dokumentu.
typ: method; celé jméno: COMEX.Document.Form.Modifier.loadDefinition;
Vrací:
definice dokumentu
null, pokud se nepodařilo definici načíst
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda loadDocument
Načte dokument.
typ: method; celé jméno: COMEX.Document.Form.Modifier.loadDocument;
Vrací:
data dokumentu
null, pokud se nepodařilo dokument načíst
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda loadDraft
Načte draft.
typ: method; celé jméno: COMEX.Document.Form.Modifier.loadDraft;
Vrací:
data draftu
null, pokud se nepodařilo data načíst
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda loadLang
Načte jazykové nastavení dokumentu.
typ: method; celé jméno: COMEX.Document.Form.Modifier.loadLang;
Vrací:
jazykové nastavení dokumentu
null, pokud se nepodařilo nastavení načíst
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda normalizeData
Vrátí normalizovaná data bez pomocných elementů a atributů.
Při normalizaci typu draft v datech ponechá prázdné opakovatelné oblasti.
typ: method; celé jméno: COMEX.Document.Form.Modifier.normalizeData;
Parametry:
$type
● hodnota typu String
typ normalizace dat (draft nebo document)
Vrací:
normalizovaná data (rootový nod)
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda reload
Znovu načte dokument/draft.
typ: method; celé jméno: COMEX.Document.Form.Modifier.reload;
Vrací:
bez návratové hodnoty
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda removeDraft
Smaže draft.
typ: method; celé jméno: COMEX.Document.Form.Modifier.removeDraft;
Vrací:
bez návratové hodnoty
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda saveDocument
Uloží dokument.
typ: method; celé jméno: COMEX.Document.Form.Modifier.saveDocument;
Parametry:
$close
● hodnota typu Boolean (výchozí: false)
true, pokud má být dokument po uložení zavřen, jinak false
$openNew
● hodnota typu Boolean (výchozí: false)
true, pokud má být po uložení načten nový prázdný dokument, jinak false
Vrací:
true, pokud se podařilo dokument uložit, jinak false
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda saveDraft
Uloží draft.
typ: method; celé jméno: COMEX.Document.Form.Modifier.saveDraft;
Parametry:
$close
● hodnota typu Boolean (výchozí: false)
true, pokud má být dokument po uložení zavřen, jinak false
Vrací:
true, pokud se podařilo draft uložit, jinak false
( umístěno v souboru /comex/modifiers/document/form/document-form.js )