Class FormControl`Abstract`

Base class of all form controls.Writes values into the fields blob, sets ui classes and defines the structure of all form controls.

Hierarchy

FormControl

Index

Constructors

Properties

defaultValue disposed element enabled label labelEl onChanged required tooltip visiting

Methods

deleteFields disable dispose enable get getAllValues getDefault getPostfixFieldId getWithId hide isRepeatingUnit set setLabel setWithId show val

Constructors

constructor

new FormControl(): FormControl
Returns FormControl

Properties

defaultValue

defaultValue: any

`Protected` disposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

onChanged

onChanged: Function

required

required: boolean

tooltip

tooltip: string

visiting

visiting: boolean = false

Methods

deleteFields

deleteFields(name: string): Promise<any>
Deletes the all fields related to the form control.
Parameters
- name: string
  
  The field id.
Returns Promise<any>

disable

disable(): void
Disables the form control.

Returns void

dispose

dispose(): void
Disposes the form control.

Returns void

enable

enable(): void
Enables the form control.

Returns void

get

get(): IFormField
Gets the corresponding field of the form control.

Returns IFormField

getAllValues

getAllValues(): any
Returns
all fields and values that are connected with the the form control.

Returns any

getDefault

getDefault(): any
Gets the default value auf the form control, if it is set.

Returns any

getPostfixFieldId

getPostfixFieldId(): string
Gets the PostfixFieldId. Relevant for operations in repeating units. Check first, if the form control is contained in a repeating unit, see: isRepeatingUnit.

Returns string

getWithId

getWithId(id: string): IFormField
Searches for a field by providing its id.
Parameters
- id: string
  
  The id of the field.
Returns IFormField

hide

hide(animate?: boolean, lock?: boolean): void
Hide FormControl
Parameters
- animate: boolean = false
  
  En/Disable animation
- lock: boolean = true
  
  Enable lock of hidden FormControl to not process control with condition
Returns void

isRepeatingUnit

isRepeatingUnit(): boolean
Checks if the form control is included in a repeating unit.

Returns boolean

set

set(value: any): number
Sets the field value of the form control. Be careful: This does not update the UI. In most cases it is better to use the val() method, see: val
Parameters
- value: any
  
  The value of the field
Returns number

setLabel

setLabel(value: string): void
Sets a new label value.
Parameters
- value: string
  
  The value to set.
Returns void

setWithId

setWithId(id: string, val: any): number
Sets any field value by providing its id.
Parameters
- id: string
  
  The id of the field.
- val: any
  
  The value of the field. Data type is an object. Its structure depends on the specific field type.
Returns number

show

show(animate?: boolean, unlock?: boolean): void
Show hidden FormControl
Parameters
- animate: boolean = false
  
  En/Disable animation
- unlock: boolean = true
  
  Disable lock of hidden state to process control with condition
Returns void

`Abstract` val

val(value?: any, disableOnChanged?: any): any
Sets ui value and updates the field value.
Parameters
- Optional value: any
  
  The value of the field. Data type is an object. Its structure depends on the specific field type/form control.
- Optional disableOnChanged: any
Returns any

Generated using TypeDoc