Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InputField

Hierarchy

Index

Properties

declaredClass

declaredClass: string

Readonly description

description: string

The field's description.

Read more...

destroyed

destroyed: boolean

Readonly domain

The input value's domain.

Read more...

Readonly editable

editable: boolean

When true, the field can be edited.

Read more...

Readonly editorType

editorType: "text-box" | "text-area"

The type of editor used when working with string fields.

Read more...

Readonly error

error: string

If the input field's value is invalid, this property returns validation error code.

Read more...

Readonly errorMessage

errorMessage: string

A user-friendly formatted error message based on the validation error code.

Read more...

Readonly group

The group this input field belongs to.

Read more...

Readonly hint

hint: string

A hint for the field's value.

Read more...

Readonly includeTime

includeTime: string

For date inputs, this enables the time input part.

Read more...

initialized

initialized: boolean

Readonly label

label: string

The field's label.

Read more...

Readonly maxLength

maxLength: number

Restricts the input length.

Read more...

Readonly minLength

minLength: number

Restricts the input length.

Read more...

Readonly name

name: string

The associated field name.

Read more...

Readonly required

required: boolean

Indicates whether the field is required.

Read more...

Readonly type

type: "number" | "date" | "unsupported" | "text"

The type of input field.

Read more...

Readonly valid

valid: boolean

When true, the input value is valid.

Read more...

Readonly value

value: any

The input's value.

Read more...

Readonly visible

visible: boolean

When true, the field is displayed.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): InputField
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns InputField

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns InputField

  • Parameters

    Returns InputField

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc