Metody v Form
Metody umístěné ve jmenném prostoru Form.
Metoda autosave
Automatické uložení draftu.
typ: method; celé jméno: COMEX.Document.Form.autosave;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.close;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
$forced
● hodnota typu Boolean (výchozí: false)
true, pokud má být dokument zavřen bez ohledu na změny, 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.getDataPath;
Parametry:
$node
● hodnota typu COMEX.XML.Node
XML nod z definice
$type
● hodnota typu String
typ dokumentu
Vrací:
cesta k nodu v datech dokumentu
( 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.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.getStructPath;
Parametry:
$node
● hodnota typu COMEX.XML.Node
XML nod z dat
$type
● hodnota typu String
typ dokumentu
Vrací:
cesta k nodu ve struktuře dokumentu
( umístěno v souboru /comex/modifiers/document/form/document-form.js )
Metoda hideTerminateButtons
Skryje tlačítkovou lištu.
typ: method; celé jméno: COMEX.Document.Form.hideTerminateButtons;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
Vrací:
bez návratové hodnoty
( 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.isChanged;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.load;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.loadBlank;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.loadDefinition;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.loadDocument;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.loadDraft;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.loadLang;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.normalizeData;
Parametry:
$data
● hodnota typu COMEX.XML.Doc
data dokumentu
$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.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.removeDraft;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
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.saveDocument;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
$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.saveDraft;
Parametry:
$document
● hodnota typu COMEX.Document.Form.Modifier
instance modifikátoru dokumentu
$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 )