Class: BuilderView

Represents all the metadata of the form builder components.

Extends

• View

Constructors

Constructor

new BuilderView(builderComponents): BuilderView

Creates metadata for form builder components.

Parameters

builderComponents

BuilderComponent[]

the array of metadata of form builder components.

Returns

BuilderView

Overrides

View.constructor

Properties

builderComponents

builderComponents: BuilderComponent[]

the array of metadata of form builder components.

Accessors

errors

Get Signature

get errors(): string[]

Returns

string[]

the array of strings with the names of the component types of the error.

---

tooltips

Get Signature

get tooltips(): string[]

Returns

string[]

the array of strings with the names of the component types of the tooltip.

---

viewerWrappers

Get Signature

get viewerWrappers(): FormViewerWrapper[]

Retrieves the viewer wrappers array.

Returns

FormViewerWrapper[]

the viewer wrappers array.

Inherited from

View.viewerWrappers

Methods

addComponent()

addComponent(component): void

Adds the component metadata to the form builder.

Parameters

component

BuilderComponent

the component metadata.

Returns

void

---

all()

all(): Model<any>[]

Returns

Model<any>[]

all component metadata for the form viewer.

Inherited from

View.all

---

define()

define(model): void

Defines the component's metadata for the form viewer.

Parameters

model

Model

the component's metadata.

Returns

void

Inherited from

View.define

---

find()

find(type): undefined | Model<any>

Returns the component's metadata for the form viewer for the specified type.

Parameters

type

string

the component type.

Returns

undefined | Model<any>

the component metadata for the form viewer for the specified type or undefined.

Inherited from

View.find

---

findMeta()

findMeta(type): undefined | Meta

Returns the component metadata for the specified component type name or undefined.

Parameters

type

string

the component type name.

Returns

undefined | Meta

the component metadata for the specified component type name or undefined.

---

get()

get(type): Model<any>

Returns the component's metadata for the form viewer for the specified type.

Parameters

type

string

the component type.

Returns

Model<any>

the component metadata for the form viewer for the specified type.

Inherited from

View.get

---

getCssLoaders()

getCssLoaders(biDi): () => Promise<void>[]

Retrieves the CSS loaders for a given BiDi.

Parameters

biDi

BiDi

the BiDi object for which to retrieve the CSS loaders.

Returns

() => Promise<void>[]

the array containing the CSS loaders for the specified BiDi.

Inherited from

View.getCssLoaders

---

getErrorAnnotations()

getErrorAnnotations(name): undefined | Annotation[]

Returns the array of metadata properties of the error component.

Parameters

name

string

the name of the error component type.

Returns

undefined | Annotation[]

the array of metadata properties of the error component.

---

getMeta()

getMeta(type): Meta

Returns the component metadata for the specified component type name.

Parameters

type

string

the component type name.

Returns

Meta

the component metadata for the specified component type name.

---

getTooltipAnnotations()

getTooltipAnnotations(name): undefined | Annotation[]

Returns the array of metadata properties of the tooltip component.

Parameters

name

string

the name of the tooltip component type.

Returns

undefined | Annotation[]

the array of metadata properties of the tooltip component.

---

removeComponent()

removeComponent(name): void

Removes the component metadata from the form builder.

Parameters

name

string

the component type name.

Returns

void

---

withCssLoader()

withCssLoader(cssLoaderType, loader): BuilderView

Applies the given CSS loader to the component based on the BiDi layout.

Parameters

cssLoaderType

CssLoaderType

the BiDi layout type, either 'common', 'ltr', or 'rtl'.

loader

() => Promise<void>

the function that returns a Promise to load CSS or other required localization resources.

Returns

BuilderView

the View instance.

Inherited from

View.withCssLoader

---

withErrorMeta()

withErrorMeta(builderComponent): this

Sets the metadata of the component that displays form's errors.

Parameters

builderComponent

BuilderComponent

the metadata of the component that displays the form's errors.

Returns

this

the instance of the BuilderView class.

---

withTemplates()

withTemplates(templates): this

Creates metadata for the form builder for templates from the specified template names.

Parameters

templates

string[]

the array of template names.

Returns

this

the instance of the BuilderView class.

---

withTooltipMeta()

withTooltipMeta(builderComponent): this

Sets the metadata of the component that displays the form's tooltips.

Parameters

builderComponent

BuilderComponent

the metadata of the component that displays the form's tooltips.

Returns

this

the instance of the BuilderView class.

---

withViewerWrapper()

withViewerWrapper(wrapper): BuilderView

Adds a wrapper to the list of viewers for this viewer wrapper.

Parameters

wrapper

FormViewerWrapper

the viewer wrapper to be added. The wrapper is a component that wraps the form viewer.

Returns

BuilderView

the View instance.

Inherited from

View.withViewerWrapper

---

create()

static create(models): View

Static wrapper for the View constructor.

Parameters

models

Model<any>[]

the components metadata.

Returns

View

the View instance.

Inherited from

View.create

---

createTemplateComponent()

static createTemplateComponent(name): BuilderComponent

Creates an instance of BuilderComponent for the specified template name.

Parameters

name

string

the template name

Returns

BuilderComponent

the BuilderComponent instance.