Interface NodeUtils

Instance variable: nodeUtils

interface NodeUtils {
    DEFAULT_REFRESH_TIMEOUT: number;
    _addDefaultMenu: ((node) => boolean);
    _anyNodeInRefresh?: boolean;
    _collapseNode: ((node, forced?) => void);
    _getNodeHandlersStoreKey: ((node) => string);
    _getNodeMenu: ((node) => MenuItem[]);
    _getViewHandlersStoreKey: ((node) => string);
    canEditNodeTitle: ((node) => boolean);
    canUseAutoSearch: (() => boolean);
    cancelNode: ((node) => void);
    closeLoadProgress: ((node) => void);
    collapseNode: ((rootNode, forced?) => void);
    collapseNodeList: ((list, forced?) => void);
    copyNodeItem: ((node, cut?) => void);
    createContextMenu: ((getNodes) => any);
    deferredRefresh: ((node, useTimeout?) => void);
    deferredRefreshCancel: ((node) => void);
    deleteItems: ((nodes, permanent?) => void);
    fillFromList: ((node, list, handlerID) => Promise<void>);
    getBrowserTracksSortString: (() => string);
    getCanBeCollapsed: ((node) => any);
    getCollectionStateRootKey: ((coll) => string);
    getDeleteText: ((node) => any);
    getDevicesBy: ((node, params, handler) => Promise<void>);
    getFirstNode: ((nodes) => any);
    getHasChildren: ((node) => boolean);
    getHasTreeChildren: ((node) => boolean);
    getHasVirtualChildrenSupport: ((node) => any);
    getHideCheckbox: ((node) => boolean);
    getMultiselectSupport: ((node) => any);
    getNodeByPath: ((rootNode, pathNodeStates) => Promise<unknown>);
    getNodeCollection: ((node) => Collection);
    getNodeDevice: ((node) => any);
    getNodeHandlerState: ((viewData) => any);
    getNodeHelpContext: ((node) => string);
    getNodeIcon: ((node) => string);
    getNodeStateRootKey: ((node, coll) => string);
    getNodeTitle: ((node, incChildCount?, acceptPromises?, forEditing?) => string | Promise<string>);
    getNodeTooltip: ((node) => string);
    getNodesTracklist: ((nodes) => any);
    getParentAtLevel: ((node, level) => SharedNode);
    getViewHandlerState: ((viewData) => any);
    initLoadProgress: ((node) => void);
    isDeleteDisabled: ((node) => boolean);
    loadChildren: ((node) => Promise<unknown>);
    onCollapsed: ((node) => void);
    onExpanded: ((node) => void);
    progress?: BackgroundTask;
    refreshNodeChildren: ((node, withoutProgress?) => Promise<unknown>);
    restoreDataSource: ((dataSource) => Promise<SharedObject>);
    restoreNode: ((parentNode, state, addToTree) => Promise<unknown>);
    setNodeHandlerState: ((viewData, state) => void);
    setNodeTitle: ((node, title) => void);
    setViewHandlerState: ((viewData, state) => void);
    storeDataSource: ((dataSource) => any);
    storeNode: ((node) => {
        dataSource: any;
        handlerID: string;
        persistentID: string;
    });
}

Properties

DEFAULT_REFRESH_TIMEOUT _addDefaultMenu _anyNodeInRefresh? _collapseNode _getNodeHandlersStoreKey _getNodeMenu _getViewHandlersStoreKey canEditNodeTitle canUseAutoSearch cancelNode closeLoadProgress collapseNode collapseNodeList copyNodeItem createContextMenu deferredRefresh deferredRefreshCancel deleteItems fillFromList getBrowserTracksSortString getCanBeCollapsed getCollectionStateRootKey getDeleteText getDevicesBy getFirstNode getHasChildren getHasTreeChildren getHasVirtualChildrenSupport getHideCheckbox getMultiselectSupport getNodeByPath getNodeCollection getNodeDevice getNodeHandlerState getNodeHelpContext getNodeIcon getNodeStateRootKey getNodeTitle getNodeTooltip getNodesTracklist getParentAtLevel getViewHandlerState initLoadProgress isDeleteDisabled loadChildren onCollapsed onExpanded progress? refreshNodeChildren restoreDataSource restoreNode setNodeHandlerState setNodeTitle setViewHandlerState storeDataSource storeNode

Properties

DEFAULT_REFRESH_TIMEOUT

DEFAULT_REFRESH_TIMEOUT: number

Undocumented

_addDefaultMenu

_addDefaultMenu: ((node) => boolean)

Type declaration

    • (node): boolean

    • Parameters

      Returns boolean

Undocumented

Optional _anyNodeInRefresh

_anyNodeInRefresh?: boolean

Undocumented

_collapseNode

_collapseNode: ((node, forced?) => void)

Type declaration

    • (node, forced?): void

    • Parameters

      Returns void

Undocumented

_getNodeHandlersStoreKey

_getNodeHandlersStoreKey: ((node) => string)

Type declaration

    • (node): string

    • Parameters

      Returns string

Undocumented

_getNodeMenu

_getNodeMenu: ((node) => MenuItem[])

Type declaration

Undocumented

_getViewHandlersStoreKey

_getViewHandlersStoreKey: ((node) => string)

Type declaration

    • (node): string

    • Parameters

      Returns string

Undocumented

canEditNodeTitle

canEditNodeTitle: ((node) => boolean)

Type declaration

    • (node): boolean

    • Parameters

      Returns boolean

Undocumented

canUseAutoSearch

canUseAutoSearch: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Undocumented

cancelNode

cancelNode: ((node) => void)

Type declaration

    • (node): void

    • Parameters

      Returns void

Undocumented

closeLoadProgress

closeLoadProgress: ((node) => void)

Type declaration

    • (node): void

    • Parameters

      Returns void

Undocumented

collapseNode

collapseNode: ((rootNode, forced?) => void)

Type declaration

    • (rootNode, forced?): void

    • Parameters

      Returns void

Undocumented

collapseNodeList

collapseNodeList: ((list, forced?) => void)

Type declaration

Undocumented

copyNodeItem

copyNodeItem: ((node, cut?) => void)

Type declaration

    • (node, cut?): void

    • Parameters

      Returns void

Undocumented

createContextMenu

createContextMenu: ((getNodes) => any)

Type declaration

    • (getNodes): any

    • Parameters

      • getNodes: any

      Returns any

Undocumented

deferredRefresh

deferredRefresh: ((node, useTimeout?) => void)

Type declaration

    • (node, useTimeout?): void

    • Parameters

      Returns void

Undocumented

deferredRefreshCancel

deferredRefreshCancel: ((node) => void)

Type declaration

    • (node): void

    • Parameters

      Returns void

Undocumented

deleteItems

deleteItems: ((nodes, permanent?) => void)

Type declaration

    • (nodes, permanent?): void

    • Parameters

      Returns void

Undocumented

fillFromList

fillFromList: ((node, list, handlerID) => Promise<void>)

Type declaration

Undocumented

getBrowserTracksSortString

getBrowserTracksSortString: (() => string)

Type declaration

    • (): string

    • Returns string

Undocumented

getCanBeCollapsed

getCanBeCollapsed: ((node) => any)

Type declaration

Undocumented

getCollectionStateRootKey

getCollectionStateRootKey: ((coll) => string)

Type declaration

    • (coll): string

    • Parameters

      Returns string

Undocumented

getDeleteText

getDeleteText: ((node) => any)

Type declaration

Undocumented

getDevicesBy

getDevicesBy: ((node, params, handler) => Promise<void>)

Type declaration

    • (node, params, handler): Promise<void>

    • Parameters

      Returns Promise<void>

Undocumented

getFirstNode

getFirstNode: ((nodes) => any)

Type declaration

Undocumented

getHasChildren

getHasChildren: ((node) => boolean)

Type declaration

    • (node): boolean

    • Parameters

      Returns boolean

Undocumented

getHasTreeChildren

getHasTreeChildren: ((node) => boolean)

Type declaration

    • (node): boolean

    • Parameters

      Returns boolean

Undocumented

getHasVirtualChildrenSupport

getHasVirtualChildrenSupport: ((node) => any)

Type declaration

Undocumented

getHideCheckbox

getHideCheckbox: ((node) => boolean)

Type declaration

    • (node): boolean

    • Parameters

      Returns boolean

Undocumented

getMultiselectSupport

getMultiselectSupport: ((node) => any)

Type declaration

Undocumented

getNodeByPath

getNodeByPath: ((rootNode, pathNodeStates) => Promise<unknown>)

Type declaration

    • (rootNode, pathNodeStates): Promise<unknown>

    • Parameters

      Returns Promise<unknown>

Undocumented

getNodeCollection

getNodeCollection: ((node) => Collection)

Type declaration

Undocumented

getNodeDevice

getNodeDevice: ((node) => any)

Type declaration

Undocumented

getNodeHandlerState

getNodeHandlerState: ((viewData) => any)

Type declaration

    • (viewData): any

    • Parameters

      Returns any

Undocumented

getNodeHelpContext

getNodeHelpContext: ((node) => string)

Type declaration

    • (node): string

    • Parameters

      Returns string

Undocumented

getNodeIcon

getNodeIcon: ((node) => string)

Type declaration

    • (node): string

    • Parameters

      Returns string

Undocumented

getNodeStateRootKey

getNodeStateRootKey: ((node, coll) => string)

Type declaration

Undocumented

getNodeTitle

getNodeTitle: ((node, incChildCount?, acceptPromises?, forEditing?) => string | Promise<string>)

Type declaration

    • (node, incChildCount?, acceptPromises?, forEditing?): string | Promise<string>

    • Parameters

      • node: SharedNode
      • Optional incChildCount: boolean
      • Optional acceptPromises: boolean
      • Optional forEditing: boolean

      Returns string | Promise<string>

Undocumented

getNodeTooltip

getNodeTooltip: ((node) => string)

Type declaration

    • (node): string

    • Parameters

      Returns string

Undocumented

getNodesTracklist

getNodesTracklist: ((nodes) => any)

Type declaration

Undocumented

getParentAtLevel

getParentAtLevel: ((node, level) => SharedNode)

Type declaration

Undocumented

getViewHandlerState

getViewHandlerState: ((viewData) => any)

Type declaration

    • (viewData): any

    • Parameters

      Returns any

Undocumented

initLoadProgress

initLoadProgress: ((node) => void)

Type declaration

    • (node): void

    • Parameters

      Returns void

Undocumented

isDeleteDisabled

isDeleteDisabled: ((node) => boolean)

Type declaration

    • (node): boolean

    • Parameters

      Returns boolean

Undocumented

loadChildren

loadChildren: ((node) => Promise<unknown>)

Type declaration

    • (node): Promise<unknown>

    • Parameters

      Returns Promise<unknown>

Undocumented

onCollapsed

onCollapsed: ((node) => void)

Type declaration

    • (node): void

    • Parameters

      Returns void

Undocumented

onExpanded

onExpanded: ((node) => void)

Type declaration

    • (node): void

    • Parameters

      Returns void

Undocumented

Optional progress

progress?: BackgroundTask

Undocumented

refreshNodeChildren

refreshNodeChildren: ((node, withoutProgress?) => Promise<unknown>)

Type declaration

    • (node, withoutProgress?): Promise<unknown>

    • Parameters

      Returns Promise<unknown>

Undocumented

restoreDataSource

restoreDataSource: ((dataSource) => Promise<SharedObject>)

Type declaration

Undocumented

restoreNode

restoreNode: ((parentNode, state, addToTree) => Promise<unknown>)

Type declaration

    • (parentNode, state, addToTree): Promise<unknown>

    • Parameters

      • parentNode: any
      • state: any
      • addToTree: any

      Returns Promise<unknown>

Undocumented

setNodeHandlerState

setNodeHandlerState: ((viewData, state) => void)

Type declaration

    • (viewData, state): void

    • Parameters

      Returns void

Undocumented

setNodeTitle

setNodeTitle: ((node, title) => void)

Type declaration

    • (node, title): void

    • Parameters

      Returns void

Undocumented

setViewHandlerState

setViewHandlerState: ((viewData, state) => void)

Type declaration

    • (viewData, state): void

    • Parameters

      Returns void

Undocumented

storeDataSource

storeDataSource: ((dataSource) => any)

Type declaration

    • (dataSource): any

    • Parameters

      • dataSource: any

      Returns any

Undocumented

storeNode

storeNode: ((node) => {
    dataSource: any;
    handlerID: string;
    persistentID: string;
})

Type declaration

    • (node): {
          dataSource: any;
          handlerID: string;
          persistentID: string;
      }

    • Parameters

      Returns {
          dataSource: any;
          handlerID: string;
          persistentID: string;
      }

      • dataSource: any

        Undocumented

      • handlerID: string

        Undocumented

      • persistentID: string

        Undocumented

Undocumented

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc