FormComponent
Extends:
Static Member Summary
Static Public Members | ||
public static get |
builderInfo: {"title": string, "icon": string, "group": string, "documentation": string, "weight": number, "schema": *} |
Static Method Summary
Static Public Methods | ||
public static |
schema(extend: ...*): * |
Member Summary
Public Members | ||
public |
|
|
public get |
currentForm: * |
|
public set |
|
|
public get |
dataReady: * |
|
public |
dataValue: * |
|
public get |
|
|
public get |
defaultValue: * |
|
public get |
emptyValue: {"data": *} |
|
public get |
errors: * |
|
public |
formObj: {"display": *, "settings": *, "components": *} |
|
public |
|
|
public get |
|
|
public set |
|
|
public get |
ready: * |
|
public get |
shouldSubmit: * | boolean: * Determine if the subform should be submitted. |
|
public |
subForm: * |
|
public |
subFormReady: * |
|
public |
|
|
public get |
visible: * |
|
public set |
|
Private Members | ||
private |
_currentForm: * |
|
private |
|
|
private |
_visible: * |
Method Summary
Public Methods | ||
public |
areAllComponentsEmpty(data: *): * |
|
public |
asString(value: *): * |
|
public |
attach(element: *): * |
|
public |
beforePage(next: *): * Submit the form before the next page is triggered. |
|
public |
beforeSubmit(): * Submit the form before the whole form is triggered. |
|
public |
calculateValue(data: *, flags: *, row: *): * |
|
public |
checkComponentConditions(data: *, flags: *, row: *): * |
|
public |
checkComponentValidity(data: *, dirty: *, row: *): * |
|
public |
createEmitter(): * |
|
public |
createSubForm(): * Create a subform instance. |
|
public |
|
|
public |
destroy() |
|
public |
detach() |
|
public |
everyComponent(args: *): * | void Pass everyComponent to subform. |
|
public |
getComponent(path: *, fn: *): * |
|
public |
getSubFormData(): * Returns the data for the subform. |
|
public |
getSubOptions(options: {}): * |
|
public |
getValue(): * |
|
public |
getValueAsString(value: *): string Prints out the value of form components as a datagrid value. |
|
public |
init(): * |
|
public |
isEmpty(value: *): * |
|
public |
isHidden(): * |
|
public |
isInternalEvent(event: *): boolean |
|
public |
loadSubForm(): * Load the subform. |
|
public |
redraw(): * |
|
public |
render(): * |
|
public |
setPristine(pristine: *) |
|
public |
setValue(submission: *, flags: {}): * |
|
public |
submitSubForm(rejectOnError: *): * Submit the subform if configured to do so. |
|
public |
|
Static Public Members
Static Public Methods
public static schema(extend: ...*): * source
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
Public Members
public componentModal: * source
public get currentForm: * source
public set currentForm source
public get dataReady: * source
public dataValue: * source
public get defaultSchema: * source
public get defaultValue: * source
public get emptyValue: {"data": *} source
public get errors: * source
public formObj: {"display": *, "settings": *, "components": *} source
public get parentVisible: * source
public set parentVisible source
public get ready: * source
public subForm: * source
public subFormReady: * source
public get visible: * source
public set visible source
Private Members
private _currentForm: * source
private _parentVisible: * source
private _visible: * source
Public Methods
public areAllComponentsEmpty(data: *): * source
Params:
Name | Type | Attribute | Description |
data | * |
Return:
* |
public beforePage(next: *): * source
Submit the form before the next page is triggered.
Params:
Name | Type | Attribute | Description |
next | * |
Return:
* |
public calculateValue(data: *, flags: *, row: *): * source
Params:
Name | Type | Attribute | Description |
data | * | ||
flags | * | ||
row | * |
Return:
* |
public checkComponentConditions(data: *, flags: *, row: *): * source
Params:
Name | Type | Attribute | Description |
data | * | ||
flags | * | ||
row | * |
Return:
* |
public checkComponentValidity(data: *, dirty: *, row: *): * source
Params:
Name | Type | Attribute | Description |
data | * | ||
dirty | * | ||
row | * |
Return:
* |
public deleteValue() source
public destroy() source
public detach() source
public everyComponent(args: *): * | void source
Pass everyComponent to subform.
Params:
Name | Type | Attribute | Description |
args | * |
Return:
* | void |
public getComponent(path: *, fn: *): * source
Params:
Name | Type | Attribute | Description |
path | * | ||
fn | * |
Return:
* |
public getSubOptions(options: {}): * source
Params:
Name | Type | Attribute | Description |
options | {} |
|
Return:
* |
public getValueAsString(value: *): string source
Prints out the value of form components as a datagrid value.
Params:
Name | Type | Attribute | Description |
value | * |
public setPristine(pristine: *) source
Params:
Name | Type | Attribute | Description |
pristine | * |
public setValue(submission: *, flags: {}): * source
Params:
Name | Type | Attribute | Description |
submission | * | ||
flags | {} |
|
Return:
* |
public submitSubForm(rejectOnError: *): * source
Submit the subform if configured to do so.
Params:
Name | Type | Attribute | Description |
rejectOnError | * |
Return:
* |