import BaseComponent from 'formiojs/src/components/base/Base.js'

public class | source

BaseComponent

This is the BaseComponent class which all elements within the FormioForm derive from.

Static Method Summary

Static Public Methods
public static	schema(sources: ...):

Constructor Summary

Public Constructor
public	constructor(component: Object, options: Object, data: Object) Initialize a new BaseComponent.

Member Summary

Public Members
public get	className: string: * Retrieves the CSS class name of this component.
public	component: * The Form.io component JSON schema.
public get	customStyle: string: * Build the custom style from the layout values
public	data: * The data object in which this component resides.
public set	dataValue(value: *) Sets the static value of this component.
public get	dataValue: : Get the static value of this component.
public get	defaultSchema: *
public get	defaultValue: *
public get	defaultViewOnlyValue: string
public	description: *
public get	disabled: boolean: * Return if the component is disabled.
public set	disabled(disabled: boolean) Disable this component.
public	element: null The bounding HTML Element which this component is rendered.
public get	emptyValue: null: * The empty value for this component.
public	error: string The existing error that this component has.
public	errorContainer: *
public	errorElement: null The HTMLElement for which the errors are rendered for this component (usually underneath the component).
public get	errorLabel: : Returns the error label for this component.
public get	errors: *
public	eventHandlers: Array An array of event handlers so that the destry command can deregister them.
public	eventListeners: Array An array of the event listeners so that the destroy command can deregister them.
public	events: * The events that are triggered for the whole FormioForm object.
public get	hasInput: *
public	i18next: *
public	id: string The ID of this component.
public	info: null The basic component information which tells the BaseComponent how to render the input element of the components that derive from this class.
public	inputs: Array An array of all of the input HTML Elements that have been added to this component.
public	invalid: boolean
public	isBuilt: boolean
public get	key: *
public set	label(value: *) Set this component's label text and render it.
public get	label: * Get this component's label text.
public	labelElement: null The HTMLElement that is assigned to the label of this component.
public get	name: string: * The readible name for this component.
public	options: {} The options for this component.
public	originalComponent: *
public	parent: BaseComponent Points to the parent component.
public	pristine: boolean If this input has been input and provided value.
public	quill: *
public	root: BaseComponent Points to the root component, usually the FormComponent.
public	row: number The row path of this component.
public get	schema: * Returns the JSON schema for this component.
public get	shouldDisable: *
public	tbody: null The HTML Element for the table body.
public	tooltip: *
public	triggerChange: function Used to trigger a new change in this component.
public	type: *
public get	validationValue: *
public	validators: [string] The validators that are assigned to this component.
public get	value: : Get the value of this component.
public	valueElement: *
public get	viewOnly: *
public set	visible
public get	visible: *
public get	wysiwygDefault: {"theme": string, "placeholder": , "modules": }

Private Members
private	_disabled: boolean Determines if this component is disabled, or not.
private	_hasCondition: null Determines if this component has a condition assigned to it.
private	_inputMask: *
private	_visible: boolean Determines if this component is visible, or not.

Method Summary

Public Methods
public	addButton(justIcon: *): HTMLElement Adds a new button to add new rows to the multiple input elements.
public	addClass(element: , className: ) Adds a class to a DOM element.
public	addEventListener(obj: , evt: , func: *) Wrapper method to add an event listener to an HTML element.
public	addInput(input: , container: , noSet: ): Add a new input to this comonent.
public	addInputError(message: , dirty: ) Add a new input error to this element.
public	addInputEventListener(input: *) Add new input element listeners.
public	addInputGroup(input: HTMLElement, container: HTMLElement): HTMLElement Adds a new input group to hold the input html elements.
public	addInputSubmitListener(input: *)
public	addNewValue(value: *) Adds a new empty value to the data array.
public	addPrefix(input: HTMLElement, inputGroup: HTMLElement): HTMLElement Adds a prefix html element.
public	addQuill(element: , settings: , onChange: ):
public	addShortcut(element: , shortcut: )
public	addShortcutToLabel(label: , shortcut: ): *
public	addSuffix(input: HTMLElement, inputGroup: HTMLElement): HTMLElement Adds a suffix html element.
public	addValue() Adds a new empty value to the data array, and add a new row to contain it.
public	append(element: *)
public	appendChild(child: *) Append different types of children.
public	appendTo(element: , container: )
public	asString(value: ): Prints out the value of this component as a string value.
public	attr(element: HtmlElement, attr: Object) Adds an object of attributes onto an element.
public	autofocus()
public	beforeNext(): * Called before a next page is triggered allowing the components to perform special functions.
public	beforeSubmit(): * Called before a submission is triggered allowing the components to perform special async functions.
public	bootstrap4Theme(name: ):
public	build() Builds the component.
public	buildInput(container: , value: )
public	buildRows(values: *) Rebuild the rows to contain the values of this component.
public	calculateValue(data: *): boolean Perform a calculated value operation.
public	ce(type: string, attr: Object, children: Various, events: Object): HTMLElement Alias for document.createElement.
public	checkConditions(data: ): Check for conditionals and hide/show the element based on those conditions.
public	checkValidity(data: , dirty: ): *
public	clear()
public	clearOnHide(show: *)
public	createDescription(container: *) Creates the description block for this input field.
public	createElement(): HTMLElement Create the outside wrapping element for this component.
public	createErrorElement() Creates a new error element to hold the errors of this element.
public	createInput(container: HTMLElement): HTMLElement Creates a new input element.
public	createLabel(container: HTMLElement) Create the HTML element for the label of this component.
public	createModal(): *
public	createTooltip(container: HTMLElement) Create the HTML element for the tooltip of this component.
public	createViewOnlyElement(): *
public	createViewOnlyLabel(container: *)
public	createViewOnlyValue(container: *)
public	createWrapper(): boolean Create the input wrapping element.
public	deleteValue() Deletes the value of the component.
public	destroy(all: *) Remove all event handlers.
public	elementInfo(): {"type": string, "component": , "changeEvent": string, "attr": } Get the element information.
public	emit(event: string, data: Object) Emit a new event.
public	empty(element: *)
public	errorMessage(type: ): Get the error message provided a certain type of error.
public	fieldLogic(data: ): Check all triggers and apply necessary actions.
public	focus()
public	getBrowserLanguage(): *
public	getElement(): HTMLElement Returns the outside wrapping element of this component.
public	getFlags(): *
public	getIcon(name: string): HTMLElement Returns an HTMLElement icon element.
public	getLabelMargin(): *
public	getLabelWidth(): *
public	getModifiedSchema(schema: , defaultSchema: ): * Returns only the schema that is different from the default.
public	getRawValue(): *
public	getRoot(): * Get FormioForm element at the root of this component tree.
public	getValue(): * Get the input value of this component.
public	getValueAt(index: ): Get the value at a specific index.
public	getView(value: ):
public	hasChanged(before: , after: ): boolean Determine if the value of this component has changed.
public	hasClass(element: , className: ): * Determines if an element has a class.
public	hasCondition(): null Determines if this component has a condition defined.
public	hasValue(data: ): Returns if this component has a value set.
public	hook(): * Allow for options to hook into the functionality of this renderer.
public	iconClass(name: , spinning: ): *
public	interpolate(string: , data: ): *
public	invalidMessage(data: , dirty: ): * Returns the invalid message, or empty string if the component is valid.
public	isEmpty(value: ):
public	isValid(data: , dirty: ): boolean Returns if the component is valid or not.
public	labelIsHidden(): *
public	labelOnTheLeft(position: ):
public	labelOnTheLeftOrRight(position: ):
public	labelOnTheRight(position: ):
public	maskPlaceholder(mask: HTMLElement): string Creates a new input mask placeholder.
public	off(event: *) Removes all listeners for a certain event.
public	on(event: string, cb: function, internal: boolean): * Register for a new event within this component.
public	onChange(flags: , fromRoot: )
public	performInputMapping(input: ):
public	prepend(element: *)
public	prependTo(element: , container: )
public	redraw()
public	removeButton(index: number): HTMLElement Creates a new "remove" row button and returns the html element of that button.
public	removeChild(element: *)
public	removeChildFrom(element: , container: )
public	removeClass(element: , className: ) Remove a class from a DOM element.
public	removeEventListener(obj: , evt: ) Remove an event listener from the object.
public	removeShortcut(element: , shortcut: )
public	removeValue(index: number) Removes a value out of the data array and rebuild the rows.
public	renderTemplate(template: , data: , actions: *): HTMLElement Render a template string into html.
public	resetValue() Resets the value of this component.
public	restoreValue() Restore the value of a control.
public	rightAlignedLabel(position: ):
public	selectOptions(select: , tag: , options: , defaultValue: )
public	setCustomValidity(message: , dirty: )
public	setDisabled(element: , disabled: )
public	setInputMask(input: HTMLElement) Sets the input mask for an input.
public	setInputStyles(input: *)
public	setLoading(element: , loading: )
public	setPristine(pristine: *) Sets the pristine flag for this component.
public	setSelectValue(select: , value: )
public	setValue(value: , flags: ): boolean Set the value of this component.
public	setValueAt(index: , value: ) Set the value at a specific index.
public	setupValueElement(element: *)
public	show(show: ): Hide or Show an element.
public	showElement(element: , show: ): * Show or hide the root element of this component.
public	splice(index: *) Splice a value from the dataValue.
public	t(text: string, params: Object): * Translate a text using the i18n system.
public	text(text: *): Text Alias to create a text node.
public	updateOnChange(flags: , changed: ): boolean Update the value on change.
public	updateValue(flags: ): Update a value of this component.
public	updateViewOnlyValue()
public	validateMultiple(value: *): boolean Check if a component is eligible for multiple validation
public	viewOnlyBuild()
public	whenReady(): *

Static Public Methods

public static schema(sources: ...): source

Params:

Name	Type	Attribute	Description
sources	...*

Return:

Public Constructors

public constructor(component: Object, options: Object, data: Object) source

Initialize a new BaseComponent.

Params:

Name	Type	Attribute	Description
component	Object		The component JSON you wish to initialize.
options	Object		The options for this component.
data	Object		The global data submission object this component will belong.

Public Members

public get className: string: * source

Retrieves the CSS class name of this component.

Return:

string

The class name of this component.

public component: * source

The Form.io component JSON schema.

public get customStyle: string: * source

Build the custom style from the layout values

Return:

string

The custom style

public data: * source

The data object in which this component resides.

public set dataValue(value: *) source

Sets the static value of this component.

public get dataValue: : source

Get the static value of this component.

Return:

public get defaultSchema: * source

public get defaultValue: * source

public get defaultViewOnlyValue: string source

public description: * source

public get disabled: boolean: * source

Return if the component is disabled.

Return:

boolean

public set disabled(disabled: boolean) source

Disable this component.

public element: null source

The bounding HTML Element which this component is rendered.

public get emptyValue: null: * source

The empty value for this component.

Return:

null

public error: string source

The existing error that this component has.

public errorContainer: * source

public errorElement: null source

The HTMLElement for which the errors are rendered for this component (usually underneath the component).

public get errorLabel: : source

Returns the error label for this component.

Return:

public get errors: * source

public eventHandlers: Array source

An array of event handlers so that the destry command can deregister them.

public eventListeners: Array source

An array of the event listeners so that the destroy command can deregister them.

public events: * source

The events that are triggered for the whole FormioForm object.

public get hasInput: * source

public i18next: * source

public id: string source

The ID of this component. This value is auto-generated when the component is created, but can also be provided from the component.id value passed into the constructor.

public info: null source

The basic component information which tells the BaseComponent how to render the input element of the components that derive from this class.

public inputs: Array source

An array of all of the input HTML Elements that have been added to this component.

public invalid: boolean source

public isBuilt: boolean source

public get key: * source

public set label(value: *) source

Set this component's label text and render it.

public get label: * source

Get this component's label text.

public labelElement: null source

The HTMLElement that is assigned to the label of this component.

public get name: string: * source

The readible name for this component.

Return:

string

The name of the component.

public options: {} source

The options for this component.

public originalComponent: * source

public parent: BaseComponent source

Points to the parent component.

public pristine: boolean source

If this input has been input and provided value.

public quill: * source

public root: BaseComponent source

Points to the root component, usually the FormComponent.

public row: number source

The row path of this component.

public get schema: * source

Returns the JSON schema for this component.

public get shouldDisable: * source

public tbody: null source

The HTML Element for the table body. This is relevant for the "multiple" flag on inputs.

public triggerChange: function source

Used to trigger a new change in this component.

public type: * source

public get validationValue: * source

public validators: [string] source

The validators that are assigned to this component.

public get value: : source

Get the value of this component.

Return:

public valueElement: * source

public get viewOnly: * source

public set visible source

public get visible: * source

public get wysiwygDefault: {"theme": string, "placeholder": , "modules": } source

Private Members

private _disabled: boolean source

Determines if this component is disabled, or not.

private _hasCondition: null source

Determines if this component has a condition assigned to it.

private _inputMask: * source

private _visible: boolean source

Determines if this component is visible, or not.

Public Methods

public addButton(justIcon: *): HTMLElement source

Adds a new button to add new rows to the multiple input elements.

Params:

Name	Type	Attribute	Description
justIcon	*

Return:

HTMLElement

The "Add New" button html element.

public addClass(element: , className: ) source

Adds a class to a DOM element.

Params:

Name	Type	Attribute	Description
element	*		The element to add a class to.
className	*		The name of the class to add.

public addEventListener(obj: , evt: , func: *) source

Wrapper method to add an event listener to an HTML element.

Params:

Name	Type	Attribute	Description
obj	*		The DOM element to add the event to.
evt	*		The event name to add.
func	*		The callback function to be executed when the listener is triggered.

public addInput(input: , container: , noSet: ): source

Add a new input to this comonent.

Params:

Name	Type	Attribute	Description
input	*
container	*
noSet	*

Return:

public addInputError(message: , dirty: ) source

Add a new input error to this element.

Params:

Name	Type	Attribute	Description
message	*
dirty	*

public addInputEventListener(input: *) source

Add new input element listeners.

Params:

Name	Type	Attribute	Description
input	*

public addInputGroup(input: HTMLElement, container: HTMLElement): HTMLElement source

Adds a new input group to hold the input html elements.

Params:

Name	Type	Attribute	Description
input	HTMLElement		The input html element.
container	HTMLElement		The containing html element for this group.

Return:

HTMLElement

The input group element.

public addInputSubmitListener(input: *) source

Params:

Name	Type	Attribute	Description
input	*

public addNewValue(value: *) source

Adds a new empty value to the data array.

Params:

Name	Type	Attribute	Description
value	*

public addPrefix(input: HTMLElement, inputGroup: HTMLElement): HTMLElement source

Adds a prefix html element.

Params:

Name	Type	Attribute	Description
input	HTMLElement		The input element.
inputGroup	HTMLElement		The group that will hold this prefix.

Return:

HTMLElement

The html element for this prefix.

public addQuill(element: , settings: , onChange: ): source

Params:

Name	Type	Attribute	Description
element	*
settings	*
onChange	*

Return:

public addShortcut(element: , shortcut: ) source

Params:

Name	Type	Attribute	Description
element	*
shortcut	*

public addShortcutToLabel(label: , shortcut: ): * source

Params:

Name	Type	Attribute	Description
label	*
shortcut	*

Return:

public addSuffix(input: HTMLElement, inputGroup: HTMLElement): HTMLElement source

Adds a suffix html element.

Params:

Name	Type	Attribute	Description
input	HTMLElement		The input element.
inputGroup	HTMLElement		The group that will hold this suffix.

Return:

HTMLElement

The html element for this suffix.

public addValue() source

Adds a new empty value to the data array, and add a new row to contain it.

public append(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public appendChild(child: *) source

Append different types of children.

Params:

Name	Type	Attribute	Description
child	*

public appendTo(element: , container: ) source

Params:

Name	Type	Attribute	Description
element	*
container	*

public asString(value: ): source

Prints out the value of this component as a string value.

Params:

Name	Type	Attribute	Description
value	*

Return:

public attr(element: HtmlElement, attr: Object) source

Adds an object of attributes onto an element.

Params:

Name	Type	Attribute	Description
element	HtmlElement		The element to add the attributes to.
attr	Object		The attributes to add to the input element.

public autofocus() source

public beforeNext(): * source

Called before a next page is triggered allowing the components to perform special functions.

Return:

public beforeSubmit(): * source

Called before a submission is triggered allowing the components to perform special async functions.

Return:

public bootstrap4Theme(name: ): source

Params:

Name	Type	Attribute	Description
name	*

Return:

public build() source

Builds the component.

public buildInput(container: , value: ) source

Params:

Name	Type	Attribute	Description
container	*
value	*

public buildRows(values: *) source

Rebuild the rows to contain the values of this component.

Params:

Name	Type	Attribute	Description
values	*

public calculateValue(data: *): boolean source

Perform a calculated value operation.

Params:

Name	Type	Attribute	Description
data	*		The global data object.

Return:

boolean

If the value changed during calculation.

public ce(type: string, attr: Object, children: Various, events: Object): HTMLElement source

Alias for document.createElement.

Params:

Name	Type	Attribute	Description
type	string		The type of element to create
attr	Object		The element attributes to add to the created element.
children	Various		Child elements. Can be a DOM Element, string or array of both.
events	Object

Return:

HTMLElement

The created element.

public checkConditions(data: ): source

Check for conditionals and hide/show the element based on those conditions.

Params:

Name	Type	Attribute	Description
data	*

Return:

public checkValidity(data: , dirty: ): * source

Params:

Name	Type	Attribute	Description
data	*
dirty	*

Return:

public clear() source

public clearOnHide(show: *) source

Params:

Name	Type	Attribute	Description
show	*

public createDescription(container: *) source

Creates the description block for this input field.

Params:

Name	Type	Attribute	Description
container	*

public createElement(): HTMLElement source

Create the outside wrapping element for this component.

Return:

HTMLElement

public createErrorElement() source

Creates a new error element to hold the errors of this element.

public createInput(container: HTMLElement): HTMLElement source

Creates a new input element.

Params:

Name	Type	Attribute	Description
container	HTMLElement		The container which should hold this new input element.

Return:

HTMLElement

Either the input or the group that contains the input.

public createLabel(container: HTMLElement) source

Create the HTML element for the label of this component.

Params:

Name	Type	Attribute	Description
container	HTMLElement		The containing element that will contain this label.

public createModal(): * source

Return:

public createTooltip(container: HTMLElement) source

Create the HTML element for the tooltip of this component.

Params:

Name	Type	Attribute	Description
container	HTMLElement		The containing element that will contain this tooltip.

public createViewOnlyElement(): * source

Return:

public createViewOnlyLabel(container: *) source

Params:

Name	Type	Attribute	Description
container	*

public createViewOnlyValue(container: *) source

Params:

Name	Type	Attribute	Description
container	*

public createWrapper(): boolean source

Create the input wrapping element. For multiple, this may be the table wrapper for the elements.

Return:

boolean

public deleteValue() source

Deletes the value of the component.

public destroy(all: *) source

Remove all event handlers.

Params:

Name	Type	Attribute	Description
all	*

public elementInfo(): {"type": string, "component": , "changeEvent": string, "attr": } source

Get the element information.

Return:

{"type": string, "component": *, "changeEvent": string, "attr": *}

public emit(event: string, data: Object) source

Emit a new event.

Params:

Name	Type	Attribute	Description
event	string		The event to emit.
data	Object		The data to emit with the handler.

public empty(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public errorMessage(type: ): source

Get the error message provided a certain type of error.

Params:

Name	Type	Attribute	Description
type	*

Return:

public fieldLogic(data: ): source

Check all triggers and apply necessary actions.

Params:

Name	Type	Attribute	Description
data	*

Return:

public focus() source

public getBrowserLanguage(): * source

Return:

public getElement(): HTMLElement source

Returns the outside wrapping element of this component.

Return:

HTMLElement

public getFlags(): * source

Return:

public getIcon(name: string): HTMLElement source

Returns an HTMLElement icon element.

Params:

Name	Type	Attribute	Description
name	string		The name of the icon to retrieve.

Return:

HTMLElement

The icon element.

public getLabelMargin(): * source

Return:

public getLabelWidth(): * source

Return:

public getModifiedSchema(schema: , defaultSchema: ): * source

Returns only the schema that is different from the default.

Params:

Name	Type	Attribute	Description
schema	*
defaultSchema	*

Return:

public getRawValue(): * source

Return:

public getRoot(): * source

Get FormioForm element at the root of this component tree.

Return:

public getValue(): * source

Get the input value of this component.

Return:

public getValueAt(index: ): source

Get the value at a specific index.

Params:

Name	Type	Attribute	Description
index	*

Return:

public getView(value: ): source

Params:

Name	Type	Attribute	Description
value	*

Return:

public hasChanged(before: , after: ): boolean source

Determine if the value of this component has changed.

Params:

Name	Type	Attribute	Description
before	*
after	*

Return:

boolean

public hasClass(element: , className: ): * source

Determines if an element has a class.

Taken from jQuery https://j11y.io/jquery/#v=1.5.0&fn=jQuery.fn.hasClass

Params:

Name	Type	Attribute	Description
element	*
className	*

Return:

public hasCondition(): null source

Determines if this component has a condition defined.

Return:

null

public hasValue(data: ): source

Returns if this component has a value set.

Params:

Name	Type	Attribute	Description
data	*

Return:

public hook(): * source

Allow for options to hook into the functionality of this renderer.

Return:

public iconClass(name: , spinning: ): * source

Params:

Name	Type	Attribute	Description
name	*
spinning	*

Return:

public interpolate(string: , data: ): * source

Params:

Name	Type	Attribute	Description
string	*
data	*

Return:

public invalidMessage(data: , dirty: ): * source

Returns the invalid message, or empty string if the component is valid.

Params:

Name	Type	Attribute	Description
data	*
dirty	*

Return:

public isEmpty(value: ): source

Params:

Name	Type	Attribute	Description
value	*

Return:

public isValid(data: , dirty: ): boolean source

Returns if the component is valid or not.

Params:

Name	Type	Attribute	Description
data	*
dirty	*

Return:

boolean

public labelIsHidden(): * source

Return:

public labelOnTheLeft(position: ): source

Params:

Name	Type	Attribute	Description
position	*

Return:

public labelOnTheLeftOrRight(position: ): source

Params:

Name	Type	Attribute	Description
position	*

Return:

public labelOnTheRight(position: ): source

Params:

Name	Type	Attribute	Description
position	*

Return:

public maskPlaceholder(mask: HTMLElement): string source

Creates a new input mask placeholder.

Params:

Name	Type	Attribute	Description
mask	HTMLElement		The input mask.

Return:

string

The placeholder that will exist within the input as they type.

public off(event: *) source

Removes all listeners for a certain event.

Params:

Name	Type	Attribute	Description
event	*

public on(event: string, cb: function, internal: boolean): * source

Params:

Name	Type	Attribute	Description
event	string		The event you wish to register the handler for.
cb	function		The callback handler to handle this event.
internal	boolean		This is an internal event handler.

Return:

Example:

let component = new BaseComponent({
  type: 'textfield',
  label: 'First Name',
  key: 'firstName'
});
component.on('componentChange', (changed) => {
  console.log('this element is changed.');
});

public onChange(flags: , fromRoot: ) source

Params:

Name	Type	Attribute	Description
flags	*
fromRoot	*

public performInputMapping(input: ): source

Params:

Name	Type	Attribute	Description
input	*

Return:

public prepend(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public prependTo(element: , container: ) source

Params:

Name	Type	Attribute	Description
element	*
container	*

public redraw() source

public removeButton(index: number): HTMLElement source

Creates a new "remove" row button and returns the html element of that button.

Params:

Name	Type	Attribute	Description
index	number		The index of the row that should be removed.

Return:

HTMLElement

The html element of the remove button.

public removeChild(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public removeChildFrom(element: , container: ) source

Params:

Name	Type	Attribute	Description
element	*
container	*

public removeClass(element: , className: ) source

Remove a class from a DOM element.

Params:

Name	Type	Attribute	Description
element	*		The DOM element to remove the class from.
className	*		The name of the class that is to be removed.

public removeEventListener(obj: , evt: ) source

Remove an event listener from the object.

Params:

Name	Type	Attribute	Description
obj	*
evt	*

public removeShortcut(element: , shortcut: ) source

Params:

Name	Type	Attribute	Description
element	*
shortcut	*

public removeValue(index: number) source

Removes a value out of the data array and rebuild the rows.

Params:

Name	Type	Attribute	Description
index	number		The index of the data element to remove.

public renderTemplate(template: , data: , actions: *): HTMLElement source

Render a template string into html.

Params:

Name	Type	Attribute	Description
template	*
data	*
actions	*

Return:

HTMLElement

The created element.

public resetValue() source

Resets the value of this component.

public restoreValue() source

Restore the value of a control.

public rightAlignedLabel(position: ): source

Params:

Name	Type	Attribute	Description
position	*

Return:

public selectOptions(select: , tag: , options: , defaultValue: ) source

Params:

Name	Type	Attribute	Description
select	*
tag	*
options	*
defaultValue	*

public setCustomValidity(message: , dirty: ) source

Params:

Name	Type	Attribute	Description
message	*
dirty	*

public setDisabled(element: , disabled: ) source

Params:

Name	Type	Attribute	Description
element	*
disabled	*

public setInputMask(input: HTMLElement) source

Sets the input mask for an input.

Params:

Name	Type	Attribute	Description
input	HTMLElement		The html input to apply the mask to.

public setInputStyles(input: *) source

Params:

Name	Type	Attribute	Description
input	*

public setLoading(element: , loading: ) source

Params:

Name	Type	Attribute	Description
element	*
loading	*

public setPristine(pristine: *) source

Sets the pristine flag for this component.

Params:

Name	Type	Attribute	Description
pristine	*		{boolean} - TRUE to make pristine, FALSE not pristine.

public setSelectValue(select: , value: ) source

Params:

Name	Type	Attribute	Description
select	*
value	*

public setValue(value: , flags: ): boolean source

Set the value of this component.

Params:

Name	Type	Attribute	Description
value	*
flags	*

Return:

boolean

If the value changed.

public setValueAt(index: , value: ) source

Set the value at a specific index.

Params:

Name	Type	Attribute	Description
index	*
value	*

public setupValueElement(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public show(show: ): source

Hide or Show an element.

Params:

Name	Type	Attribute	Description
show	*

Return:

public showElement(element: , show: ): * source

Show or hide the root element of this component.

Params:

Name	Type	Attribute	Description
element	*
show	*

Return:

public splice(index: *) source

Splice a value from the dataValue.

Params:

Name	Type	Attribute	Description
index	*

public t(text: string, params: Object): * source

Translate a text using the i18n system.

Params:

Name	Type	Attribute	Description
text	string		The i18n identifier.
params	Object		The i18n parameters to use for translation.

Return:

public text(text: *): Text source

Alias to create a text node.

Params:

Name	Type	Attribute	Description
text	*

Return:

Text

public updateOnChange(flags: , changed: ): boolean source

Update the value on change.

Params:

Name	Type	Attribute	Description
flags	*
changed	*

Return:

boolean

public updateValue(flags: ): source

Update a value of this component.

Params:

Name	Type	Attribute	Description
flags	*

Return:

public updateViewOnlyValue() source

public validateMultiple(value: *): boolean source

Check if a component is eligible for multiple validation

Params:

Name	Type	Attribute	Description
value	*

BaseComponent

Direct Subclass:

Indirect Subclass:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Methods

public static schema(sources: ...*): * source

Params:

Return:

Public Constructors

public constructor(component: Object, options: Object, data: Object) source

Params:

Public Members

public get className: string: * source

Return:

public component: * source

public get customStyle: string: * source

Return:

public data: * source

public set dataValue(value: *) source

public get dataValue: *: * source

Return:

public get defaultSchema: * source

public get defaultValue: * source

public get defaultViewOnlyValue: string source

public description: * source

public get disabled: boolean: * source

Return:

public set disabled(disabled: boolean) source

public element: null source

public get emptyValue: null: * source

Return:

public error: string source

public errorContainer: * source

public errorElement: null source

public get errorLabel: *: * source

Return:

public get errors: * source

public eventHandlers: Array source

public eventListeners: Array source

public events: * source

public get hasInput: * source

public i18next: * source

public id: string source

public info: null source

public inputs: Array source

public invalid: boolean source

public isBuilt: boolean source

public get key: * source

public set label(value: *) source

public get label: * source

public labelElement: null source

public get name: string: * source

Return:

public options: {} source

public originalComponent: * source

public parent: BaseComponent source

public pristine: boolean source

public quill: * source

public root: BaseComponent source

public row: number source

public get schema: * source

public get shouldDisable: * source

public tbody: null source

public tooltip: * source

public triggerChange: function source

public type: * source

public get validationValue: * source

public validators: [string] source

public get value: *: * source

Return:

public valueElement: * source

public get viewOnly: * source

public set visible source

public get visible: * source

public get wysiwygDefault: {"theme": string, "placeholder": *, "modules": *} source

Private Members

private _disabled: boolean source

public static schema(sources: ...): source

public get dataValue: : source

public get errorLabel: : source

public get value: : source

public get wysiwygDefault: {"theme": string, "placeholder": , "modules": } source

public addClass(element: , className: ) source

public addEventListener(obj: , evt: , func: *) source

public addInput(input: , container: , noSet: ): source

public addInputError(message: , dirty: ) source

public addQuill(element: , settings: , onChange: ): source

public addShortcut(element: , shortcut: ) source

public addShortcutToLabel(label: , shortcut: ): * source

public appendTo(element: , container: ) source

public asString(value: ): source

public bootstrap4Theme(name: ): source

public buildInput(container: , value: ) source