Interface IConfigApp

interface IConfigApp {
    configPages?: ConfigPageFactory;
    dlgForm: JQuery;
    isClientApplication: false;
    isConfigApplication: true;
    itemForm: JQuery;
    plugins: IServerPluginSettings[];
    printForm: JQuery;
    canDragDrop(nodeType, pageId): boolean;
    canGroupWrite(projectId, groupId): boolean;
    canNavigateAwayAsync(): JQueryDeferred<any>;
    canUserWrite(projectId, login): boolean;
    cancel(): void;
    dragEnter(dragged, target): boolean | string[];
    getCategories(projectId): string[];
    getCatgegoryConfig(projectId, category): null | XRCategoryExtendedType;
    getConfigPages(): ConfigPageFactory;
    getCurrentItemId(): string;
    getCustomerSetting(setting): string;
    getFieldConfig(projectId, category, field): null | XRFieldType;
    getGroupPermission(projectId): XRGroupPermissionType[];
    getItem(itemId): IDB;
    getJSONProjectSettings(projectId, settingId): IJsonSetting[];
    getLastProject(): string;
    getNeedsSave(): boolean;
    getParentId(itemId): string;
    getProjectConfig(projectId): XRProjectInfo;
    getServerSetting(settingId, defaultValue): any;
    getTree(): IDB[];
    getType(): string;
    getUser(): null | string;
    getUserPermission(projectId): XRUserPermissionType[];
    getVersion(): string;
    getVersionQualifier(): string;
    init(itemForm, dlgForm): void;
    insertItem(item, parent): void;
    isConfigApp(): true;
    itemChanged(needsSave): void;
    pingCurrentItem(): void;
    postLogin(user): void;
    registerPage(item, parent, updateUI): void;
    reloadProject(project, pageId, parentFolderId): JQueryDeferred<any>;
    removedFromTree(itemId, newId): void;
    renamePage(pageId, label, parent): void;
    resizeItem(): void;
    saveAsync(): JQueryDeferred<any>;
    selectItem(itemId, itemLabel): void;
    setCategorySettingAsync(projectId, category, settingId, settingValue, pageId): JQueryDeferred<any>;
    setJSONProjectSettingAsync(projectId, setting, pageId): JQueryDeferred<void>;
    setLastConnection(): void;
    setProjectSettingAsync(projectId, settingId, settingValue, pageId): JQueryDeferred<void>;
    setServerSetting(settingId, property, newValue): void;
    setServerSettingAsync(settingId, settingValue): JQueryDeferred<any>;
    settingExists(projectId, settingId): boolean;
    signOut(): void;
    treeSelectionChange(pageId): void;
    updateFieldConfig(projectId, category, field, newConfig): void;
    updateProjectData(projectId): JQueryDeferred<IRestResult>;
}

Hierarchy

  • IBaseApp
    • IConfigApp

Properties

configPages? dlgForm isClientApplication isConfigApplication itemForm plugins printForm

Methods

canDragDrop canGroupWrite canNavigateAwayAsync canUserWrite cancel dragEnter getCategories getCatgegoryConfig getConfigPages getCurrentItemId getCustomerSetting getFieldConfig getGroupPermission getItem getJSONProjectSettings getLastProject getNeedsSave getParentId getProjectConfig getServerSetting getTree getType getUser getUserPermission getVersion getVersionQualifier init insertItem isConfigApp itemChanged pingCurrentItem postLogin registerPage reloadProject removedFromTree renamePage resizeItem saveAsync selectItem setCategorySettingAsync setJSONProjectSettingAsync setLastConnection setProjectSettingAsync setServerSetting setServerSettingAsync settingExists signOut treeSelectionChange updateFieldConfig updateProjectData

Properties

Optional configPages

configPages?: ConfigPageFactory

dlgForm

dlgForm: JQuery

isClientApplication

isClientApplication: false

isConfigApplication

isConfigApplication: true

itemForm

itemForm: JQuery

plugins

plugins: IServerPluginSettings[]

printForm

printForm: JQuery

Methods

canDragDrop

  • canDragDrop(nodeType, pageId): boolean

  • Parameters

    • nodeType: string
    • pageId: string

    Returns boolean

canGroupWrite

canNavigateAwayAsync

canUserWrite

cancel

dragEnter

  • dragEnter(dragged, target): boolean | string[]

  • Parameters

    • dragged: FancytreeNode
    • target: FancytreeNode

    Returns boolean | string[]

getCategories

getCatgegoryConfig

  • getCatgegoryConfig(projectId, category): null | XRCategoryExtendedType

  • Parameters

    • projectId: string
    • category: string

    Returns null | XRCategoryExtendedType

getConfigPages

getCurrentItemId

getCustomerSetting

getFieldConfig

  • getFieldConfig(projectId, category, field): null | XRFieldType

  • Parameters

    • projectId: string
    • category: string
    • field: string

    Returns null | XRFieldType

getGroupPermission

getItem

getJSONProjectSettings

  • getJSONProjectSettings(projectId, settingId): IJsonSetting[]

  • Parameters

    • projectId: string
    • settingId: string

    Returns IJsonSetting[]

getLastProject

getNeedsSave

getParentId

getProjectConfig

getServerSetting

getTree

getType

getUser

getUserPermission

getVersion

getVersionQualifier

init

insertItem

isConfigApp

itemChanged

pingCurrentItem

postLogin

registerPage

reloadProject

  • reloadProject(project, pageId, parentFolderId): JQueryDeferred<any>

  • Parameters

    • project: string
    • pageId: string
    • parentFolderId: string

    Returns JQueryDeferred<any>

removedFromTree

renamePage

resizeItem

saveAsync

selectItem

setCategorySettingAsync

  • setCategorySettingAsync(projectId, category, settingId, settingValue, pageId): JQueryDeferred<any>

  • Parameters

    • projectId: string
    • category: string
    • settingId: string
    • settingValue: string
    • pageId: string

    Returns JQueryDeferred<any>

setJSONProjectSettingAsync

  • setJSONProjectSettingAsync(projectId, setting, pageId): JQueryDeferred<void>

  • Parameters

    • projectId: string
    • setting: IJsonSetting
    • pageId: string

    Returns JQueryDeferred<void>

setLastConnection

setProjectSettingAsync

  • setProjectSettingAsync(projectId, settingId, settingValue, pageId): JQueryDeferred<void>

  • Parameters

    • projectId: string
    • settingId: string
    • settingValue: string
    • pageId: null | string

    Returns JQueryDeferred<void>

setServerSetting

  • setServerSetting(settingId, property, newValue): void

  • Parameters

    • settingId: string
    • property: string
    • newValue: any

    Returns void

setServerSettingAsync

  • setServerSettingAsync(settingId, settingValue): JQueryDeferred<any>

  • Parameters

    • settingId: string
    • settingValue: string

    Returns JQueryDeferred<any>

settingExists

signOut

treeSelectionChange

updateFieldConfig

  • updateFieldConfig(projectId, category, field, newConfig): void

  • Parameters

    • projectId: string
    • category: string
    • field: string
    • newConfig: XRFieldType

    Returns void

updateProjectData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc