Class DorfMetadataBase<T, D>

Base class for field and for the nested object.

stable

Type parameters

T
D: IDorfDefinitionBase<T>

Hierarchy

DorfMetadataBase

Implements

IDorfFieldMetadata<T>
IDorfDefinitionBase<T>

Index

Constructors

constructor

Properties

Accessors

Methods

getCss

Constructors

constructor

new DorfMetadataBase(definition: D, options?: IDorfFieldMetadata<T>): DorfMetadataBase

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:53
Called by DorfMapper.

Parameters
- definition: D
  
  extension of IDorfDefinitionBase with parameters to be propagated
- Optional options: IDorfFieldMetadata<T>
  
  extension of IDorfFieldMetadata
Returns DorfMetadataBase

Properties

Protected Optional _invalid

_invalid: undefined | true | false

Protected Optional _value

_value: T

Protected definition

definition: D

extension of IDorfDefinitionBase with parameters to be propagated

Accessors

css

get css(): undefined | IDorfFieldCssClasses

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:87
CSS classes which should be assigned to this field.

inheritdoc

Returns undefined | IDorfFieldCssClasses

invalid

get invalid(): undefined | true | false

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:83
inheritdoc

Returns undefined | true | false

key

get key(): string

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:79
An unique identifier, property name. Used as id in HTML element.

inheritdoc

Returns string

label

get label(): undefined | string

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:85
Label which should describe the field.

inheritdoc

Returns undefined | string

order

get order(): number | undefined
set order(newOrder: number | undefined): void

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:89
Represents element index in the form.

inheritdoc

Returns number | undefined
- Defined in src/fields/base/abstract-dorf-field.metadata.ts:91
Represents element index in the form.

inheritdoc

Parameters
- newOrder: number | undefined
Returns void

parentCss

get parentCss(): undefined | IDorfGeneralCssClasses

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:93
When metadata is nested within the group, group is passing its CSS.

inheritdoc

Returns undefined | IDorfGeneralCssClasses

tag

get tag(): string

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:96
Tag is de facto a selector for the component. It allows to identify a particular component in HTML form.

inheritdoc

Returns string

value

get value(): undefined | T

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:81
Value of the field.

inheritdoc

Returns undefined | T

Methods

getCss

getCss(cssClass: string): undefined | string | IDorfCommonCssClasses

- Defined in src/fields/base/abstract-dorf-field.metadata.ts:103
Gets CSS classes, with accordance to the priorities. The closer the definition, the sooner applied.

Parameters
- cssClass: string
  
  classes to be got, e.g. 'label' for label ones
Returns undefined | string | IDorfCommonCssClasses

Generated using TypeDoc