Class XmlLoader

Class used to load GUI via XML.

Hierarchy

XmlLoader

Index

Constructors

constructor

Methods

Constructors

constructor

new XmlLoader(parentClass?: any): XmlLoader

- Defined in .temp/docdirectory/doc.d.ts:102511
Create a new xml loader

Parameters
- Optional parentClass: any
  
  Sets the class context. Used when the loader is instanced inside a class and not in a global context
Returns XmlLoader

Methods

disposeSearch playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:102544
Disposes the loaded layout

Returns void

getNodeByIdSearch playground for getNodeById

getNodeById(id: string): any

- Defined in .temp/docdirectory/doc.d.ts:102535
Gets a loaded node / control by id.

Parameters
- id: string
  
  the Controls id set in the xml
Returns any

element of type Control

getNodesSearch playground for getNodes

getNodes(): any

- Defined in .temp/docdirectory/doc.d.ts:102540
Gets all loaded nodes / controls

Returns any

Array of controls

isLoadedSearch playground for isLoaded

isLoaded(): boolean

- Defined in .temp/docdirectory/doc.d.ts:102529
Gets if the loading has finished.

Returns boolean

whether the loading has finished or not

loadLayoutSearch playground for loadLayout

loadLayout(xmlFile: any, rootNode: any, onSuccess?: Nullable<() => void>, onError?: Nullable<(error: string) => void>): void

- Defined in .temp/docdirectory/doc.d.ts:102552
Initiates the xml layout loading

Parameters
- xmlFile: any
  
  defines the xml layout to load
- rootNode: any
  
  defines the node / control to use as a parent for the loaded layout controls.
- Optional onSuccess: Nullable<() => void>
  
  defines the callback called on layout load successfully.
- Optional onError: Nullable<(error: string) => void>
  
  defines the callback called on layout load failure.
Returns void

loadLayoutAsyncSearch playground for loadLayoutAsync

loadLayoutAsync(xmlFile: any, rootNode: any): Promise<any>

- Defined in .temp/docdirectory/doc.d.ts:102559
Initiates the xml layout loading asynchronously

Parameters
- xmlFile: any
  
  defines the xml layout to load
- rootNode: any
  
  defines the node / control to use as a parent for the loaded layout controls.
Returns Promise<any>

Promise