Objekt speciálních služeb plochy – konstruktor SPCServices()

Upravit obsah stránky

Objekt dle tohoto konstruktoru sdružuje služby plochy a jiné pomocné metody a vlastnosti, jež jsou zpřístupněny skriptům speciálních stránek.

Metody

    bullet

    spcs.openDestin(sRef, wizRun, idRef) Metoda zajistí otevření předaného řetězcového odkazu  sRef na ploše flexideo (např. "společné/kontakty"). Použití této metody způsobí zavření speciální stránky. Argument  wizRun je typu boolean a true říká, že v případě odkazu na průvodce se má tento spustit a nikoli otevřít jeho nastavení; poslední argument idRef používá pro odkazování na ploše stabilní odkaz ve formě typu oblasti a primárního klíče (pdk) daného xitem oddělené tečkou (např. "corporate.1234");

    bullet

    spcs.chooseItm(dKey, dType, vType) Metoda zaznamená výběr položky (pro akci, makro, záložky, hrom. tisk atp.). První dva argumenty označují klíč a typ dokumentu vybírané položky, třetí pak její případný pohledový typ – zejména důležité při hromadném vytvoření záložek.

    bullet

    spcs.openItem(tgID, vType, subFolder) Otevírání položky do formuláře či otevření podsložky dokumentu. Argument tgID obsahuje podtržítkem oddělený typ a klíč dokumentu (např. kontakt_123). Pomocí argumentu vType je možné zvolit pohledový formulář pro otevření. Je-li požadováno otevření podsložky a ne formuláře, je třeba nastavit subFolder = true. Navigace opouští zobrazenou speciální stránku.

    bullet

    spcs.openChild(sLabel) Platné pro použití ve speciální složce (v přehledech je z logických důvodů třeba užívate openItem). Umožňuje otevřít labelem pojmenovanou položku složky. Není-li k dispozici label, může být použito name (jde jen o to, že se name zobrazí v adresním řádku na místo plného jména).

    bullet

    spcs.openFile(relURL) Otevírání souboru ze sídla flexideo. Odkaz se zadává jako relativní, přičemž většinou začíná files/.... Může se ovšem také jednat o soubor z exportu apod. Pokud má užvatel povolen přístup pomoci file a nikoli http protokolu, bude URL přetvořena na file-path a uživateli umožněna editace souboru. Navigace neopouští zobrazenou speciální stránku – zobrazení probíhá v novém okně.

    bullet

    spcs.openDoc(type, dkey) Speciální metoda pro otevření formuláře dokumentu. Jednodužší použití oproti metodě openItem(...). Neumožňuje otevření podsložky dokumentu. Využívá přechodu na destinaci "rozpracované/...". Je-li zapotřebí použití pohledového typu, pak se tento zadá jako typ (navigace opouští zobrazenou speciální stránku).

    bullet

    spcs.showModal(URL, args, height, width, top, left) Zjednodušuje použití webového dialogového okna, pokud jej speciální stránka využívá. Do URL se zadá odkaz na html stránku, do args argumenty, které tato webová stránka případně využívá jako dialog.

    bullet

    spcs.docPrint(dKey, dType, vType, printImediat) Metoda zpřístupňuje tiskové nástroje konkrétního dokumentu formou dialogového okna (navigace neopouští zobrazenou speciální stránku). Je opět možné vedle typu a klíče (povinné) zadat i pohledový typ pro použití jiné tiskové šablony (resp. sady šablon pohledového dokumentu). Poslední argument zajistí po otevření dialogu následně ihned i otevření dialogu pro tisk – uživatel musí ovšem tisk vždy potvrdit (zabezpečení prohlížeče).

    bullet

    spcs.getStyle(specTmpRPath) Metoda zajistí šablonu dle zadané relativní cesty s obsluhou cash (tj. načte jen jednou a ani při opuštění spec. stránky se její načtení nztrácí – výmaz objektu šablony z paměti je časován dle vnitřního nastavení plochy). specTmpRPath je rel. odkaz navazující na složku special (kmenová složka webu flexideo). Je-li šablona přímo umístěna ve složce special, pak stačí uvést její jméno. Většinou je však zapotřebí předřadit jméno jedné či více podsložek s běžným lomítkem jako oddělovačem (URL).

    bullet

    spcs.applTemp(specTmpRPath, dataNd, varObj, bToObj) Tato metoda usnadňuje aplikování XSLT s tím, že vrací buď text či objekt (pokud bToObj=true). Aplikace šablony probíhá na datový uzel odkazovaný jeho objektem v argumentu dataNd. Argument varObj je běžný objekt JScript, přičemž názvy jeho vlastností musí odpovídat názvům globálních proměnných v použité šabloně a obsah těchto vlastností pak bude přenesen do atributu select odpovídajícího xsl:variable. Argument specTmpRPath viz. metoda getStyle().

    bullet

    spcs.initSet() Tato metoda se spouští při vytvoření objektu konstruktorem a slouží pro vnitřní inicializaci objektu. Navenek je bez užitku.

    bullet

    spcs.runAction(sName, bSelectedOnly) Metoda provede spuštění akce dle předaného názvu; Podmínkou je, že uživatel stránky musí mít dle registru akcí volanou akci dostupnou; Argument bSelectedOnly == true umožňuje, v případě, že akce pracuje s vyběrem položek, vynutit u uživatele jejich výběr a použití; Pozoro: Nevrací výsledek provedení, jen zajistí platné spuštění akce a ještě před jejím spuštěním vrací řízení volající funkci (tj. provádi timeout na spuštění akce).

    bullet

    spcs.setToTable(sPath, sValue) Metoda provede vložení hodnoty nastavení v podobě řetězce sValue do nastavení určeného relativní cestou sPath. Tento odkaz musí být zadán tak, aby navazoval na uzel /special-settings/user, jehož kopie je dána jako výchozí při tvorbě a nastavování přehledu na webu. Tato hodnota zůstává nastavena až do okamžiku odhlášení uživatele (resp. ukončení webového rozhraní flexideo), zeměny nastavení. Pokud bude následně dílčí uzel table pomocí metody dats.saveSetting() uložen, tak hodnota zůstane zachována i po odhlášení uživatele.

    bullet

    spcs.saveThisSettings(bDoAlert) Provádí uložení celých nastavení vč. uživatelských u speciální tabulky. Argument bDoAlert zajistí chybovou hlášku při vzniku případné chyby. Tato metoda zjednodušuje použití dats.saveSettings(...) při ukládání nastavení aktuálně otevřeného speciálního přehledu.


Vlastnosti

    bullet

    spcs.uwork – přístup k hlavnímu objektu pracovní plochy

    bullet

    spcs.obase – přístup k objektu základny pracovní plochy

    bullet

    spcs.actTemp – aktuálně použitá XSLT šablona (při getStyle()/applTemp())

    bullet

    spcs.node – přístup k uzlu special-settings (potomek table u spec. přehledů)

    bullet

    spcs.usrNd – přístup k uzlu XML elementu uživatelských nastavení spec. přehledu

    bullet

    spcs.displNd – objekt tagu table otevřené speciální tabulky v rámci daného stromu

    bullet

    spcs.settsDOM – objekt DOM aktuál. XML souboru spec. nast. pro dokument

    bullet

    spcs.settings – js objekt kopírující XML z aktuál. souboru spec. nast. pro dokument (poznámky k spcs.settings: názvy jsou tagů použity jako názvy vlastností – pomlčky vyjmuty; v případě shodných jmen tagů je použito pole; potomky objektu spcs.settings jsou admin, user; user obsahuje aktuální nast. z table nikoli výchozí ze souboru jako admin; tagy bez potomků a atributů jsou zapsány jako prosté textové vlastnosti, tagy s potomky a/nebo atributy jako objekty ve vlastnostech svých rodičů)